[version_converter] Automatically Add UUIDs For Properties

Adding UUIDs, when converting from odML version 1.0 to 1.1.
If an ID already exists, it stays the same, if it is compatible
with the python uuid types. Otherwise (also if empty) a new ID is
created for the property.

Author: fschrader1992

odml/tools/version_converter.py

@@ -9,6 +9,8 @@
 from ..info import FORMAT_VERSION
 from ..terminology import Terminologies, REPOSITORY_BASE
 
+import uuid
+
 try:
     unicode = unicode
 except NameError:
@@ -194,6 +196,8 @@ def _convert(self, tree):
             if e.tag == "repository":
                 self._handle_repository(e)
 
+        tree = self._check_add_ids(tree)
+
         return tree
 
     def _handle_include(self, element):
@@ -410,6 +414,45 @@ def _change_entity_name(tree, elem_map, name):
             elem_map[named_path] += 1
             name.text += "-" + str(elem_map[named_path])
 
+    def _check_add_ids(self, tree):
+        """
+        Checks, whether elements (properties) possess an UUID
+        and adds one in case of absence.
+        :param tree: ElementTree of the doc
+        :return: ElementTree
+        """
+        root = tree.getroot()
+        for sec in root.iter("section"):
+            for prop in sec.iter("property"):
+                self._add_id(prop)
+
+        return tree
+
+    @staticmethod
+    def _add_id(element):
+        """
+        Checks, whether element possesses ID. If yes, make sure, it has right format.
+        Otherwise a new UUID is created.
+        :param element: lxml element.
+        """
+        oid = element.find("id")
+        new_id = ET.Element("id")
+        try:
+            if oid is not None:
+                try:
+                    if oid.text is not None:
+                        new_id.text = str(uuid.UUID(oid.text))
+                except ValueError as e:
+                    print(e)
+                    new_id.text = str(uuid.uuid4())
+                element.remove(oid)
+            else:
+                new_id.text = str(uuid.uuid4())
+        except ValueError as e:
+            print(e)
+            new_id.text = str(uuid.uuid4())
+        element.append(new_id)
+
     def _log(self, msg):
         """
         Adds the passed message to the conversion_log attribute and

test/test_version_converter.py

@@ -379,19 +379,21 @@ def test_convert_odml_file_property(self):
         self.assertEqual(sec[0].find("name").text, "Valid Property tags test")
         self.assertEqual(len(sec[0].findall("property")), 1)
         prop = sec[0].find("property")
-        self.assertEqual(len(prop), 5)
+        self.assertEqual(len(prop), 6)
         self.assertEqual(prop.find("name").text, "Property name")
         self.assertEqual(prop.find("type").text, "Property type")
         self.assertEqual(prop.find("definition").text, "Property definition")
         self.assertEqual(prop.find("dependency").text, "Property dependency")
         self.assertEqual(prop.find("dependencyvalue").text, "Property dependency value")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test non-import of Property w/o name
         self.assertEqual(len(sec[1].findall("property")), 1)
         # Test absence of non-Property tags
         prop = sec[1].find("property")
-        self.assertEqual(len(prop), 1)
+        self.assertEqual(len(prop), 2)
         self.assertEqual(len(prop.findall("name")), 1)
+        self.assertEqual(len(prop.findall("id")), 1)
 
     def test_convert_odml_file_value(self):
         """Test proper conversion of the odml.Value entity from
@@ -511,6 +513,22 @@ def test_convert_odml_file_value(self):
                       <value> 3 <type>int</type></value>
                       <name>testIntListWhiteSpace</name>
                     </property>
+                    
+                     <property>
+                      <name>Single value with UUID</name>
+                      <value>1</value>
+                      <id>aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa</id>
+                    </property>
+                    
+                     <property>
+                      <name>Single value with none-UUID ID</name>
+                      <id>1</id>
+                    </property>
+                    
+                    <property>
+                      <name>Single value with empty ID</name>
+                      <id></id>
+                    </property>
 
                   </section>
                 </odML>
@@ -521,85 +539,118 @@ def test_convert_odml_file_value(self):
         conv_doc = vc._convert(vc._parse_xml())
         root = conv_doc.getroot()
         sec = root.find("section")
-        self.assertEqual(len(sec), 14)
+        self.assertEqual(len(sec), 17)
 
         # Test single value export
         prop = sec.findall("property")[0]
-        self.assertEqual(len(prop), 2)
+        self.assertEqual(len(prop), 3)
         self.assertEqual(prop.find("value").text, "1")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test multiple value export
         prop = sec.findall("property")[1]
