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: fix integration test TestSendEnabled #22620

Merged
merged 7 commits into from
Nov 22, 2024
Merged

test: fix integration test TestSendEnabled #22620

merged 7 commits into from
Nov 22, 2024

Conversation

hieuvubk
Copy link
Contributor

@hieuvubk hieuvubk commented Nov 22, 2024

Description

Closes: #22521


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

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

  • Bug Fixes
    • Adjusted the test to ensure at least one denomination is processed, preventing scenarios where no denominations are queried.

Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request focus on the TestSendEnabled function within the tests/integration/v2/bank/determinisitic_test.go file. The modification adjusts the minimum value of the count variable from 0 to 1, ensuring that at least one denomination is processed during the test. This change aims to eliminate scenarios where no denominations are queried, while the overall structure and logic of the test cases remain unchanged.

Changes

File Change Summary
tests/integration/v2/bank/determinisitic_test.go Modified TestSendEnabled to set minimum count to 1.

Assessment against linked issues

Objective Addressed Explanation
Ensure TestSendEnabled does not allow zero denominations (22521)

Possibly related PRs

  • test(systemtests): fix failing tests #22145: This PR modifies tests in the tests/systemtests directory, which may relate to the changes made in the TestSendEnabled function in the main PR, as both involve adjustments to test cases within the testing framework.
  • test: migrate e2e/mint to system tests #22294: This PR introduces a new system test for minting functionality, which may share similar testing structures or methodologies with the changes made in the main PR's test function.
  • feat(systemtests): increase verbosity #22306: This PR enhances the verbosity of system tests, which could relate to the overall testing framework and practices that are also relevant to the modifications in the main PR's test function.

Suggested labels

backport/v0.52.x

Suggested reviewers

  • sontrinh16
  • tac0turtle
  • julienrbrt

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>, please review it.
    • 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 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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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

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.

@hieuvubk hieuvubk marked this pull request as ready for review November 22, 2024 11:20
@hieuvubk hieuvubk requested a review from a team as a code owner November 22, 2024 11:20
@hieuvubk hieuvubk changed the title [Do not merge]: Check the flacky test test: fix integration test TestSendEnabled Nov 22, 2024
@julienrbrt
Copy link
Member

have you forgot to push the fix? I only this print statement. Or github doesn't display the diff properly again

@hieuvubk
Copy link
Contributor Author

hieuvubk commented Nov 22, 2024

have you forgot to push the fix? I only this print statement. Or github doesn't display the diff properly again

I forgot, thanks for the ping

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

🧹 Outside diff range and nitpick comments (1)
tests/integration/v2/bank/determinisitic_test.go (1)

Line range hint 476-494: Consider these improvements to enhance test robustness.

  1. Add explicit assertions on the response to verify the send-enabled status matches what was set.
  2. Consider extracting the min/max count values to named constants for better maintainability.
  3. Add a comment explaining why we ensure at least one denomination is tested.
+// Min/Max number of denominations to test
+const (
+    minTestDenoms = 1
+    maxTestDenoms = 10
+)
+
 func TestSendEnabled(t *testing.T) {
     // ...
-    count := rapid.IntRange(1, 10).Draw(rt, "count")
+    // Ensure at least one denomination is tested to validate send-enabled functionality
+    count := rapid.IntRange(minTestDenoms, maxTestDenoms).Draw(rt, "count")
     // ...
+    // Verify the response matches our expectations
+    testdata.DeterministicIterationsV2(t, req, gasMeterFactory, queryFn, assertNonZeroGas, func(t *testing.T, res *banktypes.QuerySendEnabledResponse) {
+        require.Equal(t, len(denoms), len(res.SendEnabled))
+        for _, se := range res.SendEnabled {
+            require.Contains(t, denoms, se.Denom)
+        }
+    })
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e35af7c and 1add56b.

📒 Files selected for processing (1)
  • tests/integration/v2/bank/determinisitic_test.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
tests/integration/v2/bank/determinisitic_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

🔇 Additional comments (1)
tests/integration/v2/bank/determinisitic_test.go (1)

476-476: LGTM! This change fixes the flaky test by ensuring at least one denomination is tested.

The modification to set minimum count to 1 eliminates the possibility of testing zero denominations, which was likely causing inconsistent test behavior. This change ensures that the test always validates the send-enabled functionality with at least one denomination.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 22, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

utACK

@julienrbrt julienrbrt added this pull request to the merge queue Nov 22, 2024
Merged via the queue into main with commit fdb7688 Nov 22, 2024
71 of 72 checks passed
@julienrbrt julienrbrt deleted the hieu/flacky_test branch November 22, 2024 15:28
mergify bot pushed a commit that referenced this pull request Nov 22, 2024
julienrbrt pushed a commit that referenced this pull request Nov 22, 2024
Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flaky integration test
4 participants