feat(api-compare): report tested API versions in conformance report#7283
feat(api-compare): report tested API versions in conformance report#72830xDevNinja wants to merge 1 commit into
Conversation
The conformance report previously gave no indication of which API version each method was exercised under. Track the `v0`/`v1`/`v2` path of every executed test per method, expose it as a `tested_api_versions` field in the JSON report, and add an "API Versions" column to the printed summary table. Closes ChainSafe#6509
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
👮 Files not reviewed due to content moderation or server errors (2)
Warning Walkthrough skippedFile diffs could not be summarized. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report❌ Patch coverage is
Additional details and impacted files
... and 5 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Summary of changes
The conformance/
api comparereport gave no indication of which API version (v0/v1/v2) a method was tested under. This adds that information.Changes introduced in this pull request:
ReportBuilder.tested_api_versionsfield in the JSON report (omitted when empty, so existing consumers stay compatible).I went with both the JSON field and the summary column to cover the two options mentioned in the issue.
Reference issue to close (if applicable)
Closes #6509
Other information and links
The version set is a
BTreeSet<ApiPaths>so the output is deterministic (v0, v1, v2) regardless of test execution order. Added a unit test for the formatting.I didn't add a CHANGELOG entry since
forest-tool api compareis a developer/CI conformance tool rather than a node-operator-facing feature, but happy to add one if you'd prefer.Change checklist
Outside contributions