feat(DeploymentView): add serialisation/deserialisation support

Author: yt-ms

src/structurizr/view/deployment_view.py

@@ -16,7 +16,7 @@
 Used to show the mapping of container instances to deployment nodes.
 """
 
-from typing import Iterable, Optional, Union
+from typing import Iterable, List, Optional, Union
 
 from ..mixin.model_ref_mixin import ModelRefMixin
 from ..model.container_instance import ContainerInstance
@@ -26,17 +26,25 @@
 from ..model.relationship import Relationship
 from ..model.software_system_instance import SoftwareSystemInstance
 from ..model.static_structure_element import StaticStructureElement
-from .animation import Animation
-from .view import View
+from .animation import Animation, AnimationIO
+from .view import View, ViewIO
 
 
 __all__ = ("DeploymentView", "DeploymentViewIO")
 
 
-class DeploymentViewIO:
-    """Represent a deployment view."""
+class DeploymentViewIO(ViewIO):
+    """
+    Represent a deployment view.
+
+    Attributes:
+        environment: the name of the environment that this deployment view is for
+                     (e.g. "Development", "Live", etc.)
+        animations: the set of animation steps (optional)
+    """
 
-    pass
+    environment: Optional[str] = None
+    animations: List[AnimationIO] = []
 
 
 class DeploymentView(ModelRefMixin, View):
@@ -236,3 +244,12 @@ def _find_deployment_node(self, element: Element) -> DeploymentNode:
     def animations(self) -> Iterable[Animation]:
         """Return the animations for this view."""
         return list(self._animations)
+
+    @classmethod
+    def hydrate(cls, deployment_view_io: DeploymentViewIO) -> "DeploymentView":
+        """Hydrate a new DeploymentView instance from its IO."""
+        return cls(
+            environment=deployment_view_io.environment,
+            animations=map(Animation.hydrate, deployment_view_io.animations),
+            **cls.hydrate_arguments(deployment_view_io),
+        )

src/structurizr/view/view_set.py

@@ -26,7 +26,7 @@
 from .component_view import ComponentView, ComponentViewIO
 from .configuration import Configuration, ConfigurationIO
 from .container_view import ContainerView, ContainerViewIO
-from .deployment_view import DeploymentView
+from .deployment_view import DeploymentView, DeploymentViewIO
 from .system_context_view import SystemContextView, SystemContextViewIO
 from .system_landscape_view import SystemLandscapeView, SystemLandscapeViewIO
 from .view import View
@@ -55,6 +55,9 @@ class ViewSetIO(BaseModel):
     configuration: ConfigurationIO
     container_views: List[ContainerViewIO] = Field(default=(), alias="containerViews")
     component_views: List[ComponentViewIO] = Field(default=(), alias="componentViews")
+    deployment_views: List[DeploymentViewIO] = Field(
+        default=(), alias="deploymentViews"
+    )
 
     # TODO:
     # dynamic_views: List[DynamicView] = Field(set(), alias="dynamicViews")
@@ -129,6 +132,12 @@ def hydrate(cls, views: ViewSetIO, model: "Model") -> "ViewSet":
             cls._hydrate_view(view, model=model)
             component_views.append(view)
 
+        deployment_views = []
+        for view_io in views.deployment_views:
+            view = DeploymentView.hydrate(view_io)
+            cls._hydrate_view(view, model=model)
+            deployment_views.append(view)
+
         return cls(
             model=model,
             # TODO:
@@ -137,6 +146,7 @@ def hydrate(cls, views: ViewSetIO, model: "Model") -> "ViewSet":
             system_context_views=system_context_views,
             container_views=container_views,
             component_views=component_views,
+            deployment_views=deployment_views,
             configuration=Configuration.hydrate(views.configuration),
         )
 

tests/unit/view/test_deployment_view.py

@@ -17,7 +17,7 @@
 
 from structurizr import Workspace
 from structurizr.model import SoftwareSystem
-from structurizr.view.deployment_view import DeploymentView
+from structurizr.view.deployment_view import DeploymentView, DeploymentViewIO
 
 
 @pytest.fixture(scope="function")
@@ -427,3 +427,41 @@ def test_deployment_view_removing_parent_deployment_node(empty_workspace: Worksp
 
     deployment_view.remove(parent_deployment_node)
     assert len(deployment_view.element_views) == 0
+
+
+def test_deployment_view_hydration(empty_workspace: Workspace):
+    """Test round-tripping via the DeploymentViewIO instance."""
+    model = empty_workspace.model
+    views = empty_workspace.views
+
+    software_system = model.add_software_system("Software System")
+    web_application = software_system.add_container("Web Application")
+    database = software_system.add_container("Database")
+    web_application.uses(database, "Reads from and writes to", "JDBC/HTTPS")
+
+    developer_laptop = model.add_deployment_node("Developer Laptop")
+    apache_tomcat = developer_laptop.add_deployment_node("Apache Tomcat")
+    oracle = developer_laptop.add_deployment_node("Oracle")
+    web_application_instance = apache_tomcat.add_container(web_application)
+    database_instance = oracle.add_container(database)
+
+    deployment_view = views.create_deployment_view(
+        software_system=software_system,
+        key="deployment",
+        description="Description",
+        environment="Live",
+    )
+    deployment_view += developer_laptop
+    assert len(deployment_view.element_views) == 5
+
+    deployment_view.add_animation(web_application_instance)
+    deployment_view.add_animation(database_instance)
+
+    io = DeploymentViewIO.from_orm(deployment_view)
+    assert io.environment == "Live"
+    assert len(io.animations) == 2
+
+    new_deployment_view = DeploymentView.hydrate(io)
+    assert len(new_deployment_view.element_views) == 5
+    assert new_deployment_view.environment == deployment_view.environment
+    assert len(new_deployment_view.animations) == len(deployment_view.animations)