Skip to content

Add lines_vec macro for test fixtures#40

Merged
leynos merged 2 commits intomainfrom
codex/create-helper-for-vecstring-generation
Jun 15, 2025
Merged

Add lines_vec macro for test fixtures#40
leynos merged 2 commits intomainfrom
codex/create-helper-for-vecstring-generation

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 15, 2025

Summary

  • introduce lines_vec! macro for building Vec<String> in tests
  • refactor integration test fixtures to use the macro
  • document the helper in the testing guide

Testing

  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test
  • markdownlint README.md docs/*.md (fails: many pre-existing errors)

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

Summary by Sourcery

Introduce a lines_vec! macro to simplify building Vec<String> in tests, refactor existing integration test fixtures to use the macro, and document its usage in the testing guide.

Enhancements:

  • Add lines_vec! macro for concise Vec<String> construction in tests
  • Refactor all integration test fixtures to replace manual .to_string()-wrapped vectors with lines_vec! calls

Documentation:

  • Document the lines_vec! helper in the Rust testing guide

Summary by CodeRabbit

  • Documentation
    • Updated best practices to include guidance on using utility macros for constructing vectors of strings in tests, reducing repetitive code.
  • Refactor
    • Simplified test fixtures by introducing a macro for easier creation of string vectors, improving code readability without changing test behaviour.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 15, 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 15 minutes and 13 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 e146740 and 7a73cc9.

📒 Files selected for processing (3)
  • docs/rust-testing-with-rstest-fixtures.md (1 hunks)
  • tests/common/mod.rs (1 hunks)
  • tests/integration.rs (3 hunks)

Walkthrough

A new macro, lines_vec!, was introduced to simplify the creation of Vec<String> from string literals in integration test fixtures. The documentation was updated to recommend this macro as a best practice for reducing repetitive .to_string() calls. Existing test fixtures were refactored to use the macro.

Changes

File(s) Change Summary
tests/integration.rs Added lines_vec! macro for Vec<String> creation; refactored fixtures to use this macro.
docs/rust-testing-with-rstest-fixtures.md Updated best practices to recommend the new lines_vec! macro for use in test fixtures.

Sequence Diagram(s)

sequenceDiagram
    participant TestFixture
    participant lines_vec! Macro
    participant VecString

    TestFixture->>lines_vec! Macro: Invoke with string literals
    lines_vec! Macro->>VecString: Convert literals to Vec<String>
    lines_vec! Macro-->>TestFixture: Return Vec<String>
Loading

Possibly related issues

Poem

In the warren where tests abound,
A macro called lines_vec! is found.
No more .to_string() in a row—
Just hop and let your fixtures flow!
With code now neat and truly slick,
The rabbits cheer: “That did the trick!” 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 15, 2025

Reviewer's Guide

This PR adds a new lines_vec! macro to simplify building Vec<String> test fixtures, refactors all existing integration test fixtures to use the macro in place of manual .to_string() calls, and updates the testing guide documentation to describe its usage.

Flow Diagram: Simplification of Vec Fixture Creation with lines_vec! Macro

graph TD
    subgraph Old_Way_to_Create_Vec_String["Old Way: Manual Vec<String> Creation in Tests"]
        direction LR
        O1["Developer writes:"] --> O2["vec![<br/>  &quot;line1&quot;.to_string(),<br/>  &quot;line2&quot;.to_string(),<br/>  // ... more lines<br/>]"];
        O2 --> O3["Result: Vec&lt;String&gt;"];
    end

    subgraph New_Way_with_lines_vec["New Way: Using lines_vec! Macro in Tests"]
        direction LR
        N1["Developer writes:"] --> N2["lines_vec![<br/>  &quot;line1&quot;,<br/>  &quot;line2&quot;,<br/>  // ... more lines<br/>]"];
        N2 --> N3["Result: Vec&lt;String&gt;"];
    end
Loading

File-Level Changes

Change Details Files
Refactor integration fixtures to use lines_vec! macro
  • Replaced all vec![… .to_string()] expressions in tests with lines_vec!(…)
  • Unified fixture definitions into concise macro invocations
tests/integration.rs
Document the lines_vec! macro in the testing guide
  • Added a “Utility Macros” bullet describing lines_vec! and its benefits
  • Integrated guidance on using the macro to reduce verbosity
docs/rust-testing-with-rstest-fixtures.md

Possibly linked issues


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

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: 0

🧹 Nitpick comments (2)
tests/integration.rs (1)

8-13: Add lines_vec! macro for Vec<String> fixtures.

The macro correctly converts string literals into owned String values and supports an optional trailing comma. Consider extracting it into a shared test‐utilities module (e.g. tests/common/mod.rs) if you plan to reuse it across multiple integration tests.

docs/rust-testing-with-rstest-fixtures.md (1)

856-859: Enhance Utility Macros section with usage example.

The new Utility Macros item should include a short code snippet showing how to invoke lines_vec! in a fixture for clarity.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b452a9 and e146740.

📒 Files selected for processing (2)
  • docs/rust-testing-with-rstest-fixtures.md (1 hunks)
  • tests/integration.rs (3 hunks)
🔇 Additional comments (1)
tests/integration.rs (1)

27-28: Consistent use of lines_vec! macro across fixtures.

All fixtures now use lines_vec! to eliminate repetitive .to_string() calls, making each fixture definition more concise and readable.

Also applies to: 42-43, 47-48, 52-53, 57-58, 62-67, 72-77, 82-87, 92-97, 102-103, 107-108, 113-117, 122-127, 132-133

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 leynos merged commit 2df40d6 into main Jun 15, 2025
2 checks passed
@leynos leynos deleted the codex/create-helper-for-vecstring-generation branch June 15, 2025 10:05
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