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

Problem: ica query not tested #1635

Merged
merged 4 commits into from
Oct 14, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Oct 11, 2024

Solution:

  • test module safe query

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features

    • Enhanced blockchain configurations for cronos_777-1 and chainmain-1, including new parameters for message handling and account definitions.
    • Introduced functionality for querying interchain account balances.
    • Added support for new message types in interchain accounts.
  • Bug Fixes

    • Improved testing capabilities by adding balance query verification after transactions.
  • Documentation

    • Updated configuration documentation to reflect recent changes in blockchain setups.

yihuang and others added 2 commits October 11, 2024 18:00
Solution:
- test module safe query
Copy link

codecov bot commented Oct 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.87%. Comparing base (fb902d2) to head (493cbba).
Report is 1 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (fb902d2) and HEAD (493cbba). Click for more details.

HEAD has 5 uploads less than BASE
Flag BASE (fb902d2) HEAD (493cbba)
2 0
integration_tests 13 10
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1635       +/-   ##
===========================================
- Coverage   36.31%   17.87%   -18.44%     
===========================================
  Files         123       72       -51     
  Lines        9715     5168     -4547     
===========================================
- Hits         3528      924     -2604     
+ Misses       5773     4121     -1652     
+ Partials      414      123      -291     

see 69 files with indirect coverage changes

@yihuang yihuang marked this pull request as ready for review October 14, 2024 06:53
@yihuang yihuang requested a review from a team as a code owner October 14, 2024 06:53
@yihuang yihuang requested review from mmsqe and calvinaco and removed request for a team October 14, 2024 06:53
Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

Walkthrough

The changes in this pull request involve updates to the integration_tests/configs/ibc.jsonnet, integration_tests/ibc_utils.py, integration_tests/test_ica.py, and integration_tests/test_ica_precompile.py files. Modifications include enhancements to blockchain configurations for cronos_777-1 and chainmain-1, the introduction of a new class and function for querying interchain account balances, and the addition of testing functions to validate these queries. These changes collectively improve the functionality and testing capabilities related to interchain account management.

Changes

File Change Summary
integration_tests/configs/ibc.jsonnet Updated configurations for cronos_777-1 and chainmain-1, including new coin entry, message types, and parameters.
integration_tests/ibc_utils.py Added QueryBalanceRequest class and gen_query_balance_packet function for querying interchain account balances.
integration_tests/test_ica.py Introduced call_module_safe_query function to query interchain account balance after transactions.
integration_tests/test_ica_precompile.py Utilized gen_query_balance_packet in test_sc_call to enhance balance verification after transaction submissions.

Possibly related PRs

Suggested reviewers

  • devashishdxt
  • calvinaco
  • mmsqe

🐇 In the fields where the blockchains play,
New coins and messages come out to play.
With balances queried and tests that are bright,
We hop through the code, oh what a delight!
Configs and functions, all in a row,
Enhancing our world, watch our systems grow! 🐇


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

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

@yihuang yihuang requested a review from a team October 14, 2024 06:53
@yihuang yihuang enabled auto-merge October 14, 2024 06:55
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: 3

🧹 Outside diff range and nitpick comments (2)
integration_tests/test_ica.py (1)

171-181: LGTM: Implemented safe query function with minor improvement suggestion.

The call_module_safe_query function effectively implements the safe querying mechanism for ICA balance. It correctly uses the gen_query_balance_packet function and includes proper error handling.

Consider making the gas limit configurable or estimate it dynamically instead of using a fixed value of 200000. This would make the function more flexible for different network conditions and query complexities.

integration_tests/test_ica_precompile.py (1)

453-459: LGTM! Consider adding balance verification.

The addition of the balance query functionality enhances the test coverage for ICA operations. The implementation correctly generates the query packet, submits it as a transaction, and verifies the transaction success.

To further improve the test, consider adding a verification step to check if the queried balance matches the expected balance calculated during the test. This would ensure that the balance query is not only executed successfully but also returns the correct value.

Example:

expected_balance = balance  # Use the balance variable tracked in the test
queried_balance = tcontract.functions.getQueriedBalance().call()  # Assuming such a function exists
assert queried_balance == expected_balance, f"Expected balance {expected_balance}, but got {queried_balance}"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fb902d2 and 493cbba.

📒 Files selected for processing (4)
  • integration_tests/configs/ibc.jsonnet (1 hunks)
  • integration_tests/ibc_utils.py (3 hunks)
  • integration_tests/test_ica.py (2 hunks)
  • integration_tests/test_ica_precompile.py (2 hunks)
🧰 Additional context used
🔇 Additional comments (4)
integration_tests/test_ica.py (3)

12-12: LGTM: New import for balance query packet generation.

The addition of gen_query_balance_packet import is consistent with the existing code style and aligns with the PR objective of implementing safe querying for Inter-Chain Accounts.


168-168: LGTM: Added balance query test.

The addition of call_module_safe_query at the end of the test_ica function is a good placement for testing the balance query after all other operations. This change aligns well with the PR objective of implementing and testing safe querying for Inter-Chain Accounts.


Line range hint 1-181: Overall assessment: Well-implemented ICA safe querying test.

The changes in this file successfully implement and integrate the safe querying mechanism for Inter-Chain Accounts. The new functionality is well-placed within the existing test structure, and the implementation is clean and consistent with the codebase style. The only suggestion for improvement is to consider making the gas limit in the call_module_safe_query function more flexible.

To ensure that the gen_query_balance_packet function is correctly implemented in the ibc_utils.py file, please run the following verification script:

integration_tests/configs/ibc.jsonnet (1)

114-114: Adding 'MsgModuleQuerySafe' to allowed messages

The inclusion of /ibc.applications.interchain_accounts.host.v1.MsgModuleQuerySafe in the allow_messages list enables the host chain to process MsgModuleQuerySafe messages. This is necessary for testing ICA queries as outlined in the PR objectives.

integration_tests/ibc_utils.py Show resolved Hide resolved
integration_tests/ibc_utils.py Show resolved Hide resolved
integration_tests/ibc_utils.py Show resolved Hide resolved
@yihuang yihuang added this pull request to the merge queue Oct 14, 2024
Merged via the queue into crypto-org-chain:main with commit 18c337a Oct 14, 2024
42 of 43 checks passed
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