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: use NotEmpty(x) instead NotZero(len(x)) #6076

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

crodriguezvega
Copy link
Contributor

@crodriguezvega crodriguezvega commented Apr 2, 2024

Description

ref: #6067 (comment)


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 test assertions for interchain account operations to improve clarity and expressiveness.

Copy link
Contributor

coderabbitai bot commented Apr 2, 2024

Walkthrough

Walkthrough

The recent updates involve modifying assertions in test suites related to interchain account operations and upgrades. Specifically, assertions checking hostAccount have been changed from NotZero to NotEmpty. This adjustment aims to enhance the expressiveness and readability of the code by ensuring hostAccount is not empty, which is a more precise condition than simply not being zero.

Changes

Files Change Summary
e2e/tests/interchain_accounts/.../base_test.go, localhost_test.go, params_test.go, query_test.go, upgrades_test.go Replaced assertions for hostAccount from NotZero to NotEmpty in various interchain account test suites.
e2e/tests/upgrades/genesis_test.go Updated assertion for hostAccount from NotZero to NotEmpty in GenesisTestSuite.

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/coderabbit-overrides.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

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

swift and clean, thanks for the clean up!

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 71d1014 and d0e3cbd.
Files selected for processing (6)
  • e2e/tests/interchain_accounts/base_test.go (4 hunks)
  • e2e/tests/interchain_accounts/localhost_test.go (6 hunks)
  • e2e/tests/interchain_accounts/params_test.go (1 hunks)
  • e2e/tests/interchain_accounts/query_test.go (1 hunks)
  • e2e/tests/interchain_accounts/upgrades_test.go (1 hunks)
  • e2e/tests/upgrades/genesis_test.go (1 hunks)
Additional Context Used
Path-based Instructions (6)
e2e/tests/interchain_accounts/query_test.go (3)

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


Pattern e2e/**/*: "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"

e2e/tests/upgrades/genesis_test.go (3)

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


Pattern e2e/**/*: "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"

e2e/tests/interchain_accounts/params_test.go (3)

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


Pattern e2e/**/*: "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"

e2e/tests/interchain_accounts/upgrades_test.go (3)

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


Pattern e2e/**/*: "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"

e2e/tests/interchain_accounts/localhost_test.go (3)

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


Pattern e2e/**/*: "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"

e2e/tests/interchain_accounts/base_test.go (3)

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


Pattern e2e/**/*: "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 (14)
e2e/tests/interchain_accounts/query_test.go (1)

69-69: The change from NotZero(len(hostAccount)) to NotEmpty(hostAccount) improves the readability and expressiveness of the test assertion. This is a positive change that makes the test more intuitive.

e2e/tests/upgrades/genesis_test.go (1)

118-118: The change from NotZero(len(hostAccount)) to NotEmpty(hostAccount) enhances the readability and expressiveness of the test assertion, making it more intuitive. Good improvement.

e2e/tests/interchain_accounts/params_test.go (1)

158-158: Changing the assertion from NotZero(len(hostAccount)) to NotEmpty(hostAccount) is a good practice for improving test readability and expressiveness. This makes the test more intuitive.

e2e/tests/interchain_accounts/upgrades_test.go (1)

83-83: The replacement of NotZero(len(hostAccount)) with NotEmpty(hostAccount) in the assertion improves test readability and expressiveness, aligning with best practices for clear and intuitive testing.

e2e/tests/interchain_accounts/localhost_test.go (6)

125-125: The change from NotZero(len(interchainAccAddress)) to NotEmpty(interchainAccAddress) improves readability and directly conveys the intention to check for non-empty strings. This is a positive change that aligns with best practices for writing clear and concise tests.


139-139: The replacement of NotZero(len(interchainAccAddress)) with NotEmpty(interchainAccAddress) here is consistent with the previous change and maintains the improved readability and directness in expressing the test's intention. Good job on maintaining consistency across test cases.


280-280: Again, the use of NotEmpty(interchainAccAddress) instead of NotZero(len(interchainAccAddress)) is observed here. This change is consistent across the file and enhances the clarity of the test assertions. It's great to see uniformity in the approach to testing across different test cases.


294-294: The application of NotEmpty(interchainAccAddress) in place of NotZero(len(interchainAccAddress)) is consistently applied here as well. This consistency in making the test assertions more readable and expressive is commendable.


410-410: The use of NotEmpty(interchainAccAddress) for asserting the non-emptiness of interchainAccAddress is consistently applied here, further demonstrating attention to readability and clarity in the test assertions. This consistency is key to maintaining a clean and understandable codebase.


422-422: The consistent replacement of NotZero(len(interchainAccAddress)) with NotEmpty(interchainAccAddress) across all relevant test cases, as seen here, is a good practice. It ensures that the test assertions are both clear and expressive, making the tests easier to understand at a glance.

e2e/tests/interchain_accounts/base_test.go (4)

93-93: The change from NotZero(len(hostAccount)) to NotEmpty(hostAccount) in this test case is a positive improvement. It directly checks for non-empty strings, which is more readable and expressive. This change aligns with best practices for writing clear and concise tests.


192-192: Replacing NotZero(len(hostAccount)) with NotEmpty(hostAccount) here is consistent with the changes made in other test cases. This consistency in improving the readability and expressiveness of test assertions is commendable.


290-290: The use of NotEmpty(hostAccount) instead of NotZero(len(hostAccount)) for asserting the non-emptiness of hostAccount is consistently applied here. This change enhances the clarity of the test assertions and is a good practice for maintaining a clean and understandable codebase.


470-470: The consistent replacement of NotZero(len(hostAccount)) with NotEmpty(hostAccount) across all relevant test cases, as seen here, ensures that the test assertions are both clear and expressive. This consistency is key to maintaining readability and understandability in the test suite.

Copy link

sonarcloud bot commented Apr 2, 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

@crodriguezvega crodriguezvega merged commit 527ce1d into main Apr 2, 2024
76 checks passed
@crodriguezvega crodriguezvega deleted the carlos/use-not-empty-instead-notzero branch April 2, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants