feat(python): require full sharded mutation on pull requests #365
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| """Require every runtime module in exactly one successful mutation shard.""" | ||
|
There was a problem hiding this comment.
This adds a custom enforcement mechanism without documenting the native-tool gap it fills, while AGENTS.md reference: AGENTS.md:L3-L5 Useful? React with 👍 / 👎. |
||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import json | ||
| import os | ||
| import sys | ||
| from collections import Counter | ||
| from pathlib import Path | ||
| from typing import cast | ||
|
|
||
|
|
||
| class MutationShardError(Exception): | ||
| """A required mutation shard or runtime module is missing or failed.""" | ||
|
|
||
|
|
||
| def source_modules(path: Path) -> set[str]: | ||
| """Read the tracked handwritten runtime inventory. | ||
|
|
||
| Returns: | ||
| Runtime module paths. | ||
|
|
||
| """ | ||
| return { | ||
| os.fsdecode(raw) | ||
| for raw in path.read_bytes().split(b"\0") | ||
| if raw and not raw.startswith(b"src/volcano_sdk/_generated/") | ||
| } | ||
|
|
||
|
|
||
| def valid_outcomes(raw: object) -> bool: | ||
| """Accept only nonempty native killed or statically invalid outcomes. | ||
|
|
||
| Returns: | ||
| Whether the result counts are complete and successful. | ||
|
|
||
| """ | ||
| if not isinstance(raw, dict): | ||
| return False | ||
| counts = cast("dict[object, object]", raw) | ||
| if not counts or any( | ||
| name not in {"killed", "type_checked"} | ||
| or not isinstance(count, int) | ||
| or isinstance(count, bool) | ||
| or count < 0 | ||
| for name, count in counts.items() | ||
| ): | ||
| return False | ||
| validated_counts = cast("dict[str, int]", counts) | ||
| return sum(validated_counts.values()) > 0 | ||
|
|
||
|
|
||
| def shard_modules(path: Path) -> list[str]: | ||
| """Validate one native Mutmut result report. | ||
|
|
||
| Returns: | ||
| Paths audited by this shard. | ||
|
|
||
| Raises: | ||
| MutationShardError: The report is incomplete or contains failed mutants. | ||
|
|
||
| """ | ||
| raw = cast("object", json.loads(path.read_text(encoding="utf-8"))) | ||
| if not isinstance(raw, dict): | ||
| msg = f"Invalid mutation report: {path}" | ||
| raise MutationShardError(msg) | ||
| report = cast("dict[str, object]", raw) | ||
| modules = report.get("modules") | ||
| outcomes = report.get("outcomes") | ||
| failures = report.get("failures") | ||
| if ( | ||
| not isinstance(modules, list) | ||
| or not modules | ||
| or not isinstance(failures, list) | ||
| or failures | ||
| ): | ||
| msg = f"Incomplete mutation report: {path}" | ||
| raise MutationShardError(msg) | ||
| typed_modules = cast("list[object]", modules) | ||
| if not all(isinstance(module, str) for module in typed_modules): | ||
| msg = f"Invalid mutation modules: {path}" | ||
| raise MutationShardError(msg) | ||
| if not valid_outcomes(outcomes): | ||
| msg = f"Failed mutation outcomes: {path}" | ||
| raise MutationShardError(msg) | ||
| return cast("list[str]", modules) | ||
|
|
||
|
|
||
| def main(root: Path, source_path: Path, count: int) -> int: | ||
| """Check shard presence, successful results, and complete source coverage. | ||
|
|
||
| Returns: | ||
| Zero only when every runtime module appears exactly once. | ||
|
|
||
| Raises: | ||
| MutationShardError: A shard or source module is missing or invalid. | ||
|
|
||
| """ | ||
| expected = source_modules(source_path) | ||
| if not expected or count < 1: | ||
| msg = "Empty source inventory or invalid shard count" | ||
| raise MutationShardError(msg) | ||
| actual: Counter[str] = Counter() | ||
| for index in range(count): | ||
| report = root / f"mutation-outcomes-{index}" / "mutation.json" | ||
| actual.update(shard_modules(report)) | ||
| extra = sorted(set(actual) - expected) | ||
| missing = sorted(expected - set(actual)) | ||
| duplicate = sorted(name for name, occurrences in actual.items() if occurrences != 1) | ||
| if extra or missing or duplicate: | ||
| msg = f"Mutation shard inventory differs: {extra=}, {missing=}, {duplicate=}" | ||
| raise MutationShardError(msg) | ||
| print(f"Mutation shards covered {len(expected)} handwritten runtime modules") | ||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| raise SystemExit(main(Path(sys.argv[1]), Path(sys.argv[2]), int(sys.argv[3]))) | ||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the current 24-module inventory, 23 shards work only because shard 0 receives both export-only
__init__.pyand one mutatable module. If a PR removes any handwritten runtime module, shard 0 receives only__init__.py;scripts.mutation_resultsthen reports “No mutants were tested,” so the mandatory mutation job fails even though every remaining mutatable module was covered. Derive the shard topology from the inventory or otherwise ensure every shard includes a mutatable module.Useful? React with 👍 / 👎.