refactor: make writes more safe by hiding rendering function

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.

Author: DavSanchez

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

@@ -24,6 +24,8 @@ use crate::agent_type::{
 };
 use serde::Deserialize;
 
+pub mod rendered;
+
 /// Represents the file system configuration for the deployment of a host agent. Consisting of
 /// a set of directories (map keys) which in turn contain a set of files (nested map keys) with
 /// their respective content (map values).
@@ -54,7 +56,7 @@ impl FileSystem {
     ///
     /// **WARNING**: This must be called **after** the rendering process has finished
     /// or else AC might crash!
-    pub fn rendered(self) -> HashMap<PathBuf, String> {
+    fn rendered(self) -> HashMap<PathBuf, String> {
         self.0
             .into_iter()
             .flat_map(|(dir_path, dir_entries)| dir_entries.rendered_with(&dir_path))

…nt/on_host/command/filesystem_entries.rs …me_config/on_host/filesystem/rendered.rsagent-control/src/sub_agent/on_host/command/filesystem_entries.rs renamed to agent-control/src/agent_type/runtime_config/on_host/filesystem/rendered.rs agent-control/src/sub_agent/on_host/command/filesystem_entries.rs renamed to agent-control/src/agent_type/runtime_config/on_host/filesystem/rendered.rs

@@ -1,5 +1,6 @@
 use crate::agent_control::defaults::{HOST_NAME_ATTRIBUTE_KEY, OPAMP_SERVICE_VERSION};
 use crate::agent_control::run::Environment;
+use crate::agent_type::runtime_config::on_host::filesystem::rendered::RenderedFileSystemEntries;
 use crate::context::Context;
 use crate::event::SubAgentEvent;
 use crate::event::broadcaster::unbounded::UnboundedBroadcast;
@@ -10,7 +11,6 @@ use crate::sub_agent::SubAgent;
 use crate::sub_agent::effective_agents_assembler::{EffectiveAgent, EffectiveAgentsAssembler};
 use crate::sub_agent::identity::AgentIdentity;
 use crate::sub_agent::on_host::command::executable_data::ExecutableData;
-use crate::sub_agent::on_host::command::filesystem_entries::RenderedFileSystemEntries;
 use crate::sub_agent::on_host::supervisor::NotStartedSupervisorOnHost;
 use crate::sub_agent::remote_config_parser::RemoteConfigParser;
 use crate::sub_agent::supervisor::builder::SupervisorBuilder;

agent-control/src/sub_agent/on_host/builder.rs

@@ -1,7 +1,6 @@
 pub mod command_os;
 pub mod error;
 pub mod executable_data;
-pub mod filesystem_entries;
 pub mod logging;
 pub mod restart_policy;
 pub mod shutdown;

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

@@ -1,5 +1,6 @@
 use crate::agent_control::agent_id::AgentID;
 use crate::agent_type::runtime_config::health_config::OnHostHealthConfig;
+use crate::agent_type::runtime_config::on_host::filesystem::rendered::RenderedFileSystemEntries;
 use crate::agent_type::runtime_config::version_config::OnHostVersionConfig;
 use crate::context::Context;
 use crate::event::SubAgentInternalEvent;
@@ -14,7 +15,6 @@ use crate::sub_agent::identity::{AgentIdentity, ID_ATTRIBUTE_NAME};
 use crate::sub_agent::on_host::command::command_os::CommandOSNotStarted;
 use crate::sub_agent::on_host::command::error::CommandError;
 use crate::sub_agent::on_host::command::executable_data::ExecutableData;
-use crate::sub_agent::on_host::command::filesystem_entries::RenderedFileSystemEntries;
 use crate::sub_agent::on_host::command::shutdown::{
     ProcessTerminator, wait_exit_timeout, wait_exit_timeout_default,
 };

agent-control/src/sub_agent/on_host/supervisor.rs

@@ -1,8 +1,8 @@
+use crate::agent_type::runtime_config::on_host::filesystem::rendered::FileSystemEntriesError;
 use crate::event::SubAgentInternalEvent;
 use crate::event::channel::EventPublisher;
 use crate::health::health_checker::HealthCheckerError;
 use crate::sub_agent::error::SubAgentBuilderError;
-use crate::sub_agent::on_host::command::filesystem_entries::FileSystemEntriesError;
 use crate::sub_agent::supervisor::stopper::SupervisorStopper;
 use thiserror::Error;