Refactor rendering tests with macro and absolute workspace roots

[leynos]

Summary

• Introduces a render_with_world_string_field macro to render templates from string fields in the test world, reducing boilerplate in rendering tests.
• Harden workspace root path handling across manifest and stdlib: absolute paths are enforced and error messages are clearer when workspace directories cannot be opened.
• Improve command tempfile handling when workspace root is not configured, with a clearer error and safer slice handling.

Changes

• Tests

  • Added render_with_world_string_field! macro in tests/steps/stdlib_steps/rendering.rs to extract a string field from the world and render a template with it.
  • Refactored render_stdlib_template_with_url, render_stdlib_template_with_command, and render_stdlib_template_with_text to use the new macro, reducing duplication.

• Manifest handling

  • src/manifest/mod.rs: Compute workspace_root for the manifest, supporting both absolute and relative utf8_parent. Improve error messages when opening the workspace directory by using workspace_root in the message. Pass the computed workspace_root to StdlibConfig via with_workspace_root_path.

• Stdlib

  • src/stdlib/mod.rs: Enforce that the workspace root path passed to with_workspace_root_path is absolute using an assertion.
  • src/stdlib/command.rs: When a workspace root path isn’t configured, return a clear InvalidInput error instead of proceeding. Improve the write loop to use a safe slice with an explicit clippy rationale.

Why

• Reduces boilerplate in rendering tests and makes them easier to maintain.
• Improves reliability and debuggability by ensuring workspace root paths are absolute and error messages are informative.
• Aligns internal behavior with stricter path handling to prevent subtle bugs when using relative paths.

Testing & Validation

• Run cargo test to ensure the updated tests compile and pass.
• Validate behavior when workspace root is misconfigured or relative to confirm clearer error messages.
• Quick smoke test of rendering paths that exercise url, cmd, and text rendering in the stdlib tests.

🌿 Generated by Terry

---

ℹ️ Tag @terragon-labs to ask questions and address PR feedback

📎 Task: https://www.terragonlabs.com/task/62f29cac-61af-4f6f-8e9a-42c9a330b901

Summary by Sourcery

Refactor rendering tests to use a new macro for extracting string fields and tighten workspace root handling across manifest and stdlib modules with clearer errors and safety checks

New Features:

• Introduce render_with_world_string_field macro in tests to simplify template rendering from string fields

Enhancements:

• Compute workspace root as absolute by resolving relative paths and improve error messages when opening the manifest workspace directory
• Assert that workspace_root_path is absolute in StdlibConfig::with_workspace_root_path
• Return an InvalidInput error when creating command tempfiles without a configured workspace root and switch to safe slicing in the command output write loop

[sourcery-ai]

Reviewer's Guide

This PR refactors rendering tests by introducing a macro for string‐field rendering, strengthens workspace root path resolution in manifest and stdlib modules through absolute path enforcement and clearer errors, and refines command tempfile creation and buffer writes with explicit error handling and safe slicing.

Class diagram for updated StdlibConfig and CommandTempDir

classDiagram
    class StdlibConfig {
        +with_workspace_root_path(path: Utf8PathBuf) StdlibConfig
        workspace_root_path: Option<Utf8PathBuf>
    }
    class CommandTempDir {
        +create_tempfile(builder, dir_path)
    }
    StdlibConfig <|-- CommandTempDir: uses workspace_root_path

Loading

Class diagram for new render_with_world_string_field macro usage in tests

classDiagram
    class TestWorld {
        string_field: String
    }
    class render_with_world_string_field {
        +macro(world: TestWorld, template: Template)
    }
    TestWorld --> render_with_world_string_field: used by

Loading

File-Level Changes

Change	Details	Files
Introduce a macro for rendering templates from string fields in tests	Add render_with_world_string_field! macro definition Refactor render_stdlib_template_with_url to use the new macro Refactor render_stdlib_template_with_command to use the new macro Refactor render_stdlib_template_with_text to use the new macro	tests/steps/stdlib_steps/rendering.rs
Resolve and enforce absolute workspace root paths in manifest handling	Compute workspace_root as absolute by joining relative paths with cwd Improve error messages when opening workspace directories Pass computed workspace_root to StdlibConfig	src/manifest/mod.rs
Enforce and assert absolute workspace root in StdlibConfig	Add assertion to ensure workspace root path is absolute Update with_workspace_root_path to panic on non-absolute paths	src/stdlib/mod.rs
Enhance command tempfile handling and output writing safety	Return InvalidInput error when workspace root is not configured for tempfiles Replace unchecked slice indexing with explicit safe slicing for writing	src/stdlib/command.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.

[coderabbitai]

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.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch terragon/refactor-rendering-tests-macro-9y97wu

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sourcery-ai]

Hey there - I've reviewed your changes and found some issues that need to be addressed.

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `src/manifest/mod.rs:210` </location>
<code_context>
-            "failed to open workspace directory '{utf8_parent}' for manifest '{manifest_label}'"
-        )
-    })?;
+    let workspace_root = if utf8_parent.is_absolute() {
+        utf8_parent.to_path_buf()
+    } else {
</code_context>

<issue_to_address>
**issue (complexity):** Consider simplifying the workspace root resolution by building and converting the path only once, eliminating redundant variables and conversions.

```suggestion
// Instead of manually cloning, converting twice, and introducing `workspace_root_for_error`,
// you can build a single PathBuf, convert once to Utf8PathBuf, and use it directly:
use std::path::PathBuf;

let base: PathBuf = if utf8_parent.is_absolute() {
    utf8_parent.to_path_buf()
} else {
    env::current_dir()
        .context("resolve current directory for manifest workspace root")?
        .join(utf8_parent.as_str())
};

// Optionally canonicalize to resolve symlinks:
// let base = fs::canonicalize(&base).context("canonicalize workspace root")?;

let workspace_root = Utf8PathBuf::from_path_buf(base.clone())
    .map_err(|_| anyhow!(
        "workspace root '{}' contains non-UTF-8 components",
        base.display()
    ))?;

let dir = Dir::open_ambient_dir(workspace_root.as_std_path(), ambient_authority())
    .with_context(|| {
        format!(
            "failed to open workspace directory '{}' for manifest '{}'",
            workspace_root, manifest_label
        )
    })?;

Ok(StdlibConfig::new(dir)
    .with_workspace_root_path(workspace_root)
    .with_network_policy(policy))
```

- Removes the extra `cwd_utf8`, `workspace_root_for_error`, and redundant `.clone()`.
- Joins and (optionally) canonicalizes once on a `PathBuf`.
- Converts just once to `Utf8PathBuf` before opening the directory.
</issue_to_address>

### Comment 2
<location> `src/manifest/mod.rs:210` </location>
<code_context>
-            "failed to open workspace directory '{utf8_parent}' for manifest '{manifest_label}'"
-        )
-    })?;
+    let workspace_root = if utf8_parent.is_absolute() {
+        utf8_parent.to_path_buf()
+    } else {
</code_context>

<issue_to_address>
**issue (review_instructions):** Add behavioural and unit tests for new workspace root resolution logic.

The logic for resolving the workspace root from relative paths is new and non-trivial. You must add both behavioural and unit tests to verify correct handling of absolute and relative paths, including error cases for non-UTF-8 paths.

<details>
<summary>Review instructions:</summary>

**Path patterns:** `**/*`

**Instructions:**
For any new feature or change to an existing feature, both behavioural *and* unit tests are required.

</details>
</issue_to_address>

### Comment 3
<location> `src/stdlib/command.rs:145` </location>
<code_context>
             builder.tempfile_in(dir_path.as_std_path())?
         } else {
-            builder.tempfile()?
+            return Err(io::Error::new(
+                io::ErrorKind::InvalidInput,
+                "workspace root path must be configured for command tempfiles",
</code_context>

<issue_to_address>
**issue (review_instructions):** Demonstrate bug fix for missing workspace root path with a test.

You added an error for missing workspace root path when creating command tempfiles. You must add a test that demonstrates this bug fix, ensuring the error is triggered as expected.

<details>
<summary>Review instructions:</summary>

**Path patterns:** `**/*`

**Instructions:**
Bug fixes *must* be demonstrated by a test.

</details>
</issue_to_address>

---

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

[leynos]

@coderabbitai Please suggest a fix for this issue and supply a prompt for an AI coding agent to enable it to apply the fix:

src/manifest/tests.rs

Comment on lines +299 to +313

fn stdlib_config_for_manifest_resolves_relative_workspace_root() -> AnyResult<()> {
    let temp = tempdir().context("create temp workspace")?;
    let _guard = CurrentDirGuard::change_to(temp.path())?;
    let config = stdlib_config_for_manifest(Path::new("Netsukefile"), NetworkPolicy::default())?;
    let recorded = config
        .workspace_root_path()
        .context("workspace root path should be recorded")?;
    let expected = camino::Utf8Path::from_path(temp.path())
        .context("temp workspace path should be valid UTF-8")?;
    ensure!(
        recorded == expected,
        "expected workspace root {expected}, got {recorded}"
    );
    Ok(())
}

❌ New issue: Code Duplication
The module contains 2 functions with similar structure: stdlib_config_for_manifest_resolves_absolute_workspace_root,stdlib_config_for_manifest_resolves_relative_workspace_root

[leynos]

@coderabbitai Please suggest a fix for this issue and supply a prompt for an AI coding agent to enable it to apply the fix:

src/stdlib/command.rs

Comment on file

            builder.tempfile_in(dir_path.as_std_path())?
        } else {
            builder.tempfile()?
            return Err(io::Error::new(

❌ New issue: Code Duplication
The module contains 2 functions with similar structure: tests.read_pipe_capture_reports_limit_exceedance,tests.read_pipe_tempfile_respects_stream_limit

[leynos]

@coderabbitai Please suggest a fix for this issue and supply a prompt for an AI coding agent to enable it to apply the fix:

src/manifest/mod.rs

Comment on lines +210 to +232

    let workspace_base = if utf8_parent.is_absolute() {
        utf8_parent.to_path_buf().into_std_path_buf()
    } else {
        env::current_dir()
            .context("resolve current directory for manifest workspace root")?
            .join(utf8_parent.as_std_path())
    };
    let workspace_root = match Utf8PathBuf::from_path_buf(workspace_base) {
        Ok(valid) => valid,
        Err(invalid) => {
            return Err(anyhow!(
                "workspace root '{}' contains non-UTF-8 components",
                invalid.display()
            ));
        }
    };
    let dir = Dir::open_ambient_dir(workspace_root.as_path(), ambient_authority()).with_context(
        || {
            format!(
                "failed to open workspace directory '{workspace_root}' \
                 for manifest '{manifest_label}'"
            )
        },

❌ New issue: Complex Method
stdlib_config_for_manifest has a cyclomatic complexity of 9, threshold = 9