feat(DeploymentNode): add uses() for relationships between nodes

Author: yt-ms

src/structurizr/model/deployment_node.py

@@ -24,6 +24,7 @@
 from .deployment_element import DeploymentElement, DeploymentElementIO
 from .element import Element
 from .infrastructure_node import InfrastructureNode, InfrastructureNodeIO
+from .relationship import Relationship
 from .software_system import SoftwareSystem
 from .software_system_instance import SoftwareSystemInstance, SoftwareSystemInstanceIO
 
@@ -255,6 +256,22 @@ def __iadd__(
             self._add_child_deployment_node(child)
         return self
 
+    def uses(
+        self,
+        destination: "DeploymentNode",
+        description: str = "Uses",
+        technology: str = "",
+        **kwargs,
+    ) -> Optional["Relationship"]:
+        """Add a relationship between this and another deployment node."""
+        return self.model.add_relationship(
+            source=self,
+            destination=destination,
+            description=description,
+            technology=technology,
+            **kwargs,
+        )
+
     def _add_infrastructure_node(self, infra_node: InfrastructureNode):
         """Add a new infrastructure node."""
         self._infrastructure_nodes.add(infra_node)

tests/unit/model/test_deployment_node.py

@@ -16,7 +16,7 @@
 
 import pytest
 
-from structurizr.model import Container, SoftwareSystem
+from structurizr.model import Container, Relationship, SoftwareSystem
 from structurizr.model.deployment_node import DeploymentNode, DeploymentNodeIO
 from structurizr.model.infrastructure_node import InfrastructureNode
 
@@ -46,6 +46,9 @@ def get_elements(self):
         """Simulate get_elements."""
         return []
 
+    def add_relationship(self, **kwargs):
+        return Relationship(**kwargs)
+
 
 class MockElement:
     """Implement a mock element for testing."""
@@ -256,3 +259,15 @@ def test_deployment_node_serialising_infrastructure_nodes(model_with_node):
     infra_node = node2.infrastructure_nodes[0]
     assert infra_node.name == "infraNode"
     assert infra_node.parent is node2
+
+
+def test_deployment_node_uses_adds_relationship(model_with_node):
+    node1 = model_with_node.empty_node
+    node2 = DeploymentNode(name="node2")
+    node2.set_model(model_with_node)
+    rel = node1.uses(node2, "Replicates data to", technology="Some tech")
+
+    assert rel.source is node1
+    assert rel.destination is node2
+    assert rel.description == "Replicates data to"
+    assert rel.technology == "Some tech"