Skip to content

Refactor extractor tests with shared fixtures#188

Merged
leynos merged 3 commits intomainfrom
codex/refactor-test-setup-with-rstest-fixtures
Jul 6, 2025
Merged

Refactor extractor tests with shared fixtures#188
leynos merged 3 commits intomainfrom
codex/refactor-test-setup-with-rstest-fixtures

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 6, 2025

Summary

  • refactor extractor tests to use rstest fixtures
  • apply the same fixture approach to tests/app_data.rs

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Tests:

  • Replace manual construction of MessageRequest and Payload with shared rstest fixtures in extractor and app_data tests

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 6, 2025

Reviewer's Guide

This PR refactors the extractor and app_data tests by introducing shared rstest fixtures for MessageRequest and Payload, converting individual tests to use #[rstest] with injected fixtures instead of manual setup, and applying the same pattern across both test modules.

File-Level Changes

Change Details Files
Introduce shared rstest fixtures
  • Import rstest::{fixture, rstest}
  • Define #[fixture] fn request() -> MessageRequest
  • Define #[fixture] fn empty_payload() -> Payload
  • Allow unused braces on fixture definitions
tests/extractor.rs
tests/app_data.rs
Refactor extractor.rs tests to use fixtures
  • Replace #[test] with #[rstest]
  • Inject request and empty_payload into test signatures
  • Remove manual MessageRequest::default() and Payload instantiations
tests/extractor.rs
Refactor app_data.rs tests to use fixtures
  • Replace #[test] with #[rstest]
  • Inject request and empty_payload into test signatures
  • Remove manual request and payload setup
tests/app_data.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 6, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 840158f and 4fb9704.

📒 Files selected for processing (6)
  • docs/rust-testing-with-rstest-fixtures.md (3 hunks)
  • tests/app_data.rs (2 hunks)
  • tests/connection_actor.rs (2 hunks)
  • tests/extractor.rs (1 hunks)
  • tests/push_policies.rs (1 hunks)
  • tests/session_registry.rs (1 hunks)

Summary by CodeRabbit

  • Tests
    • Refactored tests to use parameterised testing with fixtures for improved readability and maintainability.
    • Introduced fixtures for default request and payload instances.
    • Converted existing test functions to use the new fixture-based approach without altering test logic or assertions.

Walkthrough

The test modules in tests/app_data.rs and tests/extractor.rs were refactored to use the rstest crate for parameterised testing. Fixture functions for MessageRequest and Payload were introduced, and test functions were updated to use these fixtures as parameters. Test logic and assertions remain unchanged.

Changes

File(s) Change Summary
tests/app_data.rs, tests/extractor.rs Refactored tests to use rstest parameterised testing and fixtures for MessageRequest and Payload. Test functions now take fixtures as parameters, and #[rstest] attributes replace #[test]. Imports updated accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant rstest
    participant FixtureRequest
    participant FixturePayload
    participant TestFunction

    TestRunner->>rstest: Start test with #[rstest]
    rstest->>FixtureRequest: Create MessageRequest fixture
    rstest->>FixturePayload: Create Payload fixture
    rstest->>TestFunction: Inject fixtures as parameters
    TestFunction->>TestFunction: Execute test logic with fixtures
    TestFunction-->>TestRunner: Return test result
Loading

Possibly related PRs

  • Add shared state container #75: Refactored tests to use rstest fixtures for MessageRequest and Payload in verifying shared state extraction, directly building on the shared state container and extractor functionality.

Poem

A rabbit hopped through fields of test,
With fixtures now, our code is blessed.
No more clutter, just clean and neat,
Parameterised tests are quite a feat!
With rstest's help, we leap ahead,
And bugs, we hope, shall stay in bed.
🐇✨

✨ 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/refactor-test-setup-with-rstest-fixtures

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 07b716f and 840158f.

📒 Files selected for processing (2)
  • tests/app_data.rs (2 hunks)
  • tests/extractor.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.rs`: Comment why, not what. Explain assumptions, edge cases, trade-offs, o...

**/*.rs: Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Use predicate functions for conditional criteria with more than two branches.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.

📄 Source: CodeRabbit Inference Engine (AGENTS.md)

List of files the instruction was applied to:

  • tests/app_data.rs
  • tests/extractor.rs
`**/*.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/app_data.rs
  • tests/extractor.rs
🧬 Code Graph Analysis (2)
tests/app_data.rs (2)
tests/extractor.rs (2)
  • request (15-15)
  • empty_payload (19-19)
src/extractor.rs (4)
  • from_message_request (184-187)
  • from_message_request (265-271)
  • from_message_request (328-335)
  • from_message_request (372-379)
tests/extractor.rs (2)
tests/app_data.rs (2)
  • request (16-16)
  • empty_payload (20-20)
src/extractor.rs (7)
  • from_message_request (184-187)
  • from_message_request (265-271)
  • from_message_request (328-335)
  • from_message_request (372-379)
  • remaining (165-165)
  • peer_addr (362-362)
  • state (54-62)
⏰ Context from checks skipped due to timeout of 240000ms (2)
  • GitHub Check: build-test
  • GitHub Check: Analyze (actions)
🔇 Additional comments (6)
tests/app_data.rs (2)

22-30: Well-structured fixture usage.

The test correctly uses the fixtures as parameters, maintaining the original test logic whilst benefiting from shared setup.


32-41: Consistent fixture usage across tests.

The test properly leverages the fixtures, ensuring consistency with the other test whilst preserving the original assertions.

tests/extractor.rs (4)

29-38: Excellent fixture integration.

The test effectively uses the fixture parameter whilst maintaining the original test logic and comprehensive documentation.


40-50: Proper fixture usage with mutable parameters.

The test correctly uses both fixtures as parameters, including the mutable modifications needed for the test scenario.


57-65: Consistent fixture application.

The test properly leverages the fixtures whilst preserving the original shared state testing logic.


72-85: Well-maintained error testing with fixtures.

The test correctly uses fixtures for error scenario testing, maintaining the original error handling verification.

Comment thread tests/app_data.rs Outdated
Comment thread tests/app_data.rs Outdated
Comment thread tests/extractor.rs Outdated
Comment thread tests/extractor.rs Outdated
@leynos leynos merged commit 0556d0c into main Jul 6, 2025
5 checks passed
@leynos leynos deleted the codex/refactor-test-setup-with-rstest-fixtures branch July 6, 2025 19:25
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