Skip to content

Add wireframe_testing crate for test helpers#112

Closed
leynos wants to merge 1 commit intomainfrom
codex/implement-wireframe-testing-crate
Closed

Add wireframe_testing crate for test helpers#112
leynos wants to merge 1 commit intomainfrom
codex/implement-wireframe-testing-crate

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 22, 2025

Summary

  • implement wireframe_testing crate exposing helper functions for driving WireframeApp
  • switch routing tests to the new crate
  • drop old tests/util.rs

Testing

  • make fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_685864dc04ac832292ff8076adf62a89

Summary by Sourcery

Add a dedicated wireframe_testing crate with async helpers for driving WireframeApp in tests, migrate routing tests to use it, and remove the old util.rs

New Features:

  • Introduce wireframe_testing crate exposing drive_with_frame, drive_with_frames, and related async helpers for WireframeApp

Enhancements:

  • Switch routing tests to use the new wireframe_testing helpers
  • Remove legacy tests/util.rs

Build:

  • Add wireframe_testing as a dev-dependency in Cargo.toml

Summary by CodeRabbit

  • Chores
    • Introduced a new development dependency to streamline testing.
  • Refactor
    • Updated test utilities to use a shared external module for improved maintainability.
  • New Features
    • Added a dedicated testing support module, providing new helper functions for testing application behaviour.
  • Cleanup
    • Removed redundant local test utilities, consolidating functionality into the new shared module.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 22, 2025

Reviewer's Guide

Extracted test-driving utilities into a new wireframe_testing crate, updated tests to use its helper functions, and removed the old util.rs

Class diagram for the new wireframe_testing crate helpers

classDiagram
    class WireframeApp
    class Serializer
    class Packet
    class helpers {
        +drive_with_frame(app: WireframeApp, frame: Vec<u8>) io::Result<Vec<u8>>
        +drive_with_frames(app: WireframeApp, frames: Vec<Vec<u8>>) io::Result<Vec<u8>>
        +drive_with_frame_with_capacity(app: WireframeApp, frame: Vec<u8>, capacity: usize) io::Result<Vec<u8>>
        +drive_with_frames_with_capacity(app: WireframeApp, frames: Vec<Vec<u8>>, capacity: usize) io::Result<Vec<u8>>
        +drive_with_frame_mut(app: &mut WireframeApp, frame: Vec<u8>) io::Result<Vec<u8>>
        +drive_with_frames_mut(app: &mut WireframeApp, frames: Vec<Vec<u8>>) io::Result<Vec<u8>>
        +drive_with_bincode(app: WireframeApp, msg: Encode) io::Result<Vec<u8>>
    }
    helpers ..> WireframeApp : uses
    helpers ..> Serializer : uses
    helpers ..> Packet : uses
    helpers ..> Encode : uses
    WireframeApp <|-- helpers
    Serializer <|-- helpers
    Packet <|-- helpers
    Encode <|-- helpers
Loading

File-Level Changes

Change Details Files
Introduce wireframe_testing crate with helper functions for driving WireframeApp
  • Created crate manifest and lib module
  • Implemented async helper functions in helpers.rs
  • Re-exported helpers from lib.rs
wireframe_testing/Cargo.toml
wireframe_testing/src/helpers.rs
wireframe_testing/src/lib.rs
Switch tests to new wireframe_testing helpers and remove old util
  • Replaced util imports with drive_* functions
  • Removed tests/util.rs file
tests/routes.rs
tests/util.rs
Add wireframe_testing as dev-dependency
  • Declared wireframe_testing path dependency under dev-dependencies
Cargo.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 22, 2025

Walkthrough

This change extracts test utility functions for driving the WireframeApp with frames from a local test module into a new standalone crate, wireframe_testing. The test code is updated to import these helpers from the new crate, and the original local utility module is deleted. The new crate is added as a development dependency.

Changes

