livery.workshop._test_guard¶
livery.workshop._test_guard ¶
The workshop's test guard: what an extension mount writes goes back after every test.
Registered under footman's footman.test_guards entry-point group, so
footman's pytest plugin calls guard
once per test process, after it has pointed the runner's directories
away, and enters what it returns around every test. Nothing here
imports pytest: a session in a venv with the workshop loads this module
whatever runs the tests.
What an extension mount writes is put back after every test: the steps the listed extensions declare, the CI jobs they contribute and join, the task tree a run keeps, and the mount's record of what it found. Each of the three modules that hold them saves and restores its own state (livery.workshop._steps.snapshot, livery.workshop._points.snapshot and livery.workshop._extensions.snapshot). These registries are the workshop's own, so footman's registry guard does not hold them. Without the guard, a step one test mounted would judge the changes of every later test in the worker. Registries the test loaded itself go back as a process starts with them, and a session that loads none of them imports nothing for the guard.
Functions:
| Name | Description |
|---|---|
guard |
Drop the check leg's label, and hand footman the mount guard. |
mount_state_stays |
Put back what an extension mount wrote during the test. |
Attributes:
| Name | Type | Description |
|---|---|---|
MOUNT_MODULES |
|
MOUNT_MODULES
module-attribute
¶
MOUNT_MODULES = ('livery.workshop._extensions', 'livery.workshop._points', 'livery.workshop._steps')
guard ¶
guard(**facts: object) -> Callable[[], AbstractContextManager[None]]
Drop the check leg's label, and hand footman the mount guard.
The job runner names the leg, its shard included, to every child it spawns, and a test that drives the gate in-process would otherwise run as that shard and leave every step without the flag to the first one. A test that wants a leg sets the variable itself.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**facts
|
object
|
What footman knows about the session: |
{}
|
Returns:
| Type | Description |
|---|---|
Callable[[], AbstractContextManager[None]]
|
|
Callable[[], AbstractContextManager[None]]
|
which footman enters around every test. |
Source code in packages/workshop/src/livery/workshop/_test_guard.py
mount_state_stays ¶
mount_state_stays() -> Generator[None, None, None]
Put back what an extension mount wrote during the test.
The registries go back as they were before the test. When the test loaded them itself, they go back as a process starts with them. A session that loads none of them imports nothing here.