Find extra elements with assertJsonStructure()

@Nakov Unfortunately assertExactJson() is not only validating the structure, but also the data. I'm looking for a way to validation the structure of a json string.

I've been playing around a bit with the Fluent Json testing, but I can't get it to work as I would have hoped. Although this is working, it's not very dynamic:

        $response = new TestResponse(new Response($json));
        $response->assertJson(fn (AssertableJson $json) =>
            $json->has('books.0', fn ($json) =>
                $json->has('isbn')
                    ->has('title')
                    ->has('author')
            )->has('books.1', fn ($json) =>
                $json->has('isbn')
                    ->has('title')
                    ->has('author')
            )
        );

How can I make it test all books without having to specify if for each book? let's say I want to validation the json of a complete library ;-)

@madman81 I don’t get the point of dynamic testing I wouldn’t do that in unit tests. I might use data providers (https://tighten.com/blog/tidying-up-your-phpunit-tests-with-data-providers) to test different cases but validating that 100 books all match does not make the sense if the code works for two books it will work for 100 as long as the cases are not different, if you happen to find different case you just update the data provider and ensure that your class returns the correct result.

@Nakov One of the goals of the unit test is also to validate that no more data is published than necessary. And this is a simplified example of course. In this example I want to make sure that all books have at least "isbn", "title" and "author". Next, some attribute might be present for some books, but not for others, like "price". This should be considered valid data. But if someone changes the code and adds for example "publisher" to the dataset, the unit test should fail. Of course it's impossible to say what attributes might be added in the future, but all should make the unit test fail.

assertJsonStructure() is great for validating that a minimal set of attributes are present, but that's not enough in this case.

@madman81 What if you wrap the response json in a collection and iterate over each item?

collect($json)->each(function(array $book) {
    $this->assertCount(3, array_keys($book));
    $this->assertTrue(isset($book['isbn'])); 
    $this->assertTrue(isset($book['title']));
    $this->assertTrue(isset($book['author']));
});

edit just read your last reply. maybe something like this where you check for disallowed attributes

$allowed = collect(['isbn','title','author','price']);

collect($json)->each(function(array $book) use ($allowed) {
    $keys = collect(array_keys($book));
	$this->assertCount(0, $keys->diff($allowed));
});

@jbloomstrom I like your solution, I used it to beautify my own implementation

A unit test to show how to use it:

    public function testLargeJson()
    {
        $json = '{
            "library_name": "My books",
            "count": 2,
            "books": [
                {
                    "isbn": 123456,
                    "title": "Nice book",
                    "chapters": [
                        "Intro",
                        "Chapter 1"
                    ],
                    "authors": [
                        {
                            "name": "Awesome writer",
                            "sex": "Male",
                            "age": 45
                        },
                        {
                            "name": "Another writer",
                            "age": 54
                        }
                    ]
                },
                {
                    "isbn": 789123,
                    "title": "Great book",
                    "authors": [
                        {
                            "name": "Awesome writer",
                            "sex": "Male",
                            "age": 45
                        }
                    ]
                }
            ]
        }';

        $structure = [
            'library_name',
            'count',
            'books' => [
                '*' => [
                    'isbn',
                    'title',
                    'chapters' => [],
                    'authors' => [
                        '*' => [
                            'name',
                            'sex',
                            'age'
                        ],
                    ],
                ],
            ],
        ];

        $this->assertTrue(JsonValidator::validateJson($structure, $json));
        $this->assertFalse(JsonValidator::validateJson($structure, $json, true));

        unset($structure['books']['*'][1]); //Remove "title"

        $this->assertFalse(JsonValidator::validateJson($structure, $json));
        $this->assertFalse(JsonValidator::validateJson($structure, $json, true));
    }