From 06aae3299fea8776e29151efe27d101f45f5fc45 Mon Sep 17 00:00:00 2001
From: Martin Lehmann <martin.lehmann@deutschebahn.com>
Date: Mon, 4 Nov 2024 13:39:39 +0100
Subject: [PATCH] feat(importer): Don't delete descriptions

If the ROS messages don't have a description for an object, keep the
current description in the Capella model unchanged. This allows adding
descriptions in the Capella model manually if they're not present in the
imported ROS messages package.

Fixes #11
---
 capella_ros_tools/importer.py           | 26 +++++++++++++++----------
 tests/data/data_model/example_msgs.yaml | 13 -------------
 2 files changed, 16 insertions(+), 23 deletions(-)

diff --git a/capella_ros_tools/importer.py b/capella_ros_tools/importer.py
index 24b27f8..e3b0caf 100644
--- a/capella_ros_tools/importer.py
+++ b/capella_ros_tools/importer.py
@@ -131,7 +131,7 @@ def _convert_class(
                 f"{field_def.type.package or pkg_name}.{field_def.type.name}"
             )
             self._promise_id_refs[promise_ref] = None
-            prop_yml = {
+            prop_yml: t.Any = {
                 "promise_id": prop_promise_id,
                 "find": {
                     "name": field_def.name,
@@ -139,7 +139,6 @@ def _convert_class(
                 "set": {
                     "type": decl.Promise(promise_ref),
                     "kind": "COMPOSITION",
-                    "description": field_def.description,
                     "min_card": decl.NewObject(
                         "LiteralNumericValue", value=field_def.type.card.min
                     ),
@@ -148,6 +147,8 @@ def _convert_class(
                     ),
                 },
             }
+            if field_def.description:
+                prop_yml["set"]["description"] = field_def.description
             props.append(prop_yml)
             self._needed_associations.setdefault(pkg_name, {})[
                 prop_promise_id
@@ -158,9 +159,11 @@ def _convert_class(
             "find": {
                 "name": msg_def.name,
             },
-            "set": {
-                "description": msg_def.description,
-            },
+            "set": (
+                {"description": msg_def.description}
+                if msg_def.description
+                else {}
+            ),
             "sync": {
                 "properties": props,
             },
@@ -174,26 +177,29 @@ def _convert_enum(
         self._promise_ids[promise_id] = None
         literals = []
         for literal in enum_def.literals:
-            literal_yml = {
+            literal_yml: t.Any = {
                 "find": {
                     "name": literal.name,
                 },
                 "set": {
-                    "description": literal.description,
                     "value": decl.NewObject(
                         "LiteralNumericValue", value=literal.value
                     ),
                 },
             }
+            if literal.description:
+                literal_yml["set"]["description"] = literal.description
             literals.append(literal_yml)
         yml = {
             "promise_id": promise_id,
             "find": {
                 "name": enum_def.name,
             },
-            "set": {
-                "description": enum_def.description,
-            },
+            "set": (
+                {"description": enum_def.description}
+                if enum_def.description
+                else {}
+            ),
             "sync": {
                 "literals": literals,
             },
diff --git a/tests/data/data_model/example_msgs.yaml b/tests/data/data_model/example_msgs.yaml
index 9e237bc..1e0ad20 100644
--- a/tests/data/data_model/example_msgs.yaml
+++ b/tests/data/data_model/example_msgs.yaml
@@ -103,7 +103,6 @@
             - find:
                 name: RED
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '0'
@@ -143,28 +142,24 @@
             - find:
                 name: OK
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '0'
             - find:
                 name: WARN
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '1'
             - find:
                 name: ERROR
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '2'
             - find:
                 name: STALE
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '3'
@@ -259,7 +254,6 @@
                 name: field
               promise_id: package2.SampleClassEnum.field
               set:
-                description: ''
                 kind: COMPOSITION
                 max_card: !new_object
                   _type: LiteralNumericValue
@@ -279,28 +273,24 @@
             - find:
                 name: OK
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '0'
             - find:
                 name: WARN
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '1'
             - find:
                 name: ERROR
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '2'
             - find:
                 name: STALE
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '3'
@@ -314,21 +304,18 @@
             - find:
                 name: RED
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '0'
             - find:
                 name: BLUE
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '1'
             - find:
                 name: YELLOW
               set:
-                description: ''
                 value: !new_object
                   _type: LiteralNumericValue
                   value: '2'