celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
345 stars 292 forks source link

chore: pass knuu as an argument to the testnet.New #3952

Closed mojtaba-esk closed 1 month ago

mojtaba-esk commented 1 month ago

As pointed out before in one of the comments, if we pass knuu as an argument to the testnet constructor, user will have more flexibility in playing with knuu options and can optimize the resource consumption based on the test requirements.

This PR attempts to achieve that goal.

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces modifications to several end-to-end test files to integrate the Knuu package for improved test execution management. Key changes include the initialization of Knuu instances with unique identifiers, the introduction of a new `Options` structure for testnet creation, and enhanced logging for better visibility during test execution. The core logic of existing tests remains intact, but the overall structure and error handling have been improved to streamline the testing process. ## Changes | File Path | Change Summary | |-----------------------------------------|---------------------------------------------------------------------------------------------------| | `test/e2e/benchmark/benchmark.go` | Modified `NewBenchmarkTest` to integrate Knuu; established context with cancellation and improved error handling for testnet creation. | | `test/e2e/major_upgrade_v2.go` | Modified `MajorUpgradeToV2` to integrate Knuu; added logging; updated testnet creation to use `testnet.Options`. | | `test/e2e/major_upgrade_v3.go` | Updated `MajorUpgradeToV3` to include Knuu; adjusted upgrade height and testnet creation. | ## Possibly related PRs - **#3395**: The `NewBenchmarkTest` function in the main PR and the `BenchmarkTest` struct introduced in this PR both involve significant modifications to test management and initialization processes, particularly with the integration of the Knuu package. - **#3556**: The modifications to the `MajorUpgradeToV2` function in this PR include adjustments to the testnet creation process, which is relevant to the changes made in the main PR regarding testnet initialization with Knuu. - **#3910**: The `MajorUpgradeToV3` function in this PR introduces a new upgrade process that utilizes a context and Knuu, similar to the enhancements made in the main PR for managing testnet upgrades and signal handling. ## Suggested labels `knuu`, `WS: Big Blonks 🔭` ## Suggested reviewers - staheri14 - cmwaters - ninabarbakadze - rootulp - evan-forbes

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): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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. ### 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.
mojtaba-esk commented 1 month ago

CI is failing b/c NewBenchmarkTest also needs to be updated to account for the TestnetOptions modification

Thanks for pointing it out. now it is fixed.

mojtaba-esk commented 1 month ago

golangci-lint is complaining

forgot to save a file, pushed again

rootulp commented 1 month ago

Oops nvm I can't push to your fork until you add me as a collaborator. cc: @mojtaba-esk

rootulp commented 1 month ago

Approving to unblock. I can address nits in a follow-up if this merges before I get permission to push my commit that addresses nits.

evan-forbes commented 1 month ago

@mojtaba-esk for future reference, this was an api breaking PR, so we should put chore! in front of it

evan-forbes commented 1 month ago

also, as a broad question, why were we able to merge this PR when only a single core app engineer approved?