Proc macro for tedge config

ci/configure_bridge.sh

@@ -31,11 +31,11 @@ sudo tedge cert show
 
 sudo tedge config set c8y.url "$URL"
 
-sudo tedge config set c8y.root.cert.path /etc/ssl/certs
+sudo tedge config set c8y.root_cert_path /etc/ssl/certs
 
 sudo tedge config set az.url "$IOTHUBNAME.azure-devices.net"
 
-sudo tedge config set az.root.cert.path /etc/ssl/certs/Baltimore_CyberTrust_Root.pem
+sudo tedge config set az.root_cert_path /etc/ssl/certs/Baltimore_CyberTrust_Root.pem
 
 sudo tedge config list
 

crates/common/tedge_config/Cargo.toml

@@ -11,12 +11,14 @@ repository = { workspace = true }
 [dependencies]
 camino = { version = "1.1.4", features = ["serde", "serde1"] }
 certificate = { path = "../certificate" }
-doku = "0.20.0"
+doku = "0.21"
 figment = { version = "0.10", features = ["env", "toml"] }
 mqtt_channel = { path = "../mqtt_channel" }
+once_cell = "1.17"
 serde = { version = "1.0", features = ["derive"] }
 serde_ignored = "0.1"
 strum_macros = { version = "0.24" }
+tedge_config_macros = { path = "../tedge_config_macros" }
 tedge_utils = { path = "../tedge_utils" }
 thiserror = "1.0"
 toml = "0.7"

crates/common/tedge_config/src/lib.rs

@@ -5,10 +5,10 @@ pub mod tedge_config_cli;
 pub use self::tedge_config_cli::config_setting::*;
 pub use self::tedge_config_cli::error::*;
 pub use self::tedge_config_cli::models::*;
+pub use self::tedge_config_cli::new;
 pub use self::tedge_config_cli::settings::*;
 pub use self::tedge_config_cli::tedge_config::*;
 pub use self::tedge_config_cli::tedge_config_defaults::*;
-use self::tedge_config_cli::tedge_config_dto::*;
 pub use self::tedge_config_cli::tedge_config_location::*;
 pub use self::tedge_config_cli::tedge_config_repository::*;
 pub use camino::Utf8Path as Path;

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

