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: Move slinky daemon tests into single suite #1198

Closed

Conversation

Eric-Warehime
Copy link
Contributor

Changelist

Moved all slinky daemon tests dependent on grpc server setup to a single Suite.

Test Plan

I was able to replicate the existing flakiness locally without this change by running all protocol/daemons tests with test.count=100. After making this change, I reran the same 100 repetition test set and was no longer able to produce the flaky result.

It's hard to be definitive in this, but it appears resolving the contention over the same socket across tests will resolve the flaky failures.

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Sorry, something went wrong.

Copy link
Contributor

coderabbitai bot commented Mar 18, 2024

Walkthrough

The update primarily focuses on streamlining and renaming the test suite within a specific Go test file. It involves changing the test suite's name from PriceFetcherTestSuite to ClientTestSuite, adjusting the test function's signature to align with this new name, and simplifying the test structure by removing setup and teardown methods. This refactor indicates a shift towards a more generalized testing approach for the client functionality.

Changes

File Path Change Summary
.../slinky/client/price_fetcher_test.go Refactored test suite name to ClientTestSuite, updated test function signature, removed setup and teardown methods, and reassigned TestPriceFetcher to the new suite.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ab14ab8 and e94f499.
Files selected for processing (1)
  • protocol/daemons/slinky/client/price_fetcher_test.go (1 hunks)
Additional comments: 1
protocol/daemons/slinky/client/price_fetcher_test.go (1)
  • 19-19: The renaming of the test suite from PriceFetcherTestSuite to ClientTestSuite aligns with the PR objectives of consolidating tests into a single suite. However, the removal of setup and teardown methods could have implications for test isolation and resource cleanup. Ensure that any required setup or cleanup is either unnecessary due to the test environment or handled appropriately within each test case.

}

func (p *PriceFetcherTestSuite) TestPriceFetcher() {
func (p *ClientTestSuite) TestPriceFetcher() {
Copy link
Contributor

Choose a reason for hiding this comment

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

The test cases within ClientTestSuite are comprehensive, covering a wide range of scenarios. It's commendable that the tests are designed to ensure the functionality of the PriceFetcher under various conditions. However, consider reviewing the error handling to ensure consistency and clarity across test cases. Additionally, using constants for repeated strings, such as error messages and currency pairs, could enhance maintainability and readability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

None yet

1 participant