feat(config-migrate): couple to infra-agent agent type, simplify

Author: DavSanchez

agent-control/src/bin/main_config_migrate.rs

@@ -1,38 +1,32 @@
 use newrelic_agent_control::agent_control::config_repository::store::AgentControlConfigStore;
-use newrelic_agent_control::agent_control::defaults::{
-    AGENT_CONTROL_DATA_DIR, AGENT_CONTROL_LOCAL_DATA_DIR, AGENT_CONTROL_LOG_DIR, SUB_AGENT_DIR,
-};
 use newrelic_agent_control::config_migrate::cli::Cli;
 use newrelic_agent_control::config_migrate::migration::agent_config_getter::AgentConfigGetter;
 use newrelic_agent_control::config_migrate::migration::config::MigrationConfig;
 use newrelic_agent_control::config_migrate::migration::converter::ConfigConverter;
-use newrelic_agent_control::config_migrate::migration::defaults::NEWRELIC_INFRA_AGENT_TYPE_CONFIG_MAPPING;
 use newrelic_agent_control::config_migrate::migration::migrator::{ConfigMigrator, MigratorError};
 use newrelic_agent_control::config_migrate::migration::persister::legacy_config_renamer::LegacyConfigRenamer;
 use newrelic_agent_control::config_migrate::migration::persister::values_persister_file::ValuesPersisterFile;
 use newrelic_agent_control::instrumentation::tracing::{TracingConfig, try_init_tracing};
 use newrelic_agent_control::values::file::ConfigRepositoryFile;
 use std::error::Error;
-use std::path::PathBuf;
 use std::sync::Arc;
 use tracing::{debug, info, warn};
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let tracing_config = TracingConfig::from_logging_path(PathBuf::from(AGENT_CONTROL_LOG_DIR));
+    let cli = Cli::load();
+    let tracing_config = TracingConfig::from_logging_path(cli.log_dir());
     let _tracer = try_init_tracing(tracing_config);
 
     info!("Starting config conversion tool...");
 
-    let config: MigrationConfig = MigrationConfig::parse(NEWRELIC_INFRA_AGENT_TYPE_CONFIG_MAPPING)?;
+    let config = MigrationConfig::parse(&cli.get_migration_config_str()?)?;
 
-    let cli = Cli::init_config_migrate_cli();
-    let remote_dir = PathBuf::from(AGENT_CONTROL_DATA_DIR);
-    let vr = ConfigRepositoryFile::new(cli.local_data_dir(), remote_dir);
+    let vr = ConfigRepositoryFile::new(cli.local_data_dir(), cli.remote_data_dir());
     let sa_local_config_loader = AgentControlConfigStore::new(Arc::new(vr));
     let config_migrator = ConfigMigrator::new(
         ConfigConverter::default(),
         AgentConfigGetter::new(sa_local_config_loader),
-        ValuesPersisterFile::new(PathBuf::from(AGENT_CONTROL_LOCAL_DATA_DIR).join(SUB_AGENT_DIR)),
+        ValuesPersisterFile::new(cli.local_sub_agent_data_dir()),
     );
 
     let legacy_config_renamer = LegacyConfigRenamer::default();

agent-control/src/config_migrate/cli.rs

@@ -1,29 +1,67 @@
-use crate::agent_control::defaults::AGENT_CONTROL_LOCAL_DATA_DIR;
+use crate::{
+    agent_control::defaults::{
+        AGENT_CONTROL_DATA_DIR, AGENT_CONTROL_LOCAL_DATA_DIR, AGENT_CONTROL_LOG_DIR, SUB_AGENT_DIR,
+    },
+    config_migrate::migration::defaults::NEWRELIC_INFRA_AGENT_TYPE_CONFIG_MAPPING,
+};
 use clap::Parser;
