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

fix(systemtests): wait longer to detect double sign #23286

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Jan 10, 2025

for more info, https://github.com/cosmos/cosmos-sdk/actions/runs/12701390978/job/35405814980?pr=23285

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Tests
    • Enhanced system test for block processing by increasing iteration count and adding a 6-second delay between block checks.

@mmsqe mmsqe requested a review from a team as a code owner January 10, 2025 01:56
Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the fraud_test.go system test file, specifically changing the block processing wait loop. The original implementation checked block processing 30 times without delays, while the new version increases the iteration count to 100 and introduces a 6-second delay between each block processing check. This adjustment aims to provide more robust and flexible block processing verification during system testing.

Changes

File Change Summary
tests/systemtests/fraud_test.go - Added time package import
- Modified block processing wait loop from 30 to 100 iterations
- Introduced 6-second delay between block checks

Sequence Diagram

sequenceDiagram
    participant Test as Fraud Test
    participant SUT as System Under Test
    
    loop Block Processing Check (100 times)
        Test->>SUT: AwaitNextBlock()
        Test-->>Test: Wait 6 seconds
    end
Loading

Possibly related PRs

Suggested labels

backport/v0.52.x

Suggested reviewers

  • sontrinh16
  • akhilkumarpilli
  • julienrbrt

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

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

🧹 Nitpick comments (1)
tests/systemtests/fraud_test.go (1)

47-48: Consider making the timeout configurable

The hardcoded values for iterations and delay could be made configurable to allow easier tuning without code changes.

Consider this approach:

+const (
+    // DefaultDoubleSignDetectionMaxAttempts is the default number of attempts to detect double signing
+    DefaultDoubleSignDetectionMaxAttempts = 100
+    // DefaultDoubleSignDetectionDelay is the default delay between attempts in seconds
+    DefaultDoubleSignDetectionDelay = 6
+)

 func TestValidatorDoubleSign(t *testing.T) {
     // ... existing code ...
-    for i := 0; i < 100; i++ {
-        systest.Sut.AwaitNextBlock(t, 6*time.Second)
+    maxAttempts := systest.GetIntConfig("DOUBLE_SIGN_DETECTION_MAX_ATTEMPTS", DefaultDoubleSignDetectionMaxAttempts)
+    delaySeconds := systest.GetIntConfig("DOUBLE_SIGN_DETECTION_DELAY", DefaultDoubleSignDetectionDelay)
+    for i := 0; i < maxAttempts; i++ {
+        systest.Sut.AwaitNextBlock(t, time.Duration(delaySeconds)*time.Second)

This would allow adjusting the values through environment variables while maintaining sensible defaults.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 517839b and 8347e3d.

📒 Files selected for processing (1)
  • tests/systemtests/fraud_test.go (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
tests/systemtests/fraud_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: tests (03)
  • GitHub Check: tests (02)
  • GitHub Check: tests (01)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-system-v2
  • GitHub Check: test-integration
  • GitHub Check: build (arm64)
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: golangci-lint
  • GitHub Check: Summary
🔇 Additional comments (2)
tests/systemtests/fraud_test.go (2)

10-10: LGTM: Import addition is correct

The time import is properly placed and necessary for the new timeout functionality.


47-48: Verify the timeout values

The increased iteration count (100) and delay (6s) significantly extend the maximum wait time to 10 minutes. While this aligns with the PR objective to wait longer for double sign detection, please verify if these specific values were chosen based on empirical evidence.

Could you share the reasoning behind choosing 6 seconds specifically? Were there test runs that showed this was the optimal delay?

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

ACK

@julienrbrt julienrbrt requested a review from alpe January 10, 2025 08:29
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 10, 2025
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

thank you, chain is moving too fast in test ;)

@tac0turtle tac0turtle added this pull request to the merge queue Jan 10, 2025
Merged via the queue into cosmos:main with commit 2ab05c6 Jan 10, 2025
68 of 76 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants