Skip to content
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

test(types/coin): add unit tests for the coins #20253

Merged

Conversation

EmilGeorgiev
Copy link
Contributor

@EmilGeorgiev EmilGeorgiev commented May 2, 2024

Description

Closes: #XXXX


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...

  • [ x] included the correct type prefix in the PR title
  • [x ] confirmed ! in the type prefix if API or client breaking change
  • [ x] targeted the correct branch (see PR Targeting)
  • [ x] provided a link to the relevant issue or specification
  • [ x] reviewed "Files changed" and left comments if necessary
  • [ x] included the necessary unit and integration tests
  • [x ] added a changelog entry to CHANGELOG.md
  • [x ] updated the relevant documentation or specification, including comments for documenting Go code
  • [x ] confirmed all CI checks have passed

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.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Tests
    • Enhanced testing for coin operations, ensuring more reliable financial transactions.
    • Addition of new test functions for improved test coverage.

@EmilGeorgiev EmilGeorgiev requested a review from a team as a code owner May 2, 2024 15:07
Copy link
Contributor

coderabbitai bot commented May 2, 2024

Walkthrough

The recent changes focus on enriching the unit testing suite in coin_test.go. New test functions have been introduced to evaluate various functionalities such as retrieving denominations by index, verifying the positivity of coin values, and parsing coin data. Alongside these additions, an existing test for adding coins with unordered denominations has been revised.

Changes

File Path Change Summary
.../coin_test.go Added tests for TestGetDenomByIndex, TestIsAllPositive, TestParseCoin; Modified TestCoinsAddUnorderedDenominations

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?

Share
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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

if !tc.valid {
s.Require().Error(err, "%s: %#v. tc #%d", tc.input, res, tcIndex)
} else if s.Assert().Nil(err, "%s: %+v", tc.input, err) {
s.Require().Equal(tc.expected, res, "coin parsing was incorrect, tc #%d", tcIndex)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
s.Require().Equal(tc.expected, res, "coin parsing was incorrect, tc #%d", tcIndex)
s.Require().Equal(tc.expected, res, "coin parsing was correct, tc #%d", tcIndex)

Correct me if im wrong, we in scope err = nil right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The message coin parsing was incorrect, tc <index> will be printed only when expected and res are not equal

res, err := sdk.ParseCoinNormalized(tc.input)
if !tc.valid {
s.Require().Error(err, "%s: %#v. tc #%d", tc.input, res, tcIndex)
} else if s.Assert().Nil(err, "%s: %+v", tc.input, err) {
Copy link
Contributor

Choose a reason for hiding this comment

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

How about checking condition tc.valid then make sure err is nil & res equal to expected in scope.

Suggested change
} else if s.Assert().Nil(err, "%s: %+v", tc.input, err) {
} else {
s.Assert().Nil(err)
...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between 5637794 and faad9fb6ec4443df59085df87c8dec34637d4bd6.
Files selected for processing (1)
  • types/coin_test.go (3 hunks)
Additional Context Used
Path-based Instructions (1)
types/coin_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"

Additional comments not posted (4)
types/coin_test.go (4)

644-657: The test function TestCoinsAddUnorderedDenominations correctly checks for panics when adding unordered denominations, which aligns with expected behavior.


1411-1421: The test function TestGetDenomByIndex correctly retrieves denominations by index and validates them, which is crucial for ensuring the integrity of coin handling.


1423-1453: The test function TestIsAllPositive effectively checks for positive coin values across different scenarios, ensuring robustness in coin value validation.


1455-1490: The test function TestParseCoin provides comprehensive test coverage for parsing coin strings, ensuring that the parsing logic handles a variety of scenarios correctly.

@EmilGeorgiev EmilGeorgiev force-pushed the test-types/coin-add-unit-tests branch from faad9fb to 53dff38 Compare May 6, 2024 20:02
Copy link
Member

@facundomedica facundomedica left a comment

Choose a reason for hiding this comment

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

LGTM thank you!

@facundomedica facundomedica added this pull request to the merge queue May 8, 2024
Merged via the queue into cosmos:main with commit 5a5c638 May 8, 2024
59 of 61 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants