Merge pull request #2117 from Ruadhri17/apt-plugin-fix

Fix config and help command issues for tedge apt plugin

crates/common/tedge_config/src/tedge_config_cli/new.rs

@@ -591,6 +591,15 @@ define_tedge_config! {
         #[tedge_config(rename = "type", example = "systemd", default(value = "service"))]
         ty: String,
     },
+
+    apt: {
+        /// The filtering criterion that is used to filter packages list output by name
+        #[tedge_config(example = "tedge.*")]
+        name: String,
+        /// The filtering criterion that is used to filter packages list output by maintainer
+        #[tedge_config(example = "thin-edge.io team.*")]
+        maintainer: String,
+    }
 }
 
 fn default_http_address(dto: &TEdgeConfigDto) -> IpAddr {
@@ -767,6 +776,8 @@ mod tests {
     #[test_case::test_case("firmware.child.update.timeout")]
     #[test_case::test_case("service.type")]
     #[test_case::test_case("run.lock_files")]
+    #[test_case::test_case("apt.name")]
+    #[test_case::test_case("apt.maintainer")]
     fn all_0_10_keys_can_be_deserialised(key: &str) {
         key.parse::<ReadableKey>().unwrap();
     }

plugins/tedge_apt_plugin/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tedge-apt-plugin"
-description = "Thin.edge.io plugin for software management using apt"
+description = "Thin-edge.io plugin for software management using apt"
 version = { workspace = true }
 authors = { workspace = true }
 edition = { workspace = true }
@@ -24,7 +24,6 @@ regex = "1"
 serde = { version = "1", features = ["derive"] }
 tedge_config = { path = "../../crates/common/tedge_config" }
 thiserror = "1.0"
-toml = "0.5"
 
 [dev-dependencies]
 anyhow = "1.0"

plugins/tedge_apt_plugin/src/main.rs

@@ -3,20 +3,31 @@ mod module_check;
 
 use crate::error::InternalError;
 use crate::module_check::PackageMetadata;
-use clap::IntoApp;
 use clap::Parser;
 use log::warn;
 use regex::Regex;
 use serde::Deserialize;
-use std::fs;
 use std::io::{self};
+use std::path::PathBuf;
 use std::process::Command;
 use std::process::ExitStatus;
 use std::process::Stdio;
+use tedge_config::new::TEdgeConfig;
 use tedge_config::TEdgeConfigLocation;
+use tedge_config::TEdgeConfigRepository;
+use tedge_config::DEFAULT_TEDGE_CONFIG_PATH;
 
 #[derive(Parser, Debug)]
+#[clap(
+    name = clap::crate_name!(),
+    version = clap::crate_version!(),
+    about = clap::crate_description!(),
+    arg_required_else_help(true)
+)]
 struct AptCli {
+    #[clap(long = "config-dir", default_value = DEFAULT_TEDGE_CONFIG_PATH)]
+    config_dir: PathBuf,
+
     #[clap(subcommand)]
     operation: PluginOp,
 }
@@ -25,9 +36,11 @@ struct AptCli {
 pub enum PluginOp {
     /// List all the installed modules
     List {
+        /// Filter packages list output by name
         #[clap(long = "--name")]
         name: Option<String>,
 
+        /// Filter packages list output by maintainer
         #[clap(long = "--maintainer")]
         maintainer: Option<String>,
     },
@@ -74,17 +87,6 @@ struct SoftwareModuleUpdate {
     pub path: Option<String>,
 }
 
-#[derive(Debug, Deserialize)]
-struct TedgeConfig {
-    pub apt: AptConfig,
-}
-
-#[derive(Debug, Deserialize)]
-struct AptConfig {
-    pub name: Option<String>,
-    pub maintainer: Option<String>,
-}
-
 fn run(operation: PluginOp) -> Result<ExitStatus, InternalError> {
     let status = match operation {
         PluginOp::List { name, maintainer } => {
@@ -289,34 +291,23 @@ fn get_name_and_version(line: &str) -> (&str, &str) {
     (name, version)
 }
 
-fn get_config() -> Option<TedgeConfig> {
-    let config_dir = TEdgeConfigLocation::default();
-
-    match fs::read_to_string(config_dir.tedge_config_file_path()) {
-        Ok(content) => match toml::from_str(&content) {
-            Ok(config) => Some(config),
-            Err(err) => {
-                warn!(
-                    "Failed to parse {}: {}",
-                    config_dir.tedge_config_file_path(),
-                    err
-                );
-                None
-            }
-        },
-        Err(_) => None,
+fn get_config(config_dir: PathBuf) -> Option<TEdgeConfig> {
+    let tedge_config_location = TEdgeConfigLocation::from_custom_root(config_dir);
+
+    match TEdgeConfigRepository::new(tedge_config_location).load_new() {
+        Ok(config) => Some(config),
+        Err(err) => {
+            warn!("Failed to load TEdgeConfig: {}", err);
+            None
+        }
     }
 }
 
 fn main() {
-    // On usage error, the process exits with a status code of 1
-
     let mut apt = match AptCli::try_parse() {
         Ok(aptcli) => aptcli,
-        Err(_) => {
-            AptCli::command()
-                .print_help()
-                .expect("Failed to print usage help");
+        Err(err) => {
+            err.print().expect("Failed to print help message");
             // re-write the clap exit_status from 2 to 1, if parse fails
             std::process::exit(1)
         }
@@ -327,13 +318,13 @@ fn main() {
         ref mut maintainer,
     } = apt.operation
     {
-        if let Some(config) = get_config() {
+        if let Some(config) = get_config(apt.config_dir) {
             if name.is_none() {
-                *name = config.apt.name;
+                *name = config.apt.name.or_none().cloned();
             }
 
             if maintainer.is_none() {
-                *maintainer = config.apt.maintainer;
+                *maintainer = config.apt.maintainer.or_none().cloned();
             }
         }
     }

tests/RobotFramework/tests/tedge/call_tedge_config_list.robot

@@ -16,6 +16,8 @@ Documentation       Purpose of this test is to verify that the tedge config list
 ...                 Set new tmp.path and return to default value
 ...                 Set new logs.path and return to default value
 ...                 Set new run.path and return to default value
+...                 Set new apt.name and return to default value
+...                 Set new apt.maintainer and return to default value
 
 Resource            ../../resources/common.resource
 Library             ThinEdgeIO
@@ -373,3 +375,27 @@ set/unset software.plugin.default
     ...    sudo tedge config unset software.plugin.default
     ${unset}    Execute Command    tedge config list
     Should Not Contain    ${unset}    software.plugin.default=
+
+set/unset apt.name
+    # Changing apt.name
+    Execute Command    sudo tedge config set apt.name tedge.*
+    ${set}    Execute Command    tedge config list
+    Should Contain    ${set}    apt.name=tedge.*
+
+    # Undo the change by using the 'unset' command, value returns to default one
+    Execute Command
+    ...    sudo tedge config unset apt.name
+    ${unset}    Execute Command    tedge config list
+    Should Not Contain    ${unset}    apt.name=
+
+set/unset apt.maintainer
+    # Changing apt.maintainer
+    Execute Command    sudo tedge config set apt.maintainer 'thin-edge.io team.*'
+    ${set}    Execute Command    tedge config list
+    Should Contain    ${set}    apt.maintainer=thin-edge.io team.*
+
+    # Undo the change by using the 'unset' command, value returns to default one
+    Execute Command
+    ...    sudo tedge config unset apt.maintainer
+    ${unset}    Execute Command    tedge config list
+    Should Not Contain    ${unset}    apt.maintainer=