-        self.assertEqual(len(prop), 2)
+        self.assertEqual(len(prop), 3)
         self.assertEqual(prop.find("value").text, "[1,2,3]")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test empty value export
         prop = sec.findall("property")[2]
-        self.assertEqual(len(prop), 1)
+        self.assertEqual(len(prop), 2)
         self.assertEqual(prop.find("name").text, "Empty value export")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test valid Value tags
         prop = sec.findall("property")[3]
-        self.assertEqual(len(prop), 7)
+        self.assertEqual(len(prop), 8)
         self.assertEqual(prop.find("value").text, "0.1")
         self.assertEqual(prop.find("type").text, "float")
         self.assertEqual(prop.find("uncertainty").text, "0.05")
         self.assertEqual(prop.find("unit").text, "mV")
         self.assertEqual(prop.find("value_origin").text, "raw.txt")
         self.assertEqual(prop.find("reference").text, "Value reference")
         self.assertEqual(len(prop.findall("filename")), 0)
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test valid multiple Value tag export
         prop = sec.findall("property")[4]
-        self.assertEqual(len(prop), 7)
+        self.assertEqual(len(prop), 8)
         self.assertEqual(prop.find("value").text, "[0.1,0.2,3]")
         self.assertEqual(prop.find("type").text, "float")
         self.assertEqual(prop.find("uncertainty").text, "0.05")
         self.assertEqual(prop.find("unit").text, "mV")
         self.assertEqual(prop.find("value_origin").text, "raw.txt")
         self.assertEqual(prop.find("reference").text, "Value reference")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test non-export of invalid Value tags
         prop = sec.findall("property")[5]
-        self.assertEqual(len(prop), 1)
+        self.assertEqual(len(prop), 2)
         self.assertEqual(len(prop.findall("name")), 1)
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test dtype 'binary' replacement
         prop = sec.findall("property")[6]
         self.assertEqual(prop.find("name").text, "Unsupported binary value type replace")
         self.assertEqual(prop.find("type").text, "text")
+        self.assertEqual(len(prop.findall("id")), 1)
         prop = sec.findall("property")[7]
         self.assertEqual(prop.find("name").text, "Unsupported binary value dtype replace")
         self.assertEqual(prop.find("type").text, "text")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test single string value with commata
         prop = sec.findall("property")[8]
         self.assertEqual(prop.find("name").text, "testSingleString")
         self.assertEqual(prop.find("value").text,
                          "Single, string, value, with, many, commata.")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test string list import
         prop = sec.findall("property")[9]
         self.assertEqual(prop.find("name").text, "testStringList")
         self.assertEqual(prop.find("value").text, "[A,B,C]")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test single string values wrapping whitespace removal
         prop = sec.findall("property")[10]
         self.assertEqual(prop.find("name").text, "testStringWhiteSpace")
         self.assertEqual(prop.find("value").text,
                          "Single string value with wrapping whitespace")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test multiple string values with wrapping whitespace removal
         prop = sec.findall("property")[11]
         self.assertEqual(prop.find("name").text, "testStringListWhiteSpace")
         self.assertEqual(prop.find("value").text,
                          "[Multiple Strings,with wrapping,Whitespace]")
+        self.assertEqual(len(prop.findall("id")), 1)
 
         # Test multiple int values with wrapping whitespaces
         prop = sec.findall("property")[12]
         self.assertEqual(prop.find("name").text, "testIntListWhiteSpace")
         self.assertEqual(prop.find("type").text, "int")
         self.assertEqual(prop.find("value").text, "[1,2,3]")
+        self.assertEqual(len(prop.findall("id")), 1)
+
+        # Test single value export
+        prop = sec.findall("property")[13]
+        self.assertEqual(len(prop), 3)
+        self.assertEqual(prop.find("value").text, "1")
+        self.assertEqual(len(prop.findall("id")), 1)
+        self.assertEqual(prop.find("id").text, "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa")
+
+        # Test single value export
+        prop = sec.findall("property")[14]
+        self.assertEqual(len(prop), 2)
+        self.assertEqual(len(prop.findall("id")), 1)
+        self.assertNotEqual(prop.find("id").text, "1")
+
+        # Test single value export
+        prop = sec.findall("property")[15]
+        self.assertEqual(len(prop), 2)
+        self.assertEqual(len(prop.findall("id")), 1)
+        self.assertNotEqual(prop.find("id").text, "1")
+
 
     def test_parse_dict_document(self):
         # Test appending tags; not appending empty sections