Skip to content

refactor: stabilize node startup in integration tests #1850

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.

Sign up for GitHub

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

Jump to bottom
Merged
tzdybal merged 1 commit into from
Sep 23, 2024
Merged

refactor: stabilize node startup in integration tests #1850

tzdybal merged 1 commit into from
Sep 23, 2024
+19 −4

Conversation

@tzdybal
Copy link
Member

@tzdybal tzdybal commented Sep 18, 2024 •
edited by coderabbitai bot
Loading

Overview

Introduce a retry mechanism for node startup to reduce flakiness in CI. Adjust initial block wait time based on the number of nodes to improve test reliability.

Resolves #1849

Summary by CodeRabbit

  • Bug Fixes

    • Improved stability and reliability of integration tests for FullNode functionality.
    • Enhanced robustness of node startup procedures to reduce test failures.

  • New Features

    • Introduced standardized wait time for block synchronization, making tests more adaptable.
    • Added functionality to attempt multiple node startups before marking tests as failed.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 18, 2024 •
edited
Loading

Walkthrough

The changes in this pull request enhance the integration tests for the FullNode functionality by introducing a standardized wait time for block synchronization and improving the robustness of node startup procedures. A new constant, initialBlockWait, is defined to manage wait times consistently, and a function, tryHardToStartNode, is added to retry node startup multiple times. These updates aim to address transient failures in Continuous Integration environments and improve overall test reliability.

Changes

Files Change Summary
node/full_node_integration_test.go - Added constant initialBlockWait = 5 for standardized wait times.
- Introduced function tryHardToStartNode(node *FullNode, t *testing.T) to retry node startup.
- Updated existing connection wait logic to utilize initialBlockWait.

Assessment against linked issues

Objective Addressed Explanation
Address TestTxGossipingAndAggregation failures (1849) ✅

Possibly related PRs

Suggested labels

T:testing, T:code-hygiene

Poem

🐇 In the code where bunnies play,
New waits and retries come to stay.
With nodes that start and sync with ease,
Our tests now dance like a gentle breeze.
Hooray for changes, bright and clear,
FullNode's strength is now right here! 🌟

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e221ca1 and 3f7123c.

Files selected for processing (1)
  • node/full_node_integration_test.go (4 hunks)
Additional comments not posted (3)
node/full_node_integration_test.go (3)

39-39: LGTM!

The initialBlockWait constant with a value of 5 is a reasonable default for standardizing the initial block wait time across test scenarios.

985-992: LGTM!

The tryHardToStartNode function is a helpful addition to make the tests less flaky in CI environments. Attempting to start the node up to 3 times before failing the test seems like a reasonable balance between test stability and duration.

Line range hint 934-981: LGTM!

The startNodes function is well-structured and ensures that all nodes are properly started and connected before proceeding with the tests. Some key observations:

  • Using tryHardToStartNode helps make the node startup more resilient.
  • Waiting for initialBlockWait blocks ensures that the nodes have established connections.
  • Gossiping transactions from each node tests the transaction propagation.
  • Waiting for FinalizeBlock to be called ensures that the blocks are being processed.
  • The 30-second timeout prevents the tests from hanging indefinitely.

Overall, this function sets up a solid foundation for the integration tests.

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 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.

CodeRabbit Configuration 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.

@tzdybal
refactor: stabilize node startup in integration tests
3f7123c 
Introduce a retry mechanism for node startup to reduce flakiness in CI. Adjust initial block wait time based on the number of nodes to improve test reliability.
@codecov
Copy link

codecov bot commented Sep 18, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.14%. Comparing base (e221ca1) to head (3f7123c).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1850      +/-   ##
==========================================
- Coverage   43.19%   43.14%   -0.06%     
==========================================
  Files          80       80              
  Lines       10387    10387              
==========================================
- Hits         4487     4481       -6     
- Misses       5161     5165       +4     
- Partials      739      741       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tzdybal tzdybal force-pushed the tzdybal/retry_start branch from 70ddc59 to 3f7123c Compare September 18, 2024 22:45
@tzdybal tzdybal marked this pull request as ready for review September 18, 2024 22:48
@RollkitBot RollkitBot requested review from a team, MSevey, Manav-Aggarwal and gupadhyaya and removed request for a team September 18, 2024 22:48
@Manav-Aggarwal Manav-Aggarwal added this pull request to the merge queue Sep 23, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 23, 2024
@tzdybal tzdybal added this pull request to the merge queue Sep 23, 2024
Merged via the queue into main with commit 8ae21f5 Sep 23, 2024
@tzdybal tzdybal deleted the tzdybal/retry_start branch September 23, 2024 16:42
@tac0turtle tac0turtle removed this from Evolve Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Manav-Aggarwal Manav-Aggarwal Manav-Aggarwal approved these changes

@gupadhyaya gupadhyaya Awaiting requested review from gupadhyaya gupadhyaya was automatically assigned from evstack/core

@tuxcanfly tuxcanfly Awaiting requested review from tuxcanfly

@yarikbratashchuk yarikbratashchuk Awaiting requested review from yarikbratashchuk

+1 more reviewer

@MSevey MSevey MSevey approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@tzdybal tzdybal

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

TestTxGossipingAndAggregation failure in CI

4 participants

@tzdybal @MSevey @Manav-Aggarwal