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

chore: follow up for testing rest of methods on 07-tendermint light client module #6135

Merged
merged 41 commits into from May 22, 2024

Conversation

charleenfei
Copy link
Contributor

@charleenfei charleenfei commented Apr 10, 2024

Description

closes: #6001


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • Tests
    • Enhanced testing suite to include scenarios for client message verification, state updates, membership checks, and timestamp retrieval, ensuring robust client and consensus state validations.
    • Updated test functions in light_client_module_test.go and upgrade_test.go for improved coverage and validation of client and consensus states, paths, proofs, delays, and error conditions.

charleenfei and others added 17 commits April 2, 2024 11:38
…ient-module-entry-points' of github.com:cosmos/ibc-go into charly/issue#6001-move-client-state-testing-to-light-client-module-entry-points
…ient-module-entry-points' of github.com:cosmos/ibc-go into charly/issue#6001-move-client-state-testing-to-light-client-module-entry-points
Copy link
Contributor

coderabbitai bot commented Apr 10, 2024

Walkthrough

The update enhances the testing coverage of the Tendermint light client module by introducing a set of new test functions. These tests cover various scenarios related to client messages, state updates, validations of client and consensus states, paths, proofs, delays, and error conditions, aiming to improve the reliability and thoroughness of testing in the module.

Changes

File Path Change Summary
.../light-clients/07-tendermint/..._test.go Added various test functions for initializing, verifying client messages, checking misbehavior, updating states, verifying memberships, non-memberships, and getting timestamps at heights. Tests cover scenarios related to client and consensus states, paths, proofs, delays, and error conditions.

Possibly related issues


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@charleenfei charleenfei added the priority PRs that need prompt reviews label Apr 11, 2024
Base automatically changed from charly/issue#6001-move-client-state-testing-to-light-client-module-entry-points to main April 11, 2024 10:16
@charleenfei charleenfei marked this pull request as ready for review April 11, 2024 10:28
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: 5

Copy link
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @charleenfei

Do we still have metrics on code cov changes? Just curious that we still hit the same amount of lines of code

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


// ensure counterparty state is committed
suite.coordinator.CommitBlock(suite.chainB)
trustedHeight := path.EndpointA.GetClientLatestHeight().(clienttypes.Height)
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure type assertion is checked to prevent potential panics.

- trustedHeight := path.EndpointA.GetClientLatestHeight().(clienttypes.Height)
+ trustedHeight, ok := path.EndpointA.GetClientLatestHeight().(clienttypes.Height)
+ suite.Require().True(ok, "type assertion should not fail")

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.

Suggested change
trustedHeight := path.EndpointA.GetClientLatestHeight().(clienttypes.Height)
trustedHeight, ok := path.EndpointA.GetClientLatestHeight().(clienttypes.Height)
suite.Require().True(ok, "type assertion should not fail")

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

modules/core/02-client/keeper/keeper_test.go Outdated Show resolved Hide resolved
Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

Just left some nits, can push an update to address them!

modules/light-clients/07-tendermint/upgrade_test.go Outdated Show resolved Hide resolved
modules/light-clients/07-tendermint/upgrade_test.go Outdated Show resolved Hide resolved
modules/light-clients/07-tendermint/upgrade_test.go Outdated Show resolved Hide resolved
modules/light-clients/07-tendermint/upgrade_test.go Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented May 21, 2024

Quality Gate Passed Quality Gate passed for 'ibc-go'

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@damiannolan damiannolan enabled auto-merge (squash) May 22, 2024 07:26
@damiannolan damiannolan merged commit 6993618 into main May 22, 2024
71 of 74 checks passed
@damiannolan damiannolan deleted the charly/followup-lcm-testing branch May 22, 2024 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority PRs that need prompt reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move client state testing to light client module entry points
4 participants