Skip to content

Document mutation-testing workflow contract tests - #71

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

Document mutation-testing workflow contract tests#71
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

  • Add a ## Mutation-testing workflow contract tests section to
    docs/developers-guide.md, documenting tests/test_workflow_contract.py,
    which pins the shape of .github/workflows/mutation-testing.yml (the caller
    of leynos/shared-actions/.github/workflows/mutation-mutmut.yml).
  • The section covers: the caller's with: inputs actually present (paths: hooks/, module-prefix-strip: ""); the shape-only SHA assertion (the
    USES_RE regex, not a hard-coded PINNED_SHA), so Dependabot bumps need no
    accompanying test edit; the pytestmark = pytest.mark.skipif(not WORKFLOW_PATH.exists(), ...) guard that self-skips the test inside
    mutmut's mutants/ sandbox (which omits .github/); and the local run
    command.
  • Placed as a new top-level section immediately after the existing "Workflow
    pins and Dependabot" section, since both discuss the same shape-only pin
    discipline.

Permutation

Permutation C (Python/mutmut), reconciled to this repository's actual values:
mutation scope is hooks/ only, module-prefix-strip is empty (flat
layout), and no exclude-globs/extra-args are set (both default upstream).

Local run command

No make test-workflow-contracts target exists. The documented command
matches the Makefile's PYTEST variable:

uv run --group dev python -m pytest tests/test_workflow_contract.py -v

Roadmap / execplan tracking

No roadmap or execplan tracking applies. ROADMAP.md has no mutation-testing
item, and docs/execplans/adopt-vendcurl.md is unrelated.

Cross-linking

docs/developers-guide.md has no table of contents or index list, so no
cross-link was added.

Docs lint

bash markdownlint docs/developers-guide.md — 0 errors (after wrapping one
86-column line to fit the 80-column limit). make spelling's underlying
checks (typos_rollout_cli.py generate/check plus typos --config typos.toml) ran clean against the new section.

File changed

Add a section to the developers' guide covering
tests/test_workflow_contract.py: the caller workflow it pins, the
shape-only SHA assertion that keeps Dependabot bumps test-free, the
sandbox skipif guard, and the local pytest command.

@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

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: f2b12dca-8726-4993-b859-7a50ed9967d3

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.

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