-use std::path::PathBuf;
+use std::{error::Error, fs, path::PathBuf};
 
 #[derive(Parser, Debug)]
 #[command(author, version, about, long_about = None)] // Read from `Cargo.toml`
 pub struct Cli {
-    /// Overrides the default local configuration path `/etc/newrelic-agent-control/`.
-    #[cfg(debug_assertions)]
+    /// Local data path used by Agent Control.
+    #[arg(long, default_value_os_t = PathBuf::from(AGENT_CONTROL_LOCAL_DATA_DIR))]
+    local_dir: PathBuf,
+
+    /// Remote data path used by Agent Control.
+    #[arg(long, default_value_os_t = PathBuf::from(AGENT_CONTROL_DATA_DIR))]
+    remote_dir: PathBuf,
+
+    /// Logs path used by Agent Control.
+    #[arg(long, default_value_os_t = PathBuf::from(AGENT_CONTROL_LOG_DIR))]
+    logs_dir: PathBuf,
+
+    /// Provides an external configuration mapping for the migration of agents to Agent Control.
     #[arg(long)]
-    local_dir: Option<PathBuf>,
+    migration_config_file: Option<PathBuf>,
 }
 
 impl Cli {
     /// Parses command line arguments
-    pub fn init_config_migrate_cli() -> Self {
+    pub fn load() -> Self {
         // Get command line args
         Self::parse()
     }
 
     pub fn local_data_dir(&self) -> PathBuf {
-        #[cfg(debug_assertions)]
-        if let Some(path) = &self.local_dir {
-            return path.clone();
-        }
+        self.local_dir.to_path_buf()
+    }
+
+    pub fn local_sub_agent_data_dir(&self) -> PathBuf {
+        self.local_dir.join(SUB_AGENT_DIR)
+    }
+
+    pub fn remote_data_dir(&self) -> PathBuf {
+        self.remote_dir.to_path_buf()
+    }
 
-        PathBuf::from(AGENT_CONTROL_LOCAL_DATA_DIR)
+    pub fn log_dir(&self) -> PathBuf {
+        self.logs_dir.to_path_buf()
+    }
+
+    pub fn get_migration_config_str(&self) -> Result<String, Box<dyn Error>> {
+        if let Some(path) = &self.migration_config_file {
+            fs::read_to_string(path).map_err(|e| {
+                format!(
+                    "Could not read provided migration config file ({}): {}",
+                    path.display(),
+                    e
+                )
+                .into()
+            })
+        } else {
+            Ok(NEWRELIC_INFRA_AGENT_TYPE_CONFIG_MAPPING.to_owned())
+        }
     }
 }

agent-control/src/config_migrate/migration.rs

@@ -5,3 +5,4 @@ pub mod converter;
 pub mod defaults;
 pub mod migrator;
 pub mod persister;
+pub mod supported_config_value;

agent-control/src/config_migrate/migration/config.rs

@@ -1,10 +1,10 @@
-use regex::Regex;
 use serde::Deserialize;
 use serde_yaml::Error;
 use std::collections::HashMap;
+use std::ffi::OsString;
 use std::fmt::{Display, Formatter};
 use std::hash::{Hash, Hasher};
-use std::path::PathBuf;
+use std::path::{Path, PathBuf};
 use thiserror::Error;
 use tracing::error;
 
@@ -101,19 +101,15 @@ pub struct DirMap {
 #[derive(Clone, Debug, PartialEq, Deserialize)]
 pub struct DirInfo {
     pub path: FilePath,
-    pub filename_patterns: Vec<String>,
+    pub extensions: Vec<String>,
 }
 
 impl DirInfo {
-    pub fn valid_filename(&self, filename: &str) -> bool {
-        for filename_pattern in &self.filename_patterns {
-            let re = Regex::new(filename_pattern)
-                .unwrap_or_else(|_| panic!("invalid filename_pattern: {filename_pattern}"));
-            if re.is_match(filename) {
-                return true;
-            }
-        }
-        false
+    pub fn valid_filename(&self, filename: impl AsRef<Path>) -> bool {
+        self.extensions
+            .iter()
+            .map(OsString::from)
+            .any(|ext| filename.as_ref().extension().is_some_and(|e| e == ext))
     }
 }
 
@@ -163,12 +159,6 @@ pub struct MigrationAgentConfig {
     pub next: Option<AgentTypeID>,
 }
 
-impl MigrationAgentConfig {
-    pub(crate) fn get_agent_type_fqn(&self) -> AgentTypeID {
-        self.agent_type_fqn.clone()
-    }
-}
-
 impl MigrationAgentConfig {
     pub fn get_file(&self, fqn_to_check: AgentTypeFieldFQN) -> Option<FilePath> {
         for (fqn, path) in self.files_map.iter() {
@@ -207,12 +197,14 @@ configs:
     dirs_map:
       config_ohis:
         path: /etc/newrelic-infra/integrations.d
-        filename_patterns:
-          - ".*\\.ya?ml$"
+        extensions:
+          - "yaml"
+          - "yml"
       logging:
         path: /etc/newrelic-infra/logging.d
-        filename_patterns:
-          - ".*\\.ya?ml$"
+        extensions:
+          - "yaml"
+          - "yml"
   -
     agent_type_fqn: newrelic/com.newrelic.another:1.0.0
     files_map:
@@ -225,13 +217,15 @@ configs:
     dirs_map:
       config_integrations:
         path: /etc/newrelic-infra/integrations.d
-        filename_patterns:
-          - ".*\\.ya?ml$"
+        extensions:
+          - "yaml"
+          - "yml"
 
       config_logging:
         path: /etc/newrelic-infra/logging.d
-        filename_patterns:
-          - ".*\\.ya?ml$"
+        extensions:
+          - "yaml"
+          - "yml"
 
   -
     agent_type_fqn: francisco-partners/com.newrelic.another:0.0.2
@@ -245,13 +239,15 @@ configs:
     dirs_map:
       config_integrations:
         path: /etc/newrelic-infra/integrations.d
-        filename_patterns:
-          - ".*\\.ya?ml$"
-        
+        extensions:
+          - "yaml"
+          - "yml"
+
       config_logging:
         path: /etc/newrelic-infra/logging.d
-        filename_patterns:
-          - ".*\\.ya?ml$"
+        extensions:
+          - "yaml"
+          - "yml"
         
   -
     agent_type_fqn: newrelic/com.newrelic.another:0.0.1
@@ -311,7 +307,11 @@ configs: []
     #[test]
     fn test_dir_info() {
         let dir_info = DirInfo {
-            filename_patterns: vec![String::from(".*\\.ya?ml$"), String::from(".*\\.otro$")],
+            extensions: vec![
+                String::from("yaml"),
+                String::from("yml"),
+                String::from("otro"),
+            ],
             path: FilePath::from("some/path"),
         };