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/distribution to system tests #21908

Merged
merged 31 commits into from
Oct 4, 2024

Conversation

akhilkumarpilli
Copy link
Contributor

@akhilkumarpilli akhilkumarpilli commented Sep 25, 2024

Description

Closes: #21854


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 comprehensive system tests for the distribution module, enhancing the reliability of reward withdrawals and gRPC queries for both validators and delegators.
    • Updated the redelegation authorization command to include a fixed gas limit and fee structure.
  • Bug Fixes

    • Improved error messages for better clarity during chain setup.
  • Refactor

    • Enhanced logging for chain startup processes and made structural adjustments for improved code readability.
  • Chores

    • Removed outdated end-to-end test suites for the distribution package, streamlining the testing framework.

Copy link
Contributor

coderabbitai bot commented Sep 25, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request introduce modifications to the TestAuthzExecRedelegateAuthorization function in the authz_test.go file, updating the command used for redelegation authorization with a fixed gas limit and fee structure. Additionally, a comprehensive suite of system tests for the distribution module is added in distribution_test.go, featuring three new test functions that validate command-line interactions and gRPC queries. The PR also includes the removal of old end-to-end tests related to the distribution functionality.

Changes

File Change Summary
tests/systemtests/authz_test.go Updated TestAuthzExecRedelegateAuthorization to use a fixed gas limit and fee structure.
tests/systemtests/distribution_test.go Added three test functions: TestWithdrawAllRewardsCmd, TestDistrValidatorGRPCQueries, and TestDistrDelegatorGRPCQueries.
tests/e2e/distribution/cli_test.go Removed end-to-end test functions TestWithdrawAllSuite and TestGRPCQueryTestSuite.
tests/e2e/distribution/grpc_query_suite.go Removed the entire GRPCQueryTestSuite for gRPC queries.
tests/e2e/distribution/withdraw_all_suite.go Removed the entire WithdrawAllTestSuite for withdrawal tests.

Assessment against linked issues

Objective Addressed Explanation
Rewrite e2e test as a system test and verify it (21854)
Delete the old e2e test The old e2e test has not been deleted as part of this PR.

Possibly related PRs

Suggested reviewers

  • alpe
  • julienrbrt
  • hieuvubk
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9c261aa and ccf100f.

📒 Files selected for processing (1)
  • tests/systemtests/authz_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/systemtests/authz_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.

@akhilkumarpilli akhilkumarpilli changed the title [WIP] test: migrate e2e/distribution to system tests test: migrate e2e/distribution to system tests Sep 27, 2024
Base automatically changed from akhil/authz-system-tests to main October 1, 2024 08:21
@akhilkumarpilli akhilkumarpilli marked this pull request as ready for review October 4, 2024 06:26
@akhilkumarpilli akhilkumarpilli requested a review from a team as a code owner October 4, 2024 06:26
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 4, 2024
// test withdraw address grpc endpoint
withdrawAddrURL := baseurl + `/cosmos/distribution/v1beta1/delegators/%s/withdraw_address`
withdrawAddrTestCases := []RestTestCase{
{
Copy link
Member

Choose a reason for hiding this comment

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

i think we can remove those cases, this is catched by unit tests

delegatorValsURL := baseurl + `/cosmos/distribution/v1beta1/delegators/%s/validators`
valsTestCases := []RestTestCase{
{
"invalid delegator validators gRPC request with wrong delegator address",
Copy link
Member

Choose a reason for hiding this comment

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

ditto

},
{
"wrong validator address (specific validator rewards)",
fmt.Sprintf(delegatorRewardsURL+`/%s`, delAddr, "wrongvaladdress"),
Copy link
Member

Choose a reason for hiding this comment

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

ditto

rewardsOutput := fmt.Sprintf(`{"rewards":[{"validator_address":"%s","reward":[%s]}],"total":[%s]}`, valOperAddr, expectedAmountOutput, expectedAmountOutput)

delegatorRewardsTestCases := []RestTestCase{
{
Copy link
Member

Choose a reason for hiding this comment

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

ditto


slashTestCases := []RestTestCase{
{
"invalid slashes gRPC request with wrong validator address",
Copy link
Member

Choose a reason for hiding this comment

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

ditto

@julienrbrt julienrbrt added this pull request to the merge queue Oct 4, 2024
Merged via the queue into main with commit 489aaae Oct 4, 2024
74 of 76 checks passed
@julienrbrt julienrbrt deleted the akhil/distr-system-tests branch October 4, 2024 15:40
@julienrbrt
Copy link
Member

@Mergifyio backport release/v0.52.x

Copy link
Contributor

mergify bot commented Oct 4, 2024

backport release/v0.52.x

✅ Backports have been created

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/distribution to system tests
5 participants