Skip to content

Pytest plugin

pytest_plugin

pytest11 plugin: every pytest session runs inside a fresh AXM sandbox.

Registered under the pytest11 entry point, so any pytest session in an environment where axm-config is installed resolves the six AXM state paths under an ephemeral mkdtemp root instead of the real ~/axm state. The sandbox lives in AXM_SANDBOX_* environment keys, so subprocesses spawned by tests inherit it. Bypass with -p no:axm_config.

pytest_configure(config)

Activate a sandbox on a fresh temporary root for this session.

Source code in packages/axm-config/src/axm_config/pytest_plugin.py
Python
29
30
31
32
33
34
35
36
37
38
39
40
@pytest.hookimpl(tryfirst=True)
def pytest_configure(config: pytest.Config) -> None:
    """Activate a sandbox on a fresh temporary root for this session."""
    from axm_config.sandbox import SandboxEscapeError, activate_sandbox

    root = Path(tempfile.mkdtemp(prefix="axm-"))
    try:
        sandbox = activate_sandbox(root)
    except SandboxEscapeError as exc:
        shutil.rmtree(root, ignore_errors=True)
        raise pytest.UsageError(str(exc)) from exc
    config.stash[_SANDBOX_KEY] = (sandbox, root)

pytest_unconfigure(config)

Restore the pre-session environment and remove the sandbox root.

Source code in packages/axm-config/src/axm_config/pytest_plugin.py
Python
43
44
45
46
47
48
49
50
51
52
53
54
def pytest_unconfigure(config: pytest.Config) -> None:
    """Restore the pre-session environment and remove the sandbox root."""
    entry = config.stash.get(_SANDBOX_KEY, None)
    if entry is None:
        return
    from axm_config.sandbox import deactivate_sandbox

    del config.stash[_SANDBOX_KEY]

    sandbox, root = entry
    deactivate_sandbox(sandbox)
    shutil.rmtree(root, ignore_errors=True)