Add assertInertiaFlash and assertInertiaFlashMissing helpers

Author: pascalbaljet

src/Testing/AssertableInertia.php

@@ -232,34 +232,56 @@ public function reloadExcept(array|string $except, ?Closure $callback = null): s
      * Assert that the Flash Data contains the given key, optionally with the expected value.
      */
     public function hasFlash(string $key, mixed $expected = null): self
+    {
+        func_num_args() > 1
+            ? static::assertFlashHas($this->flash, $key, $expected)
+            : static::assertFlashHas($this->flash, $key);
+
+        return $this;
+    }
+
+    /**
+     * Assert that the Flash Data does not contain the given key.
+     */
+    public function missingFlash(string $key): self
+    {
+        static::assertFlashMissing($this->flash, $key);
+
+        return $this;
+    }
+
+    /**
+     * Assert that the given flash data array contains the given key, optionally with the expected value.
+     *
+     * @param  array<string, mixed>  $flash
+     */
+    public static function assertFlashHas(array $flash, string $key, mixed $expected = null): void
     {
         PHPUnit::assertTrue(
-            Arr::has($this->flash, $key),
+            Arr::has($flash, $key),
             sprintf('Inertia Flash Data is missing key [%s].', $key)
         );
 
-        if (func_num_args() > 1) {
+        if (func_num_args() > 2) {
             PHPUnit::assertSame(
                 $expected,
-                Arr::get($this->flash, $key),
+                Arr::get($flash, $key),
                 sprintf('Inertia Flash Data [%s] does not match expected value.', $key)
             );
         }
-
-        return $this;
     }
 
     /**
-     * Assert that the Flash Data does not contain the given key.
+     * Assert that the given flash data array does not contain the given key.
+     *
+     * @param  array<string, mixed>  $flash
      */
-    public function missingFlash(string $key): self
+    public static function assertFlashMissing(array $flash, string $key): void
     {
         PHPUnit::assertFalse(
-            Arr::has($this->flash, $key),
+            Arr::has($flash, $key),
             sprintf('Inertia Flash Data has unexpected key [%s].', $key)
         );
-
-        return $this;
     }
 
     /**

src/Testing/TestResponseMacros.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Illuminate\Support\Arr;
+use Inertia\SessionKey;
 
 class TestResponseMacros
 {
@@ -55,4 +56,40 @@ public function inertiaProps()
             return Arr::get($page['props'], $propName);
         };
     }
+
+    /**
+     * Register the 'assertInertiaFlash' macro for TestResponse.
+     *
+     * @return Closure
+     */
+    public function assertInertiaFlash()
+    {
+        return function (string $key, mixed $expected = null) {
+            /** @phpstan-ignore-next-line */
+            $flash = $this->session()->get(SessionKey::FlashData->value, []);
+
+            func_num_args() > 1
+                ? AssertableInertia::assertFlashHas($flash, $key, $expected)
+                : AssertableInertia::assertFlashHas($flash, $key);
+
+            return $this;
+        };
+    }
+
+    /**
+     * Register the 'assertInertiaFlashMissing' macro for TestResponse.
+     *
+     * @return Closure
+     */
+    public function assertInertiaFlashMissing()
+    {
+        return function (string $key) {
+            /** @phpstan-ignore-next-line */
+            $flash = $this->session()->get(SessionKey::FlashData->value, []);
+
+            AssertableInertia::assertFlashMissing($flash, $key);
+
+            return $this;
+        };
+    }
 }

tests/Testing/TestResponseMacrosTest.php

@@ -2,10 +2,14 @@
 
 namespace Inertia\Tests\Testing;
 
+use Illuminate\Session\Middleware\StartSession;
+use Illuminate\Support\Facades\Route;
 use Illuminate\Testing\Fluent\AssertableJson;
 use Illuminate\Testing\TestResponse;
 use Inertia\Inertia;
+use Inertia\Middleware;
 use Inertia\Tests\TestCase;
+use PHPUnit\Framework\AssertionFailedError;
 
 class TestResponseMacrosTest extends TestCase
 {
@@ -77,4 +81,66 @@ public function test_it_can_retrieve_nested_inertia_prop_values_with_dot_notatio
         $this->assertSame('qux', $response->inertiaProps('bar.baz'));
         $this->assertSame('John', $response->inertiaProps('users.0.name'));
     }
+
+    public function test_it_can_assert_flash_data_on_redirect_responses(): void
+    {
+        $middleware = [StartSession::class, Middleware::class];
+
+        Route::middleware($middleware)->post('/users', function () {
+            return Inertia::flash([
+                'message' => 'User created!',
+                'notification' => ['type' => 'success'],
+            ])->back();
+        });
+
+        $this->post('/users')
+            ->assertRedirect()
+            ->assertInertiaFlash('message')
+            ->assertInertiaFlash('message', 'User created!')
+            ->assertInertiaFlash('notification.type', 'success')
+            ->assertInertiaFlashMissing('error')
+            ->assertInertiaFlashMissing('notification.other');
+    }
+
+    public function test_assert_has_inertia_flash_fails_when_key_is_missing(): void
+    {
+        $middleware = [StartSession::class, Middleware::class];
+
+        Route::middleware($middleware)->post('/users', function () {
+            return Inertia::flash('message', 'Hello')->back();
+        });
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Inertia Flash Data is missing key [other].');
+
+        $this->post('/users')->assertInertiaFlash('other');
+    }
+
+    public function test_assert_has_inertia_flash_fails_when_value_does_not_match(): void
+    {
+        $middleware = [StartSession::class, Middleware::class];
+
+        Route::middleware($middleware)->post('/users', function () {
+            return Inertia::flash('message', 'Hello')->back();
+        });
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Inertia Flash Data [message] does not match expected value.');
+
+        $this->post('/users')->assertInertiaFlash('message', 'Different');
+    }
+
+    public function test_assert_missing_inertia_flash_fails_when_key_exists(): void
+    {
+        $middleware = [StartSession::class, Middleware::class];
+
+        Route::middleware($middleware)->post('/users', function () {
+            return Inertia::flash('message', 'Hello')->back();
+        });
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('Inertia Flash Data has unexpected key [message].');
+
+        $this->post('/users')->assertInertiaFlashMissing('message');
+    }
 }