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/accounts): fix build #21725

Merged
merged 2 commits into from
Sep 16, 2024
Merged

test(e2e/accounts): fix build #21725

merged 2 commits into from
Sep 16, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 13, 2024

Description

Note, the whole tests/e2e/accounts never runs in CI because of //go:build app_v1
We should delete this build tag in the future (I believe after depinject support cc @testinginprod)


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

  • New Features

    • Introduced a utility function that enhances type safety for message conversion.
  • Bug Fixes

    • Improved error handling during the conversion process to prevent type mismatches.

@julienrbrt julienrbrt requested a review from a team as a code owner September 13, 2024 20:03
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 13, 2024
Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

Walkthrough

The changes introduce a new utility function, toAnyPb, designed to convert a gogoproto.Message to a *codectypes.Any. This function incorporates a type check to prevent conversion of gogoany.Any types and manages error handling during the conversion. Additionally, the PubKey field in the MsgInit structure is updated to utilize this new function, enhancing type safety by ensuring proper wrapping of the public key before usage.

Changes

Files Change Summary
tests/e2e/accounts/base_account_test.go Added the function toAnyPb(t *testing.T, pm gogoproto.Message) *codectypes.Any for message conversion.

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3bc707a and 82aee8b.

Files selected for processing (1)
  • tests/e2e/accounts/base_account_test.go (3 hunks)
Additional context used
Path-based instructions (1)
tests/e2e/accounts/base_account_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 (4)
tests/e2e/accounts/base_account_test.go (4)

9-10: LGTM!

The new import statement for the github.com/cosmos/gogoproto/types/any package is valid and follows the correct syntax. The alias name gogoany is clear and avoids potential naming conflicts.


15-15: LGTM!

Adding an empty line after the import statement improves code readability and follows the Uber Go Style Guide.


29-29: Excellent change!

Using the new toAnyPb utility function to set the PubKey field in the MsgInit struct improves type safety and encapsulates the conversion logic. This change ensures that the public key is correctly wrapped in the appropriate type before being used, potentially preventing errors related to type mismatches.


88-96: Great addition!

The new toAnyPb utility function is well-structured and follows the Uber Go Style Guide. It provides a convenient way to convert a gogoproto.Message to a *codectypes.Any while ensuring type safety and proper error handling.

Some key benefits of this function:

  1. The type check prevents the conversion of gogoany.Any messages, which could lead to unexpected behavior.
  2. Error handling using require.NoError ensures that the test fails if the conversion process encounters an error.
  3. The t.Helper() call improves the readability of test failure messages by pointing to the line where the test failure occurred.

Overall, this utility function enhances the robustness and maintainability of the codebase.


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

@julienrbrt julienrbrt added this pull request to the merge queue Sep 16, 2024
Merged via the queue into main with commit 924798f Sep 16, 2024
73 checks passed
@julienrbrt julienrbrt deleted the julien/teste2e-accounts branch September 16, 2024 08:36
mergify bot pushed a commit that referenced this pull request Sep 16, 2024
tac0turtle pushed a commit that referenced this pull request Sep 16, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants