fixtures Namespace Reference

Classes
class	AlwaysTrueDefaultDict

Functions
	pytest_configure (config)
	pytest_collection_modifyitems (config, items)
Optional[str]	_get_shared_cwd_id (type cls)
Path	_path_for_shared_cwd (pytest.Config config, str cwd_id)
Generator[FixtureResult, None, None]	fixture_result (pytest.FixtureRequest request, Callable tmp_path_factory)
Generator[subprocess.CompletedProcess, None, None]	completed_process (FixtureResult fixture_result)
Generator[bytes, None, None]	stdout (subprocess.CompletedProcess completed_process)
Generator[bytes, None, None]	stderr (subprocess.CompletedProcess completed_process)
Generator[int, None, None]	returncode (subprocess.CompletedProcess completed_process)
Generator[Path, None, None]	cwd (FixtureResult fixture_result)
None	check_for_exceptions (pytest.FixtureRequest request, FixtureResult fixture_result)
None	capture_class_docstring (pytest.FixtureRequest request)
Generator[Optional[Path], None, None]	reference_path (request)
Generator[dict, None, None]	reference (request, Optional[Path] reference_path)

Variables
	pytestmark
	popen_kwargs
	__doc__
	reference = expand_reference_file_name(path)

Function Documentation

_get_shared_cwd_id()

Optional[str] fixtures._get_shared_cwd_id ( type cls )

protected

Extract the id of the shared cwd directory needed by the class, if any.

If the class is marked with shared_cwd multiple times only the last one
is taken into account.

Return the id or None.

Definition at line 86 of file fixtures.py.

def _get_shared_cwd_id(cls: type) -> Optional[str]:
    """
    Extract the id of the shared cwd directory needed by the class, if any.
 
    If the class is marked with shared_cwd multiple times only the last one
    is taken into account.
 
    Return the id or None.
    """
    if hasattr(cls, "pytestmark"):
        for mark in cls.pytestmark:
            if mark.name == "shared_cwd":
                return mark.args[0]
    return None
 
 

_path_for_shared_cwd()

Path fixtures._path_for_shared_cwd ( pytest.Config config, str cwd_id )

protected

Return the path to the shared directory identified by id.

Definition at line 102 of file fixtures.py.

def _path_for_shared_cwd(config: pytest.Config, cwd_id: str) -> Path:
    """
    Return the path to the shared directory identified by id.
    """
    name = f"gaudi.{get_platform()}.{cwd_id}".replace("/", "_")
    return config.cache.mkdir(name)
 
 
@pytest.fixture(scope="class")

capture_class_docstring()

None fixtures.capture_class_docstring

(

pytest.FixtureRequest

request

)

Definition at line 178 of file fixtures.py.

) -> None:
    cls = request.cls
    if cls and cls.__doc__:
        results[f"{cls.__name__}.doc"] = inspect.getdoc(cls)
 
 
@pytest.fixture(scope="class")

check_for_exceptions()

None fixtures.check_for_exceptions	(	pytest.FixtureRequest	request,
		FixtureResult	fixture_result )

Definition at line 166 of file fixtures.py.

) -> None:
    if (
        fixture_result
        and fixture_result.run_exception is not None
        and "test_fixture_setup" not in request.keywords
    ):
        pytest.skip(f"{fixture_result.run_exception}")
 
 
@pytest.fixture(scope="class", autouse=True)

completed_process()

Generator[subprocess.CompletedProcess, None, None] fixtures.completed_process

(

FixtureResult

fixture_result

)

Definition at line 133 of file fixtures.py.

) -> Generator[subprocess.CompletedProcess, None, None]:
    yield fixture_result.completed_process if fixture_result else None
 
 
@pytest.fixture(scope="class")

cwd()

Generator[Path, None, None] fixtures.cwd

(

FixtureResult

fixture_result

)

Definition at line 161 of file fixtures.py.

def cwd(fixture_result: FixtureResult) -> Generator[Path, None, None]:
    yield Path(fixture_result.cwd) if fixture_result else None
 
 
@pytest.fixture(autouse=True)

fixture_result()

Generator[FixtureResult, None, None] fixtures.fixture_result	(	pytest.FixtureRequest	request,
		Callable	tmp_path_factory )

Definition at line 111 of file fixtures.py.

) -> Generator[FixtureResult, None, None]:
    cls = request.cls
    result = None
    if cls and issubclass(cls, SubprocessBaseTest):
        if hasattr(cls, "popen_kwargs") and "cwd" not in cls.popen_kwargs:
            cwd_id = _get_shared_cwd_id(cls)
            cls.popen_kwargs["cwd"] = (
                _path_for_shared_cwd(request.config, cwd_id)
                if cwd_id
                else tmp_path_factory.mktemp("workdir")
            )
        result = cls.run_program(
            tmp_path=tmp_path_factory.mktemp("tmp-", numbered=True)
        )
 
    yield result
 
 
