Synchronise xml2dict and dict2xml

All tools from the ecosystem shall use the same way to convert between python's
dict and XML.

slapos/proxy/views.py

@@ -28,7 +28,6 @@
 #
 ##############################################################################
 
-from lxml import etree
 import random
 import string
 import time
@@ -37,7 +36,8 @@ from slapos.slap.slap import Computer, ComputerPartition, \
     SoftwareRelease, SoftwareInstance, NotFoundError
 from slapos.proxy.db_version import DB_VERSION
 import slapos.slap
-from slapos.util import bytes2str, str2bytes, unicode2str, sqlite_connect
+from slapos.util import bytes2str, unicode2str, sqlite_connect, \
+    xml2dict, dict2xml
 
 from flask import g, Flask, request, abort
 from slapos.util import loads, dumps
@@ -53,39 +53,6 @@ class UnauthorizedError(Exception):
   pass
 
 
-def xml2dict(xml):
-  result_dict = {}
-  if xml:
-    tree = etree.fromstring(str2bytes(xml))
-    for element in tree.iter(tag=etree.Element):
-      if element.tag == 'parameter':
-        key = element.get('id')
-        value = result_dict.get(key, None)
-        if value is not None:
-          value = value + ' ' + element.text
-        else:
-          value = element.text
-        result_dict[key] = value
-  return result_dict
-
-
-def dict2xml(dictionary):
-  instance = etree.Element('instance')
-  for k, v in six.iteritems(dictionary):
-    if isinstance(k, bytes):
-      k = k.decode('utf-8')
-    if isinstance(v, bytes):
-      v = v.decode('utf-8')
-    elif not isinstance(v, six.text_type):
-      v = str(v)
-    etree.SubElement(instance, "parameter",
-                     attrib={'id': k}).text = v
-  return bytes2str(etree.tostring(instance,
-                        pretty_print=True,
-                        xml_declaration=True,
-                        encoding='utf-8'))
-
-
 def partitiondict2partition(partition):
   slap_partition = ComputerPartition(partition['computer_reference'],
       partition['reference'])

slapos/slap/util.py

-from lxml import etree
 from six.moves.urllib import parse
 import netaddr
 
-def xml2dict(xml):
-  result_dict = {}
-  if xml is not None and xml != '':
-    tree = etree.fromstring(xml.encode('utf-8'))
-    for element in tree.iter(tag=etree.Element):
-      if element.tag == 'parameter':
-        key = element.get('id')
-        value = result_dict.get(key, None)
-        if value is not None:
-          value = value + ' ' + element.text
-        else:
-          value = element.text
-        result_dict[key] = value
-  return result_dict
 
 def _addIpv6Brackets(url):
   # if master_url contains an ipv6 without bracket, add it

slapos/tests/test_util.py

@@ -120,5 +120,58 @@ class TestUtil(unittest.TestCase):
     for value in [True, False, 1, '1', 't', 'tru', 'truelle', 'f', 'fals', 'falsey']:
       self.assertRaises(ValueError, string_to_boolean, value)
 
+  xml2dict_xml = """<?xml version='1.0' encoding='utf-8'?>
+<instance>
+  <parameter id="badstr">\xc5\x81\xc4\x84\xc5\xbb\xc5\xb9""" \
+"""\xc4\x86\xc5\x9a\xc3\x90\xc3\x86\xe2\x80\x98</parameter>
+  <parameter id="intstr">1</parameter>
+  <parameter id="key">str</parameter>
+  <parameter id="ukey">ustr</parameter>
+  <parameter id="int">1</parameter>
+  <parameter id="list">[\'one\', 2]</parameter>
+  <parameter id="emptystr"></parameter>
+  <parameter id="none">None</parameter>
+  <parameter id="badu">\xc5\x81\xc4\x84\xc5\xbb\xc5\xb9""" \
+"""\xc4\x86\xc5\x9a\xc3\x90\xc3\x86\xe2\x80\x98</parameter>
+</instance>
+"""
+
+  xml2dict_indict = {
+    u'ukey': u'ustr',
+    'key': 'str',
+    'int': 1,
+    'intstr': '1',
+    'emptystr': '',
+    'none': None,
+    'list': ['one', 2],
+    'badstr': u'\u0141\u0104\u017b\u0179\u0106\u015a\u00d0\u00c6\u2018'
+              .encode('utf-8'),
+    'badu': u'\u0141\u0104\u017b\u0179\u0106\u015a\u00d0\u00c6\u2018'
+  }
+
+  xml2dict_outdict = {
+    'badstr': u'\u0141\u0104\u017b\u0179\u0106\u015a\xd0\xc6\u2018',
+    'badu': u'\u0141\u0104\u017b\u0179\u0106\u015a\xd0\xc6\u2018',
+    'emptystr': None,
+    'int': '1',
+    'intstr': '1',
+    'key': 'str',
+    'list': "['one', 2]",
+    'none': 'None',
+    'ukey': 'ustr'}
+
+  def test_xml2dict(self):
+    self.assertEqual(
+      self.xml2dict_outdict,
+      slapos.util.xml2dict(self.xml2dict_xml)
+    )
+
+  def test_dict2xml(self):
+    self.assertEqual(
+      self.xml2dict_xml,
+      slapos.util.dict2xml(self.xml2dict_indict)
+    )
+
+
 if __name__ == '__main__':
   unittest.main()

slapos/util.py

@@ -34,6 +34,8 @@ import struct
 import subprocess
 import sqlite3
 from xml_marshaller.xml_marshaller import dumps, loads
+from lxml import etree
+import six
 
 
 def mkdir_p(path, mode=0o700):
@@ -144,3 +146,37 @@ else:
     return s.encode()
   def unicode2str(s):
     return s
+
+
+def dict2xml(dictionary):
+  instance = etree.Element('instance')
+  for k, v in six.iteritems(dictionary):
+    if isinstance(k, bytes):
+      k = k.decode('utf-8')
+    if isinstance(v, bytes):
+      v = v.decode('utf-8')
+    elif not isinstance(v, six.text_type):
+      v = str(v)
+    etree.SubElement(instance, "parameter",
+                     attrib={'id': k}).text = v
+  return bytes2str(etree.tostring(instance,
+                   pretty_print=True,
+                   xml_declaration=True,
+                   encoding='utf-8'))
+
+
+def xml2dict(xml):
+  result_dict = {}
+  if xml is not None and xml != '':
+    tree = etree.fromstring(str2bytes(xml))
+    for element in tree.findall('parameter'):
+      key = element.get('id')
+      value = result_dict.get(key, None)
+      if value is not None:
+        value = value + ' ' + element.text
+      else:
+        value = element.text
+      result_dict[key] = value
+  return result_dict
+
+