feat: add ContainerInstances to DeploymentNodes

Author: yt-ms

src/structurizr/model/container_instance.py

@@ -29,6 +29,7 @@
 
 if TYPE_CHECKING:
     from .container import Container
+    from .deployment_node import DeploymentNode
     from .model import Model
 
 
@@ -60,6 +61,7 @@ def hydrate(
         cls,
         container_instance_io: ContainerInstanceIO,
         model: "Model",
+        parent: "DeploymentNode",
     ) -> "ContainerInstance":
         """Hydrate a new ContainerInstance instance from its IO.
 
@@ -69,6 +71,7 @@ def hydrate(
         instance = cls(
             **cls.hydrate_arguments(container_instance_io),
             container=container,
+            parent=parent,
         )
         model += instance
         return instance

src/structurizr/model/deployment_node.py

@@ -19,8 +19,10 @@
 
 from pydantic import Field
 
+from .container import Container
 from .container_instance import ContainerInstance, ContainerInstanceIO
 from .deployment_element import DeploymentElement, DeploymentElementIO
+from .infrastructure_node import InfrastructureNode, InfrastructureNodeIO
 from .software_system_instance import SoftwareSystemInstance, SoftwareSystemInstanceIO
 
 
@@ -63,6 +65,9 @@ class Config:
     software_system_instances: List[SoftwareSystemInstanceIO] = Field(
         default=(), alias="softwareSystemInstances"
     )
+    infrastructure_nodes: List[InfrastructureNodeIO] = Field(
+        default=(), alias="infrastructureNodes"
+    )
 
 
 DeploymentNodeIO.update_forward_refs()
@@ -94,6 +99,7 @@ def __init__(
         children: Iterable["DeploymentNode"] = (),
         container_instances: Iterable[ContainerInstance] = (),
         software_system_instances: Iterable[SoftwareSystemInstance] = (),
+        infrastructure_nodes: Iterable[InfrastructureNode] = (),
         **kwargs,
     ) -> None:
         """Initialize a deployment node."""
@@ -104,6 +110,7 @@ def __init__(
         self._children = set(children)
         self._container_instances = set(container_instances)
         self._software_system_instances = set(software_system_instances)
+        self._infrastructure_nodes = set(infrastructure_nodes)
 
     @property
     def children(self) -> Iterable["DeploymentNode"]:
@@ -120,12 +127,48 @@ def software_system_instances(self) -> Iterable[SoftwareSystemInstance]:
         """Return read-only list of software system instances."""
         return list(self._software_system_instances)
 
+    @property
+    def infrastructure_nodes(self) -> Iterable[InfrastructureNode]:
+        """Return read-only list of infrastructure nodes."""
+        return list(self._infrastructure_nodes)
+
     def add_deployment_node(self, **kwargs) -> "DeploymentNode":
         """Add a new child deployment node to this node."""
         node = DeploymentNode(**kwargs)
         self += node
         return node
 
+    def add_container_instance(
+        self, container: Container, *, replicate_relationships: bool
+    ) -> ContainerInstance:
+        """
+        Create a new instance of the given container.
+
+        Args:
+            container(Container): the Container to add an instance of.
+            replicate_relationships: True if relationships should be replicated between
+                                     the element instances in the same deployment
+                                     environment, False otherwise.
+        """
+        instance_id = (
+            max(
+                [
+                    c.instance_id
+                    for c in self.container_instances
+                    if c.container is container
+                ],
+                default=0,
+            )
+            + 1
+        )
+        instance = ContainerInstance(
+            container=container, instance_id=instance_id, parent=self
+        )
+        self._container_instances.add(instance)
+        model = self.model
+        model += instance
+        return instance
+
     def __iadd__(self, node: "DeploymentNode") -> "DeploymentNode":
         """Add a newly constructed chile deployment node to this node."""
         if node in self._children:
@@ -161,13 +204,17 @@ def hydrate(
         This will also automatically register with the model.
         """
         node = cls(
-            parent=parent,
             **cls.hydrate_arguments(deployment_node_io),
+            parent=parent,
         )
         model += node
 
         for child_io in deployment_node_io.children:
             child_node = DeploymentNode.hydrate(child_io, model=model, parent=node)
             node += child_node
 
+        for instance_io in deployment_node_io.container_instances:
+            instance = ContainerInstance.hydrate(instance_io, model=model, parent=node)
+            node._container_instances.add(instance)
+
         return node

src/structurizr/model/static_structure_element_instance.py

@@ -47,6 +47,7 @@ def __init__(
         element: StaticStructureElement,
         instance_id: int,
         health_checks: Iterable["HTTPHealthCheck"] = (),
+        parent: "DeploymentNode" = None,
         **kwargs
     ) -> None:
         """Initialize a StaticStructureElementInstance."""
@@ -56,6 +57,7 @@ def __init__(
         super().__init__(**kwargs)
         self.instance_id = instance_id
         self.health_checks = set(health_checks)
+        self.parent = parent
 
     @classmethod
     def hydrate_arguments(cls, instance_io: StaticStructureElementInstanceIO) -> dict:

tests/unit/model/test_container_instance.py

@@ -87,7 +87,7 @@ def test_container_instance_hydration_retrieves_container_from_id(model_with_con
     """Check that the container instance is retrieved from the model on hydration."""
     io = ContainerInstanceIO(container_id="19", instance_id=3, environment="Live")
 
-    instance = ContainerInstance.hydrate(io, model_with_container)
+    instance = ContainerInstance.hydrate(io, model_with_container, parent=None)
 
     assert instance.instance_id == 3
     assert instance.environment == "Live"
@@ -99,7 +99,7 @@ def test_container_instance_name_is_container_name(model_with_container):
     """Ensure container instance takes its name from its container."""
     io = ContainerInstanceIO(container_id="19", instance_id=3, environment="Live")
 
-    instance = ContainerInstance.hydrate(io, model_with_container)
+    instance = ContainerInstance.hydrate(io, model_with_container, parent=None)
 
     assert instance.name == "Mock Container"
 
@@ -114,7 +114,7 @@ def test_container_instance_hyrdates_http_health_checks(model_with_container):
         health_checks=[health_check_io],
     )
 
-    instance = ContainerInstance.hydrate(io, model_with_container)
+    instance = ContainerInstance.hydrate(io, model_with_container, parent=None)
 
     assert len(instance.health_checks) == 1
     assert list(instance.health_checks)[0].name == "name"

tests/unit/model/test_deployment_node.py

@@ -26,6 +26,7 @@ def __init__(self):
         """Initialize the mock, creating an empty node for tests."""
         self.empty_node = DeploymentNode(name="Empty")
         self.empty_node.set_model(self)
+        self.mock_element = MockElement("element")
 
     def __iadd__(self, node):
         """Simulate the model assigning IDs to new elements."""
@@ -34,6 +35,20 @@ def __iadd__(self, node):
         node.set_model(self)
         return self
 
+    def get_element(self, id: str):
+        """Simulate getting an element by ID."""
+        assert id == self.mock_element.id
+        return self.mock_element
+
+
+class MockElement:
+    """Implement a mock element for testing."""
+
+    def __init__(self, name: str):
+        """Initialise the mock."""
+        self.name = name
+        self.id = name
+
 
 @pytest.fixture(scope="function")
 def model_with_node() -> MockModel:
@@ -108,3 +123,44 @@ def test_deployment_node_serialization_of_recursive_nodes(model_with_node):
     assert new_child.name == "child"
     assert new_child.parent is new_top_node
     assert new_child.model is model_with_node
+
+
+def test_deployment_node_add_container(model_with_node):
+    """Test adding a container to a node to create an instance."""
+    node = model_with_node.empty_node
+    container = MockElement("element")
+
+    instance = node.add_container_instance(container, replicate_relationships=False)
+
+    assert instance.container is container
+    assert instance.model is model_with_node
+    assert instance.parent is node
+    assert instance in node.container_instances
+    assert instance.instance_id == 1
+
+
+def test_deployment_node_serialising_container(model_with_node):
+    """Test serialisation and deserialisation includes container instances."""
+    node = model_with_node.empty_node
+    container = model_with_node.mock_element
+    node.add_container_instance(container, replicate_relationships=False)
+
+    io = DeploymentNodeIO.from_orm(node)
+
+    assert len(io.container_instances) == 1
+    assert io.container_instances[0].id == "id"
+
+    node2 = DeploymentNode.hydrate(io, model_with_node)
+
+    assert len(node2.container_instances) == 1
+    instance = node2.container_instances[0]
+    assert instance.instance_id == 1
+    assert instance.container is container
+    assert instance.model is model_with_node
+    assert instance.parent is node2
+
+
+@pytest.mark.xfail(strict=True)
+def test_deployment_node_adding_container_replicating_relationships(model_with_node):
+    """Test replicating relationships when adding a container instance."""
+    raise AssertionError()  # Not implemented yet