File(s) Change Summary
Cargo.toml Added wireframe_testing as a development dependency via a local path.
tests/routes.rs Updated imports to use helpers from wireframe_testing instead of the deleted local util module.
tests/util.rs Deleted file. Previously contained test helpers for running WireframeApp with frames.
wireframe_testing/Cargo.toml New manifest for wireframe_testing crate with dependencies and configuration.
wireframe_testing/src/helpers.rs New module implementing asynchronous helper functions for driving WireframeApp with single or multiple frames, including bincode support.
wireframe_testing/src/lib.rs New crate root; publicly re-exports helper functions from the helpers module.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Code
    participant wireframe_testing as wireframe_testing Helpers
    participant App as WireframeApp

    Test->>wireframe_testing: drive_with_frame(app, frame)
    wireframe_testing->>App: handle_connection (via duplex stream)
    wireframe_testing->>App: Write frame(s) to App
    App-->>wireframe_testing: Processed output bytes
    wireframe_testing-->>Test: Return response bytes
Loading

Possibly related PRs

Poem

A rabbit hopped from test to crate,
Moving helpers to a brand-new gate.
No more cluttered local files—
Now helpers travel modular miles!
With frames and streams, the tests delight,
In wireframe fields, all code feels right.
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5503727 and 8d1241c.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (6)
  • Cargo.toml (1 hunks)
  • tests/routes.rs (1 hunks)
  • tests/util.rs (0 hunks)
  • wireframe_testing/Cargo.toml (1 hunks)
  • wireframe_testing/src/helpers.rs (1 hunks)
  • wireframe_testing/src/lib.rs (1 hunks)
💤 Files with no reviewable changes (1)
  • tests/util.rs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (actions)
  • GitHub Check: build-test
🔇 Additional comments (9)
Cargo.toml (1)

17-17: LGTM: Development dependency correctly configured.

The local path dependency is properly configured for the new testing crate.

tests/routes.rs (1)

15-18: Clean migration to external testing crate.

The import statements correctly reference the new wireframe_testing crate whilst maintaining the existing function names through aliasing.

wireframe_testing/Cargo.toml (2)

6-13: Dependencies are well-chosen for the testing utility.

The dependency selection is appropriate for a crate that provides async testing helpers for the wireframe library.


4-4: Verify Rust edition "2024" is valid.

The Rust edition "2024" may not be released yet. Consider using "2021" instead, which is the current stable edition.

Is Rust edition "2024" available and stable?
wireframe_testing/src/lib.rs (1)

1-11: Well-structured public API.

The module organisation and re-exports provide a clean public interface for the testing helpers.

wireframe_testing/src/helpers.rs (4)

10-10: Reasonable default buffer capacity.

The 4096-byte default capacity should be sufficient for most testing scenarios.


63-76: Solid async testing implementation.

The duplex stream approach with task spawning is an excellent pattern for testing async applications. The error handling and resource cleanup are properly implemented.


125-131: Good error conversion for bincode encoding.

Converting bincode errors to IO errors maintains consistency with the function's return type whilst preserving error information.


134-139: Clean frame transmission helper.

The private helper function properly handles sequential frame transmission with appropriate error propagation.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/implement-wireframe-testing-crate

🪧 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 auto-generate unit tests to generate unit tests for 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.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Absence of Expected Change Pattern

  • wireframe/tests/routes.rs is usually changed with: wireframe/tests/util.rs

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `wireframe_testing/src/lib.rs:1` </location>
<code_context>
+pub mod helpers;
+
+pub use helpers::{
</code_context>

<issue_to_address>
Module 'wireframe_testing' is missing a containing item comment (`//!`).

Please add a module-level doc comment at the top of this file using `//!` to describe the purpose of the module.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -0,0 +1,11 @@
pub mod helpers;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

issue (review_instructions): Module 'wireframe_testing' is missing a containing item comment (//!).

Please add a module-level doc comment at the top of this file using //! to describe the purpose of the module.

Review instructions:

Path patterns: **/*.rs

Instructions:
All modules MUST have a containing item comment (//!)

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jun 22, 2025

Stale

@leynos leynos closed this Jun 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant