docs: metrics overview table + cover every metric in the passing fixture#72
Merged
Conversation
…assing fixture The all-passing fixture (tests/data/assertions.txt) drives the run_all_passing_stdout snapshot but did not cover the file.compression and file.compressed metrics. Add a section exercising both across the string and boolean comparators (plus a couple of `not` variants) using existing fixtures: sample.bam (bgzf), plain.txt.gz (plain gzip), and text files (none). Every metric executor in engine::executor::dispatch is now represented. Also add an at-a-glance metrics overview table to the README listing each resource family, its metrics, and a short description, above the existing per-family detail tables. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
468f4cd to
6720475
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR keeps the metrics set “complete in one place” by (1) adding missing compression-related metrics to the all-passing fixture that powers the main snapshot, and (2) adding an at-a-glance metrics overview table near the top of the README Metrics section.
Changes:
- Extend
tests/data/assertions.txtto coverfile.compression(string) andfile.compressed(boolean), includingnotvariants. - Regenerate the
run_all_passing_stdoutsnapshot to include the newly passing compression assertions. - Add a concise metrics overview table to
README.mdabove the per-family metric details.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/snapshots/run_subcommand_test__run_all_passing_stdout.snap | Snapshot updated to include PASS lines for the new compression assertions. |
| tests/data/assertions.txt | Adds coverage for file.compression / file.compressed, including comparator variety and negation. |
| README.md | Adds a top-level metrics overview table to document the full metric surface area in one place. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+267
to
+269
| PASS. Expected tests/data/sample.bam file.compression not eq gzip, got bgzf | ||
| PASS. Expected tests/data/sample.bam file.compression not contains zip, got bgzf | ||
| PASS. Expected tests/data/example.csv file.compressed not eq true, got false |
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
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
Two related changes so that the metric set is both fully tested and documented in one place:
tests/data/assertions.txtdrives therun_all_passing_stdoutsnapshot but was missing thefile.compressionandfile.compressedmetrics. Added a section exercising both across the string comparators (eq,ne,starts,ends,contains,matches) and the boolean comparators (eq,ne), plus a fewnotvariants. Reuses existing fixtures:sample.bam(bgzf),plain.txt.gz(plain gzip), and text files (none). Every executor inengine::executor::dispatchis now represented.## Metricssection listing each resource family (File, Delimited, BAM, FASTA, Text), its metrics, and a short description — above the existing per-family detail tables.Verification
cargo run -- run tests/data/assertions.txt→ exit 0, all 269 assertions PASScargo test→ all tests pass;run_all_passing_stdoutsnapshot regenerated (only the 18 new compression PASS lines added)Release
Documentation/test-coverage only — no version bump intended. release-plz will open its usual release PR on merge; hold or decline it to avoid cutting a release.
🤖 Generated with Claude Code