Skip to content

Add tests for add order file #1722

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

Merged
merged 16 commits into from
May 17, 2025
Merged

Add tests for add order file #1722

merged 16 commits into from
May 17, 2025

Conversation

findolor
Copy link
Collaborator

@findolor findolor commented May 2, 2025

Motivation

See issue: #1623

Solution

Checks

By submitting this for review, I'm confirming I've done the following:

  • made this PR as small as possible
  • unit-tested any new functionality
  • linked any relevant issues or PRs
  • [ ] included screenshots (if this involves a front-end change)

fix #1623

Summary by CodeRabbit

  • Tests
    • Added comprehensive tests covering rainlang parsing, composition, error handling, and order calldata generation.
    • Improved validation of order-related functionalities including vault ID assignment and RPC URL handling.
    • Removed an obsolete test and introduced a helper function to streamline test setups.

@findolor findolor added test test code rust Related to rust crates labels May 2, 2025
@findolor findolor added this to the Test coverage, tech debt milestone May 2, 2025
@findolor findolor requested a review from hardyjosh May 2, 2025 06:59
@findolor findolor self-assigned this May 2, 2025
Copy link
Contributor

coderabbitai bot commented May 2, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change adds a new asynchronous method get_add_order_call_parameters to AddOrderArgs for generating contract call parameters, refactors execute to use this method, removes an obsolete test, and introduces multiple new tests covering rainlang parsing, composition, error handling, and calldata generation. A helper function for test deployment configuration is also added.

Changes

File(s) Change Summary
crates/common/src/add_order.rs Added async method get_add_order_call_parameters and refactored execute to use it. Removed obsolete test test_order_config_v2_validity. Added multiple new async and sync tests for rainlang parsing, composition, error cases, and calldata generation. Added helper function get_deployment for test setup.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Function
    participant AddOrderArgs
    participant RainlangParser
    participant TransactionArgs

    Test->>AddOrderArgs: Create instance with test data
    Test->>AddOrderArgs: Call compose_to_rainlang()
    AddOrderArgs-->>Test: Return rainlang string or ComposeError

    Test->>RainlangParser: try_parse_rainlang(rainlang string)
    RainlangParser-->>Test: Return bytecode or ParseError

    Test->>TransactionArgs: try_into_write_contract_parameters(addOrder2Call)
    TransactionArgs-->>Test: Return contract parameters or Error
Loading

Assessment against linked issues

Objective Addressed Explanation
Test coverage for AddOrderArgs::execute and AddOrderArgs::get_add_order_calldata (#1623) Tests cover get_add_order_calldata and get_add_order_call_parameters but do not explicitly test the execute method itself.

Possibly related PRs

  • Test common::transaction #1754: Modifies AddOrderArgs::execute and related parameter conversion methods, overlapping with the current PR’s refactor and method additions.

Suggested reviewers

  • hardyjosh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@findolor findolor requested a review from 0xgleb May 12, 2025 09:31
}

#[tokio::test]
async fn test_add_order_call_try_into_write_contract_parameters() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm a bit confused - is this testing any logic from this module?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

i have added this test because we cannot mock the ledger logic. this was the function that was called inside the execute function so i have added this to test out to flow inside that function

Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe it'd be better to take that bit out of execute, put it in a new function and test that? otherwise the logic in execute can diverge from the test and the test wouldn't catch any potential issues

@@ -974,4 +978,225 @@ _ _: 16 52;
.await
.expect_err("expected to fail but resolved");
}

#[tokio::test]
async fn test_try_parse_rainlang() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

we should probably also cover unhappy path of try_parse_rainlang

@findolor findolor requested a review from 0xgleb May 14, 2025 09:06
}

#[tokio::test]
async fn test_get_add_order_calldata_invalid_rcp_url() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

typo

Suggested change
async fn test_get_add_order_calldata_invalid_rcp_url() {
async fn test_get_add_order_calldata_invalid_rpc_url() {

}

#[tokio::test]
async fn test_add_order_call_try_into_write_contract_parameters() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe it'd be better to take that bit out of execute, put it in a new function and test that? otherwise the logic in execute can diverge from the test and the test wouldn't catch any potential issues

@findolor
Copy link
Collaborator Author

@0xgleb to test out try_generate_meta we need to mock the cbor_encode_seq function and return an error from there. the current test setup does not allow for that so i wasn't able to add error tests for that one

@hardyjosh hardyjosh enabled auto-merge May 16, 2025 14:38
@hardyjosh hardyjosh merged commit 46e540e into main May 17, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rust Related to rust crates test test code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing test - Common crate - add_order.rs
3 participants