[BLAZ-1964] Component name fixed if the length is less than 2 in Visio and Lucidchart

Author: dantolin-iriusrisk

slp_visio/slp_visio/parse/mappers/diagram_component_mapper.py

@@ -1,5 +1,3 @@
-from typing import Dict
-
 from otm.otm.entity.component import Component
 from otm.otm.entity.trustzone import Trustzone
 from slp_base import MappingFileNotValidError
@@ -8,25 +6,29 @@
 from slp_visio.slp_visio.parse.representation.representation_calculator import RepresentationCalculator
 
 
+def _normalize_component_name(name: str) -> str:
+    return f'_{name}' if len(name) == 1 else name
+
+
 class DiagramComponentMapper(DiagramMapper):
 
     def __init__(self,
-                 components: [DiagramComponent],
-                 component_mappings: Dict[str, dict],
-                 trustzone_mappings: Dict[str, dict],
+                 components: list[DiagramComponent],
+                 component_mappings: dict[str, dict],
+                 trustzone_mappings: dict[str, dict],
                  default_trustzone: Trustzone,
                  representation_calculator: RepresentationCalculator):
-        self.components: [DiagramComponent] = components
+        self.components: list[DiagramComponent] = components
         self.component_mappings = component_mappings
         self.trustzone_mappings = trustzone_mappings
         self.default_trustzone = default_trustzone
 
         self.representation_calculator = representation_calculator
 
-    def to_otm(self) -> [Component]:
+    def to_otm(self) -> list[Component]:
         return self.__map_to_otm(self.components)
 
-    def __map_to_otm(self, components: [DiagramComponent]) -> [Component]:
+    def __map_to_otm(self, components: list[DiagramComponent]) -> list[Component]:
         otm_components = []
 
         for diag_component in components:
@@ -43,7 +45,7 @@ def __build_otm_component(self, diagram_component: DiagramComponent, otm_type: s
 
         return Component(
             component_id=diagram_component.id,
-            name=diagram_component.name,
+            name=_normalize_component_name(diagram_component.name),
             component_type=otm_type,
             parent=self.__calculate_parent_id(diagram_component),
             parent_type=self._calculate_parent_type(diagram_component),

slp_visio/tests/unit/parse/mappers/test_diagram_component_mapper.py

@@ -2,17 +2,19 @@
 
 import pytest
 
+from slp_visio.slp_visio.load.objects.diagram_objects import DiagramComponent
+
 from slp_base import MappingFileNotValidError
 from slp_visio.slp_visio.parse.mappers.diagram_component_mapper import DiagramComponentMapper
 
-tz1 = MagicMock(id='tz1')
-c1 = MagicMock(id='c1')
+tz1 = DiagramComponent(id='tz1')
+c1 = DiagramComponent(id='c1', name='Component 1')
 c1.parent = tz1
-c2 = MagicMock(id='c2')
+c2 = DiagramComponent(id='c2', name='Component 2')
 c2.parent = c1
-c3 = MagicMock(id='c3')
+c3 = DiagramComponent(id='c3', name='3')
 c3.parent = None
-c4 = MagicMock(id='c4')
+c4 = DiagramComponent(id='c4', name='Component 4')
 
 
 diagram_components = [tz1, c1, c2, c3, c4]
@@ -53,17 +55,20 @@ def test_to_otm(self):
         assert components[0].id == 'c1'
         assert components[0].type == 'type-1'
         assert components[0].parent == 'tz1'
+        assert components[0].name == c1.name
 
         assert components[1].id == 'c2'
         assert components[1].type == 'type-2'
         assert components[1].parent == 'c1'
+        assert components[1].name == c2.name
 
         assert components[2].id == 'c3'
         assert components[2].type == 'type-3'
         assert components[2].parent == default_trustzone.id
+        assert components[2].name == f"_{c3.name}"
 
     def test_not_default_trustzone(self):
-        # GIVEN the diagram component mapper without default trustzone
+        # GIVEN the diagram component mapper without a default trustzone
         diagram_component_mapper = DiagramComponentMapper(
             diagram_components,
             component_mappings,
@@ -72,15 +77,11 @@ def test_not_default_trustzone(self):
             representation_calculator
         )
 
-        # WHEN to_otm is called an exception is raised
+        # WHEN to_otm is called, expect an exception
         with pytest.raises(MappingFileNotValidError) as error:
             diagram_component_mapper.to_otm()
 
-        # THEN the exception is raised
+        # THEN an exception is raised
         assert error.value.title == 'Mapping files are not valid'
         assert error.value.detail == 'No default trust zone has been defined in the mapping file'
-        assert error.value.message == 'Please, add a default trust zone'
-
-
-
-
+        assert error.value.message == 'Please, add a default trust zone'