Document mutation-testing workflow contract tests - #37
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a "Mutation-testing workflow contract tests" section to the developer guide explaining the mutation-testing caller workflow, the informational nature of its runs, and the contract test in tests/workflow_contracts/mutation_testing_test.py that pins the caller's shape. Documents the local run command (make test-workflow-contracts) and the shape-only SHA-pinning convention already described elsewhere in the guide.
|
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, documenting the.github/workflows/mutation-testing.ymlcaller (delegating toleynos/shared-actions/.github/workflows/mutation-cargo.yml) and thecontract test that pins its shape,
tests/workflow_contracts/mutation_testing_test.py.Permutation
Permutation A (Rust, single crate). The caller's actual
with:block setsextra-args: "--all-features"andsetup-commands(installingclang/lld/mold); it has nopathsorexclude-globsinputs, so thosewere omitted rather than invented. The contract test is shape-only
(
USES_REregex asserting a 40-hex-character commit SHA) — Dependabot bumpsthe pin freely with no accompanying test edit, consistent with the existing
"Workflow pins and Dependabot" guidance later in the same document.
Local run command
make test-workflow-contracts, confirmed against the realMakefiletarget(
uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q).Roadmap/execplan note
No roadmap or execplan tracking applies:
docs/roadmap.mdhas nomutation-testing entries, and the repository has no
docs/execplans/directory.
TOC/cross-link note
docs/developers-guide.mdhas no in-document table of contents or sectionindex to update.
docs/contents.md(the documentation-set index) alreadydescribes the developer guide generically ("explains the local workflow and
implementation tooling for contributors"), which remains accurate without
changes.
Docs lint
make markdownlint(which chains spelling checks andmarkdownlint-cli2)passes:
0 error(s). Two en-GB Oxford spellings introduced in the firstdraft ("summarising", "serialises") were corrected to "-ize" forms
("summarizing", "serializes") to satisfy the repository's typos
configuration.
Test plan
make markdownlintpasses with the new section included.this change.