-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(schema/testing): proper integer and decimal comparison #21241
Conversation
WalkthroughWalkthroughThe recent changes enhance the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CompareKindValues
participant IntegerParser
participant DecimalParser
User->>CompareKindValues: compare(value1, value2)
alt IntegerStringKind
CompareKindValues->>IntegerParser: parse(value1)
CompareKindValues->>IntegerParser: parse(value2)
IntegerParser-->>CompareKindValues: parsedValue1
IntegerParser-->>CompareKindValues: parsedValue2
else DecimalStringKind
CompareKindValues->>DecimalParser: parse(value1)
CompareKindValues->>DecimalParser: parse(value2)
DecimalParser-->>CompareKindValues: parsedValue1
DecimalParser-->>CompareKindValues: parsedValue2
end
CompareKindValues-->>User: return comparisonResult
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files ignored due to path filters (1)
schema/testing/go.sum
is excluded by!**/*.sum
Files selected for processing (3)
- schema/testing/diff.go (3 hunks)
- schema/testing/diff_test.go (1 hunks)
- schema/testing/go.mod (1 hunks)
Additional context used
Path-based instructions (2)
schema/testing/diff_test.go (2)
Pattern
**/*.go
: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern
**/*_test.go
: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"schema/testing/diff.go (1)
Pattern
**/*.go
: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (4)
schema/testing/go.mod (1)
5-5
: New Dependency Added: Verify Necessity and Compatibility.The addition of
github.com/cockroachdb/apd/v3
for arbitrary-precision arithmetic seems appropriate given the context of decimal comparisons. Ensure this dependency is necessary and does not conflict with other parts of the project.Verification successful
Dependency Verified:
github.com/cockroachdb/apd/v3
Is Necessary and CompatibleThe
apd
package is used inschema/testing/diff.go
for converting strings to decimal numbers, which justifies its inclusion for handling decimal arithmetic operations. There are no indications of conflicts with other parts of the project.
- Usage confirmed in
schema/testing/diff.go
.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the new `apd` package in the codebase. # Test: Search for the usage of `apd` package. Expect: Usage in `schema/testing/diff.go`. rg --type go 'apd' --glob 'schema/testing/*.go'Length of output: 269
schema/testing/diff_test.go (1)
9-111
: Comprehensive Test Coverage forCompareKindValues
.The tests cover a wide range of scenarios for different kinds of values, including
BoolKind
,BytesKind
,IntegerStringKind
, andDecimalStringKind
. This ensures that the function behaves correctly across various cases.schema/testing/diff.go (2)
99-114
: Correct Implementation forIntegerStringKind
Comparison.The use of
math/big
to handle integer comparisons ensures accurate numerical evaluations. Error handling for conversion failures is appropriately implemented.
115-128
: Correct Implementation forDecimalStringKind
Comparison.The use of the
apd
package for decimal comparisons is appropriate for ensuring precision. Error handling is well managed, providing informative messages on conversion failures.
Description
This PR adapts the value comparison in
cosmossdk.io/schema/testing
to compareIntegerStringKind
andDecimalStringKind
values semantically (usingbig.Int
andapd
) rather than textually doing string comparison.Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
IntegerStringKind
andDecimalStringKind
.