Merge lp:~billy-olsen/charm-helpers/lp1698343 into lp:charm-helpers

[Billy Olsen]

[Jorge Niedbalski (niedbalski)]

LGTM, I did some minor modifications to make lint pass/extended docstrings.

review: Approve

=== modified file 'charmhelpers/contrib/openstack/utils.py'
--- charmhelpers/contrib/openstack/utils.py	2017-06-22 14:57:18 +0000
+++ charmhelpers/contrib/openstack/utils.py	2017-06-29 03:51:49 +0000
@@ -1863,6 +1863,29 @@
     return wrap
 
 
+def ordered(orderme):
+    """Converts the provided dictionary into a collections.OrderedDict.
+
+    The items in the returned OrderedDict will be inserted based on the
+    natural sort order of the keys. Nested dictionaries will also be sorted
+    in order to ensure fully predictable ordering.
+
+    :param orderme: the dict to order
+    :return: collections.OrderedDict
+    """
+    if not isinstance(orderme, dict):
+        raise ValueError('argument must be a dict type')
+
+    result = OrderedDict()
+    for k, v in sorted(six.iteritems(orderme), key=lambda x: x[0]):
+        if isinstance(v, dict):
+            result[k] = ordered(v)
+        else:
+            result[k] = v
+
+    return result
+
+
 def config_flags_parser(config_flags):
     """Parses config flags string into dict.
 
@@ -1874,15 +1897,13 @@
          example, a string in the format of 'key1=value1, key2=value2' will
          return a dict of:
 
-             {'key1': 'value1',
-              'key2': 'value2'}.
+             {'key1': 'value1', 'key2': 'value2'}.
 
       2. A string in the above format, but supporting a comma-delimited list
          of values for the same key. For example, a string in the format of
          'key1=value1, key2=value3,value4,value5' will return a dict of:
 
-             {'key1', 'value1',
-              'key2', 'value2,value3,value4'}
+             {'key1': 'value1', 'key2': 'value2,value3,value4'}
 
       3. A string containing a colon character (:) prior to an equal
          character (=) will be treated as yaml and parsed as such. This can be
@@ -1902,7 +1923,7 @@
     equals = config_flags.find('=')
     if colon > 0:
         if colon < equals or equals < 0:
-            return yaml.safe_load(config_flags)
+            return ordered(yaml.safe_load(config_flags))
 
     if config_flags.find('==') >= 0:
         juju_log("config_flags is not in expected format (key=value)",
@@ -1915,7 +1936,7 @@
     # split on '='.
     split = config_flags.strip(' =').split('=')
     limit = len(split)
-    flags = {}
+    flags = OrderedDict()
     for i in range(0, limit - 1):
         current = split[i]
         next = split[i + 1]

=== modified file 'tests/contrib/openstack/test_os_utils.py'
--- tests/contrib/openstack/test_os_utils.py	2017-06-22 14:57:18 +0000
+++ tests/contrib/openstack/test_os_utils.py	2017-06-29 03:51:49 +0000
@@ -1,5 +1,7 @@
+import collections
 import json
 import mock
+import six
 import unittest
 import six
 
@@ -222,3 +224,30 @@
         modified_policy.update(item_to_update)
         mock_open().write.assert_called_with(
             json.dumps(modified_policy, indent=4))
+
+    def test_ordered(self):
+        data = {'one': 1, 'two': 2, 'three': 3}
+        expected = [('one', 1), ('three', 3), ('two', 2)]
+        self.assertSequenceEqual(expected,
+                                 [x for x in utils.ordered(data).items()])
+
+        data = {
+            'one': 1,
+            'two': 2,
+            'three': {
+                'uno': 1,
+                'dos': 2,
+                'tres': 3
+            }
+        }
+        expected = collections.OrderedDict()
+        expected['one'] = 1
+        nested = collections.OrderedDict()
+        nested['dos'] = 2
+        nested['tres'] = 3
+        nested['uno'] = 1
+        expected['three'] = nested
+        expected['two'] = 2
+        self.assertEqual(expected, utils.ordered(data))
+
+        self.assertRaises(ValueError, utils.ordered, "foo")