dydxprotocol / v4-chain

dydx v4 protocol
Other
224 stars 103 forks source link

switch to use the helper method to create positions #1787

Closed jayy04 closed 3 months ago

jayy04 commented 3 months ago

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates across multiple test files in this refactor primarily involve standardizing the creation of asset and perpetual positions using helper functions from a utility package (testutil). This modification not only simplifies the test setup code but also enhances readability and maintenance by centralizing test data structure creation.

Changes

Files/Paths Change Summary
protocol/daemons/liquidation/client/sub_task_runner_test.go Replaced direct assignments for positions with calls to testutil.CreateSingleAssetPosition and testutil.CreateSinglePerpetualPosition.
protocol/x/clob/client/cli/liquidations_cli_test.go Updated import statements; utilized new parameters in testutil.CreateSingleAssetPosition and testutil.CreateSinglePerpetualPosition.
protocol/x/clob/e2e/ -> app_test.go, conditional_orders_test.go, isolated_subaccount_orders_test.go, liquidation_deleveraging_test.go, long_term_orders_test.go, reduce_only_orders_test.go, short_term_orders_test.go, withdrawal_gating_test.go Unified position creation using testutil functions across multiple e2e test files.
protocol/x/clob/keeper/ -> deleveraging_test.go, liquidations_test.go, msg_server_place_order_test.go, process_operations_liquidations_test.go, process_operations_long_term_test.go, process_operations_test.go Refactored position initialization via testutil functions to streamline asset and perpetual position setups.
protocol/x/sending/app_test.go Introduced testutil for creating asset positions using CreateSingleAssetPosition.
protocol/x/subaccounts/ -> keeper/isolated_subaccount_test.go, lib/oimf_test.go, lib/updates_test.go, types/genesis_test.go, types/subaccount_test.go Replaced custom position creation logic with testutil functions to handle position creation more efficiently.
protocol/x/vault/keeper/ -> grpc_query_vault_test.go, msg_server_deposit_to_vault_test.go, orders_test.go Simplified position creation in tests by importing testutil and using appropriate helper functions.

Poem

To structure tests, we made a call,
With testutil, positions sprawl.
From clob to subaccounts, a unified way,
Refactoring makes the code obey.
Tests now simpler, clear, precise,
Our codebase earns a fresh device.
Centralized logic, oh what a gift,
Now test with ease, give code a lift!


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.