@@ -75,4 +75,7 @@ pub enum ConfigSettingError {
 
     #[error("An error occurred: {msg}")]
     Other { msg: &'static str },
+
+    #[error(transparent)]
+    Write(#[from] crate::new::WriteError),
 }

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

@@ -1,12 +1,16 @@
 use std::borrow::Cow;
+use std::collections::HashSet;
 use std::fmt::Display;
 use std::path::Path;
 use std::path::PathBuf;
+use std::sync::Mutex;
 
 use figment::providers::Format;
 use figment::providers::Toml;
+use figment::value::Uncased;
 use figment::Figment;
 use figment::Metadata;
+use once_cell::sync::Lazy;
 use serde::de::DeserializeOwned;
 
 use crate::TEdgeConfigError;
@@ -28,10 +32,22 @@ impl ConfigSources for FileOnly {
     const INCLUDE_ENVIRONMENT: bool = false;
 }
 
+#[derive(Default, Debug, PartialEq, Eq)]
+#[must_use]
+pub struct UnusedValueWarnings(Vec<String>);
+
+impl UnusedValueWarnings {
+    pub fn emit(self) {
+        for warning in self.0 {
+            tracing::warn!("{warning}");
+        }
+    }
+}
+
 /// Extract the configuration data from the provided TOML path and `TEDGE_` prefixed environment variables
 pub fn extract_data<T: DeserializeOwned, Sources: ConfigSources>(
     path: impl AsRef<Path>,
-) -> Result<T, TEdgeConfigError> {
+) -> Result<(T, UnusedValueWarnings), TEdgeConfigError> {
     let env = TEdgeEnv::default();
     let figment = Figment::new().merge(Toml::file(path));
 
@@ -43,14 +59,18 @@ pub fn extract_data<T: DeserializeOwned, Sources: ConfigSources>(
 
     let data = extract_exact(&figment, &env);
 
-    for warning in unused_value_warnings::<T>(&figment, &env)
+    let warnings = unused_value_warnings::<T>(&figment, &env)
         .ok()
-        .unwrap_or_default()
-    {
-        tracing::warn!("{warning}");
+        .map(UnusedValueWarnings)
+        .unwrap_or_default();
+
+    match data {
+        Ok(data) => Ok((data, warnings)),
+        Err(e) => {
+            warnings.emit();
+            Err(e)
+        }
     }
-
-    data
 }
 
 fn unused_value_warnings<T: DeserializeOwned>(
@@ -172,9 +192,27 @@ impl TEdgeEnv {
     }
 
     fn provider(&self) -> figment::providers::Env {
-        let pattern = self.separator;
-        figment::providers::Env::prefixed(self.prefix)
-            .map(move |name| name.as_str().replacen(pattern, ".", 1).into())
+        static WARNINGS: Lazy<Mutex<HashSet<String>>> = Lazy::new(<_>::default);
+        figment::providers::Env::prefixed(self.prefix).map(move |name| {
+            let lowercase_name = name.as_str().to_ascii_lowercase();
+            Uncased::new(
+                tracing::subscriber::with_default(
+                    tracing::subscriber::NoSubscriber::default(),
+                    || lowercase_name.parse::<crate::new::WritableKey>(),
+                )
+                .map(|key| key.as_str().to_owned())
+                .map_err(|err| {
+                    let is_read_only_key = matches!(err, crate::new::ParseKeyError::ReadOnly(_));
+                    if is_read_only_key && !WARNINGS.lock().unwrap().insert(lowercase_name.clone()) {
+                            tracing::error!(
+                                "Failed to configure tedge with environment variable `TEDGE_{name}`: {}",
+                                err.to_string().replace('\n', " ")
+                            )
+         }
+                })
+                .unwrap_or(lowercase_name),
+            )
+        })
     }
 }
 
@@ -212,6 +250,7 @@ mod tests {
             assert_eq!(
                 extract_data::<Config, FileAndEnvironment>(&PathBuf::from("tedge.toml"))
                     .unwrap()
+                    .0
                     .c8y
                     .url,
                 "override.c8y.io"
@@ -298,7 +337,7 @@ mod tests {
             jail.set_env(variable_name, "environment");
 
             let data = extract_data::<Config, FileOnly>("tedge.toml").unwrap();
-            assert_eq!(data.value, "config");
+            assert_eq!(data.0.value, "config");
             Ok(())
         })
     }

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

@@ -3,9 +3,9 @@ pub mod error;
 pub mod settings;
 pub mod tedge_config;
 pub mod tedge_config_defaults;
-pub mod tedge_config_dto;
 pub mod tedge_config_location;
 pub mod tedge_config_repository;
 
 mod figment;
 pub mod models;
+pub mod new;

crates/common/tedge_config/src/tedge_config_cli/models/connect_url.rs

@@ -1,4 +1,6 @@
 use std::convert::TryFrom;
+use std::fmt;
+use std::str::FromStr;
 use url::Host;
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, Eq, PartialEq)]
@@ -29,6 +31,26 @@ impl TryFrom<String> for ConnectUrl {
     }
 }
 
+impl FromStr for ConnectUrl {
+    type Err = InvalidConnectUrl;
+
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        ConnectUrl::try_from(input.to_string())
+    }
+}
+
+impl fmt::Display for ConnectUrl {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        self.input.fmt(f)
+    }
+}
+
+impl doku::Document for ConnectUrl {
+    fn ty() -> doku::Type {
+        String::ty()
+    }
+}
+
 impl TryFrom<&str> for ConnectUrl {
     type Error = InvalidConnectUrl;