Skip to content

Fix test compilation errors#44

Merged
leynos merged 1 commit intocodex/add-rustdoc-comment-for-wait_for_filefrom
codex/fix-compilation-errors-in-code
Aug 3, 2025
Merged

Fix test compilation errors#44
leynos merged 1 commit intocodex/add-rustdoc-comment-for-wait_for_filefrom
codex/fix-compilation-errors-in-code

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 3, 2025

Summary

  • inline test-only EnvVarGuard and derive Clone for Config
  • replace external test helpers with local implementations and add wiremock dev dependency
  • simplify logging setup and guard unsafe env var usage

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Fix test compilation errors by deriving Clone for Config, inlining test utilities, simplifying logging setup, and updating dependencies

Enhancements:

  • Derive Clone for Config
  • Inline environment variable guard and helper functions to remove external test-support/test-utils crates
  • Simplify logging setup by removing JSON formatting and using unsafe env var calls
  • Add wiremock dev dependency for HTTP mocking in tests

Tests:

  • Inline octocrab_for, temp_config, and wait_for_file helpers in daemon tests

Chores:

  • Remove test-support and test-utils dependencies from Cargo.toml and update to use wiremock

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Aug 3, 2025

Reviewer's Guide

Tests now compile after deriving Clone for Config, replacing external test helpers with inline implementations (EnvVarGuard, temp_config, octocrab_for, wait_for_file), simplifying logging setup, and updating dependencies (removed test-support/test-utils, added wiremock).

File-Level Changes

Change Details Files
Add Clone derive to Config struct
  • Extended the derive annotation to include Clone
  • Enabled Config duplication where needed
crates/comenqd/src/config.rs
Inline environment‐variable test helpers
  • Removed include! of external env_guard.rs
  • Defined EnvVarGuard with set and Drop implementations
  • Added unsafe wrappers set_env_var and remove_env_var
  • Updated tests to import from local env_guard module
crates/comenqd/src/config.rs
Replace external test utilities with local implementations in daemon.rs
  • Removed test_support and test_utils imports
  • Added local temp_config, octocrab_for, and async wait_for_file
  • Adjusted mpsc channel unpacking to drop mut on writer_rx
crates/comenqd/src/daemon.rs
Simplify logging setup and guard unsafe env var usage in tests
  • Removed JSON formatting from init_with_writer
  • Wrapped std::env::set_var in unsafe block within tests
crates/comenqd/src/logging.rs
Update Cargo.toml dependencies
  • Removed path dependencies for test-support and test-utils
  • Added wiremock = "0.6" dependency
crates/comenqd/Cargo.toml

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 Aug 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/fix-compilation-errors-in-code

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

@leynos leynos merged commit 6010207 into codex/add-rustdoc-comment-for-wait_for_file Aug 3, 2025
1 check passed
@leynos leynos deleted the codex/fix-compilation-errors-in-code branch August 3, 2025 15:31
Copy link
Copy Markdown

@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!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `crates/comenqd/src/logging.rs:69` </location>
<code_context>
     #[test]
     fn init_logging() {
         let buf = Arc::new(Mutex::new(Vec::new()));
-        std::env::set_var("RUST_LOG", "info");
+        unsafe { std::env::set_var("RUST_LOG", "info") };
         init_with_writer(BufMakeWriter { buf: buf.clone() });
         info!("captured");
</code_context>

<issue_to_address>
Using `unsafe` for `std::env::set_var` may be unnecessary on stable Rust.

If targeting stable Rust, remove the unnecessary `unsafe` block or use a cfg attribute to conditionally include it only when required.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        unsafe { std::env::set_var("RUST_LOG", "info") };
=======
        std::env::set_var("RUST_LOG", "info");
>>>>>>> REPLACE

</suggested_fix>

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.

@@ -66,7 +65,7 @@ mod tests {
#[test]
fn init_logging() {
let buf = Arc::new(Mutex::new(Vec::new()));
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

suggestion: Using unsafe for std::env::set_var may be unnecessary on stable Rust.

If targeting stable Rust, remove the unnecessary unsafe block or use a cfg attribute to conditionally include it only when required.

Suggested change
let buf = Arc::new(Mutex::new(Vec::new()));
std::env::set_var("RUST_LOG", "info");

leynos added a commit that referenced this pull request Aug 3, 2025
* Document wait_for_file re-export

* Document wait_for_file and expose retries

* Clarify wait_for_file API and test constants

* Add final new-line

* Restrict release tag pattern (#42)

* Remove unneeded import

* Fix test compilation errors (#44)

* Fix test setup sender mutability (#45)
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