Conversation
Contributor
Reviewer's GuideDocuments the planned mutation testing setup by adding a detailed execution plan for a new scheduled GitHub Actions workflow using cargo-mutants and an ADR capturing the architectural decision, workflow sketch, and rationale. Sequence diagram for mutation testing workflow execution and summary generationsequenceDiagram
actor Developer
participant GithubUI
participant Workflow as MutationTestingWorkflow
participant Runner as GitHubRunner
participant Repo as WireframeRepo
participant SetupRust as SetupRustAction
participant CargoMutants as CargoMutantsTool
participant JQ as JQSummaryScript
Developer->>GithubUI: Trigger workflow_dispatch (select branch)
GithubUI->>Workflow: Start workflow with branch input
Workflow->>Runner: Create job mutants (ubuntu-latest)
Runner->>Repo: actions/checkout@v5 (ref=branch)
Repo-->>Runner: Source code
Runner->>SetupRust: Run shared setup-rust action
SetupRust-->>Runner: Rust toolchain configured
Runner->>CargoMutants: cargo mutants --timeout-multiplier 3 --output mutants.out
CargoMutants-->>Runner: mutants.out/ with outcomes.json
Runner->>Runner: actions/upload-artifact@v4 (mutation-report)
alt outcomes.json exists
Runner->>JQ: Run jq filters on mutants.out/outcomes.json
JQ-->>Runner: caught, missed, timeout counts and survivor table
Runner->>GithubUI: Append Markdown to $GITHUB_STEP_SUMMARY
else no outcomes.json
Runner->>GithubUI: Skip summary content
end
GithubUI-->>Developer: Show job summary and downloadable artifact
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
Summary by CodeRabbit
WalkthroughAdd two documentation artefacts: an ADR proposing cargo-mutants for mutation testing with a scheduled/manual GitHub Actions workflow, and an execution plan detailing workflow steps, jq outcome parsing, artifact handling, risks, and validation steps. Changes
Sequence Diagram(s)sequenceDiagram
participant Scheduler as Scheduler / Manual trigger
participant GH_Actions as GitHub Actions (workflow)
participant Runner as Runner (job)
participant CargoMutants as cargo-mutants
participant ArtifactStore as Artifacts / Outcomes
participant StepSummary as $GITHUB_STEP_SUMMARY
rect rgba(135,206,235,0.5)
Scheduler->>GH_Actions: schedule / workflow_dispatch (branch input)
GH_Actions->>Runner: start job (setup)
end
rect rgba(144,238,144,0.5)
Runner->>Runner: setup Rust (pinned action)
Runner->>CargoMutants: install cargo-mutants
Runner->>CargoMutants: run `cargo mutants` (timeout multiplier, output dir)
CargoMutants-->>Runner: write `mutants.out/outcomes.json`
Runner->>ArtifactStore: upload `mutants.out/` artifact
end
rect rgba(255,228,181,0.5)
Runner->>Runner: parse outcomes.json with jq
Runner->>StepSummary: post counts and survivors table (if any)
StepSummary-->>GH_Actions: visible job summary + artifact link
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The ExecPlan’s risk mitigation recommends pinning the
cargo-mutantsversion, but the later "Interfaces and dependencies" section explicitly calls out having no version pin for the initial rollout; consider clarifying this as a phased plan so it’s obvious whether pinning is expected from day one or after the first run. - The ADR’s workflow sketch still uses the older jq assumptions (
.[],.scenario == "Mutant",.mutant.source_file, etc.) that the ExecPlan later corrects; it may be worth either updating the sketch now or adding a short note that the jq is illustrative and will be aligned with theoutcomes.jsonstructure during implementation to avoid confusion.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The ExecPlan’s risk mitigation recommends pinning the `cargo-mutants` version, but the later "Interfaces and dependencies" section explicitly calls out having no version pin for the initial rollout; consider clarifying this as a phased plan so it’s obvious whether pinning is expected from day one or after the first run.
- The ADR’s workflow sketch still uses the older jq assumptions (`.[]`, `.scenario == "Mutant"`, `.mutant.source_file`, etc.) that the ExecPlan later corrects; it may be worth either updating the sketch now or adding a short note that the jq is illustrative and will be aligned with the `outcomes.json` structure during implementation to avoid confusion.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c363f0c2e4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/adr-007-mutation-testing-with-cargo-mutants.md`:
- Line 36: Update the spelling in the ADR sentence that currently reads
"Minimise maintenance burden: prefer a single-binary tool that understands" to
use the -ize suffix; replace "Minimise" with "Minimize" in the
docs/adr-007-mutation-testing-with-cargo-mutants.md sentence so it reads
"Minimize maintenance burden: prefer a single-binary tool that understands".
In `@docs/execplans/mutation-testing.md`:
- Around line 193-196: Remove the developer-specific absolute path
'/data/leynos/Projects/wireframe.worktrees/mutation-testing' from the "Concrete
steps" section and either delete the line or replace it with a generic reference
such as "repository root" or "<repo-root>"; update the sentence so it simply
states that all commands are run from the repository root without including any
local filesystem paths.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 6e2e4541-713e-4c80-8e70-f03fba462c3e
📒 Files selected for processing (2)
docs/adr-007-mutation-testing-with-cargo-mutants.mddocs/execplans/mutation-testing.md
Correct the jq filters in ADR-007's workflow sketch to match the actual `cargo-mutants` `outcomes.json` structure: - Use `.outcomes[]` instead of `.[]` for array iteration - Use `.scenario != "Baseline"` instead of `.scenario == "Mutant"` to identify mutant outcomes - Update field paths: `.scenario.Mutant.file`, `.scenario.Mutant.span.start.line`, and `.scenario.Mutant.name` Also fix spelling: "Minimise" → "Minimize" on line 36. In the execplan, remove the developer-specific absolute path from the "Concrete steps" section. These changes ensure the workflow example produces accurate mutation summaries and correctly extracts surviving mutants.
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
1 participant
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 by Sourcery
Documentation: