Keep TempDir alive for worker tests

[leynos]

Summary

• return TempDir from setup_run_worker
• bind temp directories in worker tests so they persist for the test duration

Testing

• make fmt
• make lint
• make test

---

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

Summary by Sourcery

Return TempDir from setup_run_worker to ensure temporary directories persist during worker tests

Enhancements:

• Persist TempDir for the duration of worker tests by returning it from setup_run_worker

Tests:

• Update setup_run_worker signature to include TempDir in the return tuple
• Adjust existing worker tests to bind the returned TempDir to a variable

[coderabbitai]

Summary by CodeRabbit

• Tests
  • Improved test setup by introducing a new context struct for better management of test dependencies.
  • Updated existing worker tests to use the new fixture-based approach for enhanced clarity and flexibility.
  • No changes were made to the core application logic.

Walkthrough

Replace the setup_run_worker test helper with a WorkerTestContext struct encapsulating test dependencies and a new async fixture function using rstest. Update existing tests to use this fixture, enabling parameterised HTTP status codes and improved resource management. No changes to core worker logic.

Changes

Cohort / File(s)	Change Summary
Test Refactor with WorkerTestContext and rstest Fixture crates/comenqd/src/daemon.rs	Remove setup_run_worker helper; add WorkerTestContext struct and async worker_test_context fixture with optional status parameter. Update tests to accept WorkerTestContext as an async fixture parameter and adjust assertions accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Implement worker task with GitHub posting #15: Implements the original run_worker function and its initial tests, including the setup_run_worker helper replaced here.

Poem

In tests where workers once did roam,
A context now calls them home.
With fixtures neat and status set,
Cleaner code, no tangled net.
Dependencies wrapped with care,
Testing shines beyond compare! 🧑‍💻✨🐇

---

📜 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 7b1474a and 8070394.

📒 Files selected for processing (1)

• crates/comenqd/src/daemon.rs (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: 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.
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.
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.
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.
Use rstest fixtures for shared setup.
Replace duplicated tests with #[rstest(...)] parameterised cases.
Prefer mockall for mocks/stubs.
Prefer .expect() over .unwrap().
Use concat!() to combine long string literals rather than escaping newlines with a backslash.
Prefer semantic error enums. Derive std::error::Error (via the thiserror crate) for any condition the caller might inspect, retry, or map to an HTTP status.
Use an opaque error only at the app boundary. Use eyre::Report for human-readable logs; these should not be exposed in public APIs.
Never export the opaque type from a library. Convert to domain enums at API boundaries, and to eyre only in the main main() entrypoint or top-level async task.

Files:

• crates/comenqd/src/daemon.rs

---

⚙️ CodeRabbit Configuration File

**/*.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 and docs must follow en-GB-oxendict (-ize / -our) 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/

• Files must not exceed 400 lines in length

  • Large modules must be decomposed
  • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
  • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

• crates/comenqd/src/daemon.rs

🔇 Additional comments (5)

crates/comenqd/src/daemon.rs (5)

285-285: Import follows rstest guidelines correctly.

The addition of rstest::{fixture, rstest} import aligns with the coding guideline to use rstest fixtures for shared setup.

---

335-343: Struct design properly encapsulates test dependencies.

The WorkerTestContext struct effectively groups related test parameters into a meaningful unit, addressing the guideline about grouping parameters in structs. The _dir: TempDir field with underscore prefix correctly indicates it's held for lifetime management rather than direct use.

---

345-386: Fixture implementation follows rstest patterns effectively.

The worker_test_context fixture properly uses #[default(201)] for parameterisation and encapsulates all test setup logic. The error handling uses .expect() rather than .unwrap() as required by guidelines.

---

477-502: Test conversion to rstest fixture pattern is correct.

The test properly uses #[future] and #[from(worker_test_context)] attributes to work with the async fixture. The ctx.await pattern correctly handles the async fixture resolution.

---

504-530: Parameterised test correctly overrides status code.

The use of #[with(500)] properly demonstrates parameterised testing by overriding the default status code for error scenarios. This replaces duplicated test code with parameterised cases as recommended in guidelines.

✨ 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/modify-setup_run_worker-to-return-tempdir

---

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

Support

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

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

[sourcery-ai]

Reviewer's Guide

Modifies setup_run_worker to return the TempDir to extend its lifetime and updates worker tests to bind the returned TempDir, ensuring temp directories persist for the duration of each test.

Class diagram for updated setup_run_worker return type

classDiagram
    class TempDir
    class MockServer
    class Config
    class Receiver
    class Octocrab

    class TestModule {
        +async setup_run_worker(status: u16) (MockServer, Arc<Config>, Receiver, Arc<Octocrab>, TempDir)
    }

    TestModule --> MockServer
    TestModule --> Config
    TestModule --> Receiver
    TestModule --> Octocrab
    TestModule --> TempDir

Loading

Class diagram for test function signature changes

classDiagram
    class TestFunction {
        +run_worker_commits_on_success()
        +run_worker_requeues_on_error()
        - (server, cfg, rx, octo)
        + (server, cfg, rx, octo, _dir)
    }

    TestFunction --> TempDir

Loading

File-Level Changes

Change	Details	Files
Extend setup_run_worker to return the TempDir	Add TempDir to the function return signature Include dir in the returned tuple	crates/comenqd/src/daemon.rs
Bind returned TempDir in tests to maintain directory lifetime	Update test calls to destructure and bind the new _dir Ignore the _dir binding to prevent premature cleanup	crates/comenqd/src/daemon.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @leynos - I've reviewed your changes - here's some feedback:

• Consider wrapping the multiple return values of setup_run_worker in a small struct with named fields instead of a tuple to improve readability.
• Instead of returning and binding an unused TempDir (_dir) in each test, you could attach the TempDir’s lifetime to Config or a dedicated test fixture to avoid the extra return parameter.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider wrapping the multiple return values of setup_run_worker in a small struct with named fields instead of a tuple to improve readability.
- Instead of returning and binding an unused TempDir (_dir) in each test, you could attach the TempDir’s lifetime to Config or a dedicated test fixture to avoid the extra return parameter.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}