Laravel test. assert exact JSON structure

Question

I have a laravel API project. There is a lot security data, that shouldn't be shown for users in API responses. I need some way to write tests where I can get true if only the response structure is exact same as a pre-set structure in test.

So, if my test structure is $structure = [ 'data' => ['_id', 'user' => ['name', 'email], 'title']; but in response I'm recieveing more or less fields, I need this test to be failed.

In a docs I've found only:

assertJson - expecting for exact key => values, but I need a keys only; assertJsonStructure - returns true even if some fields missing or response contains some other fields.

@N69S sure I can. But I'm looking for something existing first. — Denys Siebov
– Denys Siebov, Commented Oct 3, 2019 at 13:51
Do you want to test only the structure or also the data? If you want to test the data you can use $this->assertEquals(..., ...), if you want to be sure that some values is not shown you can use $this->assertArrayNotHasKey(); — Mauro Baptista
– Mauro Baptista, Commented Oct 3, 2019 at 14:56

Serhii Posternak · Accepted Answer · 2019-10-07 14:23:26Z

1

Use Opis JSON Schema

$validator = new \Opis\JsonSchema\Validator();
$result = $validator->dataValidation($json, $schema);
PHPUnit::assertTrue($result->isValid(), "Mismatch json schema");

For your case read more about required and additionalProperties: https://docs.opis.io/json-schema/1.x/object.html#required

Your json scheme may be looks like:

{
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        }
      }
}

edited Oct 7, 2019 at 14:23

answered Oct 3, 2019 at 14:02

Serhii Posternak

5142 silver badges7 bronze badges

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

2 Comments

Denys Siebov Over a year ago

Looks good. Can I require embedded structures? Like ` [ require: ['_id' , 'title', 'user', 'user.name' , ' user.age'] ` .

Serhii Posternak Over a year ago

Yes. I updated my answer and added an example json scheme to it.

Antonio Anerão · Accepted Answer · 2023-06-21 18:30:24Z

How about using assertJsonCount() to make sure you have the expected number of keys?

I have a DataTests class that contains a public static function that returns an array with the expected keys from my endpoint. If it returns more fields or less fields the count doen't match and the assertion fails.

DataTests.php

public static function arrayStructure(): array {
        return [
            //keys
        ];
    }

MyTest.php

public function test_array_structure() {
    $this->withHeaders($headers)->post(), [])
        ->assertJsonStructure(DataTests::arrayStructure())
        ->assertJsonCount(count(DataTests::arrayStructure(), COUNT_RECURSIVE));
    }

That way if I add a new column to my array in the future my tests will fail if I don't add the new value to my arrayStructure().

Collectives™ on Stack Overflow

Laravel test. assert exact JSON structure

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related