feat: directory support, map[string]yaml var type, migration by DavSanchez · Pull Request #1685 · newrelic/newrelic-agent-control

DavSanchez · 2025-09-16T13:08:05Z

What this PR does / why we need it

This PR enhances the recently added support for filesystem operations for on-host by:

Adding a new variable type: map[string]yaml (d8374ee).
Extending the filesystem definition on the agent type mimicking a directory structure with its own ways of templating and finally emitting a list of files with their contents, to be created when spawning a sub-agent, see filesystem.rs module documentation for details! (d2d9d49)
Adapting the agent types for the Infrastructure Agent and the OTel Collector to be managed with this new method (5ffe820).

Which issue this PR fixes

fixes NR-463592
fixes NR-463598
fixes NR-463595
fixes NR-463596

Special notes for your reviewer

Sadly I still need to perform changes to the migration program and the changes are not straightforward. I'll follow the same principle as in #1640, probably continuing from there as well and merging it here as a single commit so you can review easily.

Also, commit a689506 adds trace logs with the paths to the files AC will create. If you see any risk on this (security, style, etc) let me know and I can just remove it.

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

Provided a meaningful title following conventional commit style.
Included a detailed description for the Pull Request.
Documentation under docs is aligned with the change. PENDING, BUT YOU CAN START REVIEWING!
Follows guidelines for Pull Requests in CONTRIBUTING.md.
Follows log level guidelines.

agent-control/src/sub_agent/on_host/command/filesystem_entries.rs

agent-control/src/agent_type/trivial_value.rs

agent-control/src/agent_type/variable.rs

agent-control/src/agent_type/variable/variable_type.rs

agent-control/src/agent_type/runtime_config/on_host/filesystem.rs

gsanchezgavier

Awesome! I like how you resolve it !

agent-control/agent-type-registry/newrelic/com.newrelic.infrastructure-0.1.0.yaml

agent-control/src/agent_type/runtime_config/on_host/filesystem.rs

* fix: use `relative_path` for file entry info * docs: type * feat: extend filesystem to fully support directories * feat: a specific dir for each filesystem entity (files, dirs) * test: templating * test: move test-only impls to test module * test: templating * test: proper yaml rendering * docs: detail how this module works * feat: SafePath -> PathBuf * feat(rendering): generate writable file list * feat: rendering filesystem entry list * style: rename path field * test: rendering expected file entries * test(integration): fix filesystem ops

The function `FileSystem::rendered` was public before, which could cause access to the internal `HashMap<PathBuf, String>`. If bound as mutable, it could be modified to write to unintended locations. Now the creation of `RenderedFileSystemEntries` is safer and doesn't provide visibility to the paths, only to write.

gsanchezgavier · 2025-09-26T12:30:42Z

agent-control/src/agent_type/runtime_config/on_host/filesystem.rs

    path.components().try_for_each(|comp| match comp {
        Component::Normal(_) | Component::CurDir => Ok(()),
        // Disallow other non-supported variants like roots or prefixes
        Component::ParentDir | Component::RootDir | Component::Prefix(_) => Err(format!(


cool is this also checking for ~ for instance?

Not exactly. Since ~ is a shell expansion if it's passed via the shell the character would be translated into the $HOME dir before reaching this. If somehow the literal character ~ reaches this point then a file or directory with that name will be created (from a SafePath("~")). It's not an error.

gsanchezgavier

🚀 thanks!

danielorihuela · 2025-10-01T12:32:41Z

@DavSanchez What about updating docs? In this PR or another?

DavSanchez · 2025-10-01T12:43:06Z

@DavSanchez What about updating docs? In this PR or another?

Another, after I get rid of the deprecated variable types (file and map[string]file) I'll change the docs!

DavSanchez added the onhost label Sep 18, 2025

DavSanchez force-pushed the feat/vartype-map-string-yaml branch 3 times, most recently from 6c430ae to d2d9d49 Compare September 19, 2025 14:32

DavSanchez changed the title ~~feat: add map[string]yaml var type~~ feat: directory support, map[string]yaml var type, migration Sep 19, 2025

DavSanchez force-pushed the feat/vartype-map-string-yaml branch 2 times, most recently from fded70a to ffc1b8f Compare September 19, 2025 18:13

DavSanchez mentioned this pull request Sep 19, 2025

refactor: migrate host agent types to filesystem #1619

Closed

5 tasks

DavSanchez force-pushed the feat/vartype-map-string-yaml branch from ffc1b8f to f251eb1 Compare September 23, 2025 11:02

danielorihuela reviewed Sep 23, 2025

View reviewed changes

gsanchezgavier reviewed Sep 25, 2025

View reviewed changes

DavSanchez added 8 commits September 25, 2025 12:32

feat: add map[string]yaml var type

6c6f999

style: trace level logs to paths written

3cee55c

refactor: migrate host agent types to filesystem

ba9610d

style: use capital letters

1fa4afe

docs: clarify

47d37fd

chore: remove unused From impl

2fabad5

chore: remove leftover

8b3b6d3

DavSanchez force-pushed the feat/vartype-map-string-yaml branch 2 times, most recently from 54861bc to 3ad1536 Compare September 25, 2025 13:58

feat: merge files and directories

8383858

DavSanchez force-pushed the feat/vartype-map-string-yaml branch from 3ad1536 to 8383858 Compare September 25, 2025 13:58

DavSanchez added 2 commits September 25, 2025 23:08

test: fix rendered paths comparison

e2792a5

DavSanchez force-pushed the feat/vartype-map-string-yaml branch from e5b3861 to e2792a5 Compare September 26, 2025 08:33

DavSanchez marked this pull request as ready for review September 26, 2025 08:34

DavSanchez requested a review from a team as a code owner September 26, 2025 08:34

gsanchezgavier reviewed Sep 26, 2025

View reviewed changes

gsanchezgavier previously approved these changes Sep 26, 2025

View reviewed changes

danielorihuela previously approved these changes Sep 26, 2025

View reviewed changes

fix: correctly handle yaml templating

1e8eb6a

DavSanchez dismissed stale reviews from danielorihuela and gsanchezgavier via 1e8eb6a September 29, 2025 16:10

gsanchezgavier approved these changes Oct 1, 2025

View reviewed changes

DavSanchez merged commit c1e5c88 into main Oct 2, 2025
26 checks passed

DavSanchez deleted the feat/vartype-map-string-yaml branch October 2, 2025 07:42

Conversation

DavSanchez commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it

Which issue this PR fixes

Special notes for your reviewer

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gsanchezgavier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gsanchezgavier Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

DavSanchez Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

gsanchezgavier left a comment

Choose a reason for hiding this comment

Uh oh!

danielorihuela commented Oct 1, 2025

Uh oh!

DavSanchez commented Oct 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

DavSanchez commented Sep 16, 2025 •

edited

Loading