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

feat: enables selection and execution of specific e2e benchmark tests #3595

Merged
merged 8 commits into from
Jun 20, 2024

Conversation

staheri14
Copy link
Collaborator

@staheri14 staheri14 commented Jun 18, 2024

Closes #3588

Now, you can pass the test name as an arument:

 go run ./test/e2e/benchmark TwoNodeSimple  

And at the end you will see

test-e2e-benchmark2024/06/18 15:44:38 --- ✅ PASS: TwoNodeSimple 

@staheri14 staheri14 self-assigned this Jun 18, 2024
@staheri14 staheri14 added the WS: Big Blonks 🔭 Improving consensus critical gossiping protocols label Jun 18, 2024
@staheri14 staheri14 marked this pull request as ready for review June 19, 2024 17:22
@staheri14 staheri14 requested a review from a team as a code owner June 19, 2024 17:22
@staheri14 staheri14 requested review from ramin and ninabarbakadze and removed request for a team June 19, 2024 17:22
Copy link
Contributor

coderabbitai bot commented Jun 19, 2024

Walkthrough

The changes introduce the ability to select and run specific end-to-end (e2e) benchmark tests in the Celestia project. A new structure and logging mechanism have been implemented to handle multiple tests, providing better modularity and control over the test execution process.

Changes

File Change Summary
test/e2e/benchmark/main.go Added functionality for running specific or all tests based on command-line arguments.
test/e2e/benchmark/throughput.go Renamed the test function, updated ChainID, and modified logging output.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Main as main.go
    participant Throughput as throughput.go
    participant Logger

    User->>Main: Run test with arguments
    Main->>Logger: Initialize logger
    Main->>Main: Process arguments
    alt Specific test
        Main->>Throughput: Execute specified test
    else All tests
        Main->>Main: Loop through all tests
        Main->>Throughput: Execute each test
    end
    Throughput->>Logger: Output test result
    Logger-->>User: Display result
Loading

Assessment against linked issues

Objective Addressed Explanation
Enable selection and execution of specific e2e bench tests (#3588)

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:

‼️ 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 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.

@staheri14 staheri14 requested review from rootulp, evan-forbes and cmwaters and removed request for ramin June 19, 2024 17:22
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: 2

test/e2e/benchmark/main.go Show resolved Hide resolved
test/e2e/benchmark/main.go Show resolved Hide resolved
@celestia-bot celestia-bot requested a review from a team June 19, 2024 21:58
@staheri14 staheri14 enabled auto-merge (squash) June 19, 2024 22:30
Copy link
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

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

👍

Personally I don't think we should default run all benchmarks. Unlike the correctness e2e tests, I think which benchmarks to run should always be explicitly specified. It doesn't really matter at the moment when we just have a single benchmark

@staheri14 staheri14 merged commit daaaf53 into main Jun 20, 2024
33 checks passed
@staheri14 staheri14 deleted the sanaz/run-benchmark-test-by-name branch June 20, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WS: Big Blonks 🔭 Improving consensus critical gossiping protocols
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enabling selection and execution of specific e2e bench tests
3 participants