Merge pull request #3959 from reubenmiller/feat-disable-software-update-op

feat: support disabling cloud handling of c8y_SoftwareUpdate operation

Author: reubenmiller

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

@@ -703,6 +703,10 @@ define_tedge_config! {
             /// Enable device restart feature
             #[tedge_config(example = "true", default(value = true))]
             device_restart: bool,
+
+            /// Enable software update feature
+            #[tedge_config(example = "true", default(value = true))]
+            software_update: bool,
         },
 
         mapper: {

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

@@ -129,6 +129,7 @@ impl FromCloudConfig for C8yMapperSpecificConfig {
                 firmware_update: c8y.enable.firmware_update,
                 device_profile: c8y.enable.device_profile,
                 device_restart: c8y.enable.device_restart,
+                software_update: c8y.enable.software_update,
             },
             mqtt_service: MqttServiceConfig {
                 enabled: c8y.mqtt_service.enabled,

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

@@ -387,6 +387,9 @@ pub struct EnableConfig {
 
     /// Enable device restart feature
     pub device_restart: bool,
+
+    /// Enable software_update feature
+    pub software_update: bool,
 }
 
 /// Bridge include configuration

crates/extensions/c8y_mapper_ext/src/config.rs

@@ -202,6 +202,7 @@ impl C8yMapperConfig {
             firmware_update: c8y_config.cloud_specific.enable.firmware_update,
             device_profile: c8y_config.cloud_specific.enable.device_profile,
             device_restart: c8y_config.cloud_specific.enable.device_restart,
+            software_update: c8y_config.cloud_specific.enable.software_update,
         };
         let bridge_config = BridgeConfig {
             c8y_prefix: c8y_config.bridge.topic_prefix.clone(),

crates/extensions/c8y_mapper_ext/src/converter.rs

@@ -665,8 +665,13 @@ impl CumulocityConverter {
                 }
             }
             C8yDeviceControlOperation::SoftwareUpdate(request) => {
-                self.forward_software_request(device_xid, cmd_id, request)
-                    .await?
+                if self.config.capabilities.software_update {
+                    self.forward_software_request(device_xid, cmd_id, request)
+                        .await?
+                } else {
+                    warn!("Received a c8y_SoftwareUpdate operation, however, software_update feature is disabled");
+                    vec![]
+                }
             }
             C8yDeviceControlOperation::LogfileRequest(request) => {
                 if self.config.capabilities.log_upload {
@@ -1603,6 +1608,12 @@ impl CumulocityConverter {
         &mut self,
         target: &EntityTopicId,
     ) -> Result<Vec<MqttMessage>, ConversionError> {
+        if !self.config.capabilities.software_update {
+            warn!(
+                "Received software update metadata, however, software update feature is disabled"
+            );
+            return Ok(vec![]);
+        }
         let mut registration = match self.register_operation(target, "c8y_SoftwareUpdate").await {
             Err(_) => {
                 error!("Fail to register `software-list` operation for unknown device: {target}");

crates/extensions/c8y_mapper_ext/src/lib.rs

@@ -27,6 +27,7 @@ pub struct Capabilities {
     pub firmware_update: bool,
     pub device_profile: bool,
     pub device_restart: bool,
+    pub software_update: bool,
 }
 
 #[cfg(test)]
@@ -39,6 +40,7 @@ impl Default for Capabilities {
             firmware_update: true,
             device_profile: true,
             device_restart: true,
+            software_update: true,
         }
     }
 }

crates/extensions/c8y_mapper_ext/src/operations/handler.rs

@@ -258,6 +258,13 @@ impl OperationHandler {
             ]);
         }
 
+        if capabilities.software_update {
+            topics.extend([
+                (AnyEntity, Command(OperationType::SoftwareUpdate)),
+                (AnyEntity, CommandMetadata(OperationType::SoftwareUpdate)),
+            ]);
+        }
+
         topics
     }
 }

tests/RobotFramework/tests/cumulocity/software_management/software.robot

@@ -185,6 +185,24 @@ Agent should ignore unknown software-update fields
     ...    message_pattern=.*"status":"successful".*
     ...    timeout=60
 
+Supports disabling the Cumulocity c8y_SoftwareUpdate Command
+    Execute Command    tedge config set c8y.enable.software_update false
+    Execute Command    rm -f /etc/tedge/operations/c8y/c8y_SoftwareUpdate
+
+    Restart Service    tedge-mapper-c8y
+    Service Health Status Should Be Up    tedge-mapper-c8y
+    File Should Not Exist    /etc/tedge/operations/c8y/c8y_SoftwareUpdate
+    Should Not Contain Supported Operations    c8y_SoftwareUpdate
+    ${operation}=    Cumulocity.Install Software    dummy
+    Sleep    5s    reason=Allow time for the message to be delivered
+    Operation Should Be PENDING    ${operation}    timeout=30
+
+    # Cleanup operation for cleaner logs (as pending operations pollute the test report output)
+    # Note: It does not need to be run under a TearDown hook as this code will only run
+    # if the operation is not processed, otherwise it would of been processed and thus not need cleaning up
+    Execute Command    tedge mqtt pub c8y/s/us '505,${operation.to_json()["id"]},Cancelled operation'
+    Operation Should Be FAILED    ${operation}
+
 
 *** Keywords ***
 Custom Setup