Support ignoring order with Collections.Lists Should Be Equal

bbpatel2001 · web-flow · commit 0032b78c26a7 · 2020-02-28T12:20:08.000+02:00
Fixes #2703.
diff --git a/atest/robot/standard_libraries/collections/list.robot b/atest/robot/standard_libraries/collections/list.robot
@@ -199,6 +199,9 @@ Lists Should Be Equal With Named Indices As Dictionary
 Lists Should Be Equal With Named Indices As Dictionary With Too Few Values
     Check Test Case    ${TEST NAME}
 
+Lists Should Be Equal Ignore Order
+    Check Test Case    ${TEST NAME}
+
 List Should Contain Sub List
     Check Test Case    ${TEST NAME}
 
diff --git a/atest/testdata/standard_libraries/collections/list.robot b/atest/testdata/standard_libraries/collections/list.robot
@@ -331,6 +331,11 @@ Lists Should Be Equal With Named Indices As Dictionary With Too Few Values
     ${names} =    Create Dictionary    0=a    2=c
     Lists Should Be Equal    ${L3}    ${L3B}    names=${names}
 
+Lists Should Be Equal Ignore Order    
+    ${list1} =    Create List    A    B    C    D
+    ${list2} =    Create List    D    B    C	A
+    Lists Should Be Equal    ${list1}    ${list2}    ignore_order=True
+    
 List Should Contain Sub List
     List Should Contain Sub List    ${LONG}    ${L4}
 
diff --git a/src/robot/libraries/Collections.py b/src/robot/libraries/Collections.py
@@ -346,7 +346,7 @@ def list_should_not_contain_duplicates(self, list_, msg=None):
                                  '%s found multiple times.' % seq2str(dupes))
 
     def lists_should_be_equal(self, list1, list2, msg=None, values=True,
-                              names=None):
+                              names=None, ignore_order=False):
         """Fails if given lists are unequal.
 
         The keyword first verifies that the lists have equal lengths, and then
@@ -370,6 +370,10 @@ def lists_should_be_equal(self, list1, list2, msg=None, values=True,
         need to be named. It is not necessary to name all of the indices.  When
         using a dictionary, keys can be either integers or strings that can be
         converted to integers.
+        
+        Optional ``ignore_order`` argument can be used to ignore the order of the
+        elements (element index) in the list while comparing two lists. If set to 
+        true, element order will be ignored.  This option is new in RF 3.2 now.
 
         Examples:
         | ${names} = | Create List | First Name | Family Name | Email |
@@ -380,13 +384,23 @@ def lists_should_be_equal(self, list1, list2, msg=None, values=True,
         If the items in index 2 would differ in the above examples, the error
         message would contain a row like ``Index 2 (email): name@foo.com !=
         name@bar.com``.
+        
+        | ${list1} = | Create List | apple | cherry | banana |
+        | ${list2} = | Create List | cherry | banana | apple |
+        | Lists Should Be Equal | ${list1} | ${list2} | ignore_order=True |
+        
+        list index would be ignored while comparing two lists. Above two list 
+        will be matched. 
         """
         self._validate_lists(list1, list2)
         len1 = len(list1)
         len2 = len(list2)
         default = 'Lengths are different: %d != %d' % (len1, len2)
         _verify_condition(len1 == len2, default, msg, values)
         names = self._get_list_index_name_mapping(names, len1)
+        if ignore_order:
+            list1 = sorted(list1)
+            list2 = sorted(list2)
         diffs = list(self._yield_list_diffs(list1, list2, names))
         default = 'Lists are different:\n' + '\n'.join(diffs)
         _verify_condition(diffs == [], default, msg, values)
