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

add tests for multihop price calcs #1824

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add tests for multihop price calcs #1824

wants to merge 1 commit into from

Conversation

joe-bowman
Copy link
Contributor

@joe-bowman joe-bowman commented Feb 17, 2025

1. Summary

Add additional tests for checking MultiHop price determination.

Summary by CodeRabbit

  • Tests
    • Enhanced internal validations to ensure token price calculations accurately account for complex, multi-step liquidity scenarios, resulting in more consistent asset valuations for users.

Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

Walkthrough

This change introduces a new test case, TestCalcTokenValuesPoolsMultihop, within the distribution_test.go file. The test validates token value computation through intermediary pools by unmarshalling new JSON strings for concentrated liquidity and balancer pool data. The test sets up the required parameters, calls the CalcTokenValues method, and verifies the calculated values for tokens such as aarch, uusdc, and uosmo.

Changes

File Change Summary
x/participationrewards/keeper/distribution_test.go Added TestCalcTokenValuesPoolsMultihop test case; introduced new JSON string variables for concentrated liquidity and balancer pools; set up multi-hop token price derivation and assertions for aarch, uusdc, and uosmo tokens.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test Suite
    participant K as ParticipationRewardsKeeper
    participant C as CalcTokenValues Method

    T->>K: Unmarshal JSON for pool data (CL and Balancer)
    K->>C: Setup pool parameters and data
    T->>K: Invoke CalcTokenValues for tokens (aarch, uusdc, uosmo)
    K->>T: Return computed token values
    T->>T: Assert values match expected results
Loading

Possibly related PRs

Suggested labels

x/participationrewards

Suggested reviewers

  • faddat

Poem

I'm a bunny with a hopping tune,
Testing multi-hop paths 'neath the moon.
JSON paths swirl in pools so bright,
Validating tokens by day and night.
Code and hops bound in joyful flight! 🐰

Happy testing from my burrow so tight!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

Error: unknown linters: 'usetesting', run 'golangci-lint help linters' to see the list of supported linters
Failed executing command with error: unknown linters: 'usetesting', run 'golangci-lint help linters' to see the list of supported linters

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

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.

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 (2)
x/participationrewards/keeper/distribution_test.go (2)

274-280: Consider using deterministic timestamps in test data.

The test data contains future timestamps (e.g., "2024-06-29", "2025-02-14"). While this doesn't affect the test functionality, using deterministic timestamps (e.g., a fixed past date) would make the tests more maintainable and prevent potential confusion.


282-284: Add comments to explain the test scenario.

While the function name and inline comments provide some context, it would be helpful to add more detailed comments explaining:

  • The purpose of using intermediary pools
  • The specific path taken to derive the price (e.g., aarch → usdc → osmo)
  • Why this test case is important
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4258c18 and ba2c9fc.

📒 Files selected for processing (1)
  • x/participationrewards/keeper/distribution_test.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: test quicksilver (darwin, arm64)
  • GitHub Check: build quicksilver (darwin, arm64)
  • GitHub Check: test quicksilver (amd64, windows)
  • GitHub Check: build quicksilver (amd64, darwin)
  • GitHub Check: test quicksilver (amd64, linux)
  • GitHub Check: build quicksilver (amd64, windows)
  • GitHub Check: build quicksilver (amd64, linux)
  • GitHub Check: lint
  • GitHub Check: Analyze
🔇 Additional comments (1)
x/participationrewards/keeper/distribution_test.go (1)

282-337: LGTM! Well-structured test implementation.

The test function is well-implemented with:

  • Clear setup of test environment
  • Proper error handling
  • Good test data organization
  • Appropriate assertions

Copy link

codecov bot commented Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.07%. Comparing base (4258c18) to head (ba2c9fc).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1824   +/-   ##
=======================================
  Coverage   63.07%   63.07%           
=======================================
  Files         172      172           
  Lines       15549    15549           
=======================================
  Hits         9807     9807           
  Misses       4933     4933           
  Partials      809      809           
Flag Coverage Δ
unittests 63.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Successfully merging this pull request may close these issues.

1 participant