[11.x] Add assertJsonFragments assertion

[lioneaglesolutions]

Problem

Sometimes when asserting a JSON response, it can be helpful when you're looking for multiple fragments at once. A concrete example is when you want to assert some meta values regarding pagination.

The current test looks like this;

it('can paginate teams', function () {
    $user = User::factory()->create();

    $teams = Team::factory()->count(26)->create();

    actingAs($user)
        ->getJson('v2/teams?page[size]=25&page[number]=2')
        ->assertSuccessful()
        ->assertJsonStructure([
            // ...
        ])->assertJsonFragment([
            'current_page' => 2,
        ])->assertJsonFragment([
            'per_page' => 25,
        ])->assertJsonFragment([
            'total' => 26,
        ]);
});

Now the meta key in the response will contain all of the pagination data but it's hard to prepare an assertion for that entire part of the response. Particularly, often you only want to assert a handful of the key/value pairs of the response.

Solution

By adding the assertJsonFragments method, it means you don't have to chain the assertJsonFragment calls;

it('can paginate teams', function () {
    $user = User::factory()->create();

    $teams = Team::factory()->count(26)->create();

    actingAs($user)
        ->getJson('v2/teams?page[size]=25&page[number]=2')
        ->assertSuccessful()
        ->assertJsonStructure([
            // ...
        ])->assertJsonFragments([
            ['current_page' => 2],
            ['per_page' => 25],
            ['total' => 26]
        ]);
});

[cosmastech]

Just a quick thought: might be nice if this were variadic so a user could write:

$response->assertJsonFragments(
    ['current_page' => 2],
    ['per_page' => 25],
    ['total' => 26]
);