commenting expect_list test method

Signed-off-by: Andrew Twydell <[email protected]>

Author: AndrewTwydell

tests/unit/helpers/cmci_helper.py

@@ -123,18 +123,14 @@ def run(self, module, config):
         assert isinstance(self.expected, dict)
         assert isinstance(result, dict)
 
+        # when a list of items is expected but the order varies, this block intecepts the actual result and sorts
+        # the list, allowing the expected and actual output to be compared in the same order
         if self.expected_list:
-            # get list of items from a string in the result dict - comma separated text between 2 points in string
             actual_list = result.get(self.string_containing_list)[self.chars_before_list:-self.chars_after_list].split(", ")
-            # sort alphabetically
             actual_list.sort()
-            # get the text before the list in the string
             before_list = result.get(self.string_containing_list)[:self.chars_before_list]
-            # get the text after the list in the string
             after_list = result.get(self.string_containing_list)[-self.chars_after_list:]
-            # put the text before and after the list together with the newly ordered list
             concat = before_list + ", ".join(actual_list) + after_list
-            # update the result dict to use the string with the ordered list of items
             result.update({self.string_containing_list: concat})
 
         if self.expected != result:

tests/unit/modules/test_cmci_filters.py

@@ -640,6 +640,10 @@ def test_extra_attributes_root(cmci_module):
     if sys.version_info.major <= 2:
         extension = "pyc"
 
+    # Order that Ansible returns supported parameters is not consistent everytime
+    # expect_list ensures expected and actual output are compared after sorting the 
+    # list first. This means passing tests if all expected attributes are listed, but not caring about
+    # the order. 
     before_list = "Unsupported parameters for (basic.%s) module: resources.complex_filter.orange. Supported parameters include: " % extension
     sorted_list = ["cmci_cert", "cmci_host", "cmci_key", "cmci_password",
                                 "cmci_port", "cmci_user", "context", "fail_on_nodata", "insecure",