Deprecate TEdgeConfig::try_new_sync

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

Author: didier-wenzek

crates/common/tedge_config/src/lib.rs

@@ -23,10 +23,6 @@ impl TEdgeConfig {
         config_location.load().await
     }
 
-    pub fn try_new_sync(config_location: TEdgeConfigLocation) -> Result<Self, TEdgeConfigError> {
-        config_location.load_sync()
-    }
-
     pub async fn load(config_dir: &Path) -> Result<TEdgeConfig, TEdgeConfigError> {
         let config_location = TEdgeConfigLocation::from_custom_root(config_dir);
         TEdgeConfig::try_new(config_location).await

crates/core/tedge/src/main.rs

@@ -61,7 +61,8 @@ async fn main() -> anyhow::Result<()> {
                 .context("failed to run tedge write process")?
         }
         TEdgeOptMulticall::Component(Component::TedgeAptPlugin(opt)) => {
-            tokio::task::spawn_blocking(move || tedge_apt_plugin::run_and_exit(opt))
+            let config = tedge_apt_plugin::get_config(opt.common.config_dir.as_std_path()).await;
+            tokio::task::spawn_blocking(move || tedge_apt_plugin::run_and_exit(opt, config))
                 .await
                 .context("failed to run tedge apt plugin")?
         }

crates/extensions/tedge_mqtt_bridge/src/config.rs

@@ -235,8 +235,8 @@ mod tests {
         use tedge_config::TEdgeConfig;
         use tedge_config::TEdgeConfigLocation;
 
-        #[test]
-        fn sets_certs_in_the_provided_mqtt_config() {
+        #[tokio::test]
+        async fn sets_certs_in_the_provided_mqtt_config() {
             let mut opts = MqttOptions::new("dummy-device", "127.0.0.1", 1883);
             let device_cert = rcgen::generate_simple_self_signed(["dummy-device".into()]).unwrap();
             let c8y_cert = rcgen::generate_simple_self_signed(["dummy-c8y".into()]).unwrap();
@@ -259,7 +259,8 @@ mod tests {
             std::fs::create_dir(root_cert_path.parent().unwrap()).unwrap();
             std::fs::write(&root_cert_path, c8y_cert.serialize_pem().unwrap()).unwrap();
             let tedge_config =
-                TEdgeConfig::try_new_sync(TEdgeConfigLocation::from_custom_root(ttd.path()))
+                TEdgeConfig::try_new(TEdgeConfigLocation::from_custom_root(ttd.path()))
+                    .await
                     .unwrap();
             let c8y_config = tedge_config.c8y.try_get::<str>(None).unwrap();
 

plugins/tedge_apt_plugin/src/lib.rs

@@ -27,7 +27,7 @@ use tracing::warn;
 )]
 pub struct AptCli {
     #[command(flatten)]
-    common: CommonArgs,
+    pub common: CommonArgs,
 
     #[clap(subcommand)]
     operation: PluginOp,
@@ -88,7 +88,7 @@ struct SoftwareModuleUpdate {
     pub path: Option<String>,
 }
 
-fn run_op(apt: AptCli) -> Result<ExitStatus, InternalError> {
+fn run_op(apt: AptCli, tedge_config: Option<TEdgeConfig>) -> Result<ExitStatus, InternalError> {
     if let Err(err) = log_init(
         "tedge-apt-plugin",
         &apt.common.log_args,
@@ -147,7 +147,7 @@ fn run_op(apt: AptCli) -> Result<ExitStatus, InternalError> {
             file_path,
         } => {
             let (installer, _metadata) = get_installer(module, version, file_path)?;
-            let dpk_option = get_dpk_option(apt.common.config_dir.as_std_path());
+            let dpk_option = get_dpk_option(&tedge_config);
             AptGetCmd::Install(dpk_option, vec![installer]).run()?
         }
 
@@ -173,7 +173,7 @@ fn run_op(apt: AptCli) -> Result<ExitStatus, InternalError> {
             // which will get cleaned up once it goes out of scope after this block
             let mut metadata_vec = Vec::new();
             let mut args: Vec<String> = Vec::new();
-            let dpk_option = get_dpk_option(apt.common.config_dir.as_std_path());
+            let dpk_option = get_dpk_option(&tedge_config);
 
             for update_module in updates {
                 match update_module.action {
@@ -319,8 +319,8 @@ impl AptGetCmd {
     }
 }
 
-fn get_dpk_option(config_dir: &Path) -> AptConfig {
-    match get_config(config_dir) {
+fn get_dpk_option(tedge_config: &Option<TEdgeConfig>) -> AptConfig {
+    match tedge_config {
         None => AptConfig::KeepNew,
         Some(config) => config.apt.dpk.options.config.clone(),
     }
@@ -334,10 +334,10 @@ fn get_name_and_version(line: &str) -> (&str, &str) {
     (name, version)
 }
 
-fn get_config(config_dir: &Path) -> Option<TEdgeConfig> {
+pub async fn get_config(config_dir: &Path) -> Option<TEdgeConfig> {
     let tedge_config_location = TEdgeConfigLocation::from_custom_root(config_dir);
 
-    match TEdgeConfig::try_new_sync(tedge_config_location) {
+    match TEdgeConfig::try_new(tedge_config_location).await {
         Ok(config) => Some(config),
         Err(err) => {
             warn!("Failed to load TEdgeConfig: {}", err);
@@ -346,9 +346,9 @@ fn get_config(config_dir: &Path) -> Option<TEdgeConfig> {
     }
 }
 
-pub fn run_and_exit(mut apt: AptCli) -> ! {
+pub fn run_and_exit(mut apt: AptCli, tedge_config: Option<TEdgeConfig>) -> ! {
     if let PluginOp::List { name, maintainer } = &mut apt.operation {
-        if let Some(config) = get_config(apt.common.config_dir.as_std_path()) {
+        if let Some(config) = &tedge_config {
             if name.is_none() {
                 *name = config.apt.name.or_none().cloned();
             }
@@ -359,7 +359,7 @@ pub fn run_and_exit(mut apt: AptCli) -> ! {
         }
     }
 
-    match run_op(apt) {
+    match run_op(apt, tedge_config) {
         Ok(status) if status.success() => {
             std::process::exit(0);
         }
@@ -414,6 +414,6 @@ mod tests {
                 config_dir: "".into(),
             },
         };
-        assert!(run_op(apt).is_ok())
+        assert!(run_op(apt, None).is_ok())
     }
 }