diff --git a/docs/developers-guide.md b/docs/developers-guide.md index fc439913..c1daeec4 100644 --- a/docs/developers-guide.md +++ b/docs/developers-guide.md @@ -140,6 +140,69 @@ If a workflow's behaviour genuinely depends on a feature only present from a particular commit onwards, express that as a comment or a changelog note, not as a test assertion on the SHA string. +## Mutation-testing workflow contract tests + +This repository runs scheduled, informational mutation testing through a thin +caller workflow, +[`.github/workflows/mutation-testing.yml`](../.github/workflows/mutation-testing.yml), +which delegates to the shared reusable workflow +`leynos/shared-actions/.github/workflows/mutation-mutmut.yml`. The heavy +lifting — running `mutmut`, and summarizing survivors — lives in +`shared-actions`; this repository carries only declarative configuration. The +run is **informational only**: it never gates a pull request. Survivors are +reported through the job summary and downloadable artefacts so they can be +triaged into tests, not enforced as a blocking check. The mutation targets and +test selection themselves are configured in `[tool.mutmut]` in +`pyproject.toml` (`source_paths`, `pytest_add_cli_args_test_selection`, +`also_copy`, `do_not_mutate`). + +The workflow runs in two modes. A **daily schedule** fires a change-scoped run +that mutates only the source files touched within the detection window, so +quiet days are cheap no-ops. A **manual dispatch** (the Actions "Run workflow" +control) mutates the whole package; select a branch in that control to +exercise a feature branch. + +The caller passes a small set of configuration inputs, each carrying intent: + +- `paths` — the change-detection glob (`lading/`) that decides whether a + scheduled run has anything to mutate, bounding the scheduled run to real + source changes. +- `module-prefix-strip` — set to an empty string because `lading` uses a flat + package layout (the mutable source lives in `lading/`, not `src/`), so no + prefix needs to be stripped when translating changed files to module globs. + +The `uses:` reference pins the shared workflow to a full 40-character commit +SHA rather than a branch or tag, so a force-push upstream cannot silently +change what runs here. The contract test asserts only that the pin is a full +commit SHA, not a particular value, so Dependabot bumps it automatically +without any accompanying test edit. + +Because the caller is configuration rather than code, a contract test in +[`tests/workflow_contracts/test_mutation_testing.py`](../tests/workflow_contracts/test_mutation_testing.py) +pins the shape it must uphold, failing the pull request when the caller +drifts — repointing the pin at a branch, widening the token scope, or +dropping a configuration input — rather than letting the breakage surface +only in a scheduled run. The test module self-skips when the workflow file is +absent (mutmut copies the sources into a sandbox that omits `.github/`, so +the contract test does not run there). Run it locally with: + +```bash +uv run pytest tests/workflow_contracts/test_mutation_testing.py -v +``` + +The test validates: + +- the `uses:` reference targets `mutation-mutmut.yml` pinned to a full commit + SHA; +- the `with:` block carries exactly the expected configuration (`paths` and + `module-prefix-strip` above); +- job permissions are least-privilege (`contents: read`, `id-token: write`) + and the workflow-level default token scope is empty; +- `concurrency` serializes runs per ref without cancelling one in progress; + and +- the triggers keep the daily schedule and a plain `workflow_dispatch` with + no legacy branch input. + ## Property-based testing [Hypothesis](https://hypothesis.readthedocs.io/) is a development dependency