Document mutation-testing workflow contract tests - #207
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a section to the developer guide explaining the mutation-testing caller workflow, its flat-layout `with:` inputs, and how tests/test_workflow_contract.py pins the caller's shape without locking the pinned SHA that Dependabot bumps.
|
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 the.github/workflows/mutation-testing.ymlcaller and the contract test thatpins its shape.
leynos/shared-actions/.github/workflows/mutation-mutmut.ymland onlycarries declarative configuration (the mutation run itself is
informational, never gating).
with:inputs the caller actually sets:paths: cmd_mox/andmodule-prefix-strip: ""(CmdMox uses a flat packagelayout, not
src/).tests/test_workflow_contract.py: a shape-onlyUSES_REpin(asserts a 40-hex commit SHA, not a specific value, so Dependabot bumps
need no test edit) and its
pytestmark = pytest.mark.skipif(...)guard,which self-skips inside mutmut's sandbox where
.github/is absent.uv run pytest tests/test_workflow_contract.py -v(there is nomake test-workflow-contractstarget in this repository'sMakefile).No existing mutation-testing section was present in the developer guide, so
this lands as a new top-level
##section, placed after the existing"Workflow pins and Dependabot" section (which documents the general
shape-only-pin convention this contract test follows).
The developer guide has no table of contents / index list of its own
sections, so no cross-link was added there.
docs/contents.mdlinks to thewhole developer guide file already and did not need a new entry.
No roadmap or execplan tracking applies to this change;
docs/roadmap.mdand
docs/execplans/contain no mutation-testing-related tracked task.Docs lint
make markdownlint: 0 errors.make spelling(viamake markdownlint): passes; the new section usesen-GB Oxford
-izespelling (summarizing,serializes).Test plan
make markdownlintpasses.uv run pytest tests/test_workflow_contract.py -vpasses locally (6tests), confirming the documented command is correct.