Merge pull request #3470 from Bravo555/refactor/tedge-config-visibility

refactor: Reduce number of items exported at the top crate level by `tedge_config`

Author: Bravo555

crates/common/tedge_config/src/lib.rs

@@ -1,14 +1,17 @@
 mod sudo;
-pub mod tedge_toml;
 pub use sudo::SudoCommandBuilder;
 pub mod cli;
 mod system_toml;
+pub use system_toml::*;
+
+pub mod tedge_toml;
+pub use tedge_toml::error::*;
+pub use tedge_toml::models;
+pub use tedge_toml::tedge_config::TEdgeConfig;
+pub use tedge_toml::tedge_config::TEdgeConfigDto;
+pub use tedge_toml::tedge_config::TEdgeConfigReader;
+pub use tedge_toml::tedge_config_location::*;
 
-pub use self::system_toml::*;
-pub use self::tedge_toml::error::*;
-pub use self::tedge_toml::models::*;
-pub use self::tedge_toml::tedge_config::*;
-pub use self::tedge_toml::tedge_config_location::*;
 pub use camino::Utf8Path as Path;
 pub use camino::Utf8PathBuf as PathBuf;
 pub use certificate::CertificateError;

crates/common/tedge_config/src/tedge_toml/error.rs

@@ -70,7 +70,7 @@ pub enum ConfigSettingError {
     Other { msg: &'static str },
 
     #[error(transparent)]
-    Write(#[from] crate::WriteError),
+    Write(#[from] super::WriteError),
 }
 
 impl TEdgeConfigError {

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

@@ -214,11 +214,11 @@ impl TEdgeEnv {
             Uncased::new(
                 tracing::subscriber::with_default(
                     tracing::subscriber::NoSubscriber::default(),
-                    || lowercase_name.parse::<crate::WritableKey>(),
+                    || lowercase_name.parse::<crate::tedge_toml::WritableKey>(),
                 )
                 .map(|key| key.to_string())
                 .map_err(|err| {
-                    let is_read_only_key = matches!(err, crate::ParseKeyError::ReadOnly(_));
+                    let is_read_only_key = matches!(err, crate::tedge_toml::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}`: {}",
@@ -236,6 +236,8 @@ impl TEdgeEnv {
 mod tests {
     use std::path::PathBuf;
 
+    use crate::tedge_toml::AppendRemoveItem;
+    use crate::tedge_toml::ReadError;
     use serde::Deserialize;
     use tedge_config_macros::define_tedge_config;
 
@@ -381,8 +383,6 @@ mod tests {
 
     #[test]
     fn environment_variables_can_override_profiled_configurations() {
-        use crate::AppendRemoveItem;
-        use crate::ReadError;
         use tedge_config_macros::*;
 
         define_tedge_config!(
@@ -417,8 +417,6 @@ mod tests {
 
     #[test]
     fn environment_variable_profile_warnings_use_key_with_correct_format() {
-        use crate::AppendRemoveItem;
-        use crate::ReadError;
         use tedge_config_macros::*;
 
         define_tedge_config!(
@@ -445,8 +443,6 @@ mod tests {
 
     #[test]
     fn toml_profile_warnings_use_key_with_correct_format() {
-        use crate::AppendRemoveItem;
-        use crate::ReadError;
         use tedge_config_macros::*;
 
         define_tedge_config!(

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

@@ -2,4 +2,6 @@ pub mod error;
 mod figment;
 pub mod models;
 pub mod tedge_config;
+pub use tedge_config::*;
+
 pub mod tedge_config_location;

crates/common/tedge_config/src/tedge_toml/models/host_port.rs

@@ -1,5 +1,5 @@
-use crate::ConnectUrl;
-use crate::Port;
+use super::ConnectUrl;
+use super::Port;
 use serde::Deserialize;
 use serde::Serialize;
 use std::fmt;
@@ -19,7 +19,7 @@ use url::Host;
 /// # Examples
 ///
 /// ```
-/// # use tedge_config::{HostPort, Port, HTTPS_PORT};
+/// # use tedge_config::models::{HostPort, Port, HTTPS_PORT};
 ///
 /// // use a fallback port if not present in string
 /// let http = HostPort::<HTTPS_PORT>::try_from("my-tenant.cumulocity.com".to_string()).unwrap();
@@ -142,8 +142,9 @@ pub enum ParseHostPortError {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::HTTPS_PORT;
-    use crate::MQTT_TLS_PORT;
+
+    use super::super::HTTPS_PORT;
+    use super::super::MQTT_TLS_PORT;
     use test_case::test_case;
 
     #[test_case(HostPort::<HTTPS_PORT>::try_from("test.com").unwrap(), "test.com:443")]

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

@@ -33,6 +33,7 @@ pub use self::port::*;
 pub use self::seconds::*;
 pub use self::templates_set::*;
 pub use tedge_utils::timestamp;
+pub use tedge_utils::timestamp::TimeFormat;
 pub use topic_prefix::TopicPrefix;
 
 #[derive(

crates/common/tedge_config/src/tedge_toml/tedge_config.rs

@@ -4,21 +4,21 @@ use version::TEdgeTomlVersion;
 mod append_remove;
 pub use append_remove::AppendRemoveItem;
 
+use super::models::auth_method::AuthMethod;
 use super::models::timestamp::TimeFormat;
-use crate::auth_method::AuthMethod;
-use crate::AptConfig;
-use crate::AutoFlag;
-use crate::AutoLogUpload;
-use crate::ConnectUrl;
-use crate::HostPort;
-use crate::MqttPayloadLimit;
-use crate::SecondsOrHumanTime;
-use crate::SoftwareManagementApiFlag;
-use crate::TEdgeConfigLocation;
-use crate::TemplatesSet;
-use crate::TopicPrefix;
-use crate::HTTPS_PORT;
-use crate::MQTT_TLS_PORT;
+use super::models::AptConfig;
+use super::models::AutoFlag;
+use super::models::AutoLogUpload;
+use super::models::ConnectUrl;
+use super::models::HostPort;
+use super::models::MqttPayloadLimit;
+use super::models::SecondsOrHumanTime;
+use super::models::SoftwareManagementApiFlag;
+use super::models::TemplatesSet;
+use super::models::TopicPrefix;
+use super::models::HTTPS_PORT;
+use super::models::MQTT_TLS_PORT;
+use super::tedge_config_location::TEdgeConfigLocation;
 use anyhow::anyhow;
 use anyhow::Context;
 use camino::Utf8Path;

crates/common/tedge_config/src/tedge_toml/tedge_config_location.rs

@@ -193,7 +193,7 @@ impl TEdgeConfigLocation {
 mod tests {
     use tedge_test_utils::fs::TempTedgeDir;
 
-    use crate::Cloud;
+    use crate::tedge_toml::Cloud;
     use crate::TEdgeConfigReader;
 
     use super::*;

crates/core/c8y_api/src/http_proxy.rs

@@ -14,13 +14,13 @@ use reqwest::header::InvalidHeaderValue;
 use reqwest::Url;
 use std::path::PathBuf;
 use std::time::Duration;
-use tedge_config::auth_method::AuthType;
+use tedge_config::models::auth_method::AuthType;
+use tedge_config::models::TopicPrefix;
+use tedge_config::tedge_toml::ConfigNotSet;
+use tedge_config::tedge_toml::MultiError;
+use tedge_config::tedge_toml::ReadError;
 use tedge_config::CertificateError;
-use tedge_config::ConfigNotSet;
-use tedge_config::MultiError;
-use tedge_config::ReadError;
 use tedge_config::TEdgeConfig;
-use tedge_config::TopicPrefix;
 use tracing::debug;
 use tracing::error;
 use tracing::info;

crates/core/c8y_api/src/json_c8y_deserializer.rs

@@ -12,7 +12,7 @@ use tedge_api::mqtt_topics::EntityTopicId;
 use tedge_api::SoftwareModule;
 use tedge_api::SoftwareModuleUpdate;
 use tedge_api::SoftwareUpdateCommand;
-use tedge_config::TopicPrefix;
+use tedge_config::models::TopicPrefix;
 use time::OffsetDateTime;
 
 pub struct C8yDeviceControlTopic;