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(x/slashing): add infractions test #21387

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

JulianToledano
Copy link
Contributor

@JulianToledano JulianToledano commented Aug 23, 2024

Description

Ref:
#20955


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

  • Documentation

    • Updated URLs in the README for the slashing module to direct users to the latest documentation version (release/v0.52.x).
  • Bug Fixes

    • Simplified method signatures in the slashing module by removing unused parameters, enhancing clarity without affecting functionality.
  • Tests

    • Introduced a new test suite for the HandleValidatorSignature method, validating various scenarios for validator signatures to ensure robust functionality.

@JulianToledano JulianToledano added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Aug 23, 2024
@JulianToledano JulianToledano requested a review from a team as a code owner August 23, 2024 11:07
Copy link
Contributor

coderabbitai bot commented Aug 23, 2024

Walkthrough

Walkthrough

The changes involve updating URLs in the README for the Cosmos SDK slashing module to direct users to the latest documentation version, modifying method signatures in the Querier and Migrator structs to remove unused context parameters, and introducing a new test suite to validate the HandleValidatorSignature method. These adjustments enhance code clarity and maintainability while ensuring access to current resources.

Changes

File Change Summary
x/slashing/README.md Updated URLs from version 0.47.0-rc1 to release/v0.52.x for documentation references.
x/slashing/keeper/grpc_query.go Changed method signature from req *types.QueryParamsRequest to _ *types.QueryParamsRequest in Params.
x/slashing/keeper/migrations.go Modified Migrate1to2 and Migrate2to3 method signatures by replacing ctx with _.
x/slashing/keeper/infractions_test.go Introduced a comprehensive test suite for HandleValidatorSignature, validating various validator scenarios.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8ddea56 and 7f2b73a.

Files selected for processing (4)
  • x/slashing/README.md (2 hunks)
  • x/slashing/keeper/grpc_query.go (1 hunks)
  • x/slashing/keeper/infractions_test.go (1 hunks)
  • x/slashing/keeper/migrations.go (1 hunks)
Files skipped from review due to trivial changes (3)
  • x/slashing/README.md
  • x/slashing/keeper/grpc_query.go
  • x/slashing/keeper/migrations.go
Additional context used
Path-based instructions (1)
x/slashing/keeper/infractions_test.go (2)

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


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

Additional comments not posted (7)
x/slashing/keeper/infractions_test.go (7)

3-16: Imports look good.

The import statements are appropriate and necessary for the functionality being tested.


18-126: Comprehensive test coverage for HandleValidatorSignature.

The test cases cover various scenarios, including valid validators, jailed validators, and different signing info conditions. The use of mock expectations and assertions is appropriate. Consider adding edge cases if applicable.


39-52: Test case "ok validator" is well-structured.

The test case correctly verifies the behavior for a valid validator scenario.


53-59: Test case "jailed validator" is correctly implemented.

The test case accurately handles the jailed validator scenario.


60-71: Test case "signingInfo startHeight > height" is well-structured.

The test case effectively captures the error condition when the signing info start height is greater than the current height.


72-85: Test case "absent" is appropriately structured.

The test case correctly handles the scenario where the validator is absent.


86-100: Test case "punish validator" is well-structured.

The test case effectively tests the punishment logic for a validator.

@julienrbrt julienrbrt added this pull request to the merge queue Aug 26, 2024
Merged via the queue into main with commit 28c792b Aug 26, 2024
77 checks passed
@julienrbrt julienrbrt deleted the julian/slashing-infractions-test branch August 26, 2024 10:16
mergify bot pushed a commit that referenced this pull request Aug 26, 2024
julienrbrt pushed a commit that referenced this pull request Aug 26, 2024
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:x/slashing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants