test: add unit tests for Pool

[shuhuiluo]

Introduced a new test module for the Pool entity, including various test cases to cover constructor, key generation, id retrieval, and swap functionality. Also added once_cell dependency for lazy statics in tests.

Summary by CodeRabbit

• New Features

  • Added a new development dependency for improved testing capabilities.
  • Enhanced flexibility in the Pool struct methods to support various tick spacing types.
  • Introduced new test coverage for the Pool struct, validating its functionality under different scenarios.
  • Added static variables for cryptocurrency tokens and liquidity pools to streamline testing.

• Bug Fixes

  • Streamlined import statements by removing unused aliases.
  • Removed redundant error handling in trade methods for cleaner logic.

• Documentation

  • Added a new testing module to facilitate better testing practices.

[coderabbitai]

Walkthrough

The changes encompass updates to the Cargo.toml, src/entities/pool.rs, src/lib.rs, and src/tests.rs files. A new development dependency, once_cell, was added to Cargo.toml. The Pool struct in pool.rs was modified to enhance method flexibility by introducing a generic type for tick spacing. Additionally, a test module was added to pool.rs, and a new testing module was created in lib.rs. The tests.rs file saw the introduction of static variables and constants for tokens and liquidity pools, utilizing the once_cell crate for lazy initialization.

Changes

File	Change Summary
Cargo.toml	Added once_cell as a development dependency ([dev-dependencies]).
src/entities/pool.rs	Updated get_pool_key and get_pool_id methods to accept a generic type for tick_spacing. Removed unused import I24. Added a test module with unit tests for Pool.
src/lib.rs	Introduced a new testing module (mod tests;) for conditional compilation during tests.
src/tests.rs	Added static variables for ETHER, WETH, USDC, DAI, and liquidity pools USDC_DAI, DAI_USDC. Defined constant ONE_ETHER.

Possibly related PRs

• chore: refactor ABI structs and consolidate modules #2: The changes in the main PR involve adding a new development dependency (once_cell) which may be relevant to the testing and structuring of the Pool and PoolKey in the retrieved PR, as both involve modifications to the Pool struct and its associated methods.

Suggested reviewers

• malik672

Poem

In the code where dependencies grow,
once_cell joins the show!
A Pool's methods now flex and bend,
With tests to ensure they won't offend.
Static tokens, pools in sight,
Coding magic, oh what a delight! 🎉

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 5927fc8 and 9aa8297.

📒 Files selected for processing (1)

• src/entities/trade.rs (2 hunks)

🔇 Additional comments (3)

src/entities/trade.rs (3)

706-706: Bazinga! Excellent removal of the redundant error propagation operator.

I must say, as someone with multiple doctorates worth of knowledge about programming paradigms, the removal of the ? operator here is not just correct, but theoretically elegant. The sorted_insert function is infallible, making the error propagation operator as useful as a screen door on a submarine.

---

807-807: Oh look, another superfluous ? operator bites the dust!

As I always say to Leonard when he makes similar mistakes in his experimental physics calculations, redundancy in code is like redundancy in the English language - completely unnecessary and, might I add, a waste of precious CPU cycles. The removal of this ? operator is theoretically sound.

---

Line range hint 706-807: Fascinating observation about code symmetry!

knocks three times
Code!
knocks three times
Symmetry!
knocks three times
Pattern!

I couldn't help but notice the delightful symmetry between these two changes. Both modifications occur in analogous functions (best_trade_exact_in and best_trade_exact_out), demonstrating a consistent application of the same principle. This is the kind of pattern that makes my obsessive-compulsive tendencies tingle with joy!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 53d2208 and 5927fc8.

📒 Files selected for processing (4)

• Cargo.toml (1 hunks)
• src/entities/pool.rs (3 hunks)
• src/lib.rs (1 hunks)
• src/tests.rs (1 hunks)

🔇 Additional comments (7)

Cargo.toml (1)

15-17: Bazinga! This dependency addition demonstrates remarkable cognitive aptitude!

Much like how the Heisenberg Uncertainty Principle tells us we can't simultaneously know a particle's position and momentum with absolute precision, the once_cell crate elegantly solves the conundrum of lazy initialization in test scenarios. The version selection of 1.20.2 exhibits adequate temporal proximity to contemporary releases while maintaining stability.

src/lib.rs (1)

37-38: Fascinating! The test module addition demonstrates impeccable organizational structure.

I must say, as someone with two doctorates and a profound appreciation for organizational hierarchies, the placement of this test module is exactly where it should be - after the primary modules but before the prelude. The #[cfg(test)] attribute ensures optimal compilation efficiency by conditionally including the tests. knock knock knock Perfect! knock knock knock Perfect! knock knock knock Perfect!

src/tests.rs (3)

1-5: Fascinating organization of imports! knock knock knock Approved!

The imports demonstrate a logical progression from core dependencies to specific utilities, much like the organizational principle in particle physics where we progress from quarks to atoms to molecules.

---

52-52: This constant definition is more elegant than String Theory!

The use of underscores for digit grouping demonstrates an appreciation for numerical readability that would make even Leonard jealous.

---

27-50: 🧹 Nitpick (assertive)

Good Lord! This requires my attention to detail.

While the pool initialization demonstrates symmetry that would make a physicist proud, I must point out several concerns:

1. Using Address::ZERO is like using absolute zero in thermodynamics - theoretically possible but practically concerning.
2. The initial sqrt price ratio of 1:1 (lines 34, 46) assumes perfect price parity between tokens, which, like assuming a perfectly spherical chicken in a vacuum, is highly idealistic.

Let me verify if this zero address pattern exists elsewhere:

Consider:

1. Using a deterministic address derivation for test pools
2. Setting realistic initial prices based on token decimals

src/entities/pool.rs (2)

62-76: Bazinga! Excellent use of generic type parameters!

The modification to accept a generic type I: TickIndex for tick spacing demonstrates superior type system utilization, much like the elegant mathematical precision in quantum chromodynamics.

---

443-447: Fascinating test organization! Like a well-organized comic book collection!

The modular organization of tests with proper imports and use of once_cell demonstrates exceptional attention to detail.