update data assertion methods

Author: aguingand

docs/guide/testing.md

@@ -1,5 +1,9 @@
 # Testing
 
+::: tip INFO
+This page documents the new Testing API. If you use the legacy one, please refer to [Testing (legacy)](../legacy/testing.md).
+:::
+
 Sharp provides a fluent testing API to help you test your Sharp code. These assertions and helpers are designed to be used in Feature tests.
 
 ## The `SharpAssertions` trait
@@ -24,7 +28,7 @@ use Code16\Sharp\Utils\Testing\SharpAssertions;
 
 pest()
     ->extend(\Tests\TestCase::class)
-    ->use(SharpAssertions::class)
+    ->use(SharpAssertions::class);
 ```
 
 ## Authentication
@@ -57,8 +61,11 @@ Starts a fluent interaction with an Entity List.
 $this->sharpList(Post::class)
     ->get()
     ->assertOk()
-    ->assertListCount(3)
-    ->assertListContains(['title' => 'My first post']);
+    ->assertListData(fn (AssertableJson $data) => $data
+        ->count(3)
+        ->has('0.title', 'My first post')
+        ->etc()
+    );
 ```
 
 ### Filtering the list
@@ -85,11 +92,15 @@ $this->sharpList(Post::class)
 ```
 
 If the command has a form, you can test it:
-
+    
 ```php
 $this->sharpList(Post::class)
     ->entityCommand(ExportPosts::class)
     ->getForm()
+    ->assertFormData(fn (AssertableJson $data) => $data
+        ->where('format', 'xls')
+        ->etc()
+    )
     ->post(['format' => 'csv'])
     ->assertOk();
 ```
@@ -117,6 +128,10 @@ $this->sharpList(Post::class)
     ->post(['step1_data' => 'value'])
     ->assertReturnsStep('step2')
     ->getNextStepForm()
+    ->assertFormData(fn (AssertableJson $data) => $data
+        ->where('step2_field', 'default')
+        ->etc()
+    )
     ->post(['step2_data' => 'value'])
     ->assertOk();
 ```
@@ -133,10 +148,11 @@ Starts a fluent interaction with a Show Page.
 $this->sharpShow(Post::class, 1)
     ->get()
     ->assertOk()
-    ->assertShowData([
-        'title' => 'My first post',
-        'author' => 'John Doe'
-    ]);
+    ->assertShowData(fn (AssertableJson $data) => $data
+        ->where('title', 'My first post')
+        ->where('author', 'John Doe')
+        ->etc()
+    );
 ```
 
 ### Instance Commands from Show
@@ -148,6 +164,43 @@ $this->sharpShow(Post::class, 1)
     ->assertOk();
 ```
 
+### List & dashboard fields
+
+Show Pages can contain embedded Entity Lists or Dashboards. You can test them using `sharpListField()` and `sharpDashboardField()`.
+
+#### `sharpListField(string $entityKey)`
+
+```php
+$this->sharpShow(Post::class, 1)
+    ->sharpListField(Comment::class)
+    ->get()
+    ->assertOk()
+    ->assertListData(fn (AssertableJson $data) => $data
+        ->count(5)
+    );
+```
+
+#### `sharpDashboardField(string $entityKey)`
+
+```php
+$this->sharpShow(User::class, 1)
+    ->sharpDashboardField(UserStatsDashboard::class)
+    ->get()
+    ->assertOk();
+```
+
+### Nested shows
+
+There are some cases where you have nested shows by navigating through Show List fields. You can chain `sharpShow()` calls to simulate the correct breadcrumb :
+
+```php
+$this->sharpList(Post::class)
+    ->sharpShow(Post::class, 1)
+    ->sharpListField(Comment::class)
+    ->sharpShow(Comment::class, 1)
+    ->assertOk();
+```
+
 ## Testing Forms
 
 Use `sharpForm()` to test your Forms.
@@ -180,7 +233,10 @@ If you want to test that the form displays correctly:
 $this->sharpForm(Post::class, 1)
     ->edit()
     ->assertOk()
