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(systemtests): fix query block-results in TestStakeUnstake for v2 #22782

Merged
merged 2 commits into from
Dec 6, 2024

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Dec 6, 2024

Description

updates: #22753


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

  • Chores

    • Simplified configuration by removing state storage pruning options.
  • Tests

    • Updated test logic to ensure compatibility with different system versions when querying block results.

@mmsqe mmsqe requested review from julienrbrt, hieuvubk, kocubinski and a team as code owners December 6, 2024 01:17
Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the configuration file app.toml by removing the [store.options.ss-pruning-option] section, which included parameters for state storage pruning options. Additionally, it updates the test file staking_test.go to conditionally query block results based on the system version, ensuring compatibility with version 2. The changes streamline the configuration and enhance the testing framework without altering the core test logic.

Changes

File Path Change Summary
server/v2/testdata/app.toml Removed the entire section [store.options.ss-pruning-option] including parameters keep-recent and interval.
tests/systemtests/staking_test.go Added a conditional check to query block results from different endpoints based on system version.

Possibly related PRs

Suggested labels

C:server/v2, C:server/v2 api, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • akhilkumarpilli

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 10c5400 and 345eee1.

📒 Files selected for processing (2)
  • server/v2/testdata/app.toml (0 hunks)
  • tests/systemtests/staking_test.go (1 hunks)
💤 Files with no reviewable changes (1)
  • server/v2/testdata/app.toml
🧰 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 (2)
tests/systemtests/staking_test.go (2)

45-49: LGTM! Version-specific query handling looks correct.

The conditional logic appropriately handles different system versions by querying the correct endpoint for block results. This maintains compatibility while allowing for version-specific behavior.


Line range hint 1-71: Test coverage looks comprehensive.

The test thoroughly covers the staking workflow:

  • Initial setup and chain initialization
  • Token delegation
  • Validator update verification
  • Token undelegation
  • Balance and delegation state verification

The assertions are well-placed and verify the expected outcomes at each step.

Let's verify the test coverage for related staking operations:

✅ Verification successful

Let me gather more specific information about staking test coverage.


Test coverage is comprehensive and well-structured across all levels

The test coverage for staking operations is extensive and thorough, with tests at multiple levels:

  • System tests cover end-to-end workflows including:

    • Delegation and undelegation flows
    • Validator updates verification
    • Balance checks
  • Integration tests comprehensively cover:

    • Validator operations (bonding, unbonding, power changes)
    • Delegation operations (staking, unstaking, redelegation)
    • Slashing scenarios
    • Genesis handling
    • GRPC queries
    • Edge cases and deterministic behaviors

The original review comment correctly assessed the test coverage as comprehensive.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other staking-related test cases to ensure comprehensive coverage

# Look for other staking test files
fd -e go -x grep -l "staking" {}

# Check for other staking-related test functions
ast-grep --pattern 'func Test$_($_) {
  $$$
  "staking"
  $$$
}'

Length of output: 9397


Script:

#!/bin/bash
# Check for system test coverage of staking operations
rg -A 5 "func Test.*" tests/systemtests/staking_test.go

# Check for integration test coverage of staking operations
rg -A 5 "func Test.*" tests/integration/staking/keeper/

Length of output: 30867


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.

@github-actions github-actions bot added the C:server/v2 Issues related to server/v2 label Dec 6, 2024
Copy link
Contributor

@hieuvubk hieuvubk left a comment

Choose a reason for hiding this comment

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

lgtm

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.

Thanks!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 6, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Dec 6, 2024
Merged via the queue into cosmos:main with commit 3a2a0ac Dec 6, 2024
72 of 80 checks passed
mergify bot pushed a commit that referenced this pull request Dec 6, 2024
…#22782)

(cherry picked from commit 3a2a0ac)

# Conflicts:
#	server/v2/testdata/app.toml
julienrbrt added a commit that referenced this pull request Dec 6, 2024
@julienrbrt julienrbrt mentioned this pull request Dec 6, 2024
9 tasks
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 C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants