Merge pull request #2508 from jarhodes314/feat/unix-timestamp-measurements

Add support for parsing unix timestamp measurements

Author: jarhodes314

Cargo.lock

@@ -132,6 +132,7 @@ sha256 = "1.1"
 shell-words = "1.1"
 signal-hook = "0.3"
 signal-hook-tokio = { version = "0.3", features = ["futures-v0_3"] }
+strum = "0.24"
 strum_macros = "0.24"
 syn = { version = "2", features = ["full", "extra-traits"] }
 tedge-agent = { path = "crates/core/tedge_agent" }
@@ -190,3 +191,7 @@ opt-level = "z"
 panic = "abort"
 strip = "symbols"
 overflow-checks = true
+[profile.dev]
+codegen-units = 16
+opt-level = "z"
+strip = "symbols"

Cargo.toml

@@ -8,6 +8,10 @@ license = { workspace = true }
 homepage = { workspace = true }
 repository = { workspace = true }
 
+[features]
+default = []
+test = []
+
 [dependencies]
 anyhow = { workspace = true }
 camino = { workspace = true, features = ["serde", "serde1"] }
@@ -19,9 +23,10 @@ once_cell = { workspace = true }
 reqwest = { workspace = true, features = ["rustls-tls-native-roots"] }
 serde = { workspace = true, features = ["rc"] }
 serde_ignored = { workspace = true }
+strum = { workspace = true }
 strum_macros = { workspace = true }
 tedge_config_macros = { workspace = true }
-tedge_utils = { workspace = true }
+tedge_utils = { workspace = true, features = ["timestamp"] }
 thiserror = { workspace = true }
 toml = { workspace = true }
 tracing = { workspace = true }
@@ -31,6 +36,7 @@ url = { workspace = true }
 [dev-dependencies]
 assert_matches = { workspace = true }
 figment = { workspace = true, features = ["test"] }
+serde_json = { workspace = true }
 tedge_test_utils = { workspace = true }
 tempfile = { workspace = true }
 test-case = { workspace = true }

crates/common/tedge_config/Cargo.toml

@@ -73,6 +73,22 @@ pub fn extract_data<T: DeserializeOwned, Sources: ConfigSources>(
     }
 }
 
+#[cfg(feature = "test")]
+pub fn extract_from_toml_str<T: DeserializeOwned>(toml: &str) -> Result<T, TEdgeConfigError> {
+    let env = TEdgeEnv::default();
+    let figment = Figment::new().merge(Toml::string(toml));
+
+    let data = extract_exact(&figment, &env);
+
+    let warnings = unused_value_warnings::<T>(&figment, &env)
+        .ok()
+        .map(UnusedValueWarnings)
+        .unwrap_or_default();
+
+    warnings.emit();
+    data
+}
+
 fn unused_value_warnings<T: DeserializeOwned>(
     figment: &Figment,
     env: &TEdgeEnv,

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

@@ -7,6 +7,8 @@ pub mod port;
 pub mod seconds;
 pub mod templates_set;
 
+pub use tedge_utils::timestamp;
+
 pub const HTTPS_PORT: u16 = 443;
 pub const MQTT_TLS_PORT: u16 = 8883;
 

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

@@ -1,3 +1,4 @@
+use super::models::timestamp::TimeFormat;
 use crate::AutoFlag;
 use crate::ConnectUrl;
 use crate::HostPort;
@@ -468,6 +469,12 @@ define_tedge_config! {
             #[tedge_config(example = "true")]
             #[tedge_config(default(value = true))]
             timestamp: bool,
+
+            /// The format that will be used by the mapper when sending timestamps to Azure IoT
+            #[tedge_config(example = "rfc-3339")]
+            #[tedge_config(example = "unix")]
+            #[tedge_config(default(variable = "TimeFormat::Unix"))]
+            timestamp_format: TimeFormat,
         },
 
         /// Set of MQTT topics the Azure IoT mapper should subscribe to
@@ -492,6 +499,12 @@ define_tedge_config! {
             #[tedge_config(example = "true")]
             #[tedge_config(default(value = true))]
             timestamp: bool,
+
+            /// The format that will be used by the mapper when sending timestamps to AWS IoT
+            #[tedge_config(example = "rfc-3339")]
+            #[tedge_config(example = "unix")]
+            #[tedge_config(default(variable = "TimeFormat::Unix"))]
+            timestamp_format: TimeFormat,
         },
 
         /// Set of MQTT topics the AWS IoT mapper should subscribe to
@@ -735,6 +748,12 @@ define_tedge_config! {
         /// The thin-edge.io service's service type
         #[tedge_config(rename = "type", example = "systemd", default(value = "service"))]
         ty: String,
+
+        /// The format that will be used for the timestamp when generating service "up" messages in thin-edge JSON
+        #[tedge_config(example = "rfc-3339")]
+        #[tedge_config(example = "unix")]
+        #[tedge_config(default(variable = "TimeFormat::Unix"))]
+        timestamp_format: TimeFormat,
     },
 
     apt: {

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

@@ -55,6 +55,22 @@ impl TEdgeConfigRepository {
         Ok(dto)
     }
 
+    #[cfg(feature = "test")]
+    /// A test only method designed for injecting configuration into tests
+    ///
+    /// ```
+    /// use tedge_config::TEdgeConfigRepository;
+    /// let config = TEdgeConfigRepository::load_toml_str("service.ty = \"service\"");
+    ///
+    /// assert_eq!(&config.service.ty, "service");
+    /// // Defaults are preserved
+    /// assert_eq!(config.enable.sudo, true);
+    /// ```
+    pub fn load_toml_str(toml: &str) -> TEdgeConfig {
+        let dto = super::figment::extract_from_toml_str(toml).unwrap();
+        TEdgeConfig::from_dto(&dto, &TEdgeConfigLocation::default())
+    }
+
     fn load_dto_with_warnings<Sources: ConfigSources>(
         &self,
         path: &Utf8Path,

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

@@ -124,7 +124,7 @@ fn generate_structs(
         .unzip();
 
     Ok(quote! {
-        #[derive(::doku::Document, ::serde::Serialize, Debug)]
+        #[derive(::doku::Document, ::serde::Serialize, Debug, Clone)]
         #[non_exhaustive]
         #[doc = #doc_comment]
         pub struct #name {

crates/common/tedge_config_macros/impl/src/reader.rs

@@ -13,18 +13,29 @@ repository = { workspace = true }
 # No features on by default
 default = []
 logging = []
-fs-notify = ["strum_macros", "notify", "notify-debouncer-full"]
+fs-notify = ["strum", "notify", "notify-debouncer-full"]
+timestamp = ["strum", "time", "serde", "serde_json"]
 
 [dependencies]
 anyhow = "1.0.71"
+doku = { workspace = true }
 futures = { workspace = true }
 mqtt_channel = { workspace = true }
 nix = { workspace = true }
 notify = { workspace = true, optional = true }
 notify-debouncer-full = { workspace = true, optional = true }
-strum_macros = { workspace = true, optional = true }
+serde = { workspace = true, optional = true }
+serde_json = { workspace = true, optional = true }
+strum = { workspace = true, optional = true, features = ["derive"] }
 tempfile = { workspace = true }
 thiserror = { workspace = true }
+time = { workspace = true, features = [
+    "formatting",
+    "local-offset",
+    "parsing",
+    "serde",
+    "serde-well-known",
+], optional = true }
 tokio = { workspace = true, default_features = false, features = [
     "fs",
     "io-util",

crates/common/tedge_utils/Cargo.toml

@@ -8,3 +8,6 @@ pub mod timers;
 pub mod futures;
 #[cfg(feature = "fs-notify")]
 pub mod notify;
+
+#[cfg(feature = "timestamp")]
+pub mod timestamp;