Document mutation-testing workflow contract tests - #71
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a section to the developers' guide covering tests/test_workflow_contract.py: the caller workflow it pins, the shape-only SHA assertion that keeps Dependabot bumps test-free, the sandbox skipif guard, and the local pytest command.
|
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
## Mutation-testing workflow contract testssection todocs/developers-guide.md, documentingtests/test_workflow_contract.py,which pins the shape of
.github/workflows/mutation-testing.yml(the callerof
leynos/shared-actions/.github/workflows/mutation-mutmut.yml).with:inputs actually present (paths: hooks/,module-prefix-strip: ""); the shape-only SHA assertion (theUSES_REregex, not a hard-codedPINNED_SHA), so Dependabot bumps need noaccompanying test edit; the
pytestmark = pytest.mark.skipif(not WORKFLOW_PATH.exists(), ...)guard that self-skips the test insidemutmut'smutants/sandbox (which omits.github/); and the local runcommand.
pins and Dependabot" section, since both discuss the same shape-only pin
discipline.
Permutation
Permutation C (Python/mutmut), reconciled to this repository's actual values:
mutation scope is
hooks/only,module-prefix-stripis empty (flatlayout), and no
exclude-globs/extra-argsare set (both default upstream).Local run command
No
make test-workflow-contractstarget exists. The documented commandmatches the Makefile's
PYTESTvariable:Roadmap / execplan tracking
No roadmap or execplan tracking applies.
ROADMAP.mdhas no mutation-testingitem, and
docs/execplans/adopt-vendcurl.mdis unrelated.Cross-linking
docs/developers-guide.mdhas no table of contents or index list, so nocross-link was added.
Docs lint
bash markdownlint docs/developers-guide.md— 0 errors (after wrapping one86-column line to fit the 80-column limit).
make spelling's underlyingchecks (
typos_rollout_cli.py generate/checkplustypos --config typos.toml) ran clean against the new section.File changed
docs/developers-guide.md