Document mutation-testing workflow contract tests - #276
Draft
leynos wants to merge 1 commit into
Draft
Conversation
Add a developer's guide section explaining the mutation-testing caller workflow's contract test (tests/workflow_contracts/mutation_testing_test.py): what it pins, why the SHA assertion is shape-only, and how to run it locally with make test-workflow-contracts.
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
Adds a new "Mutation-testing workflow contract tests" section (
## 37.) todocs/developers-guide.md, documenting the caller workflow.github/workflows/mutation-testing.ymland its contract test,
tests/workflow_contracts/mutation_testing_test.py.The section covers:
(
mutation-cargo.yml), the two run modes (daily change-scoped schedule,whole-workspace manual dispatch), and the informational (non-gating)
nature of the run;
with:inputs the caller sets —paths,exclude-globs,extra-args(including the--test-workspace=true --test-tool=nextestflags and the
schema_helpers_uitrybuild exclusion),shard-count: 8,and
setup-commands— with no invented inputs;USES_REregex assertinga full 40-hex commit SHA, not a hard-coded pin), its
pytest.mark.skipifself-skip guard for mutation sandboxes that omit.github/, and the local run command,make test-workflow-contracts;codescene_coverage_test.py, which pins a different action at its ownSHA, so the two are not conflated.
This repository's
docs/developers-guide.mdhas no table of contents orindex list near the top (sections are plain numbered
##headings), so nocross-link entry was added; the new section is simply the next numbered
heading in sequence.
No roadmap or execplan tracking applies:
docs/roadmap.mdhas nomutation-testing items, and
docs/execplans/mutation-testing.mdis alreadymarked
IMPLEMENTEDfor the original (now superseded) workflow shape — itis not a checklist for this documentation addition.
Docs lint
make markdownlint(spelling/typos +markdownlint-cli2on changedMarkdown files) passes with no errors on the final version of this change.
Only the Rust/Python test suites were skipped, per this being a docs-only
change.
Test plan
make markdownlintpassesEdited file:
docs/developers-guide.md