Problem: test_tx_inclusion is flaky when nodes halt due to different gas_wanted

[mmsqe]

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

Closes: https://github.com/crypto-org-chain/cronos/issues/1656

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
  • Introduced new test functions to enhance transaction testing capabilities, including handling for batch transactions and gas management.
• Bug Fixes
  • Improved error handling in transaction tests to ensure exceptions are raised appropriately during contract interactions.
• Chores
  • Updated utility functions for better control over timeouts and error handling, including a new timeout parameter for waiting functions.
  • Minor code formatting improvements for better readability.

[coderabbitai[bot]]

Walkthrough

The pull request introduces modifications to the integration_tests/test_basic.py and integration_tests/utils.py files. It adds new test cases for transaction inclusion and enhances existing tests to improve error handling and synchronization. Additionally, the utility functions are updated to include a timeout parameter for better control during block waiting operations. These changes aim to enhance the robustness and reliability of transaction testing, particularly in scenarios involving gas management and batch transactions.

Changes

File	Change Summary
integration_tests/test_basic.py	- Added test_tx_inclusion to evaluate heavy transaction inclusion under varying max_gas_wanted configurations.
	- Enhanced test_failed_transfer_tx to verify inclusion of failed transfer transactions in batch transactions.
	- Minor synchronization improvements with added sleep statements.
	- Refined error handling in test_exception and test_refund_unused_gas_when_contract_tx_reverted.
integration_tests/utils.py	- Updated wait_for_new_blocks to include a timeout parameter for maximum wait time.
	- Improved error handling in wait_for_block to capture and print AssertionError exceptions.
	- Minor formatting changes for improved readability.

Assessment against linked issues

Objective	Addressed	Explanation
Test test_tx_inclusion for flakiness related to transaction inclusion (#1656)	✅
Enhance error handling in transaction tests (#1656)	✅

Possibly related PRs

• #1484: Addresses functionality of the max_gas_wanted parameter, relevant to new test cases in this PR.
• #1538: Introduces enhancements to integration_tests/test_basic.py, including modifications to test_tx_inclusion.
• #1539: Focuses on transaction handling and testing in integration_tests/test_basic.py, related to main PR changes.

Suggested reviewers

• devashishdxt
• calvinaco

🐇 In the meadow, where bunnies play,
New tests hop in, brightening the day.
With gas limits set, and errors caught,
Our code is stronger, as we’ve sought!
So let’s celebrate, with a joyful cheer,
For robust testing is finally here! 🥳

---

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 16.64%. Comparing base (8a50b30) to head (cc5f7d9). Report is 1 commits behind head on main.

:exclamation: There is a different number of reports uploaded between BASE (8a50b30) and HEAD (cc5f7d9). Click for more details.

HEAD has 12 uploads less than BASE

| Flag | BASE (8a50b30) | HEAD (cc5f7d9) | |------|------|------| |integration_tests|20|10| ||2|0|

Additional details and impacted files

[](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1657?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain) ```diff @@ Coverage Diff @@ ## main #1657 +/- ## =========================================== - Coverage 34.94% 16.64% -18.30% =========================================== Files 123 72 -51 Lines 11803 6212 -5591 =========================================== - Hits 4124 1034 -3090 + Misses 7265 5055 -2210 + Partials 414 123 -291 ``` [see 69 files with indirect coverage changes](https://app.codecov.io/gh/crypto-org-chain/cronos/pull/1657/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=crypto-org-chain)