Conversation
Reviewer's GuideIntroduce an async wait_for_file helper in a new test support module to replace ad-hoc polling loops, refactor daemon and cucumber listener tests to use this helper, and expose the support module for reuse in Cucumber tests. Class diagram for new test support utilitiesclassDiagram
class util {
+async fn wait_for_file(path: &Path, retries: u32, delay: Duration) -> ()
}
class mod {
<<module>>
}
mod <|-- util: contains
Class diagram for refactored daemon test module usageclassDiagram
class DaemonTests {
+async fn setup_run_worker(status: u16)
+async fn test_queue_directory_creation()
+async fn test_listener_socket_creation()
}
class util {
+async fn wait_for_file(path: &Path, retries: u32, delay: Duration) -> ()
}
DaemonTests ..> util: uses
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 45 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
Summary by CodeRabbit
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
crates/comenqd/src/daemon.rs(3 hunks)tests/cucumber.rs(1 hunks)tests/steps/listener_steps.rs(2 hunks)tests/support/mod.rs(1 hunks)tests/support/util.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.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
returnin single-line functions.Move conditionals with >2 branches into a predicate function.
Avoid
unsafeunless 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
rstestfixtures for shared setup and to avoid repetition between tests.Replace duplicated tests with
#[rstest(...)]parameterised cases.Prefer
mockallfor 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:
tests/support/mod.rstests/cucumber.rstests/support/util.rstests/steps/listener_steps.rscrates/comenqd/src/daemon.rs
🧬 Code Graph Analysis (2)
tests/steps/listener_steps.rs (1)
tests/support/util.rs (1)
wait_for_file(22-30)
crates/comenqd/src/daemon.rs (1)
tests/support/util.rs (1)
wait_for_file(22-30)
🔇 Additional comments (9)
tests/support/util.rs (3)
1-4: LGTM! Excellent module documentation.The module doc comment properly explains the purpose and utility, following the required
//!format and en-GB spelling conventions.
9-21: LGTM! Comprehensive function documentation.The doc comment includes a clear description and practical example demonstrating proper usage.
22-30: Remove explicitreturnstatement on line 25.Line 25 violates the coding guideline that prohibits
returnin single-line functions.- return true; + trueLikely an incorrect or invalid review comment.
tests/support/mod.rs (1)
1-3: LGTM! Clean module organisation.The module properly declares the util submodule and includes the required module doc comment.
tests/cucumber.rs (1)
2-2: LGTM! Proper module integration.The support module import correctly makes the test utilities available to the cucumber test framework.
tests/steps/listener_steps.rs (2)
8-8: LGTM! Proper utility import.The import correctly references the new wait_for_file utility from the support module.
69-73: LGTM! Excellent refactoring to use shared utility.The manual polling loop has been properly replaced with the reusable
wait_for_fileutility. The timeout parameters (10 tries × 10ms) are appropriate for test scenarios, and the assertion message is descriptive.crates/comenqd/src/daemon.rs (2)
241-241: LGTM! Appropriate timeout for queue directory creation.The 200 tries × 10ms delay (2 second timeout) is reasonable for waiting for queue directory creation, and properly replaces the manual polling logic.
305-305: LGTM! Appropriate timeout for socket creation.The 10 tries × 10ms delay (100ms timeout) is reasonable for waiting for socket creation, and properly replaces the manual polling logic.
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
tests/steps/listener_steps.rs (1)
78-90: Swapunwrap()forexpect()to comply with project lint policy.The file opts into
unwrap_used, but the coding guidelines mandateexpect()for clearer failure output. Replace bareunwrap()calls throughout this test.- let data = serde_json::to_vec(&req).unwrap(); + let data = serde_json::to_vec(&req).expect("serialise request");
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (7)
Cargo.toml(2 hunks)crates/comenqd/Cargo.toml(1 hunks)crates/comenqd/src/daemon.rs(3 hunks)test-support/Cargo.toml(1 hunks)test-support/src/lib.rs(1 hunks)test-support/src/util.rs(1 hunks)tests/steps/listener_steps.rs(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.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 usingArcto 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 unnecessarymutbindings.
Handle errors with theResulttype instead of panicking where feasible.
Avoidunsafecode unless absolutely necessary and document any usage clearly.
Place function attributes after doc comments.
Do not usereturnin 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.
Preferexpectoverallow.
Prefer.expect()over.unwrap().
Useconcat!()to combine long string literals rather than escaping newlines with a backslash.
Prefer semantic error enums. Derivestd::error::Error(via thethiserrorcrate) for any condition the caller might inspect, retry, or map to an HTTP status.
Use an opaque error only at the app boundary. Useeyre::Reportfor 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 toeyreonly in the mainmain()entrypoint or top-level async task.
Files:
tests/steps/listener_steps.rstest-support/src/lib.rscrates/comenqd/src/daemon.rstest-support/src/util.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
returnin single-line functions.Move conditionals with >2 branches into a predicate function.
Avoid
unsafeunless 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
rstestfixtures for shared setup and to avoid repetition between tests.Replace duplicated tests with
#[rstest(...)]parameterised cases.Prefer
mockallfor 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:
tests/steps/listener_steps.rstest-support/src/lib.rscrates/comenqd/src/daemon.rstest-support/src/util.rs
Cargo.toml
📄 CodeRabbit Inference Engine (AGENTS.md)
Cargo.toml: Use explicit version ranges inCargo.tomland keep dependencies up-to-date.
Mandate caret requirements for all dependencies: All crate versions specified inCargo.tomlmust use SemVer-compatible caret requirements (e.g.,some-crate = "1.2.3").
Prohibit unstable version specifiers: The use of wildcard (*) or open-ended inequality (>=) version requirements is strictly forbidden as they introduce unacceptable risk and unpredictability. Tilde requirements (~) should only be used where a dependency must be locked to patch-level updates for a specific, documented reason.
Files:
Cargo.toml
🧬 Code Graph Analysis (3)
tests/steps/listener_steps.rs (1)
test-support/src/util.rs (1)
wait_for_file(22-30)
test-support/src/lib.rs (1)
test-support/src/util.rs (1)
wait_for_file(22-30)
crates/comenqd/src/daemon.rs (1)
test-support/src/util.rs (1)
wait_for_file(22-30)
🔇 Additional comments (12)
test-support/Cargo.toml (2)
4-4: Pin the edition to a currently-stable release.Edition
2024targets the upcoming Rust edition and requires a nightly toolchain. Ensure the CI image supplies a compatible compiler, otherwise downgrade to2021to keep the crate buildable on stable.
6-7: LGTM – workspace dependency is correctly declared.
Using the workspace-scopedtokioavoids version skew across crates.crates/comenqd/Cargo.toml (1)
26-26: LGTM – dev-dependency wired in cleanly.
The relative path resolves inside the workspace and keeps the production build free from test-only code.Cargo.toml (2)
30-35: LGTM – workspace member list updated.
The new crate is properly added to the workspace, allowing cargo to build it by default.
24-25: Avoid redundant path specifications.Because
test-supportis already a workspace member, listing it again under[dev-dependencies]is optional. Remove the stanza to rely on the implicit workspace resolution and trim duplication.- test-support = { path = "test-support" } + # test-support is a workspace member; explicit dev-dep not requiredLikely an incorrect or invalid review comment.
crates/comenqd/src/daemon.rs (4)
168-168: LGTM! Proper module dependency resolves fragile path import.The import of
wait_for_filefromtest_supportcrate addresses the previous concern about brittle relative path imports and follows proper modularity principles.
172-172: LGTM! Import cleanup removes unusedInstant.Removing
Instantfrom the tokio::time import is appropriate since the manual polling loops that used it have been replaced with thewait_for_fileutility.
239-239: LGTM! Simplified test synchronisation improves maintainability.The replacement of the manual polling loop with
wait_for_filemakes the test more readable and maintainable. The parameters (200 tries, 10ms delay) provide adequate waiting time for the queue directory creation.
303-303: LGTM! Consistent use of wait_for_file utility.The refactoring correctly replaces manual polling with the shared utility. The parameters (10 tries, 10ms delay) are appropriate for socket creation timing.
test-support/src/util.rs (3)
1-4: LGTM! Proper module documentation follows guidelines.The module-level documentation clearly explains the purpose and utility, adhering to the requirement that every module must begin with a
//!doc comment.
9-21: LGTM! Comprehensive Rustdoc documentation with practical example.The function documentation follows Rust conventions with a clear description and practical example. The
ignoreattribute in the example is appropriate since it contains async code that cannot be executed in doc tests without additional setup.
22-30: LGTM! Clean implementation with appropriate error handling.The function implementation is correct and follows Rust best practices:
- Uses immutable parameters
- Avoids panicking by returning
boolinstead ofResult- Performs a final existence check after the loop to handle edge cases
- Simple, readable logic that matches the documented behaviour
The approach of checking existence one final time after the loop ensures correctness even if the file appears during the final sleep period.
1 participant
Summary
wait_for_fileasync helperwait_for_filein listener steps and daemon testsTesting
make lintmake testhttps://chatgpt.com/codex/tasks/task_e_6888f7f383e08322ad8cf2ffd76d7a4a
Summary by Sourcery
Add a reusable wait_for_file utility for asynchronous tests and refactor existing daemon and listener tests to use it, exposing the support module to cucumber tests
New Features:
Enhancements:
Tests: