added tests for new __repr__() implementation. see notes under __repr…

…__() in ModelElement class

sysml/element.py

@@ -32,6 +32,13 @@ def __init__(self, name=None):
         self._uuid = str(_uuid.uuid1())
 
     def __repr__(self):
+        # Needs to be rewritten, such that it returns a long formatted string
+        # by default, but a shorter formatted string when called from within a
+        # dictionary. See tests/test_model.py (line 162 & 245)
+        # A decorator seems to make the most sense for implementing this.
+        # Suggestion for returning long formatted string element, use
+        # hasattr(), as not all model elements will share the same attributes
+        # (e.g., parts, references, values, etc.)
         return "{} {}".format(self.stereotype, self.name)
 
     @_abstractproperty

tests/test_model.py

@@ -13,8 +13,8 @@ def model():
 
 
 def test_model(model):
-    assert repr(model) == "\xabmodel\xbb Constitution-class Starship"
-    assert repr(type(model)) == "<class 'sysml.system.Model'>"
+    # assert repr(model) == "\xabmodel\xbb Constitution-class Starship"
+    # assert repr(type(model)) == "<class 'sysml.system.Model'>"
 
     assert model.stereotype == "\xabmodel\xbb"
 
@@ -28,7 +28,7 @@ def test_model(model):
 
 def test_valueType():
     kesselrun = sysml.ValueType(12, 'parsec')
-    assert repr(kesselrun) == "\xabvalueType\xbb 12 parsec"
+    # assert repr(kesselrun) == "\xabvalueType\xbb 12 parsec"
     assert kesselrun.magnitude == 12
     assert kesselrun.units == 'parsec'
     assert kesselrun.name == '12 parsec'
@@ -57,7 +57,7 @@ def test_valueType():
     assert round(distToProximaCentari.magnitude, 3) == 1.301
     assert distToProximaCentari.units == 'parsec'
     # isDroidsWeAreLookingFor = sysml.ValueType(False)
-    # assert repr(isDroidsWeAreLookingFor) == "\xabvalueType\xbb False bool"
+    # # assert repr(isDroidsWeAreLookingFor) == "\xabvalueType\xbb False bool"
     # assert isDroidsWeAreLookingFor.magnitude is False
     # assert isDroidsWeAreLookingFor.units == 'dimensionless'
     # assert isDroidsWeAreLookingFor.name == 'False bool'
@@ -81,25 +81,6 @@ def test_valueType():
         assert "is not defined in the unit registry" in str(info.value)
 
 
-def test_block(model):
-    """Add block elements to package objects using built-in add_part()
-    method"""
-
-    starship_block = sysml.Block('Constitution-class Starship')
-
-    assert repr(starship_block) == "\xabblock\xbb Constitution-class Starship"
-    assert repr(type(starship_block)) == "<class 'sysml.element.Block'>"
-    assert uuid.UUID(starship_block.uuid, version=1)
-    assert starship_block.multiplicity == 1
-
-    with pytest.raises(AttributeError) as info:
-        starship_block.uuid = 47
-        assert "can't set attribute" in str(info.value)
-    with pytest.raises(AttributeError) as info:
-        starship_block.uuid = "47"
-        assert "can't set attribute" in str(info.value)
-
-
 def test_package(model):
     """Create a package, labeled 'Structure', within model which will serve as
     namespace for the system structure
@@ -120,10 +101,10 @@ def test_package(model):
 
     model.add('holodeck', holodeck)
 
-    assert repr(model['holodeck']) == "\xabpackage\xbb Holodeck"
-    assert repr(type(model['holodeck'])) == package_type
+    # assert repr(model['holodeck']) == "\xabpackage\xbb Holodeck"
+    # assert repr(type(model['holodeck'])) == package_type
     assert uuid.UUID(model['holodeck'].uuid, version=1)
-    assert repr(model.elements) == "{'holodeck': \xabpackage\xbb Holodeck}"
+    # assert repr(model.elements) == "{'holodeck': \xabpackage\xbb Holodeck}"
 
     model.remove('holodeck')
 
@@ -145,8 +126,8 @@ def test_package(model):
 
     assert starship_block is model['structure']['starship']
 
-    assert repr(model['structure']) == "\xabpackage\xbb structure"
-    assert repr(type(model['structure'])) == package_type
+    # assert repr(model['structure']) == "\xabpackage\xbb structure"
+    # assert repr(type(model['structure'])) == package_type
     assert uuid.UUID(model['structure'].uuid, version=1)
 
     with pytest.raises(AttributeError) as info:
@@ -157,6 +138,38 @@ def test_package(model):
         assert "can't set attribute" in str(info.value)
 
 
+def test_block(model):
+    """Add block elements to package objects using built-in add_part()
+    method"""
+
+    starship_block = sysml.Block('Constitution-class Starship')
+
+    assert starship_block.name == "Constitution-class Starship"
+    assert starship_block.stereotype == "\xabblock\xbb"
+    assert starship_block.multiplicity == 1
+    assert uuid.UUID(starship_block.uuid, version=1)
+
+    l1 = "name: Constitution-class Starship\n"
+    l2 = "stereotype: \xabblock\xbb\n"
+    l3 = "parts: []\n"
+    l4 = "references: []\n"
+    l5 = "values: []\n"
+    l6 = "constraints: []\n"
+    l7 = "flows: []\n"
+    l8 = "multiplicity: {}\n".format(starship_block.multiplicity)
+    l9 = "uuid: {}".format(starship_block.uuid)
+
+    # assert repr(starship_block) == l1+l2+l3+l4+l5+l6+l7+l8+l9
+    assert repr(type(starship_block)) == "<class 'sysml.element.Block'>"
+
+    with pytest.raises(AttributeError) as info:
+        starship_block.uuid = 47
+        assert "can't set attribute" in str(info.value)
+    with pytest.raises(AttributeError) as info:
+        starship_block.uuid = "47"
+        assert "can't set attribute" in str(info.value)
+
+
 @pytest.mark.skip('Deprecated')
 def test_block_stereotype():
     """Test block stereotype"""
@@ -181,11 +194,10 @@ def test_block_partProperty(model):
     Parts added to a block element are dictionary-callable via the 'parts'
     attribute"""
 
-    starship_block = model['structure']['starship']
+    starship_block = sysml.Block('Constitution-class Starship')
 
     starship_block.add_part('saucer section', sysml.Block('Primary Hull'))
-    starship_block['engineering'] = sysml.Block('Engineering Hull')
-    starship_block.add_part('cloak', sysml.Block('Cloaking device'))
+    starship_block['engineering'] = sysml.Block('Secondary Hull')
 
     with pytest.raises(TypeError) as info:
         starship_block.add_part()
@@ -209,23 +221,37 @@ def test_block_partProperty(model):
 
     primaryhull = starship_block.parts['saucer section']
     engineeringhull = starship_block.parts['engineering']
-    cloaking_device = starship_block.parts['cloak']
 
-    assert primaryhull == starship_block['saucer section']
-    assert engineeringhull == starship_block['engineering']
-    assert cloaking_device == starship_block['cloak']
+    assert primaryhull is starship_block['saucer section']
+    assert engineeringhull is starship_block['engineering']
+
+    assert starship_block.name == "Constitution-class Starship"
+    assert starship_block.stereotype == "\xabblock\xbb"
+    assert starship_block.multiplicity == 1
+    assert uuid.UUID(starship_block.uuid, version=1)
 
-    assert repr(primaryhull) == "\xabblock\xbb Primary Hull"
-    assert repr(engineeringhull) == "\xabblock\xbb Engineering Hull"
-    assert repr(cloaking_device) == "\xabblock\xbb Cloaking device"
+    l1 = "name: Constitution-class Starship\n"
+    l2 = "stereotype: \xabblock\xbb\n"
+    l3 = "parts: \n"
+    l4 = "\tsaucer section: \xabblock\xbb Primary Hull\n"
+    l5 = "\tengineering: \xabblock\xbb Secondary Hull\n"
+    l6 = "references: []\n"
+    l7 = "values: []\n"
+    l8 = "constraints: []\n"
+    l9 = "flows: []\n"
+    l10 = "multiplicity: {}\n".format(starship_block.multiplicity)
+    l11 = "uuid: {}".format(starship_block.uuid)
+
+    # assert repr(starship_block) == l1 + l2+l3+l4+l5+l6+l7+l8+l9+l10+l11
+    assert repr(type(starship_block)) == "<class 'sysml.element.Block'>"
 
     assert repr(type(primaryhull)) == "<class 'sysml.element.Block'>"
     assert repr(type(engineeringhull)) == "<class 'sysml.element.Block'>"
-    assert repr(type(cloaking_device)) == "<class 'sysml.element.Block'>"
-
     assert uuid.UUID(primaryhull.uuid, version=1)
     assert uuid.UUID(engineeringhull.uuid, version=1)
 
+    starship_block.add_part('cloak', sysml.Block('Cloaking device'))
+    cloaking_device = starship_block.parts['cloak']
     starship_block.remove_part('cloak')
 
     with pytest.raises(KeyError) as info:
@@ -267,11 +293,11 @@ def test_block_partProperty_withMultiplicity(model):
     nacelle = starship_block.parts['nacelle']
     pylon = starship_block.parts['pylons']
 
-    assert repr(nacelle) == "\xabblock\xbb Nacelle"
-    assert repr(pylon) == "\xabblock\xbb Pylon"
+    # assert repr(nacelle) == "\xabblock\xbb Nacelle"
+    # assert repr(pylon) == "\xabblock\xbb Pylon"
 
-    assert repr(type(nacelle)) == "<class 'sysml.element.Block'>"
-    assert repr(type(pylon)) == "<class 'sysml.element.Block'>"
+    # assert repr(type(nacelle)) == "<class 'sysml.element.Block'>"
+    # assert repr(type(pylon)) == "<class 'sysml.element.Block'>"
 
     assert nacelle.multiplicity == 2
     assert pylon.multiplicity == 2
@@ -324,8 +350,8 @@ def test_requirements(model):
 
     package_type = "<class 'sysml.element.Package'>"
 
-    assert repr(model['requirements']) == "\xabpackage\xbb Requirements"
-    assert repr(type(model['requirements'])) == package_type
+    # assert repr(model['requirements']) == "\xabpackage\xbb Requirements"
+    # assert repr(type(model['requirements'])) == package_type
 
     assert uuid.UUID(model['requirements'].uuid, version=1)
 
@@ -354,12 +380,12 @@ def test_requirements(model):
 
     assert top_lvl_req is model['requirements']['top-level']
     assert functional_req is model['requirements']['functional']
-    assert repr(top_lvl_req) == "\xabrequirement\xbb Top-level"
-    assert repr(functional_req) == "\xabrequirement\xbb Functional"
+    # assert repr(top_lvl_req) == "\xabrequirement\xbb Top-level"
+    # assert repr(functional_req) == "\xabrequirement\xbb Functional"
 
     requirement_type = "<class 'sysml.element.Requirement'>"
-    assert repr(type(top_lvl_req)) == requirement_type
-    assert repr(type(functional_req)) == requirement_type
+    # assert repr(type(top_lvl_req)) == requirement_type
+    # assert repr(type(functional_req)) == requirement_type
 
     assert top_lvl_req.stereotype == "\xabrequirement\xbb"
 
@@ -389,16 +415,16 @@ def test_derive_requirement(model):
 
     assert deriveReqt is model['requirements']['deriveReqt1']
 
-    assert repr(deriveReqt.client) == "\xabrequirement\xbb Functional"
-    assert repr(deriveReqt.supplier) == "\xabrequirement\xbb Top-level"
+    # assert repr(deriveReqt.client) == "\xabrequirement\xbb Functional"
+    # assert repr(deriveReqt.supplier) == "\xabrequirement\xbb Top-level"
 
     requirement_type = "<class 'sysml.element.Requirement'>"
     derivereqt_type = "<class 'sysml.element.DeriveReqt'>"
 
-    assert repr(type(deriveReqt)) == derivereqt_type
+    # assert repr(type(deriveReqt)) == derivereqt_type
 
-    assert repr(type(deriveReqt.client)) == requirement_type
-    assert repr(type(deriveReqt.supplier)) == requirement_type
+    # assert repr(type(deriveReqt.client)) == requirement_type
+    # assert repr(type(deriveReqt.supplier)) == requirement_type
     assert deriveReqt.stereotype == "\xabderiveReqt\xbb"
 
     assert uuid.UUID(deriveReqt.uuid, version=1)
@@ -437,24 +463,24 @@ def test_satisfy_requirement(model):
 
     assert satisfy is model['requirements']['satisfy1']
 
-    assert repr(warpdrive) == "\xabblock\xbb Class-7 Warp Drive"
-    assert repr(reqt1) == "\xabrequirement\xbb Functional"
+    # assert repr(warpdrive) == "\xabblock\xbb Class-7 Warp Drive"
+    # assert repr(reqt1) == "\xabrequirement\xbb Functional"
 
     assert satisfy.stereotype == "\xabsatisfy\xbb"
 
     assert satisfy.name == satisfy.name
     assert satisfy.stereotype == "\xabsatisfy\xbb"
 
-    assert repr(satisfy.client) == "\xabblock\xbb Class-7 Warp Drive"
-    assert repr(satisfy.supplier) == "\xabrequirement\xbb Functional"
+    # assert repr(satisfy.client) == "\xabblock\xbb Class-7 Warp Drive"
+    # assert repr(satisfy.supplier) == "\xabrequirement\xbb Functional"
 
     satisfy_type = "<class 'sysml.element.Satisfy'>"
     block_type = "<class 'sysml.element.Block'>"
     requirement_type = "<class 'sysml.element.Requirement'>"
 
-    assert repr(type(satisfy)) == satisfy_type
-    assert repr(type(satisfy.client)) == block_type
-    assert repr(type(satisfy.supplier)) == requirement_type
+    # assert repr(type(satisfy)) == satisfy_type
+    # assert repr(type(satisfy.client)) == block_type
+    # assert repr(type(satisfy.supplier)) == requirement_type
 
     assert uuid.UUID(satisfy.uuid, version=1)