Skip to content

Fix LCOV precision for coverage parser#43

Merged
leynos merged 2 commits intomainfrom
codex/fix-coverage-percentage-precision-with-decimal
Jul 28, 2025
Merged

Fix LCOV precision for coverage parser#43
leynos merged 2 commits intomainfrom
codex/fix-coverage-percentage-precision-with-decimal

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 28, 2025

Summary

  • use Decimal arithmetic to round LCOV coverage the same as Cobertura

Testing

  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_68871f92b37483229aa60be1403beb45

Summary by Sourcery

Replace float-based LCOV coverage percentage calculation with Decimal arithmetic and explicit ROUND_HALF_UP quantization to match Cobertura's rounding and ensure consistent two-decimal formatting.

Bug Fixes:

  • Fix LCOV coverage rounding precision by using Decimal.quantize with ROUND_HALF_UP

Enhancements:

  • Simplify zero-coverage case to explicitly return "0.00" when no lines are found

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 28, 2025

Reviewer's Guide

This PR updates the LCOV coverage parser to use Decimal-based arithmetic for two-decimal, half-up rounding consistent with Cobertura, simplifies the coverage-hit XPath expression, and restructures the total() function to explicitly handle zero-line cases.

File-Level Changes

Change Details Files
Use Decimal arithmetic for precise LCOV percentage rounding
  • Wrap lines_hit and lines_found in Decimal
  • Quantize result to two decimal places with ROUND_HALF_UP
.github/actions/generate-coverage/scripts/coverage_parsers.py
Restructure total() logic for zero-case handling
  • Add explicit if branch returning "0.00" when no lines found
  • Convert computed percent to a string for return
.github/actions/generate-coverage/scripts/coverage_parsers.py
Simplify covered count computation
  • Collapse multi-line covered XPath count into a single-line expression
.github/actions/generate-coverage/scripts/coverage_parsers.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 28, 2025

Summary by CodeRabbit

  • Refactor
    • Improved consistency in coverage percentage rounding to match standard CLI output, ensuring results are rounded to two decimal places using a unified method.
    • Minor formatting clean-up for improved readability.

Walkthrough

Unify rounding precision and method for coverage percentage calculations by introducing a QUANT constant and applying ROUND_HALF_UP rounding mode in both Cobertura and LCOV parsing functions. Refactor the LCOV coverage calculation for clarity and clean up minor formatting in the lines_from_detail function.

Changes

Cohort / File(s) Change Summary
Coverage Parsing Precision and Formatting
.github/actions/generate-coverage/scripts/coverage_parsers.py
Introduce QUANT constant for rounding; update quantisation in coverage percentage functions to use ROUND_HALF_UP; refactor LCOV calculation logic; tidy up formatting in lines_from_detail.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Poem

Precision now rules the coverage game,
With QUANT and rounding, results are the same.
No more stray decimals, no more doubt—
Two digits, half up, is what it’s about.
Clean code, clear maths, a tidy display,
Celebrate coverage the decimal way!
🧮✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22dfa00 and d76a615.

📒 Files selected for processing (1)
  • .github/actions/generate-coverage/scripts/coverage_parsers.py (4 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
.github/actions/generate-coverage/scripts/coverage_parsers.py (1)
.github/actions/generate-coverage/tests/test_scripts.py (1)
  • xpath (56-75)
🔇 Additional comments (4)
.github/actions/generate-coverage/scripts/coverage_parsers.py (4)

24-26: Excellent introduction of unified precision constant.

The QUANT constant eliminates code duplication whilst ensuring consistent rounding behaviour across both parsers. The clear documentation explaining alignment with coverage.py's CLI output provides valuable context for future maintainers.


72-72: Good formatting cleanup.

Removing the unnecessary parentheses and line breaks improves readability whilst maintaining functionality.


87-87: Proper use of unified QUANT constant.

Replacing the inline decimal literal with the shared QUANT constant ensures consistent precision across both parsers whilst maintaining the same rounding behaviour.


117-123: Excellent refactoring for clarity and consistency.

The explicit if-else structure significantly improves readability compared to the previous conditional expression. The implementation now perfectly mirrors the Cobertura function's approach, using proper Decimal arithmetic with the unified QUANT constant and ROUND_HALF_UP rounding. This directly fulfils the PR objective of ensuring consistent precision between both parsers.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/fix-coverage-percentage-precision-with-decimal

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

  • Cache the Decimal('0.01') quantization unit as a module‐level constant to avoid recreating it on every invocation.
  • Add a brief inline comment explaining why ROUND_HALF_UP is chosen so future maintainers understand the rounding rationale.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Cache the Decimal('0.01') quantization unit as a module‐level constant to avoid recreating it on every invocation.
- Add a brief inline comment explaining why ROUND_HALF_UP is chosen so future maintainers understand the rounding rationale.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos leynos merged commit ac8bb34 into main Jul 28, 2025
2 checks passed
@leynos leynos deleted the codex/fix-coverage-percentage-precision-with-decimal branch July 28, 2025 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant