feat(testing): Add view data assertions

Author: Xammie

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

@@ -59,7 +59,7 @@ public function assertHeaderContains(string $name, mixed $value): self
         Assert::assertContains(
             $value,
             $header->values,
-            sprintf('Failed to assert that response header [%s] value contains %s. These header values were found: %s', $name, $value, $headerString),
+            sprintf('Failed to assert that response header [%s] value contains [%s]. These header values were found: %s', $name, $value, $headerString),
         );
 
         return $this;
@@ -132,7 +132,7 @@ public function assertHasSession(string $key, ?Closure $test = null): self
         Assert::assertNotNull(
             $data,
             sprintf(
-                'No session value was set for %s, available session keys: %s',
+                'No session value was set for [%s], available session keys: %s',
                 $key,
                 implode(', ', array_keys($session->data)),
             ),
@@ -156,7 +156,7 @@ public function assertHasValidationError(string $key, ?Closure $test = null): se
             $key,
             $validationErrors,
             sprintf(
-                'No validation error was set for %s, available validation errors: %s',
+                'No validation error was set for [%s], available validation errors: %s',
                 $key,
                 implode(', ', array_keys($validationErrors)),
             ),
@@ -219,6 +219,78 @@ public function assertNotSee(string $search): self
         return $this;
     }
 
+    public function assertViewData(string $key, ?Closure $test = null): self
+    {
+        $data = $this->body->data;
+        $value = $data[$key];
+
+        Assert::assertArrayHasKey(
+            key: $key,
+            array: $data,
+            message: sprintf(
+                'No view data was set for [%s], available view data keys: %s',
+                $key,
+                implode(', ', array_keys($data)),
+            ),
+        );
+
+        if ($test !== null) {
+            $test($data, $value);
+        }
+
+        return $this;
+    }
+
+    public function assertViewDataMissing(string $key): self
+    {
+        $data = $this->body->data;
+
+        Assert::assertArrayNotHasKey(
+            key: $key,
+            array: $data,
+            message: sprintf('Failed asserting that view data key [%s] was not set', $key),
+        );
+
+        return $this;
+    }
+
+    public function assertViewDataAll(Closure $test): self
+    {
+        $data = $this->body->data;
+
+        $test($data);
+
+        return $this;
+    }
+
+    public function assertView(string $view): self
+    {
+        if (! ($this->body instanceof View)) {
+            Assert::fail(sprintf('Response is not a %s', View::class));
+        }
+
+        Assert::assertEquals(
+            expected: $view,
+            actual: $this->body->path,
+        );
+
+        return $this;
+    }
+
+    public function assertViewModel(string $expected, ?Closure $test = null): self
+    {
+        Assert::assertInstanceOf(
+            expected: $expected,
+            actual: $this->body,
+        );
+
+        if ($test !== null) {
+            $test($this->body);
+        }
+
+        return $this;
+    }
+
     public function dd(): void
     {
         // @phpstan-ignore disallowed.function

tests/Fixtures/Controllers/TestController.php

@@ -20,6 +20,7 @@
 use Tempest\Router\Put;
 use Tempest\Router\Trace;
 use Tempest\View\View;
+use Tests\Tempest\Fixtures\Views\ViewModel;
 use Tests\Tempest\Fixtures\Views\ViewWithResponseData;
 
 use function Tempest\view;
@@ -96,4 +97,10 @@ public function viewWithResponseData(): Response
         return new Created(new ViewWithResponseData())
             ->addHeader('x-from-view', 'true');
     }
+
+    #[Get('/view-model')]
+    public function viewModel(): Response
+    {
+        return new Ok(new ViewModel('Brent'));
+    }
 }

tests/Fixtures/Views/ViewModel.php

@@ -14,7 +14,8 @@ final class ViewModel implements View
     public function __construct(
         public readonly string $name,
     ) {
-        $this->path = __DIR__ . '/withViewModel.php';
+        $this->path = 'withViewModel.php';
+        $this->relativeRootPath = __DIR__;
     }
 
     public function currentDate(): string

tests/Integration/Http/ViewDataTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Integration\Http;
+
+use Tempest\View\GenericView;
+use Tests\Tempest\Fixtures\Controllers\RelativeViewController;
+use Tests\Tempest\Fixtures\Controllers\TestController;
+use Tests\Tempest\Fixtures\Views\ViewModel;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+use function Tempest\uri;
+
+/**
+ * @internal
+ */
+final class ViewDataTest extends FrameworkIntegrationTestCase
+{
+    public function test_can_assert_view_data(): void
+    {
+        $this->http
+            ->get(uri([TestController::class, 'withView']))
+            ->assertViewData('name')
+            ->assertViewData('name', function (array $data, string $value): void {
+                $this->assertEquals(['name' => 'Brent'], $data);
+                $this->assertEquals('Brent', $value);
+            })
+            ->assertViewDataMissing('email')
+            ->assertViewDataAll(function (array $data): void {
+                $this->assertEquals(['name' => 'Brent'], $data);
+            });
+    }
+
+    public function test_can_assert_generic_view_model(): void
+    {
+        $this->http
+            ->get(uri([RelativeViewController::class, 'asFunction']))
+            ->assertViewModel(GenericView::class)
+            ->assertView('./relative-view.view.php');
+    }
+
+    public function test_can_assert_view_model(): void
+    {
+        $this->http
+            ->get(uri([TestController::class, 'viewModel']))
+            ->assertViewModel(ViewModel::class, function (ViewModel $model): void {
+                $this->assertEquals('Brent', $model->name);
+            })
+            ->assertView('withViewModel.php');
+    }
+}