wip

aguingand · aguingand · commit b140c77cb4fe · 2026-01-22T16:31:20.000+01:00
diff --git a/docs/guide/testing.md b/docs/guide/testing.md
@@ -279,3 +279,13 @@ $this->sharpDashboard(MyDashboard::class)
     ->post()
     ->assertOk();
 ```
+
+## Global filters
+
+If your app contains global filters, you should be able to test normally, but it will be set to its default value. If you need, you can set a specific value using `withGlobalFilter()`:
+
+```php
+$this->withGlobalFilter(CompanyFilter::class, 'apple')
+    ->sharpList(Post::class)
+    //...
+```
diff --git a/src/Filters/GlobalFilters/GlobalFilters.php b/src/Filters/GlobalFilters/GlobalFilters.php
@@ -53,9 +53,14 @@ public function toArray(): array
     }
 
     public function isDeclared(string $key): bool
+    {
+        return $this->getDeclaredFilter($key) !== null;
+    }
+
+    public function getDeclaredFilter(string $key): ?GlobalRequiredFilter
     {
         return collect(sharp()->config()->get('global_filters'))
-            ->contains(function (GlobalRequiredFilter $filter) use ($key) {
+            ->first(function (GlobalRequiredFilter $filter) use ($key) {
                 $filter->buildFilterConfig();
 
                 if (class_exists($key)) {
diff --git a/src/Utils/Testing/EntityList/PendingEntityList.php b/src/Utils/Testing/EntityList/PendingEntityList.php
@@ -51,8 +51,11 @@ public function sharpForm(string $entityClassNameOrKey, string|int $instanceId):
 
     public function withFilter(string $filterKey, mixed $value): static
     {
-        $key = $this->entityList->filterContainer()->findFilterHandler($filterKey)->getKey();
-        $this->filterValues[$key] = $value;
+        $filter = $this->entityList->filterContainer()->findFilterHandler($filterKey);
+
+        PHPUnit::assertNotNull($filter, sprintf('Unknown entity list filter [%s]', $filterKey));
+
+        $this->filterValues[$filter->getKey()] = $value;
 
         return $this;
     }
diff --git a/src/Utils/Testing/HasGlobalFilters.php b/src/Utils/Testing/HasGlobalFilters.php
@@ -0,0 +1,67 @@
+<?php
+
+namespace Code16\Sharp\Utils\Testing;
+
+use Code16\Sharp\Filters\GlobalFilters\GlobalFilters;
+use Code16\Sharp\Filters\GlobalRequiredFilter;
+use Illuminate\Support\Facades\URL;
+use PHPUnit\Framework\Assert as PHPUnit;
+
+/**
+ * @internal
+ */
+trait HasGlobalFilters
+{
+    private array $globalFilterValues = [];
+    private ?string $globalFilterSegment = null;
+
+    public function withSharpGlobalFilter(string $globalFilterKeyOrClassName, mixed $value): static
+    {
+        $filter = app(GlobalFilters::class)->filterContainer()->findFilterHandler($globalFilterKeyOrClassName);
+
+        if (! $filter) {
+            $declaredFilter = app(GlobalFilters::class)->getDeclaredFilter($globalFilterKeyOrClassName);
+            PHPUnit::assertNotNull($declaredFilter, "Global filter [$globalFilterKeyOrClassName] is not declared.");
+            PHPUnit::assertTrue($declaredFilter->authorize(), "Global filter [$globalFilterKeyOrClassName] is not authorized.");
+            PHPUnit::assertNotEmpty($declaredFilter->values(), "Global filter [$globalFilterKeyOrClassName] has no values.");
+        }
+
+        $this->globalFilterValues[$filter->getKey()] = $value;
+
+        $this->setGlobalFilterUrlDefault();
+
+        return $this;
+    }
+
+    /**
+     * @deprecated use withSharpGlobalFilter() instead
+     */
+    public function withSharpGlobalFilterValues(array|string $globalFilterValues): static
+    {
+        $this->globalFilterSegment = collect((array) $globalFilterValues)
+            ->implode(GlobalFilters::$valuesUrlSeparator);
+
+        $this->setGlobalFilterUrlDefault();
+
+        return $this;
+    }
+
+    /**
+     * @internal
+     */
+    public function setGlobalFilterUrlDefault(): static
+    {
+        if ($this->globalFilterSegment) {
+            URL::defaults(['globalFilter' => $this->globalFilterSegment]);
+        } else {
+            $values = collect(app(GlobalFilters::class)->getFilters())
+                ->map(fn (GlobalRequiredFilter $globalFilter) => $this->globalFilterValues[$globalFilter->getKey()] ?? $globalFilter->defaultValue()
+                )
+                ->implode(GlobalFilters::$valuesUrlSeparator);
+
+            URL::defaults(['globalFilter' => $values ?: GlobalFilters::$defaultKey]);
+        }
+
+        return $this;
+    }
+}
diff --git a/src/Utils/Testing/SharpAssertions.php b/src/Utils/Testing/SharpAssertions.php
@@ -3,62 +3,58 @@
 namespace Code16\Sharp\Utils\Testing;
 
 use Closure;
-use Code16\Sharp\Filters\GlobalFilters\GlobalFilters;
 use Code16\Sharp\Http\Context\SharpBreadcrumb;
 use Code16\Sharp\Utils\Entities\SharpEntityManager;
 use Code16\Sharp\Utils\Links\BreadcrumbBuilder;
 use Code16\Sharp\Utils\Testing\Dashboard\PendingDashboard;
 use Code16\Sharp\Utils\Testing\EntityList\PendingEntityList;
 use Code16\Sharp\Utils\Testing\Form\PendingForm;
 use Code16\Sharp\Utils\Testing\Show\PendingShow;
-use Illuminate\Support\Facades\URL;
 
 trait SharpAssertions
 {
     use GeneratesCurrentPageUrl;
+    use HasGlobalFilters;
 
     private BreadcrumbBuilder $breadcrumbBuilder;
-    private ?string $globalFilter = null;
 
     public function setUpSharpAssertions(): void
     {
-        URL::defaults(['globalFilter' => $this->globalFilter ?: GlobalFilters::$defaultKey]);
+        $this->setGlobalFilterUrlDefault();
     }
 
     public function sharpList(string $entityClassNameOrKey): PendingEntityList
     {
+        $this->setGlobalFilterUrlDefault();
+
         return new PendingEntityList($this, $entityClassNameOrKey);
     }
 
     public function sharpShow(string $entityClassNameOrKey, int|string|null $instanceId = null): PendingShow
     {
+        $this->setGlobalFilterUrlDefault();
+
         return new PendingShow($this, $entityClassNameOrKey, $instanceId);
     }
 
     public function sharpForm(string $entityClassNameOrKey, int|string|null $instanceId = null): PendingForm
     {
+        $this->setGlobalFilterUrlDefault();
+
         return new PendingForm($this, $entityClassNameOrKey, $instanceId);
     }
 
     public function sharpDashboard(string $entityClassNameOrKey): PendingDashboard
     {
-        return new PendingDashboard($this, $entityClassNameOrKey);
-    }
-
-    public function withSharpGlobalFilterValues(array|string $globalFilterValues): self
-    {
-        $this->globalFilter = collect((array) $globalFilterValues)
-            ->implode(GlobalFilters::$valuesUrlSeparator);
-
-        URL::defaults(['globalFilter' => $this->globalFilter ?: GlobalFilters::$defaultKey]);
+        $this->setGlobalFilterUrlDefault();
 
-        return $this;
+        return new PendingDashboard($this, $entityClassNameOrKey);
     }
 
     /**
      * @deprecated use withSharpBreadcrumb() instead
      */
-    public function withSharpCurrentBreadcrumb(...$breadcrumb): self
+    public function withSharpCurrentBreadcrumb(...$breadcrumb): static
     {
         $this->breadcrumbBuilder = new BreadcrumbBuilder();
 
@@ -77,7 +73,7 @@ public function withSharpCurrentBreadcrumb(...$breadcrumb): self
      * @param  (\Closure(BreadcrumbBuilder): BreadcrumbBuilder)  $callback
      * @return $this
      */
-    public function withSharpBreadcrumb(Closure $callback): self
+    public function withSharpBreadcrumb(Closure $callback): static
     {
         $this->breadcrumbBuilder = $callback(new BreadcrumbBuilder());
 
@@ -92,7 +88,6 @@ public function deleteFromSharpShow(string $entityClassNameOrKey, mixed $instanc
             ->delete(
                 route(
                     'code16.sharp.show.delete', [
-                        'globalFilter' => $this->globalFilter,
                         'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                         'entityKey' => $entityKey,
                         'instanceId' => $instanceId,
@@ -114,7 +109,6 @@ public function deleteFromSharpList(string $entityClassNameOrKey, mixed $instanc
             )
             ->delete(
                 route('code16.sharp.api.list.delete', [
-                    'globalFilter' => $this->globalFilter,
                     'entityKey' => $entityKey,
                     'instanceId' => $instanceId,
                 ])
@@ -131,7 +125,6 @@ public function getSharpForm(string $entityClassNameOrKey, mixed $instanceId = n
                     ? route(
                         'code16.sharp.form.edit',
                         [
-                            'globalFilter' => $this->globalFilter,
                             'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                             'entityKey' => $entityKey,
                             'instanceId' => $instanceId,
@@ -140,7 +133,6 @@ public function getSharpForm(string $entityClassNameOrKey, mixed $instanceId = n
                     : route(
                         'code16.sharp.form.create',
                         [
-                            'globalFilter' => $this->globalFilter,
                             'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                             'entityKey' => $entityKey,
                         ]
@@ -157,7 +149,6 @@ public function getSharpSingleForm(string $entityClassNameOrKey)
                 route(
                     'code16.sharp.form.edit',
                     [
-                        'globalFilter' => $this->globalFilter,
                         'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                         'entityKey' => $entityKey,
                     ]
@@ -173,7 +164,6 @@ public function updateSharpForm(string $entityClassNameOrKey, $instanceId, array
             ->post(
                 route(
                     'code16.sharp.form.update', [
-                        'globalFilter' => $this->globalFilter,
                         'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                         'entityKey' => $entityKey,
                         'instanceId' => $instanceId,
@@ -191,7 +181,6 @@ public function updateSharpSingleForm(string $entityClassNameOrKey, array $data)
             ->post(
                 route(
                     'code16.sharp.form.update', [
-                        'globalFilter' => $this->globalFilter,
                         'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                         'entityKey' => $entityKey,
                     ]
@@ -209,7 +198,6 @@ public function getSharpShow(string $entityClassNameOrKey, $instanceId)
                 route(
                     'code16.sharp.show.show',
                     [
-                        'globalFilter' => $this->globalFilter,
                         'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                         'entityKey' => $entityKey,
                         'instanceId' => $instanceId,
@@ -227,7 +215,6 @@ public function storeSharpForm(string $entityClassNameOrKey, array $data)
                 route(
                     'code16.sharp.form.store',
                     [
-                        'globalFilter' => $this->globalFilter,
                         'parentUri' => $this->breadcrumbBuilder($entityKey)->generateUri(),
                         'entityKey' => $entityKey,
                     ]
@@ -317,7 +304,7 @@ public function callSharpEntityCommandFromList(
             );
     }
 
-    public function loginAsSharpUser($user): self
+    public function loginAsSharpUser($user): static
     {
         return $this->actingAs($user, sharp()->config()->get('auth.guard') ?: config('auth.defaults.guard'));
     }
diff --git a/tests/Http/SharpAssertionsHttpTest.php b/tests/Http/SharpAssertionsHttpTest.php
@@ -24,6 +24,7 @@
 use Code16\Sharp\Utils\Testing\SharpAssertions;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Testing\Fluent\AssertableJson;
+use Illuminate\Testing\TestResponse;
 
 pest()
     ->use(ResetUrlDefaults::class)
@@ -794,3 +795,59 @@ public function execute(array $data = []): array
         ->dashboardCommand('cmd-form')->getForm()->post(['action' => 'info'])
         ->assertReturnsInfo('dashboard');
 });
+
+it('set default global filter', function () {
+    fakeGlobalFilter();
+
+    $this
+        ->sharpList(PersonEntity::class)
+        ->get()
+        ->assertOk()
+        ->tap(fn (TestResponse $response) => expect($response->baseRequest->route('globalFilter'))->toEqual('two')
+        );
+
+    $this
+        ->sharpShow(PersonEntity::class, 1)
+        ->get()
+        ->assertOk()
+        ->tap(fn (TestResponse $response) => expect($response->baseRequest->route('globalFilter'))->toEqual('two')
+        );
+
+    $this
+        ->sharpForm(PersonEntity::class)
+        ->create()
+        ->assertOk()
+        ->tap(fn (TestResponse $response) => expect($response->baseRequest->route('globalFilter'))->toEqual('two')
+        );
+});
+
+it('set specified global filter', function () {
+    fakeGlobalFilter('test');
+
+    $this->withSharpGlobalFilter('test', 'one');
+
+    $this
+        ->sharpList(PersonEntity::class)
+        ->get()
+        ->assertOk()
+        ->tap(fn (TestResponse $response) => expect($response->baseRequest->route('globalFilter'))->toEqual('one')
+        );
+
+    $this->withSharpGlobalFilter('test', 'two');
+
+    $this
+        ->sharpShow(PersonEntity::class, 1)
+        ->get()
+        ->assertOk()
+        ->tap(fn (TestResponse $response) => expect($response->baseRequest->route('globalFilter'))->toEqual('two')
+        );
+
+    $this->withSharpGlobalFilter('test', 'one');
+
+    $this
+        ->sharpForm(PersonEntity::class)
+        ->create()
+        ->assertOk()
+        ->tap(fn (TestResponse $response) => expect($response->baseRequest->route('globalFilter'))->toEqual('one')
+        );
+});

Original file line number	Diff line number	Diff line change
`@@ -53,9 +53,14 @@ public function toArray(): array`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`public function isDeclared(string $key): bool`
	`56`	`+ {`
	`57`	`+ return $this->getDeclaredFilter($key) !== null;`
	`58`	`+ }`
	`59`	`+`
	`60`	`+ public function getDeclaredFilter(string $key): ?GlobalRequiredFilter`
`56`	`61`	`{`
`57`	`62`	`return collect(sharp()->config()->get('global_filters'))`
`58`		`- ->contains(function (GlobalRequiredFilter $filter) use ($key) {`
	`63`	`+ ->first(function (GlobalRequiredFilter $filter) use ($key) {`
`59`	`64`	`$filter->buildFilterConfig();`
`60`	`65`
`61`	`66`	`if (class_exists($key)) {`
Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,11 @@ public function sharpForm(string $entityClassNameOrKey, string\|int $instanceId):`
`51`	`51`
`52`	`52`	`public function withFilter(string $filterKey, mixed $value): static`
`53`	`53`	`{`
`54`		`- $key = $this->entityList->filterContainer()->findFilterHandler($filterKey)->getKey();`
`55`		`- $this->filterValues[$key] = $value;`
	`54`	`+ $filter = $this->entityList->filterContainer()->findFilterHandler($filterKey);`
	`55`	`+`
	`56`	`+ PHPUnit::assertNotNull($filter, sprintf('Unknown entity list filter [%s]', $filterKey));`
	`57`	`+`
	`58`	`+ $this->filterValues[$filter->getKey()] = $value;`
`56`	`59`
`57`	`60`	`return $this;`
`58`	`61`	`}`