test(e2e benchmark): introduces test manifest and its related utilities

[staheri14]

The first PR towards #3363
Closes #3457

There will be an additional follow-up PR to further refactor the E2EThroughput.

The E2EThroughput has been successfully tested (with the changes in this PR) and is functioning properly.
You may run:

go run ./test/e2e/benchmark  -v

[coderabbitai]

Walkthrough

Walkthrough

The modifications primarily focus on enhancing configuration flexibility and initialization processes in various test environments. Changes include adding new parameters and options for testnet setups, adjusting node and transaction client configurations, and updating logging and test durations based on manifest settings. The introduction of a manifest structure centralizes testnet parameters, facilitating easier modifications and scalability in test setups.

Changes

Files	Summary
test/e2e/benchmark/throughput.go	Extensive updates to testnet configuration using manifest struct.
test/e2e/check_upgrades.go, test/e2e/simple.go	Added "test" parameter to testnet.New function calls.
test/e2e/testnet/... (multiple files)	Introduced and modified various configurations and initialization methods to increase flexibility and adaptability of test environments.
test/e2e/testnet/txsimNode.go	Updated log messages related to transaction client image settings.

Assessment against linked issues

Objective	Addressed	Explanation
Add a comment about what TxClients indicates (#3457)	❌	The changes do not include any added comments or documentation about the TxClients field as requested.

---

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b1ab656 and 92f304c.

Files selected for processing (1)

• test/e2e/benchmark/throughput.go (2 hunks)

Additional comments not posted (7)

test/e2e/benchmark/throughput.go (7)

30-52: Introduced manifest struct to centralize configuration parameters.

This change aligns with the PR's objective to enhance flexibility and configurability in the E2EThroughput benchmark tests. The struct encapsulates various parameters, making the test setup more manageable and readable.

---

54-56: Modification in testnet.New to include manifest parameters.

The inclusion of manifest.ChainID and manifest.GetGenesisModifiers() in the testnet.New function call is a good practice as it utilizes the centralized configuration provided by the manifest struct, enhancing the configurability of the test network.

---

59-59: Use of manifest to set consensus parameters.

Utilizing manifest.GetConsensusParams() to set consensus parameters is a clean and efficient way to configure network settings dynamically based on the test requirements.

---

65-68: Genesis nodes creation using manifest.

The use of manifest values in testNet.CreateGenesisNodes function ensures that the genesis nodes are configured consistently with the centralized test parameters. This is crucial for maintaining the integrity and consistency of the test environment.

---

78-80: Configuration of transaction clients using manifest.

Properly configuring the transaction clients using parameters from manifest ensures that the clients behave as expected during tests. This is essential for achieving reliable and consistent benchmark results.

---

85-90: Dynamic configuration of testnet setup using manifest.

The dynamic configuration of the testnet using options like WithPerPeerBandwidth, WithTimeoutPropose, and others, as derived from manifest, demonstrates a flexible and maintainable approach to setting up the test environment.

---

99-99: Usage of manifest.TestDuration for controlling sleep duration.

Replacing fixed sleep times with a configurable value from manifest is a significant improvement. It allows for more tailored control over operation timings, which can be crucial for different testing scenarios.

---

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
• Mastodon
• Reddit
• LinkedIn

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.

[rootulp]

Thanks for addressing my feedback!

[rach-id]

utAck. Great stuff 🎉 🎉

[evan-forbes]

👍