assertJsonStructure breaks comparing structure with itself

[DerManoMann]

• Laravel Version: 5.8.18
• PHP Version: 7.3.5

Description:

Comparing a data structure with itself beaks with message Failed asserting that an array has the key 1.
Using assertExactJson does work, though.

Steps To Reproduce:

        $data = ['data' => ['user_id' => 1, 'role' => 'admin']];
        (new TestResponse(new Response()))->assertJsonStructure($data, $data);

[driesvints]

Why would you want to do this? Can you provide a full test for this?

[DerManoMann]

Well, this is just a test case to demonstrate the problem.
In my test class it would look like this:

$response->assertJsonStructure(['data' => ['user_id' => 1, 'role' => 'admin']]);

[DerManoMann]

I would expect the assert to pass if the structure matches, even if the id and role values are not the same.

[driesvints]

Hmm, I think you're maybe right. It seems to me that the $value on this line actually needs to be $key:

framework/src/Illuminate/Foundation/Testing/TestResponse.php

Line 600 in 435c05b

PHPUnit::assertArrayHasKey($value, $responseData);

But this has been around for two years already and no-one ever reported problems with this so I'm not really sure if it's broken or not: #17700

Maybe if I can ping the original author (@cretueusebiu) he can explain why this is implemented as $value and not $key.

[driesvints]

There are also no tests for the second $responseData param so it's hard to check what the actual expected behavior is.

[cretueusebiu]

At that time I just ported the method from the browser-kit-testing repo.

[driesvints]

I finally get what's happening. The thing is that the $structure argument only needs the structure and not the any data. So it's not a one-on-one match with the actual response.

@DerManoMann what you need to do is this:

$response->assertJsonStructure(['data' => ['user_id', 'role']]);

The docs could use an example. I'll try to send in a PR for this but feel free to beat me to it.

[DerManoMann]

I thought it might be something like that, although I am not convinced this is a good solution. At the minimum it is not intuitive at all.

The thing is, the method makes me compare an array (or object) with string keys (properties) with an array that has those as values with numeric keys.
To me that not really comparing two structures, but checking one structure against nested meta data describing the structure.

Personally, I'd be much happier wtith something that really compares two structures while ignoring all values except for array/object.

Anyway, thanks for looking into this, I do appreciate your time.