@pytest.fixture(scope="class")

pytest_collection_modifyitems()

fixtures.pytest_collection_modifyitems	(		config,
			items )

Record source code of tests.

Definition at line 69 of file fixtures.py.

def pytest_collection_modifyitems(config, items):
    """
    Record source code of tests.
    """
    for item in items:
        if isinstance(item, pytest.Function) and not item.get_closest_marker(
            "do_not_collect_source"
        ):
            name = (
                f"{item.parent.name}.{item.originalname}"
                if isinstance(item.parent, pytest.Class)
                else item.originalname
            )
            source_code = CodeWrapper(inspect.getsource(item.function), "python")
            results[f"{name}.source_code"] = source_code
 
 

pytest_configure()

fixtures.pytest_configure

(

config

)

Definition at line 58 of file fixtures.py.

def pytest_configure(config):
    config.addinivalue_line(
        "markers",
        "shared_cwd(id): make SubprocessBaseTest tests share a working directory",
    )
    config.addinivalue_line(
        "markers",
        "do_not_collect_source: flag the test code as not to be collected",
    )
 
 

reference()

Generator[dict, None, None] fixtures.reference	(		request,
		Optional[Path]	reference_path )

Definition at line 211 of file fixtures.py.

def reference(request, reference_path: Optional[Path]) -> Generator[dict, None, None]:
    cls = request.cls
    original_reference_data = None
    current_reference_data = None
 
    if reference_path:
        if reference_path.exists() and reference_path.stat().st_size > 0:
            with open(reference_path, "r") as f:
                original_reference_data = yaml.safe_load(f)
        else:
            # if the file does not exist we may have a relative path, so
            # we have to resolve it wrt the file containing the test class
            reference_path = file_path_for_class(cls).parent / reference_path
            original_reference_data = AlwaysTrueDefaultDict(lambda: None)
 
        current_reference_data = original_reference_data.copy()
 
    elif hasattr(cls, "reference") and isinstance(cls.reference, dict):
        original_reference_data = cls.reference
        current_reference_data = original_reference_data.copy()
 
    yield current_reference_data
 
    if current_reference_data == original_reference_data:
        return
 
    if reference_path:
        cnt = 0
        newrefname = f"{reference_path}.new"
        while os.path.exists(newrefname):
            cnt += 1
            newrefname = f"{reference_path}.~{cnt}~.new"
 
        if os.environ.get("GAUDI_TEST_IGNORE_STDOUT_VALIDATION") == "1":
            # when we ignore stdout validation we just overwrite the reference file
            newrefname = reference_path
 
        os.makedirs(os.path.dirname(newrefname), exist_ok=True)
        with open(newrefname, "w") as f:
            yaml.safe_dump(current_reference_data, f, sort_keys=False)

reference_path()

Generator[Optional[Path], None, None] fixtures.reference_path

(

request

)

Definition at line 187 of file fixtures.py.

def reference_path(request) -> Generator[Optional[Path], None, None]:
    cls = request.cls
 
    if not hasattr(cls, "reference") or cls.reference is None:
        yield None
 
    elif isinstance(cls.reference, (str, os.PathLike)):
        path = cls.reference
        if hasattr(cls, "resolve_path"):
            path = cls.resolve_path(path)
 
        path = expand_reference_file_name(path)
        yield Path(path) if path else None
 
    elif isinstance(cls.reference, dict):
        yield None
 
    else:
        raise ValueError(
            f"Invalid reference type {type(cls.reference)}, only str, PathLike or dict are allowed"
        )
 
 
@pytest.fixture(scope="class")

returncode()

Generator[int, None, None] fixtures.returncode

(

subprocess.CompletedProcess

completed_process

)

Definition at line 154 of file fixtures.py.

) -> Generator[int, None, None]:
    yield completed_process.returncode if completed_process else None
 
 
@pytest.fixture(scope="class")

stderr()

Generator[bytes, None, None] fixtures.stderr

(

subprocess.CompletedProcess

completed_process

)

Definition at line 147 of file fixtures.py.

) -> Generator[bytes, None, None]:
    yield completed_process.stderr if completed_process else None
 
 
@pytest.fixture(scope="class")

stdout()

Generator[bytes, None, None] fixtures.stdout

(

subprocess.CompletedProcess

completed_process

)

Definition at line 140 of file fixtures.py.

) -> Generator[bytes, None, None]:
    yield completed_process.stdout if completed_process else None
 
 
@pytest.fixture(scope="class")

Variable Documentation

__doc__

fixtures.__doc__

private

Definition at line 182 of file fixtures.py.

popen_kwargs

fixtures.popen_kwargs

Definition at line 118 of file fixtures.py.

pytestmark

fixtures.pytestmark

Definition at line 96 of file fixtures.py.

reference

fixtures.reference = expand_reference_file_name(path)

Definition at line 193 of file fixtures.py.