Class TestRun

tools/testing/test_run.py:6–228

TestRun defines the set of tests that should be run together in a single pytest invocation. It'll either be a whole test file or a subset of a test file. This class assumes that we won't always know the full set of TestClasses in a test file. So it's designed to include or exclude

class TestRun:
    """
    TestRun defines the set of tests that should be run together in a single pytest invocation.
    It'll either be a whole test file or a subset of a test file.

    This class assumes that we won't always know the full set of TestClasses in a test file.
    So it's designed to include or exclude explicitly requested TestClasses, while having accepting
    that there will be an ambiguous set of "unknown" test classes that are not expliclty called out.
    Those manifest as tests that haven't been explicitly excluded.
    """

    test_file: str
    _exclued: Set[str]  # Tests that should be excluded from this test run
    _included: Set[str]  # If non-empy, only these tests should be run in this test run

    def __init__(
        self,
        name: str,
        excluded: Optional[Iterable[str]] = None,
        included: Optional[Iterable[str]] = None,
    ) -> None:
        self._excluded = set()
        self._included = set()

        if excluded and included:
            raise ValueError("Can't specify both included and excluded")

        if "::" in name:
            assert (
                not included and not excluded
            ), "Can't specify included or excluded tests when specifying a test class in the file name"
            self.test_file, test_class = name.split("::")
            self._included.add(test_class)
        else:
            self.test_file = name

        # For testing purposes
        if excluded:
            self._excluded = set(excluded)
        if included:
            self._included = set(included)

    @staticmethod
    def empty() -> "TestRun":
        return TestRun("")

    def is_empty(self) -> bool:
        # Lack of a test_file means that this is an empty run,
        # which means there is nothing to run. It's the zero.
        return not self.test_file

    def is_full_file(self) -> bool:
        return not self._included and not self._excluded

    def included(self) -> Set[str]:
        return self._included.copy()

    def excluded(self) -> Set[str]: