Deprecate TEdgeConfigRepository

Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>

Author: didier-wenzek

crates/common/tedge_config/src/lib.rs

@@ -7,7 +7,6 @@ pub use self::tedge_config_cli::error::*;
 pub use self::tedge_config_cli::models::*;
 pub use self::tedge_config_cli::tedge_config::*;
 pub use self::tedge_config_cli::tedge_config_location::*;
-pub use self::tedge_config_cli::tedge_config_repository::*;
 pub use camino::Utf8Path as Path;
 pub use camino::Utf8PathBuf as PathBuf;
 pub use certificate::CertificateError;
@@ -16,11 +15,26 @@ pub use tedge_config_macros::OptionalConfig;
 
 impl TEdgeConfig {
     pub fn new(config_location: TEdgeConfigLocation) -> Result<Self, TEdgeConfigError> {
-        TEdgeConfigRepository::new(config_location).load()
+        config_location.load()
     }
 
     pub fn load(config_dir: &Path) -> Result<TEdgeConfig, TEdgeConfigError> {
         let config_location = TEdgeConfigLocation::from_custom_root(config_dir);
         TEdgeConfig::new(config_location)
     }
+
+    #[cfg(feature = "test")]
+    /// A test only method designed for injecting configuration into tests
+    ///
+    /// ```
+    /// use tedge_config::TEdgeConfig;
+    /// let config = TEdgeConfig::load_toml_str("service.ty = \"service\"");
+    ///
+    /// assert_eq!(&config.service.ty, "service");
+    /// // Defaults are preserved
+    /// assert_eq!(config.sudo.enable, true);
+    /// ```
+    pub fn load_toml_str(toml: &str) -> TEdgeConfig {
+        TEdgeConfigLocation::load_toml_str(toml)
+    }
 }

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

@@ -10,13 +10,8 @@ use super::figment::FileAndEnvironment;
 use super::figment::FileOnly;
 use super::figment::UnusedValueWarnings;
 
-/// TEdgeConfigRepository is responsible for loading and storing TEdgeConfig entities.
-#[derive(Debug, Clone)]
-pub struct TEdgeConfigRepository {
-    config_location: TEdgeConfigLocation,
-}
-
-impl TEdgeConfigRepository {
+/// TEdgeConfigLocation is responsible for loading and storing TEdgeConfig entities.
+impl TEdgeConfigLocation {
     pub fn update_toml(
         &self,
         update: &impl Fn(&mut TEdgeConfigDto) -> ConfigSettingResult<()>,
@@ -28,20 +23,16 @@ impl TEdgeConfigRepository {
     }
 
     fn toml_path(&self) -> &Utf8Path {
-        self.config_location.tedge_config_file_path()
-    }
-
-    pub fn new(config_location: TEdgeConfigLocation) -> Self {
-        Self { config_location }
+        self.tedge_config_file_path()
     }
 
     pub fn load(&self) -> Result<TEdgeConfig, TEdgeConfigError> {
         let dto = self.load_dto::<FileAndEnvironment>(self.toml_path())?;
         debug!(
             "Loading configuration from {:?}",
-            self.config_location.tedge_config_file_path
+            self.tedge_config_file_path
         );
-        Ok(TEdgeConfig::from_dto(&dto, &self.config_location))
+        Ok(TEdgeConfig::from_dto(&dto, self))
     }
 
     fn load_dto<Sources: ConfigSources>(
@@ -59,8 +50,8 @@ impl TEdgeConfigRepository {
     /// A test only method designed for injecting configuration into tests
     ///
     /// ```
-    /// use tedge_config::TEdgeConfigRepository;
-    /// let config = TEdgeConfigRepository::load_toml_str("service.ty = \"service\"");
+    /// use tedge_config::TEdgeConfigLocation;
+    /// let config = TEdgeConfigLocation::load_toml_str("service.ty = \"service\"");
     ///
     /// assert_eq!(&config.service.ty, "service");
     /// // Defaults are preserved
@@ -101,17 +92,13 @@ impl TEdgeConfigRepository {
         Ok((dto, warnings))
     }
 
-    pub fn get_config_location(&self) -> &TEdgeConfigLocation {
-        &self.config_location
-    }
-
     // TODO: Explicitly set the file permissions in this function and file ownership!
     fn store<S: Serialize>(&self, config: &S) -> Result<(), TEdgeConfigError> {
         let toml = toml::to_string_pretty(&config)?;
 
         // Create `$HOME/.tedge` or `/etc/tedge` directory in case it does not exist yet
-        if !self.config_location.tedge_config_root_path.exists() {
-            fs::create_dir(self.config_location.tedge_config_root_path())?;
+        if !self.tedge_config_root_path.exists() {
+            fs::create_dir(self.tedge_config_root_path())?;
         }
 
         atomically_write_file_sync(self.toml_path(), toml.as_bytes())?;
@@ -196,7 +183,7 @@ child_update_timeout = 3429
 type = "a-service-type""#;
         let (_tempdir, config_location) = create_temp_tedge_config(toml).unwrap();
         let toml_path = config_location.tedge_config_file_path();
-        let (dto, warnings) = TEdgeConfigRepository::new(config_location.clone())
+        let (dto, warnings) = config_location
             .load_dto_with_warnings::<FileOnly>(toml_path)
             .unwrap();
 

crates/core/tedge/src/cli/config/cli.rs

@@ -41,29 +41,29 @@ pub enum ConfigCmd {
 
 impl BuildCommand for ConfigCmd {
     fn build_command(self, context: BuildContext) -> Result<Box<dyn Command>, ConfigError> {
-        let config_repository = context.config_repository;
+        let config_location = context.config_location;
 
         match self {
             ConfigCmd::Get { key } => Ok(GetConfigCommand {
                 key,
-                config: config_repository.load()?,
+                config: config_location.load()?,
             }
             .into_boxed()),
             ConfigCmd::Set { key, value } => Ok(SetConfigCommand {
                 key,
                 value,
-                config_repository,
+                config_location,
             }
             .into_boxed()),
             ConfigCmd::Unset { key } => Ok(UnsetConfigCommand {
                 key,
-                config_repository,
+                config_location,
             }
             .into_boxed()),
             ConfigCmd::List { is_all, is_doc } => Ok(ListConfigCommand {
                 is_all,
                 is_doc,
-                config: config_repository.load()?,
+                config: config_location.load()?,
             }
             .into_boxed()),
         }

crates/core/tedge/src/cli/config/commands/set.rs

@@ -1,11 +1,11 @@
 use crate::command::Command;
-use tedge_config::TEdgeConfigRepository;
+use tedge_config::TEdgeConfigLocation;
 use tedge_config::WritableKey;
 
 pub struct SetConfigCommand {
     pub key: WritableKey,
     pub value: String,
-    pub config_repository: TEdgeConfigRepository,
+    pub config_location: TEdgeConfigLocation,
 }
 
 impl Command for SetConfigCommand {
@@ -18,7 +18,7 @@ impl Command for SetConfigCommand {
     }
 
     fn execute(&self) -> anyhow::Result<()> {
-        self.config_repository.update_toml(&|dto| {
+        self.config_location.update_toml(&|dto| {
             dto.try_update_str(self.key, &self.value)
                 .map_err(|e| e.into())
         })?;

crates/core/tedge/src/cli/config/commands/unset.rs

@@ -1,10 +1,10 @@
 use crate::command::Command;
-use tedge_config::TEdgeConfigRepository;
+use tedge_config::TEdgeConfigLocation;
 use tedge_config::WritableKey;
 
 pub struct UnsetConfigCommand {
     pub key: WritableKey,
-    pub config_repository: TEdgeConfigRepository,
+    pub config_location: TEdgeConfigLocation,
 }
 
 impl Command for UnsetConfigCommand {
@@ -13,7 +13,7 @@ impl Command for UnsetConfigCommand {
     }
 
     fn execute(&self) -> anyhow::Result<()> {
-        self.config_repository.update_toml(&|dto| {
+        self.config_location.update_toml(&|dto| {
             dto.unset_key(self.key);
             Ok(())
         })?;

crates/core/tedge/src/command.rs

@@ -128,12 +128,12 @@ pub trait Command {
 ///     fn build_command(self, context: BuildContext) -> Result<Box<dyn Command>, ConfigError> {
 ///         let cmd = match self {
 ///             ConfigCmd::Set { key, value } => SetConfigCommand {
-///                 config_repository: context.config_repository,
+///                 config_location: context.config_location,
 ///                 key,
 ///                 value,
 ///             }.into_boxed(),
 ///             ConfigCmd::Get { key } => GetConfigCommand {
-///                 config: context.config_repository.load()?,
+///                 config: context.load_config()?,
 ///                 key,
 ///             }.into_boxed(),
 ///         };
@@ -149,17 +149,13 @@ pub trait BuildCommand {
 ///
 #[derive(Debug)]
 pub struct BuildContext {
-    pub config_repository: tedge_config::TEdgeConfigRepository,
     pub config_location: tedge_config::TEdgeConfigLocation,
 }
 
 impl BuildContext {
     pub fn new(config_dir: impl AsRef<Path>) -> Self {
         let config_location = tedge_config::TEdgeConfigLocation::from_custom_root(config_dir);
-        BuildContext {
-            config_repository: tedge_config::TEdgeConfigRepository::new(config_location.clone()),
-            config_location,
-        }
+        BuildContext { config_location }
     }
 
     pub fn load_config(&self) -> Result<tedge_config::TEdgeConfig, tedge_config::TEdgeConfigError> {

crates/extensions/c8y_mapper_ext/src/converter.rs

@@ -1627,7 +1627,7 @@ pub(crate) mod tests {
     use tedge_api::mqtt_topics::MqttSchema;
     use tedge_api::mqtt_topics::OperationType;
     use tedge_api::SoftwareUpdateCommand;
-    use tedge_config::TEdgeConfigRepository;
+    use tedge_config::TEdgeConfig;
     use tedge_mqtt_ext::test_helpers::assert_messages_matching;
     use tedge_mqtt_ext::Message;
     use tedge_mqtt_ext::MqttMessage;
@@ -2825,7 +2825,7 @@ pub(crate) mod tests {
     async fn handles_empty_service_type_2383() {
         let tmp_dir = TempTedgeDir::new();
         let mut config = c8y_converter_config(&tmp_dir);
-        let tedge_config = TEdgeConfigRepository::load_toml_str("service.ty = \"\"");
+        let tedge_config = TEdgeConfig::load_toml_str("service.ty = \"\"");
         config.service = tedge_config.service.clone();
 
         let (mut converter, _) = create_c8y_converter_from_config(config);
@@ -3136,7 +3136,7 @@ pub(crate) mod tests {
         let device_id = "test-device".into();
         let device_topic_id = EntityTopicId::default_main_device();
         let device_type = "test-device-type".into();
-        let tedge_config = TEdgeConfigRepository::load_toml_str("service.ty = \"service\"");
+        let tedge_config = TEdgeConfig::load_toml_str("service.ty = \"service\"");
         let c8y_host = "test.c8y.io".into();
         let tedge_http_host = "localhost".into();
         let auth_proxy_addr = "127.0.0.1".into();

crates/extensions/c8y_mapper_ext/src/tests.rs

@@ -35,7 +35,7 @@ use tedge_api::mqtt_topics::EntityTopicId;
 use tedge_api::mqtt_topics::MqttSchema;
 use tedge_api::CommandStatus;
 use tedge_api::SoftwareUpdateCommand;
-use tedge_config::TEdgeConfigRepository;
+use tedge_config::TEdgeConfig;
 use tedge_file_system_ext::FsWatchEvent;
 use tedge_mqtt_ext::test_helpers::assert_received_contains_str;
 use tedge_mqtt_ext::test_helpers::assert_received_includes_json;
@@ -2382,7 +2382,7 @@ pub(crate) async fn spawn_c8y_mapper_actor(
     let device_name = "test-device".into();
     let device_topic_id = EntityTopicId::default_main_device();
     let device_type = "test-device-type".into();
-    let config = TEdgeConfigRepository::load_toml_str("service.ty = \"service\"");
+    let config = TEdgeConfig::load_toml_str("service.ty = \"service\"");
     let c8y_host = "test.c8y.io".into();
     let tedge_http_host = "localhost:8888".into();
     let mqtt_schema = MqttSchema::default();

crates/extensions/tedge_health_ext/src/tests.rs

@@ -12,7 +12,7 @@ use tedge_actors::SimpleMessageBoxBuilder;
 use tedge_api::mqtt_topics::EntityTopicId;
 use tedge_api::mqtt_topics::MqttSchema;
 use tedge_api::mqtt_topics::Service;
-use tedge_config::TEdgeConfigRepository;
+use tedge_config::TEdgeConfig;
 use tedge_mqtt_ext::MqttConfig;
 use tedge_mqtt_ext::MqttMessage;
 use tedge_mqtt_ext::Topic;
@@ -82,7 +82,7 @@ async fn spawn_a_health_check_actor(
     let mut health_mqtt_builder = MqttActorBuilder::new(mqtt_config);
 
     let mqtt_schema = MqttSchema::new();
-    let config = TEdgeConfigRepository::load_toml_str("service.ty = \"service\"");
+    let config = TEdgeConfig::load_toml_str("service.ty = \"service\"");
     let service = Service {
         service_topic_id: EntityTopicId::default_main_service(service_to_be_monitored)
             .unwrap()