Fix for issue #112 - ArrayComparator in canonicalize mode

sebastianbergmann · Aug 12, 2024 · b021fdb · b021fdb
1 parent e12faed
commit b021fdb
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 2 deletions.
diff --git a/src/ArrayComparator.php b/src/ArrayComparator.php
@@ -9,6 +9,7 @@
  */
 namespace SebastianBergmann\Comparator;
 
+use function array_is_list;
 use function array_key_exists;
 use function assert;
 use function is_array;
@@ -39,8 +40,13 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0,
         assert(is_array($actual));
 
         if ($canonicalize) {
-            sort($expected);
-            sort($actual);
+            if (array_is_list($expected)) {
+                sort($expected);
+            }
+
+            if (array_is_list($actual)) {
+                sort($actual);
+            }
         }
 
         $remaining        = $actual;

diff --git a/tests/ArrayComparatorTest.php b/tests/ArrayComparatorTest.php
@@ -67,6 +67,30 @@ public static function assertEqualsSucceedsProvider(): array
                 ['true'],
                 [true],
             ],
+            [
+                [1, [1, 2, 3]],
+                [[3, 1, 2], 1],
+                0,
+                true,
+            ],
+            [
+                [1, [4, 7], [1, 2, 3], [0, 0, 0, 0]],
+                [[3, 1, 2], [0, 0, 0, 0], [4, 7], 1],
+                0,
+                true,
+            ],
+            [
+                [1, [4, [4, 5, 6, 7, 8]], [1, 2, 3]],
+                [[3, 1, 2], [[4, 8, 6, 7, 5], 4], 1],
+                0,
+                true,
+            ],
+            [
+                [null, null, 1, 1],
+                [1, null, 1, null],
+                0,
+                true,
+            ],
         ];
     }
 
@@ -112,6 +136,24 @@ public static function assertEqualsFailsProvider(): array
                 ['false'],
                 [false],
             ],
+            [
+                ['a' => '1', 'b' => '2'],
+                ['c' => '1', 'd' => '2'],
+                0,
+                true,
+            ],
+            [
+                ['a' => '1', 'b' => '2'],
+                ['a' => '2', 'b' => '1'],
+                0,
+                true,
+            ],
+            [
+                ['a' => '1', 'b' => '2'],
+                ['a' => '1', 'b' => '2', 'c' => '2'],
+                0,
+                true,
+            ],
         ];
     }