sort_list support for python 3 (#115)

sort_list support for python 3

Reviewed-by: https://github.com/apps/ansible-zuul

Author: GomathiselviS

changelogs/fragments/114-sort_list_listofdicts.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - sort_list will sort a list of dicts using the sorted method with key as an argument.

plugins/module_utils/network/common/utils.py

@@ -150,6 +150,15 @@ def transform_commands(module):
 
 def sort_list(val):
     if isinstance(val, list):
+        if isinstance(val[0], dict):
+            sorted_keys = [tuple(sorted(dict_.keys())) for dict_ in val]
+            # All keys should be identical
+            if len(set(sorted_keys)) != 1:
+                raise ValueError("dictionaries do not match")
+
+            return sorted(
+                val, key=lambda d: tuple(d[k] for k in sorted_keys[0])
+            )
         return sorted(val)
     return val
 

tests/unit/module_utils/network/common/test_utils.py

@@ -144,13 +144,37 @@ def test_transform_commands():
     ]
 
 
-def test_sort():
+def test_sort_list():
     data = [3, 1, 2]
     assert [1, 2, 3] == utils.sort_list(data)
 
-    string_data = "123"
+    string_data = "312"
     assert string_data == utils.sort_list(string_data)
 
+    data = [{"a": 1, "b": 2}, {"a": 1, "c": 1}, {"a": 1, "b": 0}]
+    with pytest.raises(ValueError, match="dictionaries do not match"):
+        utils.sort_list(data)
+
+    data = [{"a": 1, "b": 2}, {"a": 1, "b": 1}, {"a": 0, "b": 3}]
+    assert utils.sort_list(data) == [
+        {"a": 0, "b": 3},
+        {"a": 1, "b": 1},
+        {"a": 1, "b": 2},
+    ]
+
+    data = [
+        {"a": 1, "c": [1, 2, 3], "b": 1},
+        {"a": 1, "c": [3, 4, 5], "b": 0},
+        {"a": 1, "c": [1, 1], "b": 0},
+        {"a": 0, "c": [99, 98, 97, 96, 95], "b": 27},
+    ]
+    assert utils.sort_list(data) == [
+        {"a": 0, "b": 27, "c": [99, 98, 97, 96, 95]},
+        {"a": 1, "b": 0, "c": [1, 1]},
+        {"a": 1, "b": 0, "c": [3, 4, 5]},
+        {"a": 1, "b": 1, "c": [1, 2, 3]},
+    ]
+
 
 def test_dict_diff():
     with pytest.raises(AssertionError, match="`base` must be of type <dict>"):