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): temporarily disable rate limiter e2e test #2463

Closed
wants to merge 1 commit into from

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Jul 11, 2024

Description

Temporarily disable the rate limiter E2E test for letting other admin test pass.
Issue for the bug tracked: #2424

Disabling the test for now is a easier workaround as the rate limiter E2E test doesn't properly test the functionality: #2090 and we need the other test to be testable directly in the CI to simplify the testing process for the coming release

Summary by CodeRabbit

  • Bug Fixes

    • Temporarily disabled rate limiter test causing failures to investigate and fix the issue.
  • Chores

    • Updated test suite to remove the problematic rate limiter test from routine checks.

@lumtis lumtis added no-changelog Skip changelog CI check ADMIN_TESTS Run make start-admin-tests labels Jul 11, 2024
Copy link
Contributor

coderabbitai bot commented Jul 11, 2024

Walkthrough

The localE2ETest function in local.go has been updated to comment out the TestRateLimiterName test due to a bug causing it to fail. Consequently, the adminTestRoutine no longer accepts e2etests.TestRateLimiterName as an argument. References to related GitHub issues and workarounds have been documented to address the problem.

Changes

File Change Summary
cmd/zetae2e/local/local.go Commented out the TestRateLimiterName test in localE2ETest and updated adminTestRoutine to reflect this removal. Added comments and references to GitHub issues.

Poem

In the code's deep sea, a bug did hide,
The rate limiter test, it did not abide.
So we commented it out, with a note and a sigh,
Fixes are pending, on GitHub they lie.
Keep pushing forward, with code that's bright,
Until all tests pass, in the dawn's first light. 🌟


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>.
    • 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 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.

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

Outside diff range, codebase verification and nitpick comments (1)
cmd/zetae2e/local/local.go (1)

281-289: LGTM! Consider adding more context to the TODO comments.

The comments are clear and provide the necessary context for disabling the test. The TODO comments properly reference the relevant GitHub issues.

Consider adding more context to the TODO comments to specify what needs to be fixed or defined.

-  // TODO: fix the error causing the test failure
+  // TODO: Investigate and fix the underlying issue causing the TestRateLimiterName test failure

-  // TODO: define proper threshold for test assertion
+  // TODO: Define proper threshold for rate limiting in the TestRateLimiterName test assertion
Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0db41c and b1e91b2.

Files selected for processing (1)
  • cmd/zetae2e/local/local.go (1 hunks)
Additional context used
Path-based instructions (1)
cmd/zetae2e/local/local.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

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

Outside diff range, codebase verification and nitpick comments (1)
cmd/zetae2e/local/local.go (1)

281-289: Track TODOs in the issue tracker.

The comments provide clear context for why the TestRateLimiterName test is disabled and link to relevant issues. However, it is recommended to track TODOs in the issue tracker rather than in the code to ensure they are not overlooked.

-  // TODO: fix the error causing the test failure
-  // https://github.com/zeta-chain/node/issues/2424
-  // TODO: define proper threshold for test assertion
-  // https://github.com/zeta-chain/node/issues/2090
+  // See issue #2424 for fixing the error causing the test failure.
+  // See issue #2090 for defining a proper threshold for test assertion.
Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0db41c and b1e91b2.

Files selected for processing (1)
  • cmd/zetae2e/local/local.go (1 hunks)
Additional context used
Path-based instructions (1)
cmd/zetae2e/local/local.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d0db41c and b1e91b2.

Files selected for processing (1)
  • cmd/zetae2e/local/local.go (1 hunks)
Additional context used
Path-based instructions (1)
cmd/zetae2e/local/local.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

Additional comments not posted (1)
cmd/zetae2e/local/local.go (1)

281-288: LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to adminTestRoutine are updated accordingly to match the new parameter list.

Verification successful

Verified: The function calls to adminTestRoutine have been updated accordingly to match the new parameter list.

  • The function call and definition are consistent with each other.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `adminTestRoutine` match the new parameter list.

# Test: Search for the function usage. Expect: Only occurances of the new parameter list.
rg --type go $'adminTestRoutine'

Length of output: 238


Script:

#!/bin/bash
# Retrieve the function definition of adminTestRoutine from cmd/zetae2e/local/admin.go
rg --type go -A 10 $'func adminTestRoutine' cmd/zetae2e/local/admin.go

# Retrieve the call to adminTestRoutine from cmd/zetae2e/local/local.go
rg --type go -A 5 $'adminTestRoutine' cmd/zetae2e/local/local.go

Length of output: 662

cmd/zetae2e/local/local.go Show resolved Hide resolved
@lumtis lumtis added this pull request to the merge queue Jul 11, 2024
@lumtis lumtis removed this pull request from the merge queue due to a manual request Jul 11, 2024
@lumtis lumtis marked this pull request as draft July 11, 2024 14:49
@lumtis
Copy link
Member Author

lumtis commented Jul 11, 2024

Closing as it has been fixed

@lumtis lumtis closed this Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADMIN_TESTS Run make start-admin-tests breaking:cli no-changelog Skip changelog CI check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants