test: more testing around adding relationships

Author: yt-ms

tests/integration/test_model_element_relationships.py

@@ -16,11 +16,17 @@
 See https://github.com/Midnighter/structurizr-python/issues/31.
 """
 
+from pathlib import Path
+
 import pytest
 
+from structurizr import Workspace
 from structurizr.model import Model
 
 
+DEFINITIONS = Path(__file__).parent / "data" / "workspace_definition"
+
+
 @pytest.mark.xfail(strict=True)
 def test_adding_relationship_to_element_adds_to_model():
     """
@@ -31,15 +37,31 @@ def test_adding_relationship_to_element_adds_to_model():
     sys1 = model.add_software_system(name="sys1")
     sys2 = model.add_software_system(name="sys2")
 
-    sys1.add_relationship(source=sys1, destination=sys2, description="uses")
-    assert len(sys1.relationships) == 1
-    assert len(list(sys1.get_relationships())) == 1  # Currently will fail
-    assert len(model.get_relationships()) == 1  # Currently will fail
-    assert len(sys2.relationships) == 1  # Currently will fail
-    assert len(list(sys2.get_relationships())) == 1  # Currently will fail
+    r = sys1.add_relationship(source=sys1, destination=sys2, description="uses")
+    assert list(sys1.relationships) == [r]
+    assert list(sys1.get_relationships()) == [r]  # Currently will fail
+    assert list(model.get_relationships()) == [r]  # Currently will fail
+    assert list(sys2.relationships) == []  # relationships only contains outbound
+    assert list(sys2.get_relationships()) == [r]  # Currently will fail
+
+
+def test_adding_relationship_to_model_adds_to_element():
+    """
+    Make sure that when a relationship is added via Element.add_relationship it also
+    gets added to the model and to the other element.
+    """
+    model = Model()
+    sys1 = model.add_software_system(name="sys1")
+    sys2 = model.add_software_system(name="sys2")
+
+    r = model.add_relationship(source=sys1, destination=sys2, description="uses")
+    assert list(sys1.relationships) == [r]
+    assert list(sys1.get_relationships()) == [r]
+    assert list(model.get_relationships()) == [r]
+    assert list(sys2.relationships) == []  # relationships only contains outbound
+    assert list(sys2.get_relationships()) == [r]
 
 
-@pytest.mark.xfail(strict=True)
 def test_adding_relationship_via_uses_adds_to_elements():
     """
     Make sure that when a relationship is added via StaticStructureElement.uses
@@ -49,9 +71,32 @@ def test_adding_relationship_via_uses_adds_to_elements():
     sys1 = model.add_software_system(name="sys1")
     sys2 = model.add_software_system(name="sys2")
 
-    sys1.uses(sys2, "uses")
-    assert len(sys1.relationships) == 1
-    assert len(list(sys1.get_relationships())) == 1
-    assert len(model.get_relationships()) == 1
-    assert len(sys2.relationships) == 1  # Currently will fail
-    assert len(list(sys2.get_relationships())) == 1
+    r = sys1.uses(sys2, "uses")
+    assert list(sys1.relationships) == [r]
+    assert list(sys1.get_relationships()) == [r]
+    assert list(model.get_relationships()) == [r]
+    assert list(sys2.relationships) == []  # relationships only contains outbound
+    assert list(sys2.get_relationships()) == [r]
+
+
+@pytest.mark.parametrize(
+    "filename",
+    ["BigBank.json"],
+)
+def test_relationships_after_deserialisation_are_consistent(filename):
+    """Make sure that relationships are consistent between the Model and the Element after deserialisation."""
+    path = DEFINITIONS / filename
+    workspace = Workspace.load(path)
+    model = workspace.model
+    atm = model.get_software_system_with_id("9")
+    mainframe = model.get_software_system_with_id("4")
+    customer = model.get_element("1")
+
+    assert len(atm.relationships) == 1
+    assert (
+        len(list(atm.get_relationships())) == 2
+    )  # One to mainframe, one from personal banking customer
+    assert len(list(atm.get_afferent_relationships())) == 1
+    assert list(atm.get_afferent_relationships())[0].source is customer
+    assert len(list(atm.get_efferent_relationships())) == 1
+    assert list(atm.get_efferent_relationships())[0].destination is mainframe