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

test(e2e benchmark): refactors E2EThroughput #3395

Merged
merged 34 commits into from
May 17, 2024

Conversation

staheri14
Copy link
Contributor

@staheri14 staheri14 commented Apr 26, 2024

A follow-up PR for #3391 that addresses and closes #3363.

Summary of changes:
The BenchmarkTest type has been introduced, inheriting all the behaviors of a Testnet. Additionally, it encapsulates a Manifest that defines the test network topology, parameters, and configurations, etc., and directs the network formation.

@staheri14 staheri14 self-assigned this Apr 26, 2024
@staheri14 staheri14 changed the title WIP test(e2e benchmark): refactors E2EThroughput Apr 26, 2024
@staheri14 staheri14 added WS: Big Blonks 🔭 Improving consensus critical gossiping protocols testing items that are strictly related to adding or extending test coverage labels Apr 26, 2024
@staheri14 staheri14 marked this pull request as ready for review May 17, 2024 16:16
@staheri14 staheri14 requested a review from a team as a code owner May 17, 2024 16:16
@staheri14 staheri14 requested review from cmwaters and rach-id and removed request for a team May 17, 2024 16:16
Copy link
Contributor

coderabbitai bot commented May 17, 2024

Walkthrough

Walkthrough

The recent changes streamline the process for setting up nodes and running benchmark tests by introducing the BenchmarkTest struct in the test/e2e/benchmark package. This struct centralizes test settings and methods, utilizing the testnet package for testnet creation, node management, and test execution. The adjustments in manifest.go and throughput.go align with this new structure, enhancing test scenario management.

Changes

File Path Change Summary
test/e2e/benchmark/benchmark.go Introduced BenchmarkTest struct, added setup and execution methods, imported testnet package.
test/e2e/benchmark/manifest.go Changed package declaration to main, updated types to use testnet.Resources.
test/e2e/benchmark/throughput.go Renamed testnet.Manifest to Manifest, updated ChainID, refactored test setup and execution flow.

Assessment against linked issues

Objective Addressed Explanation
Consolidate test settings for enhanced e2e benchmarking test scenario management (#3363)

The changes successfully consolidate test settings into the BenchmarkTest struct, addressing the objectives of issue #3363 by simplifying the process for test developers and facilitating the comparison of different test scenarios.


Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 15b200c and 62a8781.
Files selected for processing (2)
  • test/e2e/benchmark/benchmark.go (1 hunks)
  • test/e2e/benchmark/throughput.go (3 hunks)
Files skipped from review as they are similar to previous changes (2)
  • test/e2e/benchmark/benchmark.go
  • test/e2e/benchmark/throughput.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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@celestia-bot celestia-bot requested a review from a team May 17, 2024 16:21
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: 0

Out of diff range and nitpick comments (2)
test/e2e/benchmark/throughput.go (1)

54-56: Ensure error handling is robust and provides clear context for failures.

Consider enhancing the error message to include more specific details about the failure context when creating a new benchmark test.

test/e2e/benchmark/manifest.go (1)

1-1: Change of package declaration from testnet to main is significant. Ensure this aligns with the project's architectural standards.

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: 1

Comment on lines +68 to +69
blockchain, err := testnode.ReadBlockchain(context.Background(),
benchTest.Node(0).AddressRPC())
Copy link
Contributor

Choose a reason for hiding this comment

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

Use of context.Background() in ReadBlockchain might not be ideal for all scenarios. Consider passing a context that can be controlled externally.

- blockchain, err := testnode.ReadBlockchain(context.Background(),
+ ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+ defer cancel()
+ blockchain, err := testnode.ReadBlockchain(ctx,

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
blockchain, err := testnode.ReadBlockchain(context.Background(),
benchTest.Node(0).AddressRPC())
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
blockchain, err := testnode.ReadBlockchain(ctx,
benchTest.Node(0).AddressRPC())

rootulp
rootulp previously approved these changes May 17, 2024
test/e2e/benchmark/benchmark.go Outdated Show resolved Hide resolved
test/e2e/benchmark/throughput.go Outdated Show resolved Hide resolved
Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

utAck

@staheri14 staheri14 merged commit fc49336 into main May 17, 2024
33 checks passed
@staheri14 staheri14 deleted the sanaz/refactor-E2EThroughput branch May 17, 2024 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testing items that are strictly related to adding or extending test coverage WS: Big Blonks 🔭 Improving consensus critical gossiping protocols
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consolidate test settings for enhanced e2e benchmarking test scenario management
3 participants