feat(testing): Improve ApiTestAssertionsTrait::assertJsonEquals

[DaedalusDev]

Q	A
Branch	main
Tickets	Closes #5751, closes #5751
License	MIT

Improve ApiTestAssertionsTrait::assertJsonEquals by replacing assertEqualsCanonicalizing with assertEquals.

[soyuka]

order of arrays is not guaranteed I think that this is needed and don't get why it wouldn't work

[DaedalusDev]

<?php

namespace App\Tests\Api;

use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;

/**
 * @internal
 *
 * @coversNothing
 */
class CanolicalizingTest extends ApiTestCase
{
    public function testCanonicalizing(): void
    {
        static::assertEqualsCanonicalizing(
            [
                [
                    'id' => 1,
                ],
                [
                    'id' => 2,
                ],
            ],
            [
                [
                    'id' => 2,
                ],
                [
                    'id' => 1,
                ],
            ],
            'assertEqualsCanonicalizing :-(',
        );
        static::assertEqualsCanonicalizing(
            [
                'foo' => 5,
                'bar' => 10,
            ],
            [
                'bar' => 5,
                'foo' => 10,
            ],
            'assertEqualsCanonicalizing :-(',
        );
    }

    public function testWithoutCanonicalizing(): void
    {
        static::assertEquals(
            [
                [
                    'id' => 1,
                ],
                [
                    'id' => 2,
                ],
            ],
            [
                [
                    'id' => 2,
                ],
                [
                    'id' => 1,
                ],
            ],
            'assertEquals :-(',
        );
        static::assertEquals(
            [
                'foo' => 5,
                'bar' => 10,
            ],
            [
                'bar' => 5,
                'foo' => 10,
            ],
            'assertEquals :-(',
        );
    }
}

Result :

[soyuka]

mhh I see, would it be possible to sort the array so that the comparison works nonetheless? or do you think it's not needed (We had the problem in the past)

[dunglas]

We also need to check that comparing ['a', 'b', 'c'] with ['b', 'c', 'a'] fails because while JSON objects are unordered, JSON arrays are.

[DaedalusDev]

Test will fail. I have mention an exemple in the related issued, with a result and comparison result : #5751 (comment)

<?php

namespace App\Tests\Api;

use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
use App\Tests\ApiTestCaseTrait;
use JsonException;

use const JSON_THROW_ON_ERROR;

/**
 * @internal
 *
 * @coversNothing
 */
class CanolicalizingTest extends ApiTestCase
{
    use ApiTestCaseTrait;

    /**
     * @throws JsonException
     */
    public function testJson(): void
    {
        $json = json_decode('["c", "b", "a"]', true, 512, JSON_THROW_ON_ERROR);
        static::assertEqualsCanonicalizing(
            ['a', 'b', 'c'],
            $json,
            'Canonicalizing :-(',
        );
        static::assertEquals(
            ['a', 'b', 'c'],
            $json,
            'Assert equals',
        );
    }
}

Here, we facing a false positive test because assert with assertEqualsCanonicalizing won't throw an error...
Best regards.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[bendavies]

just came across this.
It is madness that assertJsonEquals currently ignores keys.
I've found a few ignored errors in my testsuite down to this.

We should look to get this merged.

[soyuka]

Should we target another branch then main though? @dunglas any opinion?

[bendavies]

it seems we should be using https://github.com/sebastianbergmann/phpunit/blob/main/src/Framework/Constraint/JsonMatches.php in some way which does the canonicalizing

[bendavies]

this seems to do the trick

    public static function assertJsonEquals(array|string $json, string $message = ''): void
    {
        if (\is_array($json)) {
            $json = json_encode(
                $json,
                JSON_UNESCAPED_UNICODE
                | JSON_UNESCAPED_SLASHES
                | JSON_PRESERVE_ZERO_FRACTION
                | JSON_THROW_ON_ERROR);
        }

        $constraint = new JsonMatches($json);

        static::assertThat(self::getHttpResponse()->getContent(false), $constraint, $message);
    }

[soyuka]

thanks @DaedalusDev @bendavies !