[10.x] Add assertJsonPathCanonicalizing method (#48117)

* Add assertJsonPathCanonicalizing method

* Fix linting issue

* Update AssertableJsonString.php

* Update TestResponse.php

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: gdebrauwer

src/Illuminate/Testing/AssertableJsonString.php

@@ -246,6 +246,20 @@ public function assertPath($path, $expect)
         return $this;
     }
 
+    /**
+     * Assert that the given path in the response contains all of the expected values without looking at the order.
+     *
+     * @param  string  $path
+     * @param  array  $expect
+     * @return $this
+     */
+    public function assertPathCanonicalizing($path, $expect)
+    {
+        PHPUnit::assertEqualsCanonicalizing($expect, $this->json($path));
+
+        return $this;
+    }
+
     /**
      * Assert that the response has a given JSON structure.
      *

src/Illuminate/Testing/TestResponse.php

@@ -662,6 +662,20 @@ public function assertJsonPath($path, $expect)
         return $this;
     }
 
+    /**
+     * Assert that the given path in the response contains all of the expected values without looking at the order.
+     *
+     * @param  string  $path
+     * @param  array  $expect
+     * @return $this
+     */
+    public function assertJsonPathCanonicalizing($path, array $expect)
+    {
+        $this->decodeResponseJson()->assertPathCanonicalizing($path, $expect);
+
+        return $this;
+    }
+
     /**
      * Assert that the response has the exact given JSON.
      *

tests/Testing/TestResponseTest.php

@@ -1219,6 +1219,29 @@ public function testAssertJsonPathWithClosureCanFail()
         $response->assertJsonPath('data.foo', fn ($value) => $value === null);
     }
 
+    public function testAssertJsonPathCanonicalizing()
+    {
+        $response = TestResponse::fromBaseResponse(new Response(new JsonSerializableSingleResourceStub));
+
+        $response->assertJsonPathCanonicalizing('*.foo', ['foo 0', 'foo 1', 'foo 2', 'foo 3']);
+        $response->assertJsonPathCanonicalizing('*.foo', ['foo 1', 'foo 0', 'foo 3', 'foo 2']);
+
+        $response = TestResponse::fromBaseResponse(new Response(new JsonSerializableSingleResourceWithIntegersStub));
+
+        $response->assertJsonPathCanonicalizing('*.id', [10, 20, 30]);
+        $response->assertJsonPathCanonicalizing('*.id', [30, 10, 20]);
+    }
+
+    public function testAssertJsonPathCanonicalizingCanFail()
+    {
+        $response = TestResponse::fromBaseResponse(new Response(new JsonSerializableSingleResourceStub));
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Failed asserting that two arrays are equal.');
+
+        $response->assertJsonPathCanonicalizing('*.foo', ['foo 0', 'foo 2', 'foo 3']);
+    }
+
     public function testAssertJsonFragment()
     {
         $response = TestResponse::fromBaseResponse(new Response(new JsonSerializableSingleResourceStub));