Document mutation-testing workflow contract tests - #192
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a section to the developer guide explaining the mutation-testing caller workflow and the contract test that pins its shape, so contributors know what the test asserts and how to run it locally.
|
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 new
## Mutation-testing workflow contract testssection todocs/developers-guide.md, placed after theexisting "Workflow pins and Dependabot" section and before
"Property-based testing".
Documents the thin caller
.github/workflows/mutation-testing.yml,which delegates to
leynos/shared-actions/.github/workflows/mutation-mutmut.yml(Permutation C: Python/mutmut), the
pathsandmodule-prefix-stripinputs it actually sets, and the
[tool.mutmut]configuration inpyproject.toml.Documents the contract test
tests/workflow_contracts/test_mutation_testing.py:it is shape-only (a
USES_REregex asserting a full 40-hex commit SHA,not a hard-coded value, so Dependabot bumps freely), it self-skips via
pytestmark = pytest.mark.skipif(...)when the workflow file is absent(mutmut's sandbox omits
.github/), and it validates theuses:pin, thewith:block, job/workflow permissions,concurrency, and triggers.Documents the local run command, verified to pass:
(6 passed). There is no
make test-workflow-contractstarget in thisrepository's
Makefile, so the directpytestinvocation is documentedinstead.
Roadmap / execplan note
Checked
docs/roadmap.mdanddocs/execplans/; neither contains anymutation-testing or contract-test tracking item, so no roadmap/execplan
tracking applies to this change.
Table of contents note
docs/developers-guide.mdhas no internal table of contents or sectionindex near the top (it opens with prose and then runs straight into
headings), so no cross-link was added there.
docs/contents.mdis awhole-repository documentation index and already links to
developers-guide.mdas a single entry; it does not enumerate the guide'sinternal sections, so it was left unchanged.
Docs-lint result
Ran
make markdownlint(the repository's Markdown lint + spelling gate,which chains
spellingthenmarkdownlint-cli2). It initially caught twoen-GB-oxendict
-ise/-izeviolations introduced by the new section(
summarising->summarizing,serialises->serializes); both werefixed and the gate now passes cleanly (0 errors). The Rust/Python test
suites were intentionally not run, per the docs-only scope of this change.
Files changed
docs/developers-guide.md