Skip to content

Scope EnvLock in NINJA_ENV tests#117

Merged
leynos merged 1 commit intocodex/add-envlock-and-mockable-env-for-ninja_envfrom
codex/refactor-test_support-dependencies-and-methods
Aug 15, 2025
Merged

Scope EnvLock in NINJA_ENV tests#117
leynos merged 1 commit intocodex/add-envlock-and-mockable-env-for-ninja_envfrom
codex/refactor-test_support-dependencies-and-methods

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 15, 2025

Summary

  • scope EnvLock in tests to avoid manual drops
  • capture and restore original NINJA_ENV value after each test

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Improve NINJA_ENV tests by scoping EnvLock in inner blocks, eliminating manual drop calls, and ensuring the original environment variable is captured and restored automatically.

Enhancements:

  • Refactor NINJA_ENV tests to scope EnvLock usage within blocks for automatic acquisition and release
  • Use std::env::var(NINJA_ENV).ok() to capture the original environment value

Tests:

  • Restore the original NINJA_ENV value after each test within a scoped EnvLock

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 15, 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/refactor-test_support-dependencies-and-methods

🪧 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.
    • 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.
  • 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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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 Aug 15, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Scoped EnvLock usage and automated NINJA_ENV state capture/restore in ninja_env tests to ensure isolation without manual drops.

File-Level Changes

Change Details Files
Scoped EnvLock acquisitions into code blocks
  • Replaced manual EnvLock acquire/drop with block-scoped let _lock = EnvLock::acquire() during test setup
  • Wrapped restore phase in a block with scoped EnvLock to replace explicit drop calls
tests/ninja_env_tests.rs
Capture and restore original NINJA_ENV using std::env::var().ok()
  • Changed std::env::var_os(NINJA_ENV) to std::env::var(NINJA_ENV).ok() for consistent value capture
  • Moved restoration logic inside scoped EnvLock and applied std::env::set_var or remove_var based on captured state
tests/ninja_env_tests.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

@leynos leynos merged commit aa0dee7 into codex/add-envlock-and-mockable-env-for-ninja_env Aug 15, 2025
2 checks passed
@leynos leynos deleted the codex/refactor-test_support-dependencies-and-methods branch August 15, 2025 01:14
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 there - 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> `tests/ninja_env_tests.rs:47` </location>
<code_context>
     assert!(std::env::var(NINJA_ENV).is_err());

     // Restore original global state for isolation
</code_context>

<issue_to_address>
Consider asserting the value of NINJA_ENV after restoration.

This will verify that the restoration logic correctly resets NINJA_ENV to its prior state.

Suggested implementation:

```rust
    // Restore original global state for isolation
    {
        let _lock = EnvLock::acquire();
        if let Some(val) = before {

```

```rust
        if let Some(val) = before {
            // Assert that NINJA_ENV is restored to its original value
            assert_eq!(std::env::var(NINJA_ENV).as_deref(), Some(val.as_str()));
        } else {
            // Assert that NINJA_ENV is not set after restoration
            assert!(std::env::var(NINJA_ENV).is_err());
        }

```
</issue_to_address>

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.

Comment thread tests/ninja_env_tests.rs
@@ -46,13 +47,14 @@ fn override_ninja_env_unset_removes_variable() {
assert!(std::env::var(NINJA_ENV).is_err());
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

suggestion (testing): Consider asserting the value of NINJA_ENV after restoration.

This will verify that the restoration logic correctly resets NINJA_ENV to its prior state.

Suggested implementation:

    // Restore original global state for isolation
    {
        let _lock = EnvLock::acquire();
        if let Some(val) = before {
        if let Some(val) = before {
            // Assert that NINJA_ENV is restored to its original value
            assert_eq!(std::env::var(NINJA_ENV).as_deref(), Some(val.as_str()));
        } else {
            // Assert that NINJA_ENV is not set after restoration
            assert!(std::env::var(NINJA_ENV).is_err());
        }

leynos added a commit that referenced this pull request Aug 15, 2025
* Add guard for NINJA_ENV overrides

* Quote NINJA_ENV in doc comment

* Centralise NINJA_ENV and cover unset restoration

* Remove manual NINJA_ENV cleanup in tests

* Add crate for shared NINJA_ENV constant

* Scope EnvLock in NINJA_ENV tests (#117)

* Apply review suggestions for ninja env crate (#118)

* Document NINJA_ENV and restore via OsString (#120)

* Refine ninja env docs and tests (#121)
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