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: added packet data forwards compatibility test #6089

Merged
merged 5 commits into from
May 22, 2024

Conversation

srdtrk
Copy link
Member

@srdtrk srdtrk commented Apr 4, 2024

Description

closes: #XXXX


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
    • Added a new test function to check the app's handling of packets with additional data fields.

@srdtrk srdtrk added the testing Testing package and unit/integration tests label Apr 4, 2024
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Warning

Review Failed

The head commit changed during the review from 6257dfe to 325de33.

Walkthrough

The update includes a new test function, TestPacketBackwardsCompatibility, in the KeeperTestSuite. This test aims to validate the module's ability to process packets containing a new field, "new_field," ensuring seamless handling without disruptions.

Changes

File Change Summary
.../transfer/keeper/relay_test.go Added TestPacketBackwardsCompatibility to KeeperTestSuite to test handling packets with new_field.

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.

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 Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between b465156 and de17de5.
Files selected for processing (1)
  • modules/apps/transfer/keeper/relay_test.go (1 hunks)
Additional Context Used
Path-based Instructions (1)
modules/apps/transfer/keeper/relay_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 (1)
modules/apps/transfer/keeper/relay_test.go (1)

917-999: Consider adding negative test cases for TestPacketBackwardsCompatibility to cover scenarios where the new field disrupts the expected packet processing.

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 Status

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between de17de5 and 4a5b037.
Files selected for processing (1)
  • modules/apps/transfer/keeper/relay_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • modules/apps/transfer/keeper/relay_test.go

Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

Looks good it's a nice addition, thanks @srdtrk !

Just a small nit but otherwise LGTM

modules/apps/transfer/keeper/relay_test.go Outdated Show resolved Hide resolved
Comment on lines +918 to +921
// We are testing a scenario where a packet in the future has a new populated
// field called "new_field". And this packet is being sent to this module which
// doesn't have this field in the packet data. The module should be able to handle
// this packet without any issues.
Copy link
Contributor

Choose a reason for hiding this comment

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

this test will test is effectively testing compatibility of new fields in the packet data in version N and version N+1 right? If we were to run an E2E and add a new field to packet data and execute a MsgTransfer against an older version of ibc-go (pre-json marshalling) this could still blow up right?

Copy link
Contributor

Choose a reason for hiding this comment

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

actually I guess it just means that whichever version we are about to tag will be able to successfully process unknown fields, it doesn't necessarily mean it will be backwards compatible with a previous release right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. Unless we backport this feature

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe this should be called a future proof test?

Copy link

sonarcloud bot commented Apr 5, 2024

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

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud

@colin-axner colin-axner added the priority PRs that need prompt reviews label May 21, 2024
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.

ACK, agree it'd be nice to use expError, we can update the pr if you don't have time

@colin-axner colin-axner changed the title test: added packet data backwards compatibility test test: added packet data forwards compatibility test May 22, 2024
Copy link

sonarcloud bot commented May 22, 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

@colin-axner colin-axner merged commit af57c5d into main May 22, 2024
75 of 76 checks passed
@colin-axner colin-axner deleted the serdar/issue#xxx-test-backwards-comp branch May 22, 2024 10:19
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 testing Testing package and unit/integration tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants