fix(View): support blank descriptions in diagrams from the Structuriz…

…r UI (issue #40)
Midnighter · Dec 27, 2020 · b5d7f05 · b5d7f05
1 parent f92e98f
commit b5d7f05
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,7 @@ History
 Next Release
 ------------
 * Fix: Don't duplicate relationships if ``add_nearest_neighbours()`` called twice (#63)
+* Fix: Support blank diagrams descriptions from the Structurizr UI (#40)
 
 0.3.0 (2020-11-29)
 ------------------

diff --git a/src/structurizr/view/view.py b/src/structurizr/view/view.py
@@ -42,7 +42,7 @@ class ViewIO(BaseModel, ABC):
     """
 
     key: str
-    description: str
+    description: str = ""
     software_system_id: Optional[str] = Field(default=None, alias="softwareSystemId")
     paper_size: Optional[PaperSize] = Field(default=None, alias="paperSize")
     automatic_layout: Optional[AutomaticLayoutIO] = Field(

diff --git a/tests/unit/view/test_view.py b/tests/unit/view/test_view.py
@@ -15,8 +15,6 @@
 
 """Ensure the expected behaviour of View."""
 
-import pytest
-
 from structurizr.model import Model
 from structurizr.view.view import View, ViewIO
 
@@ -82,7 +80,6 @@ def test_adding_all_relationships():
     assert rel2 in [vr.relationship for vr in view.relationship_views]
 
 
-@pytest.mark.xfail(strict=True)
 def test_missing_json_description_allowed():
     """
     Ensure that missing descriptions in the JSON form are supported.
@@ -98,4 +95,5 @@ def test_missing_json_description_allowed():
         "key": "System1-SystemContext"
     }
     """
-    ViewIO.parse_raw(json)  # Fails as description is missing
+    io = ViewIO.parse_raw(json)
+    assert io is not None