Document mutation-testing workflow contract tests - #301
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a developer guide section explaining the mutation-testing caller workflow and its shape-only contract test, so contributors know what the test enforces and how to run it locally before touching either file.
Contributor
|
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, explaining.github/workflows/mutation-testing.yml, its delegation toleynos/shared-actions/.github/workflows/mutation-cargo.yml, and thecontract test that pins the caller's shape.
make test-workflow-contracts.Permutation
Permutation A — Rust (single crate).
ddlintis a single-crate package (noworkspace), so the section describes a manual dispatch that "mutates the
whole crate".
Contract-test style
Shape-only:
tests/workflow_contracts/mutation_testing_test.pyuses aUSES_REregex asserting...@[0-9a-f]{40}; the pinned SHA value itself isnot hard-coded, so Dependabot bumps it without any accompanying test edit.
The
with:block is asserted by equality against a separateEXPECTED_WITHdict (
exclude-globs,extra-args— this repo's caller has nopathsinput). The module has no
pytestmark/skip guard; ddlint is a Rust crate, sothere is no mutmut sandbox that omits
.github/.Local run command
make test-workflow-contracts, which runs:Roadmap / execplan note
No roadmap or execplan tracking applies.
docs/roadmap.mdanddocs/execplans/*were searched for "mutation" and contain no matching task,so nothing was ticked or annotated.
TOC / cross-link
docs/developers-guide.mdhas no in-page table of contents (headings rundirectly, no index list).
docs/contents.mdalready lists the developerguide as a whole document ("Maintainer-facing workflow and implementation
guidance for the current codebase"), which already covers this addition, so
no cross-link changes were needed.
Docs lint result
make markdownlintpassed after the change (it chainsspelling, whichenforces en-GB Oxford-
izespelling via pinnedtypos). Two Oxford-spellingfixes were needed in the drafted prose (
summarising→summarizing,serialises→serializes) before the gate passed cleanly. The gate'sspellingstep regeneratestypos.tomlfrom the shared dictionary as aside effect; that regeneration was unrelated to this change and was reverted
before committing, leaving
typos.tomluntouched in this PR.Only the docs gate was run, per instructions; the Rust/Python test suites
were not run.
Changed file
docs/developers-guide.md