max-sixty/cargo-affected

Letzte erfasste Quellaktivität: 11. Oktober 2026 um 06:43

SkillsMP-Katalog aktualisiert: 9. November 2026 um 14:22

gesammelte Skills: 1

GitHub-Stars: 5
GitHub-Forks: 0

Mit einem KI-Assistenten installieren

Diesen Prompt kopieren und in den verwendeten KI-Assistenten einfügen.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/max-sixty/cargo-affected.

README des Repositorys

README-Quelldatei: README.md

README-Quelldatei lesen

Vollständige README anzeigen

# cargo-affected [![maintained with tend](https://img.shields.io/badge/maintained_with-tend-bba580?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxNiAxNiI+PGcgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMCwxNikgc2NhbGUoMC4wMTI1LC0wLjAxMjUpIiBmaWxsPSIjZmZmIiBzdHJva2U9Im5vbmUiPjxwYXRoIGQ9Ik02ODAgMTEyOCBjNjIgLTk2IDY5IC0xNzggMjAgLTI0MSAtMTcgLTIyIC0yMCAtNDAgLTIwIC0xMzQgbDEgLTEwOCAyMSAyOCBjMTEgMTYgMzAgNDcgNDIgNzAgMTIgMjIgMzIgNDkgNDYgNTkgMzcgMjcgMTE0IDM4IDE4NCAyNyA5MyAtMTUgOTQgLTE4IDQ0IC03OSAtNzIgLTg4IC0xMDkgLTExMyAtMTc2IC0xMTcgLTMxIC0yIC02NCAxIC03MiA2IC0yMyAxNSAyMSA1NiAxMDcgOTggNDAgMjAgNzEgMzggNjkgNDAgLTYgNyAtODggLTE3IC0xMjYgLTM3IC00OSAtMjUgLTEwMCAtNzggLTEyMSAtMTI1IC0xNSAtMzMgLTE5IC02NiAtMTkgLTE4OCAwIC0xNTcgOCAtMTk1IDUwIC0yMzIgMTcgLTE2IDM2IC0yMCA4NSAtMTkgNjIgMSA2MyAxIDczIC0zMiA5IC0zMiA5IC0zMyAtMjIgLTQwIC01MCAtMTIgLTEzMiAtNyAtMTY0IDEwIC00MCAyMSAtNzkgNjkgLTkyIDExNCAtNSAyMCAtMTAgMTAyIC0xMCAxODIgMCA4MCAtNSAxNjIgLTExIDE4NCAtMjIgNzkgLTEzNSAxNjYgLTIzNCAxODEgLTM3IDYgLTM1IDMgMzAgLTI4IDc4IC0zOSAxNDQgLTkxIDEzMiAtMTA0IC01IC00IC0zNyAtOCAtNzEgLTggLTc3IDAgLTExNyAyNCAtMTgyIDEwOSAtNTIgNjggLTUxIDcwIDQyIDg1IDcxIDExIDE0MyAwIDE4MyAtMjkgMTYgLTExIDQwIC00MyA1NCAtNzMgMTMgLTI5IDMyIC01OSA0MSAtNjYgMTQgLTEyIDE2IC03IDE2IDU4IDAgNTkgNCA3NyAyMyAxMDIgMTkgMjYgMjMgNDYgMjUgMTMwIDMgNjcgMCA5OSAtNyA5OSAtNyAwIC0xMSAtMjMgLTEyIC01NyAwIC0zMiAtNiAtNzYgLTEyIC05NyBsLTEyIC00MCAtMjcgMzIgYy0zNCA0MSAtNDMgOTYgLTI0IDE1MSAxNCA0MSA3NSAxNDEgODYgMTQxIDMgMCAyMSAtMjQgNDAgLTUyeiIvPjwvZz48L3N2Zz4K)](https://github.com/max-sixty/tend) Like pytest-testmon for Rust. Maps each test to the source-line ranges it touches via LLVM coverage, then reruns only the tests whose ranges overlap `git diff` hunks. > **Status: extremely early.** Linux, macOS, and Windows MSVC > (`x86_64-pc-windows-msvc`) are supported. `x86_64-pc-windows-gnu` and > `aarch64-pc-windows-msvc` are intentionally excluded — coverage > instrumentation is broken upstream on those targets (see > [rust-lang/rust#111098][gnu-bug] and [#150123][arm-bug]). The author is > starting to use this in their own repos; others probably shouldn't yet. > The schema can change without migration, behavior may break, and there is > no support promise. CI should still run the full test suite. [gnu-bug]: https://github.com/rust-lang/rust/issues/111098 [arm-bug]: https://github.com/rust-lang/rust/issues/150123 ## Installation ```sh cargo install cargo-affected cargo install cargo-nextest --locked rustup component add llvm-tools ``` ## Quick start ```sh # Build with coverage instrumentation and record what each test touches. cargo affected collect # After editing: cargo affected run # run only tests overlapping the diff cargo affected status # dry-run: show what would run cargo affected clean # wipe the coverage cache ``` `status` predicts `run`, so give it the same post-`--` args you'd give `run` — `cargo affected status -- --features extra`. Those flags decide which tests get built, and a dry run of a feature-less build can't tell you about tests that only exist with the feature on. For CI integration or debugging selection, both `run` and `status` accept `--report-json <PATH>` to emit a structured artifact alongside their normal output. See [`docs/report-json.md`](docs/report-json.md) for the schema and a stable summary line CI can grep. `run` diffs the working tree against the git sha that was HEAD when `collect` last ran. Recollect periodically — every committed change since the last collect adds to the diff and broadens selection. When the coverage cache can't anchor a precise selection — no coverage yet, environment fingerprint changed, every recorded `collect_sha` missing from the repo (rebased and pruned, garbage-collected, beyond a shallow boundary) — `run` emits a stderr notice naming which fingerprint components differ and runs every test. Common fingerprint changes: a workspace `Cargo.toml` / `Cargo.lock` edit, a new rustc version, or a DB collected on a different host OS — `rustc -vV` records the host triple, so a Linux-collected DB cache-misses on macOS or Windows (and vice versa). A `collect_sha` that is *present* in the repo but not on `HEAD`'s lineage (siblings, post-`reset` orphans, the CI PR-vs-main-tip shape) is still usable: `git diff <sha> HEAD` resolves either way and stored ranges live in the sha's coordinate system. `cargo affected run` is therefore a strict superset of `cargo nextest run`: always at least as safe. ## How it works `collect`: 1. `cargo nextest list` enumerates every test. 2. `llvm-cov export` reads each test binary's coverage map once — where every instrumented function lives in the source. That doesn't vary per test, and it's the expensive part. 3. `cargo nextest run` runs the tests with `-C instrument-coverage` and a per-test `LLVM_PROFILE_FILE`. 4. For each test, `llvm-profdata` merges its profraw into the list of functions it executed, and those are looked up in the map from step 2. 5. Per `(test, file, function)`, the min/max line span is stored in `target/affected/coverage.db` (SQLite), keyed by a fingerprint of `Cargo.lock`, all workspace `Cargo.toml`s, `rustc -vV`, `RUSTFLAGS`, and `CARGO_BUILD_TARGET`. The git HEAD sha is recorded alongside. `run`: 1. `git diff -U0 <collect_sha>` produces OLD-side line ranges for changed files — same coordinate system as storage. 2. For each changed file, the DB returns stored function ranges overlapping any hunk; the union of matching tests is run via `cargo nextest run`. 3. If a hunk overlaps no stored range (struct fields, `#[derive]`, `const`, `use`, `mod`), a per-file backstop selects every test that touched the file. Crate roots (`lib.rs` / `main.rs` / `tests/*.rs`) are stored with a sentinel range covering the whole file, scoped per nextest target. An edit to a crate root reselects every test in that target, every test in the same package that links the lib (bins, integration tests), and every test in workspace packages that transitively depend on it. ## Accuracy model `cargo affected run` is an approximation — it trades correctness for speed. CI should still run the full suite. ### False positives (tests selected that didn't need to run) - **Function-level granularity.** A hit function's full line span is treated as one range, so an edit anywhere inside it reruns every test that touched the function — even if the edited line is unreachable from those tests. - **Structural-edit backstop.** Hunks outside any LLVM region (struct fields, derives, consts, `use`, `mod`) reselect every test that touched the file. - **Crate roots.** Any edit to `lib.rs` / `main.rs` / `tests/*.rs` reruns every test in that target, every test in the same package that links the lib, and every test in workspace packages that transitively depend on it. - **Comment- and whitespace-only edits.** Selection diffs lines, not semantics. ### False negatives (tests skipped that should have run) - **Non-Rust sources.** `include_str!` / `include_bytes!` targets, SQL files, migrations, assets, snapshots, and templates aren't seen by llvm-cov — a change confined to one selects no test. [Input rules](#input-rules) close this for inputs you can name. - **Build-time inputs not in the fingerprint.** The fingerprint covers `Cargo.lock`, workspace `Cargo.toml`s, `rustc -vV`, `RUSTFLAGS`, and `CARGO_BUILD_TARGET`. Changes to `build.rs`, `rust-toolchain.toml`, or `.cargo/config.toml` don't currently invalidate the cache. - **Proc-macro crate source.** A proc-macro's own source files compile into a host dylib, not the test binary, so editing a proc-macro crate won't reselect its downstream tests. - **External state.** Tests that read env vars, filesystem state, or the network can change outcome without any source file changing. When in doubt, `cargo affected collect` to refresh coverage, or skip cargo-affected and run the full suite. ## Input rules Coverage can't link a test to a non-Rust input it reads at runtime — an insta `.snap`, a doc a sync-test compares against, an `include_str!` target — so a change confined to that input selects no test (see [false negatives](#false-negatives-tests-skipped-that-should-have-run)). Optional `[[workspace.metadata.affected.rule]]` tables in `Cargo.toml` close the gap by mapping input globs to the tests that depend on them (use `[[package.metadata.affected.rule]]` in a single-crate project): ```toml # Any `.snap` edit re-runs the integration suite that owns the snapshots. [[workspace.metadata.affected.rule]] globs = ["**/*.snap"] filterset = "binary_id(=mycrate::integration)" # Doc-sync tests read these inputs at runtime; run that module when any change. [[workspace.metadata.affected.rule]] globs = ["README.md", "docs/**/*.md"] filterset = "test(/readme_sync/)" ``` Each rule pairs `globs` (matched against changed paths) with a nextest `filterset` (the full [filter-expression language](https://nexte.st/docs/filtersets/)). When a changed path matches, the filterset is resolved with `cargo nextest list -E` and its tests are force-selected — reported under a `config` category distinct from coverage-driven selection. A Rust-only diff matches no globs and takes the exact prior path, so the speedup is preserved; the extra `nextest list` runs only on diffs that touch a configured input. A rule that matches a path but resolves to no tests warns rather than failing silently. No rules → no change in behavior. The rules live in `[*.metadata]`, which cargo ignores for the build — so cargo-affected excludes it from the coverage fingerprint. Editing a rule is cache-neutral: it doesn't force a re-collect, so you can iterate on rules freely. Rules are a remedy of last resort, not a substitute for coverage: prefer letting `collect` map Rust changes. Reach for a rule only for inputs llvm-cov structurally cannot see, and keep periodic full runs for everything else. ## Comparison with similar tools The biggest design choice is *how* a tool decides what changed. The headline difference vs. [pytest-testmon] (the closest analogue) is that cargo-affected anchors selection on a git SHA: `collect` records the HEAD sha alongside the coverage data, and `run` asks git for the diff against it. testmon is VCS-agnostic — it stores a per-block checksum and compares the current source's checksums against the stored ones on every test run. | | cargo-affected | [pytest-testmon] | [`jest --changedSince`] | [Bazel] / [Buck] | | ----------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------- | | Test-to-code mapping | LLVM source-based coverage | `coverage.py` | Static module-import graph | Declared `BUILD` deps | | Granularity | Function-level source line ranges | AST blocks (function / method / class) | File | Target | | Change detection | `git diff -U0 <collect_sha>` (text) | AST-block checksum mismatch | `git`/`hg` diff of changed files | Build-graph reachability | | Uses VCS commit data | Yes — records HEAD sha at `collect`, diffs against it on every `run` | No — works independently of VCS | Yes — at runtime only, no stored sha | No | | Persistent state | SQLite at `target/affected/coverage.db` (per-test line ranges + env fingerprint + collect_sha) | SQLite at `.testmondata` (per-test block checksums) | None | Build graph + remote cache | | When state updates | Explicit `cargo affected collect` | Silently after every test run | n/a | On every build | | Whitespace/comment edits | Count as changes (text diff) | Ignored (checksums stable across formatting) | Count (file mtime / diff) | Ignored (no source diff) | | Env invalidation | Fingerprint: `Cargo.lock`, workspace `Cargo.toml`s, `rustc -vV`, `RUSTFLAGS`, `CARGO_BUILD_TARGET` | Python version, env vars, installed package versions | n/a | Toolchain + declared inputs | | Falls back to full run when | Fingerprint mismatch, every recorded `collect_sha` missing from the repo, no coverage yet | DB schema mismatch | No git repo / no merge base | n/a | The trade-off: - **Anchoring on a SHA** (cargo-affected) means `collect` is a separate, explicit step and `run` does cheap text diffs — but it depends on the recorded `collect_sha` still being in the repo (any commit reachable by the local `.git/` works, including siblings of `HEAD`), and any commit since `collect` widens the diff. Whitespace and comment edits look like real changes because we diff text, not AST. - **Recomputing checksums every run** (testmon) is VCS-agnostic and ignores cosmetic edits, at the cost of reparsing all source on every invocation and updating the DB on every run. - **Static-graph approaches** ([jest], [Bazel], [Buck]) skip dynamic coverage entirely — fast and deterministic, but conservative on reflection, plugin loading, and runtime dispatch, where coverage-based tools see the actual edges. ### Why git instead of content hashes The obvious alternative — testmon's design — is to hash each item and rerun any test whose dependencies' hashes changed. We track line ranges instead because of coordinates: stored data is keyed to OLD-side line numbers, and after any edit those don't point at the same code in the working tree. Bridging the two coordinate systems takes either: - A diff in OLD-side coordinates (`git diff -U0 <collect_sha>`, language-agnostic), or - An AST parse to re-find each item in current source by stable identity and rehash (`syn` for Rust). Tests themselves don't need stable identity — nextest gives canonical names, and "rerun any test in a file that changed" is a fine concession. The coordinate problem is on the *source* side, where dropping git means choosing between a parser and a precision drop: | | Precision | Needs parser | Needs git | | ---------------------------------- | --------- | ------------ | --------- | | Line ranges + `git diff` (today) | Function | No | Yes | | Per-file content hash | File | No | No | | Per-item content hash via `syn` | Function | Yes | No | Git is the cheapest bridge that keeps function-level precision without a parser. If the git dependency becomes a real constraint, per-item hashes via `syn` are the natural next step — strictly more work, but VCS-agnostic and robust to whitespace and comment edits. [pytest-testmon]: https://testmon.org/ [`jest --changedSince`]: https://jestjs.io/docs/cli#--changedsince [Bazel]: https://bazel.build/ [Buck]: https://buck2.build/ [jest]: https://jestjs.io/ ## License Dual-licensed under MIT or Apache-2.0 at your option.

README des Repositorys wird geladen…

Skills in diesem Repository

Klassifizierung ausstehend

Skill

Beruf

Beschreibung

Aktualisiert

running-tend

nicht klassifiziert

Project-specific guidance loaded by tend workflows alongside CLAUDE.md.

Quellsprache: Englisch

2026-10-11

Es werden 1 von 1 gesammelten Skills angezeigt.