add json assertions on the TestResponseHelper

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

Author: Treggats

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

@@ -6,9 +6,11 @@
 
 use Closure;
 use Generator;
+use JsonException;
 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 +221,77 @@ 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(
+            [$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 assertHasJsonValidationError(string $key, ?Closure $test = null): self
+    {
+        Assert::assertInstanceOf(Invalid::class, $this->response);
+
+        $validationErrors = array_map(function ($failingRules) use ($key) {
+            try {
+                $errors = json_decode($failingRules, true, 512, JSON_THROW_ON_ERROR);
+            } catch (JsonException) {
+                $errors = [];
+            }
+
+            return arr($errors)->filter(fn (array $_error, $errorKey) => $errorKey === $key)->flatten()->first();
+        }, $this->response->getHeader('x-validation')->values);
+
+        Assert::assertNotEmpty($validationErrors, message: 'no validation errors found');
+
+        if ($test !== null) {
+            $test($validationErrors);
+        }
+
+        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/Integration/Http/ValidationResponseTest.php

@@ -4,8 +4,14 @@
 
 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\Migrations\CreatePublishersTable;
+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 +49,76 @@ public function test_original_values(): void
                 $this->assertEquals($values, $data);
             });
     }
+
+    public function test_assert_json_by_keys_assertion(): void
+    {
+        $this->migrate(
+            CreateMigrationsTable::class,
+            CreatePublishersTable::class,
+            CreateAuthorTable::class,
+            CreateBookTable::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']);
+    }
+
+    public function test_update_book(): void
+    {
+        $this->migrate(
+            CreateMigrationsTable::class,
+            CreatePublishersTable::class,
+            CreateAuthorTable::class,
+            CreateBookTable::class,
+        );
+
+        $book = Book::create(
+            title: 'The Odyssee',
+            author: Author::create(name: 'Homer'),
+        );
+
+        $this->http
+            ->post(
+                uri([ValidationController::class, 'updateBook'], book: 1),
+                body: ['title' => 'Beyond the Odyssee'],
+            )
+            ->assertOk();
+
+        $book->refresh();
+
+        $this->assertSame($book->title, 'Beyond the Odyssee');
+    }
+
+    public function test_failing_post_request(): void
+    {
+        $this->migrate(
+            CreateMigrationsTable::class,
+            CreatePublishersTable::class,
+            CreateAuthorTable::class,
+            CreateBookTable::class,
+        );
+
+        Book::create(
+            title: 'The Odyssee',
+            author: Author::create(name: 'Homer'),
+        );
+
+        $this->http
+            ->post(
+                uri([ValidationController::class, 'updateBook'], book: 1),
+                body: ['book' => ['title' => 1]],
+            )
+            ->assertHasJsonValidationError('title', function (array $errors): void {
+                $this->assertContains('Value should be between 1 and 120', $errors);
+            });
+
+        $this->assertSame('The Odyssee', Book::find(id: 1)->first()->title);
+    }
 }