Document mutation-testing workflow contract tests - #27
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Contributors triaging a mutation-testing survivor, or reworking the caller's inputs, had nothing in the developer guide explaining what the contract test in tests/workflow_contracts/mutation_testing_test.py actually pins or how to run it locally. Add a section describing the caller's two modes, its extra-args and setup-commands inputs, the shape-only SHA pin, and the local make test-workflow-contracts 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
Adds a "Mutation-testing workflow contract tests" section to
docs/developers-guide.md, documenting thecontract test in
tests/workflow_contracts/mutation_testing_test.pythatpins the shape of
.github/workflows/mutation-testing.yml.leynos/shared-actions/.github/workflows/mutation-cargo.yml.USES_REasserts theuses:ref isa full 40-hex commit SHA without pinning the value itself, so Dependabot
bumps it without an accompanying test edit. There is no
PINNED_SHAconstant and no
pytestmarkskip guard (this is a Rust repo; themutmut-sandbox skip only applies to Python callers).extra-args: "--all-features"andsetup-commands(installsclang/lld/mold).pathsandexclude-globsare not set, so thesection notes the shared workflow's defaults apply.
make test-workflow-contracts, taken from theMakefiletarget of the same name; confirmed passing locally (6 tests).docs/roadmap.mdordocs/execplans/tracking to annotate.docs/developers-guide.mdhas no internal table of contents tocross-link the new section into;
docs/contents.md(the docs-set index)already lists the developer guide as a single entry, so no change was
needed there either.
Docs-lint result
make markdownlint(spelling +markdownlint-cli2) passes: 0 errors. Twospelling nits caught by the repository's en-GB-oxendict policy were fixed
before landing (
summarising→summarizing,serialises→serializes), and the CI step nameInstall mold linkerwas moved into acode span so
moldwas not flagged as a misspelling ofmould.Test plan
make test-workflow-contracts— 6 passed (sanity-checks thedocumented local command; not required by this docs-only change).
make markdownlint— 0 errors.