Class TestSet

Test/testlib/testset.py:216–274

A suite of related images used for testing, comprised of a list of TestImage instances. TestImages are discovered by reading images from a directory in the filesystem. Attributes: name: The name of the test set. tests: The list of TestImages forming the set.

class TestSet:
    '''
    A suite of related images used for testing, comprised of a list of
    TestImage instances. TestImages are discovered by reading images from a
    directory in the filesystem.

    Attributes:
        name: The name of the test set.
        tests: The list of TestImages forming the set.
    '''

    def __init__(self, name: str, set_dir: Path, profiles: list[str],
                 formats: list[str], target_image: Optional[str] = None):
        '''
        Create a new TestSet using file-system discovery to find the images.

        Args:
            name: The name of the test set.
            set_dir: The root directory of the test set.
            profiles: The compressor profiles to allow.
            formats: The image formats to allow.
            target_image: The name of the image to keep (for bug repo).

        Raise:
            TestSetException: The test set could not be loaded.
        '''
        self.name = name

        if not set_dir.exists() or not set_dir.is_dir():
            raise TestSetException(f'Bad test set directory ({set_dir})')

        self.tests = []

        for (dir_path, _, file_names) in set_dir.walk():
            for file_name in file_names:
                file_path = dir_path / file_name

                # Only select image files
                ext = file_path.suffix
                if ext not in TestImage.TEST_EXTS:
                    continue

                # Create the TestImage for each file on disk
                image = TestImage(file_path)

                # Filter out the images we don't want to keep
                if image.color_profile not in profiles:
                    continue

                if image.color_format not in formats:
                    continue

                if target_image and image.file_name != target_image:
                    continue

                self.tests.append(image)

        # Sort the images so they are in a stable order