-    ->assertFormData(['title' => 'Existing Post']);
+    ->assertFormData(fn (AssertableJson $data) => $data
+        ->where('title', 'Existing Post')
+        ->etc()
+    );
 ```
 
 From an `AssertableForm` (the result of `edit()` or `create()`), you can also call `update()` or `store()`:
@@ -223,26 +279,3 @@ $this->sharpDashboard(MyDashboard::class)
     ->post()
     ->assertOk();
 ```
-
-## Testing Embedded Components
-
-Show Pages can contain embedded Entity Lists or Dashboards. You can test them using `sharpListField()` and `sharpDashboardField()`.
-
-### `sharpListField(string $entityKey)`
-
-```php
-$this->sharpShow(Post::class, 1)
-    ->sharpListField(Comment::class)
-    ->get()
-    ->assertOk()
-    ->assertListCount(5);
-```
-
-### `sharpDashboardField(string $entityKey)`
-
-```php
-$this->sharpShow(User::class, 1)
-    ->sharpDashboardField(UserStatsDashboard::class)
-    ->get()
-    ->assertOk();
-```

src/Data/Commands/CommandFormData.php

@@ -23,6 +23,7 @@ public function __construct(
         /** @var array<string> */
         public ?array $locales = null,
         public ?PageAlertData $pageAlert = null,
+        public ?array $_rawData = null,
     ) {}
 
     public static function from(array $form): self
@@ -36,6 +37,7 @@ public static function from(array $form): self
             layout: FormLayoutData::optional($form['layout'] ?? null),
             locales: $form['locales'] ?? null,
             pageAlert: PageAlertData::optional($form['pageAlert']),
+            _rawData: $form['_rawData'] ?? null,
         );
     }
 }

src/Http/Controllers/Api/Commands/HandlesCommandForm.php

@@ -33,6 +33,9 @@ protected function getCommandForm(InstanceCommand|EntityCommand|DashboardCommand
             'locales' => $commandHandler->hasDataLocalizations()
                 ? $commandHandler->getDataLocalizations()
                 : null,
+            ...app()->environment('testing') ? [
+                '_rawData' => $formData,
+            ] : [],
         ];
     }
 }

src/Http/Controllers/FormController.php

