Fix NaN coverage percentage when no resources are collected#46
Open
tas50 wants to merge 1 commit into
Open
Conversation
Coverage#report! computed the percentage as `(touched / total.to_f * 100).round(2)`. When a run collects no resources (total == 0), that is `0 / 0.0` which evaluates to NaN. The human ERB template hides this, but the value still flows into the report hash and any programmatic/JSON consumer sees NaN. Extract the math into a coverage_percentage helper that returns 0.0 when there are no resources, and unit test it. Signed-off-by: Tim Smith <tsmith84@proton.me>
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
1 participant
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
ChefSpec::Coverage#report!computed the coverage percentage as:When a run collects no resources (
total == 0), that's0 / 0.0, which evaluates toNaN. The bundled human ERB template guards display withif @total == 0, so it's invisible there — but theNaNstill lands in thereporthash and is handed to every registered output, including JSON and any programmatic consumer.Fix
Extract the calculation into a private
coverage_percentage(touched, total)helper that returns0.0when there are no resources, and use it inreport!.0.0(rather than100.0) is the least-surprising value for "nothing was collected."Testing
spec/unit/coverage_spec.rb(TDD — verified it failed first) covering the zero-resources case (0.0, notNaN), a normal percentage, and rounding.bundle exec rspec spec/unit/→165 examples, 0 failures.cookstyle --chefstyle -c .rubocop.yml→ no offenses.Note
Adds
spec/unit/coverage_spec.rb, which #44 also adds (there it coversCoverage::ResourceWrapper). Whichever merges first, the other just needs the twodescribeblocks combined into the one file.