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: e2e/staking to system tests #21882

Merged
merged 2 commits into from
Sep 25, 2024
Merged

test: e2e/staking to system tests #21882

merged 2 commits into from
Sep 25, 2024

Conversation

JulianToledano
Copy link
Contributor

@JulianToledano JulianToledano commented Sep 24, 2024

Description

Updates current staking system test to also checks validator updates

Closes:
#21874


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

    • Corrected a grammatical error in the documentation for better clarity.
  • Tests

    • Enhanced the TestStakeUnstake function to improve validation of staking and unstaking operations, including updated token amounts and validator public key checks.
  • Chores

    • Removed outdated end-to-end test files for the staking module, streamlining the test suite.

@JulianToledano JulianToledano requested a review from a team as a code owner September 24, 2024 14:41
@JulianToledano JulianToledano linked an issue Sep 24, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Sep 24, 2024

Walkthrough

Walkthrough

The changes involve the deletion of end-to-end test files related to the staking module in a Cosmos SDK application. Specifically, the files cli_test.go and suite.go have been removed, which included test suites for validating staking functionality. Additionally, minor documentation corrections were made in getting_started.md, and enhancements were applied to the staking_test.go file to improve the validation of staking and unstaking operations.

Changes

Files Change Summary
tests/e2e/staking/cli_test.go, tests/e2e/staking/suite.go Deleted end-to-end test files for the staking module. cli_test.go included a test suite for staking functionality, while suite.go managed test environment setup and validation of validator updates through RPC calls.
tests/systemtests/getting_started.md Minor textual correction made for grammatical accuracy.
tests/systemtests/staking_test.go Modified the TestStakeUnstake function to increase token delegation amounts and adjust expected balance assertions. Added validation for the validator's public key after delegation and updated expected balances post-unstaking.

Possibly related PRs

Suggested labels

C:x/staking, C:Simulations, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • sontrinh16
  • tac0turtle
  • akhilkumarpilli
  • testinginprod

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

Outside diff range and nitpick comments (3)
tests/systemtests/staking_test.go (3)

36-36: LGTM: Increased stake amount for better test coverage

The increase in staking amount from 10000stake to 1000000stake significantly enhances the test coverage. This aligns well with the PR objective of improving the testing framework and may help detect issues that could arise with larger stakes.

Consider defining the stake amount as a constant at the top of the file for easier maintenance and readability. For example:

const testStakeAmount = "1000000stake"

Then use this constant in the test:

rsp = cli.RunAndWait("tx", "staking", "delegate", valAddr, testStakeAmount, "--from="+account1Addr, "--fees=1stake")

42-47: LGTM: Added validator update check

The new section to check if the validator has been updated directly addresses the PR objective. It effectively queries the block results and verifies the validator's public key, enhancing the test coverage.

Consider adding a more descriptive error message to the assert.NotEmpty call to provide clearer context if the test fails:

assert.NotEmpty(t, validatorUpdates, "Expected non-empty validator updates after delegation")

Line range hint 1-63: Overall assessment: Significant improvements to test coverage and alignment with PR objectives

The changes made to this test file substantially enhance the coverage of staking and unstaking operations:

  1. Increased stake amounts provide a more robust test scenario.
  2. The new validator update check directly addresses the PR's main objective.
  3. All related assertions have been consistently updated to reflect the new stake amounts.

These modifications align well with the PR objectives and strengthen the testing framework. The test now covers a wider range of scenarios and includes crucial checks for validator updates.

Consider adding edge cases to further improve the test coverage:

  1. Test with the maximum allowed stake amount.
  2. Test with the minimum allowed stake amount.
  3. Test multiple delegations and undelegations in a single test to ensure cumulative effects are correctly handled.
Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bc3ddfa and 12e6219.

Files selected for processing (4)
  • tests/e2e/staking/cli_test.go (0 hunks)
  • tests/e2e/staking/suite.go (0 hunks)
  • tests/systemtests/getting_started.md (1 hunks)
  • tests/systemtests/staking_test.go (2 hunks)
Files not reviewed due to no reviewable changes (2)
  • tests/e2e/staking/cli_test.go
  • tests/e2e/staking/suite.go
Files skipped from review due to trivial changes (1)
  • tests/systemtests/getting_started.md
Additional context used
Path-based instructions (1)
tests/systemtests/staking_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 not posted (5)
tests/systemtests/staking_test.go (5)

15-15: LGTM: Clear and relevant comment added

The added comment "// check validator has been updated" aligns well with the PR objective of including checks for validator updates. It enhances the readability of the test by clearly stating the purpose of the upcoming code.


33-33: LGTM: Validator public key retrieval added

The introduction of the valPk variable to store the validator's public key is a necessary addition for the new validator update check. The use of the gjson library for parsing is consistent with the existing code style.


40-41: LGTM: Updated balance assertion

The assertion for the account balance after staking has been correctly updated to reflect the increased stake amount. This change is consistent with the modification in the staking amount and ensures the test remains accurate.


50-50: LGTM: Updated delegation amount assertion

The assertion for the delegation amount has been correctly updated to "1000000", reflecting the increased stake amount. This change maintains consistency with the earlier modification in the staking amount and ensures the test remains accurate.


58-58: LGTM: Updated remaining delegation assertion

The assertion for the remaining delegation amount after unbonding has been correctly updated to "995000". This accurately reflects the increased initial stake amount (1000000) minus the unbonded amount (5000). The change maintains consistency with the earlier modifications in the staking amount and ensures the test remains accurate.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 25, 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.

ACK

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.

test/e2e/staking to system tests
4 participants