Document mutation-testing workflow contract tests - #209
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a developers' guide section describing the mutmut caller workflow and the pytest module that pins its shape, so maintainers know what the contract test covers and how to run it locally without reverse engineering the workflow and test files.
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/developers-guide.md, describing the mutmut caller workflow(
.github/workflows/mutation-testing.yml→shared-actions'mutation-mutmut.yml), its two configuration inputs (paths,module-prefix-strip), and its shape-only SHA pin.### Workflow contract testssubsection coveringtests/test_workflow_contract.py: what it asserts (uses reference,with:block, permissions, concurrency, triggers) and how to run itlocally.
Notes for reviewers
deliberately not enrolled in this workflow (no repository-root
Cargo.toml), and this doc change does not touch that.USES_REintests/test_workflow_contract.pymatchesmutation-mutmut.yml@[0-9a-f]{40}without asserting a specific SHA, soDependabot bumps require no test edit.
skipifguard..github/is listed in[tool.mutmut].also_copyinpyproject.toml, so the workflow file is copied into mutmut's sandbox andthe contract test runs there rather than self-skipping. The section
documents this explicitly instead of describing a guard that does not
exist.
uv run --with pytest --with pyyaml pytest tests/test_workflow_contract.py -q(verified: 6 passed). There is no dedicated Makefile target, and the test
also falls outside
PYTEST_TARGETS(the glob listmake testuses), sothis is the command a maintainer actually needs.
docs/developers-guide.mdhas no per-section table ofcontents (only a flat ADR list at the top), so no TOC entry was added.
docs/contents.mdindexes whole documents, not sections, and its existingentry for the developers' guide already covers this addition — no change
needed there.
docs/roadmap.mdhas no mutation-testing orcontract-test task; no roadmap/execplan tracking applies to this change.
markdownlint-cli2 docs/developers-guide.md— 0 errors.typos --config typos.toml docs/developers-guide.md— 0 errors (twowords were corrected from
-iseto-izespellings to match theproject's en-GB Oxford spelling convention enforced by
typos.toml).Edited file:
docs/developers-guide.md