Merge pull request #2920 from reubenmiller/feat-device-profile-operation

feat: support device profile operation

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

@@ -505,7 +505,7 @@ define_tedge_config! {
             firmware_update: bool,
 
             /// Enable device_profile feature
-            #[tedge_config(example = "true", default(value = false))]
+            #[tedge_config(example = "true", default(value = true))]
             device_profile: bool,
         },
 

crates/core/tedge_agent/src/agent.rs

@@ -1,3 +1,4 @@
+use crate::device_profile_manager::DeviceProfileManagerBuilder;
 use crate::file_transfer_server::actor::FileTransferServerBuilder;
 use crate::file_transfer_server::actor::FileTransferServerConfig;
 use crate::operation_file_cache::FileCacheActorBuilder;
@@ -251,6 +252,8 @@ impl Agent {
         // Software update actor
         let mut software_update_builder = SoftwareManagerBuilder::new(self.config.sw_update_config);
 
+        DeviceProfileManagerBuilder::try_new(&self.config.operations_dir)?;
+
         // Converter actor
         let mut converter_actor_builder = WorkflowActorBuilder::new(
             self.config.operation_config,

crates/core/tedge_agent/src/device_profile_manager/mod.rs

@@ -0,0 +1,17 @@
+use camino::Utf8PathBuf;
+use tedge_utils::file::create_file_with_defaults;
+use tedge_utils::file::FileError;
+
+pub struct DeviceProfileManagerBuilder {}
+
+impl DeviceProfileManagerBuilder {
+    pub fn try_new(ops_dir: &Utf8PathBuf) -> Result<Self, FileError> {
+        let workflow_file = ops_dir.join("device_profile.toml");
+        if !workflow_file.exists() {
+            let workflow_definition = include_str!("../resources/device_profile.toml");
+
+            create_file_with_defaults(workflow_file, Some(workflow_definition))?;
+        }
+        Ok(Self {})
+    }
+}

crates/core/tedge_agent/src/lib.rs

@@ -21,6 +21,7 @@ use tedge_config::DEFAULT_TEDGE_CONFIG_PATH;
 use tracing::log::warn;
 
 mod agent;
+mod device_profile_manager;
 mod file_transfer_server;
 mod operation_file_cache;
 mod operation_workflows;

crates/core/tedge_agent/src/operation_workflows/actor.rs

@@ -361,6 +361,25 @@ impl WorkflowActor {
 
                 Ok(())
             }
+            OperationAction::Iterate(target_json_path, handlers) => {
+                match OperationAction::process_iterate(
+                    state.clone(),
+                    &target_json_path,
+                    handlers.clone(),
+                ) {
+                    Ok(next_state) => {
+                        self.publish_command_state(next_state, &mut log_file)
+                            .await?
+                    }
+                    Err(err) => {
+                        error!("Iteration failed due to: {err}");
+                        let new_state = state
+                            .update(handlers.on_error.expect("on_error target can not be none"));
+                        self.publish_command_state(new_state, &mut log_file).await?;
+                    }
+                }
+                Ok(())
+            }
         }
     }
 

crates/core/tedge_agent/src/resources/device_profile.toml

@@ -0,0 +1,40 @@
+operation = "device_profile"
+
+[init]
+action = "proceed"
+on_success = "scheduled"
+
+[scheduled]
+action = "proceed"
+on_success = "executing"
+
+[executing]
+action = "proceed"
+on_success = "next_operation"
+
+[next_operation]
+iterate = "${.payload.operations}"
+on_next = "apply_operation"
+on_success = "successful"
+on_error = "rollback"
+
+[apply_operation]
+operation = "${.payload.@next.item.operation}"
+input = "${.payload.@next.item.payload}"
+on_exec = "awaiting_operation"
+
+[awaiting_operation]
+action = "await-operation-completion"
+on_success = "next_operation"
+on_error = "rollback"
+
+[rollback]
+action="proceed"
+on_success = { status = "failed", reason = "Device profile application failed" }
+on_error = { status = "failed", reason = "Rollback failed" }
+
+[successful]
+action = "cleanup"
+
+[failed]
+action = "cleanup"

crates/core/tedge_api/Cargo.toml

@@ -33,6 +33,7 @@ tokio = { workspace = true, features = ["fs", "process"] }
 
 [dev-dependencies]
 anyhow = { workspace = true }
+assert-json-diff = { workspace = true }
 assert_matches = { workspace = true }
 clock = { workspace = true }
 maplit = { workspace = true }

crates/core/tedge_api/src/workflow/error.rs

@@ -15,6 +15,9 @@ pub enum WorkflowDefinitionError {
 
     #[error("Unknown action: {action}")]
     UnknownAction { action: String },
+
+    #[error("The provided target {0} is not a valid path expression")]
+    InvalidPathExpression(String),
 }
 
 /// Error related to a script definition