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: migrate e2e/mint to system tests #22294

Merged
merged 3 commits into from
Oct 17, 2024
Merged

Conversation

akhilkumarpilli
Copy link
Contributor

@akhilkumarpilli akhilkumarpilli commented Oct 17, 2024

Description

Closes: #22291


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

  • New Features

    • Introduced a new system test suite for minting-related gRPC queries, validating mint parameters and inflation rates.
  • Bug Fixes

    • Removed outdated end-to-end test files that were no longer necessary for the mint module.

@akhilkumarpilli akhilkumarpilli marked this pull request as ready for review October 17, 2024 08:23
@akhilkumarpilli akhilkumarpilli requested a review from a team as a code owner October 17, 2024 08:23
Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request involves the deletion of end-to-end (E2E) test files for the mint package and the introduction of a new system test file. The deleted files (cli_test.go, grpc.go, and suite.go) contained E2E test suites that managed the test environment for minting functionalities. In contrast, the new file mint_test.go implements system tests that focus on gRPC queries related to minting, resetting the blockchain state, and validating responses against expected outputs.

Changes

File Path Change Summary
tests/e2e/mint/cli_test.go File deleted.
tests/e2e/mint/grpc.go Method TestQueryGRPC removed.
tests/e2e/mint/suite.go Type E2ETestSuite removed; functions NewE2ETestSuite, SetupSuite, and TearDownSuite removed.
tests/systemtests/mint_test.go New file added with function TestMintQueries for system tests on minting-related gRPC queries.

Possibly related PRs

Suggested reviewers

  • alpe
  • julienrbrt
  • tac0turtle
  • hieuvubk

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8876f6d and 64e1f17.

📒 Files selected for processing (1)
  • tests/systemtests/mint_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/systemtests/mint_test.go

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.

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: 2

🧹 Outside diff range and nitpick comments (1)
tests/systemtests/mint_test.go (1)

40-43: Offer assistance to resolve the queryAtHeight discrepancy

The TODO comment suggests uncertainty about why queryAtHeight differs between v1 and v2. I can help investigate this issue to understand the underlying cause and update the test accordingly, ensuring consistent behavior across versions.

Would you like me to look into the difference in queryAtHeight values between v1 and v2 and suggest code adjustments?

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 553e110 and 8876f6d.

📒 Files selected for processing (4)
  • tests/e2e/mint/cli_test.go (0 hunks)
  • tests/e2e/mint/grpc.go (0 hunks)
  • tests/e2e/mint/suite.go (0 hunks)
  • tests/systemtests/mint_test.go (1 hunks)
💤 Files with no reviewable changes (3)
  • tests/e2e/mint/cli_test.go
  • tests/e2e/mint/grpc.go
  • tests/e2e/mint/suite.go
🧰 Additional context used
📓 Path-based instructions (1)
tests/systemtests/mint_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/systemtests/mint_test.go (1)

12-97: Implementation of TestMintQueries is comprehensive

The test function covers the necessary scenarios for minting queries, including both gRPC and CLI interfaces. The test cases are well-defined, and assertions use require.JSONEq appropriately.

blockHeightHeader := "x-cosmos-block-height"
queryAtHeight := "1"

// TODO: check why difference in values basequeryAtH on height between v1 and v2
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Typo in comment needs correction

There's a typo in the comment at line 40. The phrase "check why difference in values basequeryAtH on height between v1 and v2" should be corrected for clarity. It should likely read: "check why there is a difference in values of queryAtHeight based on height between v1 and v2."

Comment on lines +79 to +82
// TODO: remove below check once grpc gateway is implemented in v2
if isV2() {
return
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Use t.Skip() to properly skip tests

Instead of returning early when isV2() is true, use t.Skip() to indicate that the test is being intentionally skipped. This approach provides clearer test output and accurately reflects the test status.

Apply this change:

-		return
+		t.Skip("Skipping test until gRPC gateway is implemented in v2")
	}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// TODO: remove below check once grpc gateway is implemented in v2
if isV2() {
return
}
// TODO: remove below check once grpc gateway is implemented in v2
if isV2() {
t.Skip("Skipping test until gRPC gateway is implemented in v2")
}

@akhilkumarpilli akhilkumarpilli added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 17, 2024

// TODO: check why difference in values basequeryAtH on height between v1 and v2
if isV2() {
queryAtHeight = "2"
Copy link
Member

Choose a reason for hiding this comment

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

lets open an issue about this so we dont forget it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Opened #22302

@julienrbrt julienrbrt added this pull request to the merge queue Oct 17, 2024
Merged via the queue into main with commit 29ea9c8 Oct 17, 2024
75 of 76 checks passed
@julienrbrt julienrbrt deleted the akhil/mint-system-tests branch October 17, 2024 13:21
mergify bot pushed a commit that referenced this pull request Oct 17, 2024
julienrbrt pushed a commit that referenced this pull request Oct 17, 2024
Co-authored-by: Akhil Kumar P <36399231+akhilkumarpilli@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.

tests/e2e/mint to system tests
4 participants