search

celestiaorg / celestia-app

PoS application for the consensus portion of the Celestia network. Built using celestia-core (fork of CometBFT) and the cosmos-sdk
https://celestia.org
Apache License 2.0
328 stars 261 forks source link

chore(e2e benchmark test): allows selection of only one test #3618

Closed staheri14 closed 3 days ago

staheri14 commented 4 days ago

Closes https://github.com/celestiaorg/celestia-app/issues/3617

Before this PR, you could run:

 go run ./test/e2e/benchmark
test-e2e-benchmark2024/06/24 13:02:13 No particular test specified. Running all tests.
test-e2e-benchmark2024/06/24 13:02:13 go run ./test/e2e/benchmark <test_name> to run a specific test
test-e2e-benchmark2024/06/24 13:02:13 Valid tests are: TwoNodeSimple

and it would start running all the benchmark tests. However, after this PR, it will require user to specify the test name:

go run ./test/e2e/benchmark                       
test-e2e-benchmark2024/06/24 13:26:24 No test is specified.
test-e2e-benchmark2024/06/24 13:26:24 Usage: go run ./test/e2e/benchmark <test_name>
test-e2e-benchmark2024/06/24 13:26:24 Valid tests are: TwoNodeSimple
coderabbitai[bot] commented 4 days ago
Walkthrough ## Walkthrough The changes in `test/e2e/benchmark/main.go` refactor the test selection logic to explicitly select and run a specific benchmark test if its name is provided as a command-line argument. This change ensures that not all benchmarks are run by default, aligning the behavior with the new requirement of explicitly specifying which benchmarks to run. ## Changes | Files | Change Summary | |------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | test/e2e/benchmark/main.go | Refactored the `main` function to check if a test name is provided as a command-line argument and run that specific test, instead of iterating over all tests. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant CommandLine participant MainFunction as main.go CommandLine->>MainFunction: Start with arguments alt Test name provided MainFunction->>MainFunction: Run specified test else No test name provided MainFunction->>MainFunction: (old) Iterate and run all tests MainFunction->>MainFunction: (new) Skip running tests end ``` ## Assessment against linked issues | Objective | Addressed | Explanation | |-------------------------------------------------------------------------------|-----------|---------------------------------------------| | Consider explicitly specifying benchmarks instead of defaulting to all (#3617)| ✅ | |
Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between feebe324e4db0097f7c8df3c686224761a887bbe and 0722825e25b478fa9b726d65e411ffbffc9b1bfc.
Files selected for processing (1) * test/e2e/benchmark/main.go (1 hunks)
Files skipped from review as they are similar to previous changes (1) * test/e2e/benchmark/main.go
--- 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): > :bangbang: **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 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 as 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. 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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.