Document mutation-testing workflow contract tests - #183
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a section to the developer's guide describing the mutation-testing caller workflow and the contract test that pins its shape, so contributors know why the test exists, what it validates, and how to run it locally before touching the caller or its pin.
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, documenting the informational mutation-testingcaller workflow (
.github/workflows/mutation-testing.yml) and the contracttest that pins its shape (
tests/workflow_contracts/mutation_testing_test.py).workspace, and
extra-argscarries--test-workspace=true(alongside--all-features) so each crate is mutated against the full workspace testrun, matching the
make testbaseline.USES_REasserts the pin is a full40-hex commit SHA on
mutation-cargo.yml, not a specific value, soDependabot bumps it without any accompanying test edit. There is no
pytestmarkskip guard; this is a Rust repository, so.github/is notstripped from any sandbox the test runs in.
make test-workflow-contracts(the Makefiletarget exists and wraps
uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q).docs/developers-guide.mditself (only
##/###headings), so no in-file cross-link was added.docs/contents.mdindexes whole documents, not developer's-guidesubsections, and already lists the developer's guide, so it needed no
change either.
docs/roadmap.mdanddocs/execplans/*and found no open item referencingthe mutation-testing workflow or its contract test.
Docs lint
make markdownlint(spelling/typos check plusmarkdownlint-cli2) passescleanly against the full doc set, including the new section.
Test plan
make markdownlintEdited file:
docs/developers-guide.md.