Merge pull request #263 from mpsonntag/propertyTest

Fixes and Section/Property tests

LGTM

Author: achilleas-k

odml/base.py

@@ -35,7 +35,9 @@ def get_terminology_equivalent(self):
 
     def __eq__(self, obj):
         """
-        Do a deep comparison of this object and its odml properties
+        Do a deep comparison of this object and its odml properties.
+        The 'id' attribute of an object is excluded, since it is
+        unique within a document.
         """
         # cannot compare totally different stuff
         if not isinstance(obj, _baseobj):
@@ -45,7 +47,9 @@ def __eq__(self, obj):
             return False
 
         for key in self._format:
-            if getattr(self, key) != getattr(obj, key):
+            if key == "id":
+                continue
+            elif getattr(self, key) != getattr(obj, key):
                 return False
 
         return True

odml/property.py

@@ -329,18 +329,22 @@ def remove(self, value):
 
     def get_path(self):
         """
-        Return the absolute path to this object
+        Return the absolute path to this object.
         """
+        if not self.parent:
+            return "/"
+
         return self.parent.get_path() + ":" + self.name
 
     def clone(self):
         """
-        Clone this object to copy it independently
-        to another document
+        Clone this object to copy it independently to another document.
         """
         obj = super(BaseProperty, self).clone()
-        obj._section = None
+        obj._parent = None
         obj.value = self._value
+        obj._id = str(uuid.uuid4())
+
         return obj
 
     def merge(self, other, strict=True):
@@ -408,9 +412,10 @@ def get_merged_equivalent(self):
         Return the merged object (i.e. if the section is linked to another one,
         return the corresponding property of the linked section) or None
         """
-        if self._parent._merged is None:
+        if self.parent is None or self.parent._merged is None:
             return None
-        return self._parent._merged.contains(self)
+
+        return self.parent._merged.contains(self)
 
     @inherit_docstring
     def get_terminology_equivalent(self):

odml/section.py

@@ -307,6 +307,7 @@ def clone(self, children=True):
         to another document
         """
         obj = super(BaseSection, self).clone(children)
+        obj._id = str(uuid.uuid4())
 
         obj._props = base.SmartList()
         if children:

test/test_odMLMetadata.xml

@@ -187,8 +187,17 @@ def test_parent(self):
     def test_dtype(self):
         pass
 
-    def test_path(self):
-        pass
+    def test_get_path(self):
+        doc = Document()
+        sec = Section(name="parent", parent=doc)
+
+        # Check root path for a detached Property.
+        prop = Property(name="prop")
+        self.assertEqual("/", prop.get_path())
+
+        # Check absolute path of Property in a Document.
+        prop.parent = sec
+        self.assertEqual("/%s:%s" % (sec.name, prop.name), prop.get_path())
 
     def test_value_origin(self):
         p = Property("P")
@@ -199,12 +208,19 @@ def test_value_origin(self):
         self.assertEqual(p.value_origin, None)
 
     def test_set_id(self):
+        p = Property(name="P")
+        self.assertIsNotNone(p.id)
+
         p = Property("P", id="79b613eb-a256-46bf-84f6-207df465b8f7")
         self.assertEqual(p.id, "79b613eb-a256-46bf-84f6-207df465b8f7")
 
-        Property("P", id="id")
+        p = Property("P", id="id")
         self.assertNotEqual(p.id, "id")
 
+        # Make sure id cannot be reset programmatically.
+        with self.assertRaises(AttributeError):
+            p.id = "someId"
+
     def test_merge(self):
         p_dst = Property("p1", value=[1, 2, 3], unit="Hz", definition="Freude\t schoener\nGoetterfunken\n",
                          reference="portal.g-node.org", uncertainty=0.0)
@@ -255,6 +271,48 @@ def test_merge(self):
         int_p.merge(double_p, strict=False)
         self.assertEqual(len(int_p), 2)
 
+    def test_clone(self):
+        sec = Section(name="parent")
+
+        # Check different id.
+        prop = Property(name="original")
+        clone_prop = prop.clone()
+        self.assertNotEqual(prop.id, clone_prop.id)
+
+        # Check parent removal in clone.
+        prop.parent = sec
+        clone_prop = prop.clone()
+        self.assertIsNotNone(prop.parent)
+        self.assertIsNone(clone_prop.parent)
+
+    def test_get_merged_equivalent(self):
+        sec = Section(name="parent")
+        mersec = Section(name="merged_section")
+        merprop_other = Property(name="other_prop", value="other")
+        merprop = Property(name="prop", value=[1, 2, 3])
+
+        # Check None on unset parent.
+        prop = Property(name="prop")
+        self.assertIsNone(prop.get_merged_equivalent())
+
+        # Check None on parent without merged Section.
+        prop.parent = sec
+        self.assertIsNone(prop.get_merged_equivalent())
+
+        # Check None on parent with merged Section but no attached Property.
+        sec.merge(mersec)
+        self.assertIsNone(prop.get_merged_equivalent())
+
+        # Check None on parent with merged Section and unequal Property.
+        merprop_other.parent = mersec
+        self.assertIsNone(prop.get_merged_equivalent())
+
+        # Check receiving merged equivalent Property.
+        merprop.parent = mersec
+        self.assertIsNotNone(prop.get_merged_equivalent())
+        self.assertEqual(prop.get_merged_equivalent(), merprop)
+
+
 if __name__ == "__main__":
     print("TestProperty")
     tp = TestProperty()