From 97ed9f87dc982cd04fdc33dadb31e2df1175d964 Mon Sep 17 00:00:00 2001
From: Ryan Chandler <ryangjchandler@gmail.com>
Date: Fri, 22 Apr 2022 15:40:14 +0100
Subject: [PATCH] feature: page action testing helpers

---
 packages/admin/.stubs.php                     |  7 +++++
 .../admin/src/FilamentServiceProvider.php     |  4 +++
 packages/admin/src/Testing/TestsPages.php     | 31 +++++++++++++++++++
 .../views/fixtures/pages/actions.blade.php    |  0
 tests/src/Admin/Fixtures/Pages/Actions.php    | 27 ++++++++++++++++
 tests/src/Admin/Pages/PageActionTest.php      | 25 +++++++++++++++
 .../src/Admin/Pages/PagesServiceProvider.php  |  2 ++
 7 files changed, 96 insertions(+)
 create mode 100644 packages/admin/.stubs.php
 create mode 100644 packages/admin/src/Testing/TestsPages.php
 create mode 100644 tests/resources/views/fixtures/pages/actions.blade.php
 create mode 100644 tests/src/Admin/Fixtures/Pages/Actions.php
 create mode 100644 tests/src/Admin/Pages/PageActionTest.php

diff --git a/packages/admin/.stubs.php b/packages/admin/.stubs.php
new file mode 100644
index 0000000000..76c3a04d1d
--- /dev/null
+++ b/packages/admin/.stubs.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Livewire\Testing {
+    class TestableLivewire {
+        public function callPageAction(string $name, array $formData = []): static {}
+    }
+}
diff --git a/packages/admin/src/FilamentServiceProvider.php b/packages/admin/src/FilamentServiceProvider.php
index 699a903ee9..634585742c 100644
--- a/packages/admin/src/FilamentServiceProvider.php
+++ b/packages/admin/src/FilamentServiceProvider.php
@@ -14,6 +14,7 @@ use Filament\Http\Responses\Auth\LogoutResponse;
 use Filament\Pages\Dashboard;
 use Filament\Pages\Page;
 use Filament\Resources\Resource;
+use Filament\Testing\TestsPages;
 use Filament\Widgets\AccountWidget;
 use Filament\Widgets\FilamentInfoWidget;
 use Filament\Widgets\Widget;
@@ -22,6 +23,7 @@ use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Livewire\Component;
 use Livewire\Livewire;
+use Livewire\Testing\TestableLivewire;
 use ReflectionClass;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -90,6 +92,8 @@ class FilamentServiceProvider extends PackageServiceProvider
 
     public function packageBooted(): void
     {
+        TestableLivewire::mixin(new TestsPages);
+
         $this->bootLivewireComponents();
     }
 
diff --git a/packages/admin/src/Testing/TestsPages.php b/packages/admin/src/Testing/TestsPages.php
new file mode 100644
index 0000000000..0c4c681399
--- /dev/null
+++ b/packages/admin/src/Testing/TestsPages.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Filament\Testing;
+
+/**
+ * @mixin \Livewire\Testing\TestableLivewire
+ */
+class TestsPages
+{
+    public function callPageAction()
+    {
+        return function (string $name, array $formData = []) {
+            $this
+                ->call('mountAction', $name)
+                ->assertSet('mountedAction', $name)
+                ->set('mountedActionData', $formData);
+
+            $action = $this->instance()->getMountedAction();
+
+            if ($action->shouldOpenModal()) {
+                $this
+                ->assertDispatchedBrowserEvent('open-modal', [
+                    'id' => 'page-action'
+                ])
+                ->call('callMountedAction');
+            }
+
+            return $this->call('callMountedAction');
+        };
+    }
+}
diff --git a/tests/resources/views/fixtures/pages/actions.blade.php b/tests/resources/views/fixtures/pages/actions.blade.php
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/src/Admin/Fixtures/Pages/Actions.php b/tests/src/Admin/Fixtures/Pages/Actions.php
new file mode 100644
index 0000000000..544c7c378c
--- /dev/null
+++ b/tests/src/Admin/Fixtures/Pages/Actions.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Filament\Tests\Admin\Fixtures\Pages;
+
+use Filament\Forms\Components\TextInput;
+use Filament\Pages\Actions\ButtonAction;
+use Filament\Pages\Page;
+use Illuminate\Contracts\View\View;
+
+class Actions extends Page
+{
+    protected static string $view = 'fixtures.pages.actions';
+
+    protected function getActions(): array|View|null
+    {
+        return [
+            ButtonAction::make('foo')
+                ->action(fn () => $this->dispatchBrowserEvent('foo-called')),
+            ButtonAction::make('foo-form')
+                ->form([
+                    TextInput::make('name')
+                        ->required()
+                ])
+                ->action(fn (array $data) => $this->dispatchBrowserEvent('foo-form-called', $data)),
+        ];
+    }
+}
diff --git a/tests/src/Admin/Pages/PageActionTest.php b/tests/src/Admin/Pages/PageActionTest.php
new file mode 100644
index 0000000000..50073ce53e
--- /dev/null
+++ b/tests/src/Admin/Pages/PageActionTest.php
@@ -0,0 +1,25 @@
+<?php
+
+use Filament\Tests\Admin\Fixtures\Pages\Actions;
+use Filament\Tests\Admin\Pages\TestCase;
+use Livewire\Livewire;
+
+uses(TestCase::class);
+
+it('can call a page action', function () {
+    Livewire::test(Actions::class)
+        ->callPageAction('foo')
+        ->assertSuccessful()
+        ->assertDispatchedBrowserEvent('foo-called');
+});
+
+it('can call a page action with data', function () {
+    Livewire::test(Actions::class)
+        ->callPageAction('foo-form', [
+            'name' => 'Ryan',
+        ])
+        ->assertHasNoErrors()
+        ->assertDispatchedBrowserEvent('foo-form-called', [
+            'name' => 'Ryan',
+        ]);
+});
diff --git a/tests/src/Admin/Pages/PagesServiceProvider.php b/tests/src/Admin/Pages/PagesServiceProvider.php
index 0cf037352c..52b33faee3 100644
--- a/tests/src/Admin/Pages/PagesServiceProvider.php
+++ b/tests/src/Admin/Pages/PagesServiceProvider.php
@@ -3,6 +3,7 @@
 namespace Filament\Tests\Admin\Pages;
 
 use Filament\PluginServiceProvider;
+use Filament\Tests\Admin\Fixtures\Pages\Actions;
 use Filament\Tests\Admin\Fixtures\Pages\Settings;
 
 class PagesServiceProvider extends PluginServiceProvider
@@ -13,6 +14,7 @@ class PagesServiceProvider extends PluginServiceProvider
     {
         return [
             Settings::class,
+            Actions::class,
         ];
     }
 }