@@ -37,6 +37,10 @@ public function create(string $globalFilter, string $parentUri, EntityKey $entit
         $form->buildFormConfig();
         $formData = $form->newInstance();
 
+        if (app()->environment('testing')) {
+            Inertia::share('_rawData', $formData);
+        }
+
         return Inertia::render('Form/Form', [
             'form' => FormData::from([
                 ...$this->buildFormData($form, $formData, $entityKey),
@@ -90,6 +94,10 @@ public function edit(string $globalFilter, string $parentUri, EntityKey $entityK
             ->breadcrumb()
             ->getParentShowCachedBreadcrumbLabel() ?: $entity->getLabelOrFail($entityKey->multiformKey());
 
+        if (app()->environment('testing')) {
+            Inertia::share('_rawData', $formData);
+        }
+
         return Inertia::render('Form/Form', [
             'form' => FormData::from([
                 ...$this->buildFormData($form, $formData, $entityKey, $instanceId),

src/Utils/Testing/Commands/AssertableCommandForm.php

@@ -7,6 +7,7 @@
 use Code16\Sharp\EntityList\SharpEntityList;
 use Code16\Sharp\Show\SharpShow;
 use Code16\Sharp\Utils\Testing\DelegatesToResponse;
+use Illuminate\Testing\Fluent\AssertableJson;
 use Illuminate\Testing\TestResponse;
 
 class AssertableCommandForm
@@ -35,7 +36,20 @@ public function post(array $data = []): AssertableCommand
         );
     }
 
-    public function formData(): ?array
+    /**
+     * @param  Closure(AssertableJson): mixed  $callback
+     */
+    public function assertFormData(Closure $callback): static
+    {
+        $this->response->assertJson(fn (AssertableJson $json) => $json
+            ->has('_rawData', $callback)
+            ->etc()
+        );
+
+        return $this;
+    }
+
+    protected function formData(): ?array
     {
         return $this->response->json('data');
     }

src/Utils/Testing/EntityList/AssertableEntityList.php

@@ -2,10 +2,12 @@
 
 namespace Code16\Sharp\Utils\Testing\EntityList;
 
+use Closure;
 use Code16\Sharp\Utils\Testing\DelegatesToResponse;
 use Code16\Sharp\Utils\Testing\Show\PendingShow;
+use Illuminate\Testing\Fluent\AssertableJson;
 use Illuminate\Testing\TestResponse;
-use PHPUnit\Framework\Assert as PHPUnit;
+use Inertia\Testing\AssertableInertia;
 
 class AssertableEntityList
 {
@@ -16,33 +18,23 @@ public function __construct(
         protected PendingEntityList $pendingEntityList,
     ) {}
 
-    public function assertListCount(int $count): self
+    /**
+     * @param  Closure(AssertableJson): mixed  $callback
+     */
+    public function assertListData(Closure $closure): static
     {
-        PHPUnit::assertCount($count, $this->listData());
+        if ($this->pendingEntityList->parent instanceof PendingShow) {
+            $this->response->assertJson(fn (AssertableJson $json) => $json
+                ->has('data', $closure)
+                ->etc()
+            );
+        } else {
+            $this->response->assertInertia(fn (AssertableInertia $page) => $page
+                ->has('entityList.data', $closure)
+                ->etc()
+            );
+        }
 
         return $this;
     }
-
-    public function assertListContains(array $attributes): self
-    {
-        PHPUnit::assertTrue(
-            collect($this->listData())
-                ->contains(fn ($item) => collect($attributes)
-                    ->every(fn ($value, $key) => isset($item[$key]) && $item[$key] === $value)
-                ),
-            sprintf(
-                'Failed asserting that data contains an item with attributes: %s',
-                json_encode($attributes)
-            )
-        );
-
-        return $this;
-    }
-
-    protected function listData(): array
-    {
-        return $this->pendingEntityList->parent instanceof PendingShow
-            ? $this->response->json('data')
-            : $this->response->inertiaProps('entityList.data');
-    }
 }

src/Utils/Testing/Form/AssertableForm.php

@@ -2,8 +2,11 @@
 
 namespace Code16\Sharp\Utils\Testing\Form;
 
+use Closure;
 use Code16\Sharp\Utils\Testing\DelegatesToResponse;
+use Illuminate\Testing\Fluent\AssertableJson;
 use Illuminate\Testing\TestResponse;
+use Inertia\Testing\AssertableInertia;
 
 class AssertableForm
 {
@@ -29,7 +32,20 @@ public function update(array $data = []): TestResponse
         );
     }
 
-    public function formData(): array
+    /**
+     * @param  Closure(AssertableJson): mixed  $callback
+     */
+    public function assertFormData(Closure $callback): static
+    {
+        $this->response->assertInertia(fn (AssertableInertia $page) => $page
+            ->has('_rawData', fn (AssertableJson $json) => $callback($json))
+            ->etc()
+        );
+
+        return $this;
+    }
+
+    protected function formData(): array
     {
         return $this->response->inertiaProps('form.data');
     }

src/Utils/Testing/Show/AssertableShow.php

@@ -2,6 +2,7 @@
 
 namespace Code16\Sharp\Utils\Testing\Show;
 
+use Closure;
 use Code16\Sharp\Utils\Testing\DelegatesToResponse;
 use Illuminate\Testing\Fluent\AssertableJson;
 use Illuminate\Testing\TestResponse;
@@ -15,15 +16,14 @@ public function __construct(
         protected TestResponse $response,
     ) {}
 
-    public function showData(): array
-    {
-        return $this->response->inertiaProps('_rawData');
-    }
-
-    public function assertShowData(array $expectedData): self
+    /**
+     * @param  Closure(AssertableJson): mixed  $callback
+     */
+    public function assertShowData(Closure $callback): static
     {
         $this->response->assertInertia(fn (AssertableInertia $page) => $page
-            ->has('_rawData', fn (AssertableJson $json) => $json->whereAll($expectedData)->etc())
+            ->has('_rawData', fn (AssertableJson $json) => $callback($json))
+            ->etc()
         );
 
         return $this;