fix: use big.Rat for precise calculation #504
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR aims to enhance the accuracy of coverage, code-to-test ratio, and test execution time computations by switching from float64 to arbitrary-precision *big.Rat calculations. Key changes include:
- Replacing float64 values with *big.Rat in evaluation functions.
- Updating test cases to support both float64 and *big.Rat inputs.
- Introducing pre-calculated *big.Rat edge-case values and adjusting error messages accordingly.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| config/config_test.go | Revised test cases to convert float64 to *big.Rat and added new tests leveraging big.Rat values. |
| config/config.go | Updated functions to use *big.Rat instead of float64, including conversion logic for error messages. |
Comments suppressed due to low confidence (1)
config/config.go:365
- Verify that converting currentF to an int64 when creating a time.Duration does not cause unintended precision loss; consider adding a comment to document that this conversion is acceptable for error messaging.
return fmt.Errorf("test execution time is %v. the condition in the `testExecutionTime.acceptable:` section is not met (`%s`)", time.Duration(int64(currentF)), org)
Comment on lines
+226
to
+227
| covRat = big.NewRat(int64(tt.cov*10000), 10000) | ||
| prevRat = big.NewRat(int64(tt.prev*10000), 10000) |
There was a problem hiding this comment.
Consider extracting the repeated conversion logic from float64 to *big.Rat into a helper function to reduce duplication across the test cases.
Suggested change
| covRat = big.NewRat(int64(tt.cov*10000), 10000) | |
| prevRat = big.NewRat(int64(tt.prev*10000), 10000) | |
| covRat = float64ToBigRat(tt.cov) | |
| prevRat = float64ToBigRat(tt.prev) |
Copilot uses AI. Check for mistakes.
Comment on lines
+266
to
+268
| diffF, _ := diff.Float64() | ||
| currentF, _ := current.Float64() | ||
| prevF, _ := prev.Float64() |
There was a problem hiding this comment.
The conversion of *big.Rat values to float64 for use in expression evaluation is repeated; consider abstracting this conversion into a helper function to improve readability and reduce duplication.
Suggested change
| diffF, _ := diff.Float64() | |
| currentF, _ := current.Float64() | |
| prevF, _ := prev.Float64() | |
| diffF := ratToFloat64(diff) | |
| currentF := ratToFloat64(current) | |
| prevF := ratToFloat64(prev) |
Copilot uses AI. Check for mistakes.
Code Metrics Report
Details | | main (ca82aca) | #504 (8658084) | +/- |
|---------------------|----------------|----------------|-------|
+ | Coverage | 50.3% | 50.4% | +0.1% |
| Files | 53 | 53 | 0 |
| Lines | 3825 | 3841 | +16 |
+ | Covered | 1925 | 1938 | +13 |
+ | Code to Test Ratio | 1:0.5 | 1:0.5 | +0.0 |
| Code | 7494 | 7511 | +17 |
+ | Test | 4415 | 4475 | +60 |
| Test Execution Time | 30s | 30s | 0s |Code coverage of files in pull request scope (61.8% → 63.4%)
Benchmark-0 (this is custom metrics test)
Benchmark-1 (this is custom metrics test)
Reported by octocov |
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.
Fix: #503
Summary
This pull request introduces significant changes to improve precision in calculations for coverage, code-to-test ratio, and test execution time by replacing
float64with*big.Rat(arbitrary-precision rational numbers). It also updates the corresponding test cases to accommodate the new precision-based logic. Below is a summary of the most important changes:Precision Improvements in Calculations:
float64with*big.Ratfor calculations: Updated functionscoverageAcceptable,codeToTestRatioAcceptable, andtestExecutionTimeAcceptableto use*big.Ratinstead offloat64for improved precision in comparisons and calculations. (config/config.go, [1] [2] [3] [4]big.Ratoperations: Added logic to compute differences and convert*big.Ratvalues tofloat64for compatibility in error messages and expressions. (config/config.go, [1] [2] [3]Test Enhancements:
*big.Rat: Modified test cases for coverage, code-to-test ratio, and test execution time to include bothfloat64and*big.Ratinputs, ensuring precision-sensitive scenarios are tested. (config/config_test.go, [1] [2] [3]big.Ratvalues for edge cases: Introduced specialbig.Ratvalues (e.g.,almostSixty,oneThirdPlusSmall,almostOneMinute) to test scenarios that cannot be represented accurately withfloat64. (config/config_test.go, [1] [2] [3]Code Maintenance:
math/big: Added themath/bigpackage to support arbitrary-precision rational number operations. (config/config.go, [1];config/config_test.go, [2]These changes ensure greater accuracy in calculations and robustness in handling edge cases, particularly for conditions that require high precision.