Skip to content

Test LengthFormat error handling#166

Merged
leynos merged 1 commit intomainfrom
codex/add-parameterised-tests-for-invalid-prefix-sizes
Jul 4, 2025
Merged

Test LengthFormat error handling#166
leynos merged 1 commit intomainfrom
codex/add-parameterised-tests-for-invalid-prefix-sizes

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 4, 2025

Summary

  • add parameterised tests for invalid prefix sizes and lengths
  • check that encode/decode return InvalidInput

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Use rstest to consolidate and expand error handling tests for LengthFormat, parameterizing invalid prefix sizes and excessive lengths and asserting InvalidInput errors.

Enhancements:

  • Replace individual invalid-prefix tests with parameterized rstest usage

Tests:

  • Parameterize encode error tests for invalid prefix sizes (0, 3, 5 bytes) using rstest
  • Parameterize decode error tests for invalid prefix sizes (0, 3, 5 bytes) using rstest
  • Add rstest cases for encode failures when payload length exceeds prefix capacity

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 4, 2025

Reviewer's Guide

Converted singular invalid-prefix-size tests into parameterized rstests for broader coverage and added parameterized overflow tests for length-format errors.

File-Level Changes

Change Details Files
Parameterize unsupported-prefix-size tests with rstest
  • Replaced encode/decode #[test]s with #[rstest] and multiple #[case]s for invalid prefix sizes
  • Renamed tests to encode/decode_fails_for_invalid_prefix_size
  • Updated decode test buffer setup to use vec![0u8; bytes].as_slice()
tests/response.rs
Add parameterized tests for frame-length overflow
  • Introduced encode_fails_for_length_too_large #[rstest] covering 1-byte and 2-byte overflows
  • Assert that encoder returns InvalidInput for oversized frames
tests/response.rs

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 Jul 4, 2025

Summary by CodeRabbit

  • Tests
    • Expanded test coverage with parameterised tests for unsupported prefix sizes and endianness.
    • Added new parameterised tests to verify errors when encoding frames with lengths exceeding supported limits.
    • Improved test structure for better validation of error handling.

Walkthrough

The changes convert existing tests for unsupported prefix sizes in frame encoding and decoding into parameterised tests using the rstest framework, allowing multiple cases to be tested. A new parameterised test checks that encoding frames with overly large lengths fails as expected. No production logic was altered.

Changes

File(s) Change Summary
tests/response.rs Converted two tests to parameterised rstest tests for invalid prefix sizes and endianness; added a new parameterised test for encoding with excessive lengths; adjusted buffer initialisation in decode test.

Poem

A rabbit hopped through fields of code,
With tests that now can take a load—
Of prefixes, lengths, and cases wide,
Parameterised, they leap with pride.
Bugs beware, for every size,
This bunny’s tests will scrutinise! 🐇


📜 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 b2bc64c and ae2ed48.

📒 Files selected for processing (1)
  • tests/response.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: * Seek to keep the cyclomatic complexity of functions no more than 12...

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

  • Adhere to single responsibility and CQRS

  • Place function attributes after doc comments.

  • Do not use return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless absolutely necessary.

  • Every module must begin with a //! doc comment that explains the module's purpose and utility.

  • Comments must use en-GB-oxendict spelling and grammar.

  • Lints must not be silenced except as a last resort.

    • #[allow] is forbidden.
    • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
    • No lint groups, no blanket or file-wide suppression.
    • Include FIXME: with link if a fix is expected.
  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for mocks/stubs.

  • Prefer .expect() over .unwrap()

  • Ensure that any API or behavioural changes are reflected in the documentation in docs/

  • Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

  • tests/response.rs
🧬 Code Graph Analysis (1)
tests/response.rs (3)
src/app.rs (4)
  • fmt (121-126)
  • new (197-197)
  • new (252-252)
  • from (139-139)
src/frame.rs (2)
  • new (38-38)
  • new (230-230)
wireframe_testing/src/helpers.rs (1)
  • processor (22-22)
🔇 Additional comments (3)
tests/response.rs (3)

138-150: Excellent parameterization of the encode test.

The conversion from individual tests to parameterized tests using rstest follows the coding guidelines perfectly. The test cases cover edge cases (0 bytes) and unsupported prefix sizes (3, 5) with different endianness values.


152-162: Good parameterization with improved dynamic buffer allocation.

The conversion to parameterized tests is well done. The change from a fixed byte slice to vec![0u8; bytes].as_slice() at line 159 is a smart improvement that dynamically creates buffers matching the test case prefix size, making the test more robust and self-contained.


164-175: Comprehensive new test for length validation.

The new parameterized test effectively validates that encoding fails when payload length exceeds the prefix size capacity. The test cases are well-chosen:

  • 1-byte prefix with 256 bytes (exceeds u8::MAX + 1)
  • 2-byte prefix with 65,536 bytes (exceeds u16::MAX + 1)

The error handling verification with InvalidInput error kind is appropriate.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in a Comment
  • Commit Unit Tests in branch codex/add-parameterised-tests-for-invalid-prefix-sizes

🪧 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
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 they look great!


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.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jul 4, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 4, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jul 4, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 4, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jul 4, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 4, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos leynos merged commit f49a727 into main Jul 4, 2025
5 checks passed
@leynos leynos deleted the codex/add-parameterised-tests-for-invalid-prefix-sizes branch July 4, 2025 20:37
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