Skip to content

Document mutation-testing workflow contract tests - #183

Draft
leynos wants to merge 1 commit into
mainfrom
docs/mutation-contract-tests
Draft

Document mutation-testing workflow contract tests#183
leynos wants to merge 1 commit into
mainfrom
docs/mutation-contract-tests

Conversation

@leynos

@leynos leynos commented Jul 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a new ## Mutation-testing workflow contract tests section to
    docs/developers-guide.md, documenting the informational mutation-testing
    caller workflow (.github/workflows/mutation-testing.yml) and the contract
    test that pins its shape (tests/workflow_contracts/mutation_testing_test.py).
  • Permutation B (Rust workspace): the manual-dispatch run mutates the whole
    workspace, and extra-args carries --test-workspace=true (alongside
    --all-features) so each crate is mutated against the full workspace test
    run, matching the make test baseline.
  • Contract-test style: shape-only. USES_RE asserts the pin is a full
    40-hex commit SHA on mutation-cargo.yml, not a specific value, so
    Dependabot bumps it without any accompanying test edit. There is no
    pytestmark skip guard; this is a Rust repository, so .github/ is not
    stripped from any sandbox the test runs in.
  • Local run command documented: make test-workflow-contracts (the Makefile
    target exists and wraps
    uv run --with 'pytest>=8' --with 'pyyaml>=6' pytest tests/workflow_contracts -q).
  • No table of contents/index list exists inside docs/developers-guide.md
    itself (only ##/### headings), so no in-file cross-link was added.
    docs/contents.md indexes whole documents, not developer's-guide
    subsections, and already lists the developer's guide, so it needed no
    change either.
  • No roadmap or execplan tracking applies to this change; checked
    docs/roadmap.md and docs/execplans/* and found no open item referencing
    the mutation-testing workflow or its contract test.

Docs lint

make markdownlint (spelling/typos check plus markdownlint-cli2) passes
cleanly against the full doc set, including the new section.

Test plan

  • make markdownlint
  • No Rust/Python test suite run (docs-only change, per brief)

Edited file: docs/developers-guide.md.

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.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @leynos, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4768ebb6-e8d7-4320-95e7-27929040fe9a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mutation-contract-tests

Comment @coderabbitai help to get the list of available commands.

codescene-access[bot]

This comment was marked as outdated.

@codescene-access codescene-access Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No quality gates enabled for this code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant