test(DeploymentView): improve code coverage

Author: yt-ms

src/structurizr/view/deployment_view.py

@@ -20,8 +20,8 @@
 
 from ..mixin.model_ref_mixin import ModelRefMixin
 from ..model.container_instance import ContainerInstance
+from ..model.deployment_element import DeploymentElement
 from ..model.deployment_node import DeploymentNode
-from ..model.element import Element
 from ..model.infrastructure_node import InfrastructureNode
 from ..model.relationship import Relationship
 from ..model.software_system_instance import SoftwareSystemInstance
@@ -205,9 +205,7 @@ def add_animation(
                     deployment_node = deployment_node.parent
 
         if element_ids_in_this_step == set():
-            raise ValueError(
-                "None of the specified container instances exist in this view."
-            )
+            raise ValueError("None of the specified instances exist in this view.")
 
         for relationship_view in self.relationship_views:
             relationship = relationship_view.relationship
@@ -228,13 +226,14 @@ def add_animation(
             )
         )
 
-    def _find_deployment_node(self, element: Element) -> DeploymentNode:
+    def _find_deployment_node(self, element: DeploymentElement) -> DeploymentNode:
         all_deployment_nodes = [
             e for e in self.model.get_elements() if isinstance(e, DeploymentNode)
         ]
         for node in all_deployment_nodes:
             if (
                 element in node.container_instances
+                or element in node.software_system_instances
                 or element in node.infrastructure_nodes
             ):
                 return node

tests/unit/view/test_deployment_view.py

@@ -17,6 +17,7 @@
 
 from structurizr import Workspace
 from structurizr.model import SoftwareSystem
+from structurizr.model.container_instance import ContainerInstance
 from structurizr.view.deployment_view import DeploymentView, DeploymentViewIO
 
 
@@ -224,6 +225,22 @@ def test_deployment_view_add_relationship(empty_workspace: Workspace):
     assert len(deployment_view.relationship_views) == 1
 
 
+def test_deployment_view_adding_system_instance(empty_workspace: Workspace):
+    """Test that `SoftwareSystemInstance` is supported within deployment view."""
+    model = empty_workspace.model
+    software_system = model.add_software_system("Software System")
+    deployment_node = model.add_deployment_node("Deployment Node")
+    software_system_instance = deployment_node.add_software_system(software_system)
+
+    deployment_view = empty_workspace.views.create_deployment_view(
+        software_system=software_system, key="deployment", description="Description"
+    )
+    deployment_view.add_default_elements()
+
+    views = deployment_view.element_views
+    assert any([x.element is software_system_instance for x in views])
+
+
 def test_add_animation_step_raises_if_no_elements(empty_workspace: Workspace):
     """Check error handling if no elements passed."""
     deployment_view = empty_workspace.views.create_deployment_view(
@@ -233,6 +250,26 @@ def test_add_animation_step_raises_if_no_elements(empty_workspace: Workspace):
         deployment_view.add_animation()
 
 
+def test_deployment_view_find_deployment_node(empty_workspace: Workspace):
+    """Test _find_deployment_node."""
+    model = empty_workspace.model
+    software_system = model.add_software_system("Software System")
+    container1 = software_system.add_container("Container 1")
+    node1 = model.add_deployment_node("Deployment Node 1")
+    container_instance1 = node1.add_container(container1)
+    container2 = software_system.add_container("Container 2")
+    container_instance2 = ContainerInstance(container=container2, instance_id=1)
+    # Explicitly we don't add container_instance2 to a deployment node
+
+    deployment_view = empty_workspace.views.create_deployment_view(
+        software_system=software_system, key="deployment", description="Description"
+    )
+    deployment_view += node1
+
+    assert deployment_view._find_deployment_node(container_instance1) is node1
+    assert deployment_view._find_deployment_node(container_instance2) is None
+
+
 def test_add_animation_step(empty_workspace: Workspace):
     """Check happy path."""
     model = empty_workspace.model