feat: publish supported log types on config_update completion

Author: albinsuresh

crates/extensions/tedge_log_manager/src/config.rs

@@ -63,10 +63,14 @@ impl LogManagerConfig {
             ChannelFilter::Command(OperationType::LogUpload),
         );
 
-        let log_metadata_sync_topics = mqtt_schema.topics(
+        let mut log_metadata_sync_topics = mqtt_schema.topics(
             EntityFilter::Entity(&mqtt_device_topic_id),
             ChannelFilter::Command(OperationType::SoftwareUpdate),
         );
+        log_metadata_sync_topics.add_all(mqtt_schema.topics(
+            EntityFilter::Entity(&mqtt_device_topic_id),
+            ChannelFilter::Command(OperationType::ConfigUpdate),
+        ));
 
         Ok(Self {
             mqtt_schema,

crates/extensions/tedge_log_manager/src/lib.rs

@@ -262,6 +262,6 @@ impl MessageSink<CmdMetaSyncSignal> for LogManagerBuilder {
 impl SyncOnCommand for LogManagerBuilder {
     /// Return the list of operations for which this actor wants to receive sync signals
     fn sync_on_commands(&self) -> Vec<OperationType> {
-        vec![OperationType::SoftwareUpdate]
+        vec![OperationType::SoftwareUpdate, OperationType::ConfigUpdate]
     }
 }

crates/extensions/tedge_log_manager/src/tests.rs

@@ -99,8 +99,9 @@ async fn new_log_manager_builder(
     SimpleMessageBox<NoMessage, FsWatchEvent>,
     UploaderMessageBox,
 ) {
-    let log_metadata_sync_topics =
+    let mut log_metadata_sync_topics =
         TopicFilter::new_unchecked("te/device/main///cmd/software_update/+");
+    log_metadata_sync_topics.add_unchecked("te/device/main///cmd/config_update/+");
 
     let config = LogManagerConfig {
         mqtt_schema: MqttSchema::default(),
@@ -672,6 +673,82 @@ async fn log_types_published_on_software_update_message() -> Result<(), anyhow::
     Ok(())
 }
 
+#[tokio::test]
+async fn log_types_published_on_config_update_message() -> Result<(), anyhow::Error> {
+    let tempdir = prepare()?;
+    let (mut mqtt, _fs, _uploader) = spawn_log_manager_actor(tempdir.path()).await;
+
+    let log_reload_topic = Topic::new_unchecked("te/device/main///cmd/log_upload");
+    let config_update_topic = Topic::new_unchecked("te/device/main///cmd/config_update/1234");
+
+    // Skip the initial log types message on startup
+    mqtt.skip(1).await;
+
+    mqtt.send(MqttMessage::new(
+        &config_update_topic,
+        r#"
+        {
+            "status": "init",
+            "updateList": []
+        }"#,
+    ))
+    .await?;
+
+    mqtt.send(MqttMessage::new(
+        &config_update_topic,
+        r#"
+        {
+            "status": "executing",
+            "updateList": []
+        }"#,
+    ))
+    .await?;
+
+    // The log manager does not react to `config_update` in state other than "successful" or "failed"
+    assert!(mqtt.recv().await.is_none());
+
+    // Send a config_update message in terminal state that trigger log types reload
+    let config_update_message = r#"
+        {
+            "status": "successful",
+            "updateList": []
+        }"#;
+    mqtt.send(MqttMessage::new(
+        &config_update_topic,
+        config_update_message,
+    ))
+    .await?;
+
+    // The log manager should publish the log types again
+    assert_eq!(
+        mqtt.recv().await,
+        Some(
+            MqttMessage::new(&log_reload_topic, r#"{"types":["type_one","type_two"]}"#)
+                .with_retain()
+        )
+    );
+
+    // Failed config update should also trigger log types reload
+    mqtt.send(MqttMessage::new(
+        &config_update_topic,
+        r#"
+        {
+            "status": "failed",
+            "updateList": []
+        }"#,
+    ))
+    .await?;
+    assert_eq!(
+        mqtt.recv().await,
+        Some(
+            MqttMessage::new(&log_reload_topic, r#"{"types":["type_one","type_two"]}"#)
+                .with_retain()
+        )
+    );
+
+    Ok(())
+}
+
 #[tokio::test]
 async fn log_types_not_published_on_random_command_update() -> Result<(), anyhow::Error> {
     let tempdir = prepare()?;

tests/RobotFramework/tests/cumulocity/log/log_operation_plugins.robot

@@ -37,6 +37,21 @@ Supported log types updated on software update
     ...    message_contains=cron::journald
     Should Support Log File Types    cron::journald    includes=${True}
 
+Supported log types updated on config update
+    [Documentation]    Updating any configuration should trigger supported log types update
+    ${config_url}=    Cumulocity.Create Inventory Binary
+    ...    tedge-configuration-plugin
+    ...    tedge-configuration-plugin
+    ...    contents=files=[]
+    ${start_time}=    Get Unix Timestamp
+    ${operation}=    Cumulocity.Set Configuration    tedge-configuration-plugin    url=${config_url}
+    Operation Should Be SUCCESSFUL    ${operation}    timeout=120
+
+    Should Have MQTT Messages
+    ...    topic=te/device/main///cmd/log_upload
+    ...    date_from=${start_time}
+    ...    message_contains=software-management
+
 Log operation journald plugin can return logs for all units
     Should Support Log File Types    all-units::journald    includes=${True}
     ${start_timestamp}=    Get Current Date    UTC    -1 hours    result_format=%Y-%m-%dT%H:%M:%S+0000