add json assertions on the TestResponseHelper

Signed-off-by: Tonko Mulder <[email protected]>

Author: Treggats

src/Tempest/Framework/Testing/Http/TestResponseHelper.php

@@ -9,6 +9,7 @@
 use PHPUnit\Framework\Assert;
 use Tempest\Http\Cookie\CookieManager;
 use Tempest\Http\Response;
+use Tempest\Http\Responses\Invalid;
 use Tempest\Http\Session\Session;
 use Tempest\Http\Status;
 use Tempest\Validation\Rule;
@@ -219,9 +220,54 @@ public function assertNotSee(string $search): self
         return $this;
     }
 
+    public function assertJson(array $expected): self
+    {
+        Assert::assertNotNull($this->response->body);
+        Assert::assertEquals($expected, $this->response->body);
+
+        return $this;
+    }
+
+    public function assertJsonByKeys(array $expected, array $keys): self
+    {
+        $filteredBody = array_reduce(
+            compact('expected'),
+            function ($carry) use ($keys) {
+                foreach ($keys as $key) {
+                    if (isset($this->response->body[$key])) {
+                        $carry[$key] = $this->response->body[$key];
+                    }
+
+                    if (str_contains($key, '.') && substr_count($key, '.') === 1) {
+                        [$relation, $relatedKey] = explode('.', $key);
+                        $carry[$relation][$relatedKey] = $this->body[$relation][$relatedKey];
+                    }
+                }
+
+                return $carry;
+            },
+            [],
+        );
+
+        Assert::assertNotEmpty($filteredBody);
+        Assert::assertEquals($expected, $filteredBody);
+
+        return $this;
+    }
+
+    public function assertHasNoJsonValidationErrors(): self
+    {
+        Assert::assertNotInstanceOf(Invalid::class, $this->response);
+
+        return $this;
+    }
+
     public function dd(): void
     {
-        // @phpstan-ignore disallowed.function
+        /**
+         * @noinspection ForgottenDebugOutputInspection
+         * @phpstan-ignore disallowed.function
+         */
         dd($this->response); // @mago-expect best-practices/no-debug-symbols
     }
 }

tests/Fixtures/Controllers/ValidationController.php

@@ -5,10 +5,12 @@
 namespace Tests\Tempest\Fixtures\Controllers;
 
 use Tempest\Http\Response;
+use Tempest\Http\Responses\Json;
 use Tempest\Http\Responses\Ok;
 use Tempest\Http\Responses\Redirect;
 use Tempest\Router\Get;
 use Tempest\Router\Post;
+use Tests\Tempest\Fixtures\Modules\Books\Models\Book;
 
 use function Tempest\uri;
 
@@ -25,4 +27,19 @@ public function store(RequestForValidationController $request): Response // @mag
     {
         return new Redirect(uri([self::class, 'get']));
     }
+
+    #[Get(uri: '/test-validation-responses-json/{book}')]
+    public function book(Book $book): Response
+    {
+        $book->load('author');
+
+        return new Json([
+            'id' => $book->id->id,
+            'title' => $book->title,
+            'author' => [
+                'id' => $book->author->id->id,
+                'name' => $book->author->name,
+            ],
+        ]);
+    }
 }

tests/Integration/Http/ValidationResponseTest.php

@@ -4,8 +4,13 @@
 
 namespace Tests\Tempest\Integration\Http;
 
+use Tempest\Database\Migrations\CreateMigrationsTable;
 use Tempest\Http\Session\Session;
 use Tests\Tempest\Fixtures\Controllers\ValidationController;
+use Tests\Tempest\Fixtures\Migrations\CreateAuthorTable;
+use Tests\Tempest\Fixtures\Migrations\CreateBookTable;
+use Tests\Tempest\Fixtures\Modules\Books\Models\Author;
+use Tests\Tempest\Fixtures\Modules\Books\Models\Book;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
 use function Tempest\uri;
@@ -43,4 +48,23 @@ public function test_original_values(): void
                 $this->assertEquals($values, $data);
             });
     }
+
+    public function test_assert_json_by_keys_assertion(): void
+    {
+        $this->migrate(
+            CreateMigrationsTable::class,
+            CreateBookTable::class,
+            CreateAuthorTable::class,
+        );
+
+        $author = Author::create(name: 'Homer');
+        Book::create(title: 'The Odyssee', author: $author);
+
+        $this->http
+            ->get(uri([ValidationController::class, 'book'], book: 1))
+            ->assertHasNoJsonValidationErrors()
+            ->assertJson(['id' => 1, 'title' => 'The Odyssee', 'author' => ['id' => 1, 'name' => 'Homer']])
+            ->assertJsonByKeys(['id' => 1, 'title' => 'The Odyssee'], ['id', 'title'])
+            ->assertJsonByKeys(['author' => ['name' => 'Homer']], ['author.name']);
+    }
 }