Laravel/PHPUnit: Assert json element exists without defining the value

Question

I'm sending a post request in a test case, and I want to assert that a specific element. Let's say I have a key x which exists in the response. In this case, I can't say seeJson(['x' => whatever]); because the value is unknown. For sure, I can't do it with seeJson(['x']);.

Is there a way to solve this?

If it matters:

Laravel: v5.2.31

PHPUnit: 5.3.4

dump() is a void method. If I could use it, i'd have to use ob_start() and ob_get_clean(). I'll have to check and see if I can use that in a test. — Milad.N
– Milad.N, Commented May 16, 2016 at 12:38
And one more thing. How would you pass or fail a test then? Because you'd have to break the test request's method chain. I found a fail method. But I'll have to look into it more. — Milad.N
– Milad.N, Commented May 16, 2016 at 12:40
Nope, don't worry about those. You can't get the dump in a variable using ob_start() in a test :-( — Milad.N
– Milad.N, Commented May 16, 2016 at 12:53

Илья Савич · Accepted Answer · 2018-09-20 11:24:52Z

52

May it will be helpful for anyone else. You can write this test for your check response json structure

$this->post('/api/login/', [
        'email' => '[email protected]',
        'password' => '123123123',
    ])->assertJsonStructure([
        'status',
        'result' => [
            'id',
            'email',
            'full_name',
        ],
    ]);

edited Sep 20, 2018 at 11:24

answered Feb 14, 2017 at 15:11

Илья Савич

7441 gold badge6 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Stetzon Over a year ago

Thank you, this works. Note when writing Laravel HTTP tests, it is $response->assertJsonStructure(array $structure);

ak93 Over a year ago

How would you assert that a child array has X members, or possibly check that it has "no more than X members" or "no less than X members"?

CJ Dennis Over a year ago

Please edit your answer from seeJsonStructure to assertJsonStructure. I wasted time trying to get your answer to work, because that method name does not exist. I would edit the answer myself, but such an edit should be rejected as "not what the author intended".

Ivanka Todorova Over a year ago

@CJDennis Question is tagged with laravel-5.2, in that version it was seeJsonStructure.

Milad.N · Accepted Answer · 2016-05-17 07:50:05Z

13

~~Although it's not optimal at all, I chose to use this code to test the situation:~~

~~$this->post(URL, PARAMS)->see('x');~~

~~X is a hypothetical name, and the actual element key has a slim chance of popping up in the rest of the data. otherwise this nasty workaround wouldn't be practical.~~

UPDATE:

Here's the solution to do it properly:

public function testCaseName()

{
    $this->post(route('route.name'), [
        'param1' => 1,
        'param2' => 10,
    ], [
        'headers_if_any' => 'value'
    ]);

    $res_array = (array)json_decode($this->response->content());

    $this->assertArrayHasKey('x', $res_array);
}

edited May 17, 2016 at 7:50

answered May 16, 2016 at 12:13

Milad.N

2,3393 gold badges29 silver badges48 bronze badges

3 Comments

Zaher Over a year ago

padding true as the second parameter to json_decode will return the values as array json_decode($this->response->content(), true) php.net/json_decode

miken32 Over a year ago

$this->response is not available any longer in modern Laravel. Current code would look like $r = $this->post(...); then you can work with $r->getContent()

Alexander Leon Bulatov Over a year ago

Nowadays it is not appropriate for Laravel 11.

Collectives™ on Stack Overflow

Laravel/PHPUnit: Assert json element exists without defining the value

2 Answers 2

4 Comments

UPDATE:

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

UPDATE:

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related