Fix fake index assertion callbacks

Author: stevebauman

composer.json

@@ -27,7 +27,7 @@
     },
     "require": {
         "php": "^8.2",
-        "directorytree/opensearch-adapter": "^1.0",
+        "directorytree/opensearch-adapter": "^1.2.1",
         "directorytree/opensearch-client": "^1.0",
         "illuminate/console": "^11.0|^12.0|^13.0",
         "illuminate/database": "^11.0|^12.0|^13.0",
@@ -47,7 +47,7 @@
             "url": "../OpenSearchAdapter",
             "options": {
                 "versions": {
-                    "directorytree/opensearch-adapter": "1.0.1"
+                    "directorytree/opensearch-adapter": "1.2.1"
                 }
             }
         },

src/Testing/Fakes/FakeIndexManager.php

@@ -144,10 +144,22 @@ public function assertChecked(string $index): static
 
     /**
      * Assert that the given index was created.
+     *
+     * @param  (callable(?Mapping, ?Settings): bool)|null  $callback
      */
-    public function assertCreated(string $index, ?callable $modifier = null): static
+    public function assertCreated(string $index, ?callable $callback = null): static
     {
-        $this->manager->assertCreated($this->blueprint($index, $modifier));
+        $assertion = isset($callback)
+            ? fn (IndexBlueprint $index): bool => $callback(
+                $index->mapping(),
+                $index->settings(),
+            )
+            : null;
+
+        $this->manager->assertCreated(
+            MigrationPrefix::index($index),
+            $assertion,
+        );
 
         return $this;
     }
@@ -164,24 +176,30 @@ public function assertNotCreated(string $index): static
 
     /**
      * Assert that the given index mapping was updated.
+     *
+     * @param  (callable(Mapping): bool)|null  $callback
      */
-    public function assertMappingPut(string $index, callable $modifier): static
+    public function assertMappingPut(string $index, ?callable $callback = null): static
     {
-        $modifier($mapping = new Mapping);
-
-        $this->manager->assertMappingPut(MigrationPrefix::index($index), $mapping);
+        $this->manager->assertMappingPut(
+            MigrationPrefix::index($index),
+            $callback,
+        );
 
         return $this;
     }
 
     /**
      * Assert that the given index settings were updated.
+     *
+     * @param  (callable(Settings): bool)|null  $callback
      */
-    public function assertSettingsPut(string $index, callable $modifier): static
+    public function assertSettingsPut(string $index, ?callable $callback = null): static
     {
-        $modifier($settings = new Settings);
-
-        $this->manager->assertSettingsPut(MigrationPrefix::index($index), $settings);
+        $this->manager->assertSettingsPut(
+            MigrationPrefix::index($index),
+            $callback,
+        );
 
         return $this;
     }
@@ -243,21 +261,4 @@ public function assertAliasDeleted(string $index, string $alias): static
 
         return $this;
     }
-
-    /**
-     * Create an index blueprint for an assertion.
-     */
-    protected function blueprint(string $index, ?callable $modifier = null): IndexBlueprint
-    {
-        if (isset($modifier)) {
-            $modifier(
-                $mapping = new Mapping,
-                $settings = new Settings,
-            );
-
-            return new IndexBlueprint(MigrationPrefix::index($index), $mapping, $settings);
-        }
-
-        return new IndexBlueprint(MigrationPrefix::index($index));
-    }
 }

tests/Unit/Facades/IndexTest.php

@@ -1,8 +1,11 @@
 <?php
 
+use DirectoryTree\OpenSearchAdapter\Indices\Mapping;
+use DirectoryTree\OpenSearchAdapter\Indices\Settings;
 use DirectoryTree\OpenSearchMigrations\Facades\Index;
 use DirectoryTree\OpenSearchMigrations\IndexManagerInterface;
 use DirectoryTree\OpenSearchMigrations\Testing\Fakes\FakeIndexManager;
+use PHPUnit\Framework\ExpectationFailedException;
 
 it('resolves the index manager interface', function (): void {
     expect(Index::getFacadeRoot())->toBeInstanceOf(IndexManagerInterface::class);
@@ -14,7 +17,10 @@
 
     $fake = Index::fake();
 
-    Index::create('posts');
+    Index::create('posts', function (Mapping $mapping, Settings $settings): void {
+        $mapping->text('title');
+        $settings->index(['number_of_replicas' => 0]);
+    });
     Index::putAlias('posts', 'published_posts');
 
     expect(Index::getFacadeRoot())->toBe($fake)
@@ -26,6 +32,96 @@
         ->assertAliasPut('posts', 'published_posts');
 });
 
+it('asserts created index definitions with a callback', function (): void {
+    config()->set('opensearch-migrations.index_name_prefix', 'tenant_');
+
+    $fake = Index::fake();
+
+    Index::create('posts', function (Mapping $mapping, Settings $settings): void {
+        $mapping->text('title');
+        $settings->index(['number_of_replicas' => 0]);
+    });
+
+    $fake->assertCreated(
+        'posts',
+        fn (?Mapping $mapping, ?Settings $settings): bool => (
+            $mapping?->toArray() === [
+                'properties' => [
+                    'title' => ['type' => 'text'],
+                ],
+            ]
+            && $settings?->toArray() === [
+                'index' => ['number_of_replicas' => 0],
+            ]
+        )
+    );
+});
+
+it('fails when a created index does not satisfy the callback', function (): void {
+    $fake = Index::fake();
+
+    Index::create('posts');
+
+    expect(fn () => $fake->assertCreated('posts', fn (): bool => false))
+        ->toThrow(ExpectationFailedException::class);
+});
+
+it('asserts updated mappings with an optional callback', function (): void {
+    config()->set('opensearch-migrations.index_name_prefix', 'tenant_');
+
+    $fake = Index::fake();
+
+    Index::putMapping('posts', function (Mapping $mapping): void {
+        $mapping->keyword('status');
+    });
+
+    $fake
+        ->assertMappingPut('posts')
+        ->assertMappingPut('posts', fn (Mapping $mapping): bool => $mapping->toArray() === [
+            'properties' => [
+                'status' => ['type' => 'keyword'],
+            ],
+        ]);
+});
+
+it('fails when an updated mapping does not satisfy the callback', function (): void {
+    $fake = Index::fake();
+
+    Index::putMapping('posts', function (Mapping $mapping): void {
+        $mapping->keyword('status');
+    });
+
+    expect(fn () => $fake->assertMappingPut('posts', fn (): bool => false))
+        ->toThrow(ExpectationFailedException::class);
+});
+
+it('asserts updated settings with an optional callback', function (): void {
+    config()->set('opensearch-migrations.index_name_prefix', 'tenant_');
+
+    $fake = Index::fake();
+
+    Index::putSettings('posts', function (Settings $settings): void {
+        $settings->index(['refresh_interval' => -1]);
+    });
+
+    $fake
+        ->assertSettingsPut('posts')
+        ->assertSettingsPut('posts', fn (Settings $settings): bool => $settings->toArray() === [
+            'index' => ['refresh_interval' => -1],
+        ]);
+});
+
+it('fails when updated settings do not satisfy the callback', function (): void {
+    $fake = Index::fake();
+
+    Index::putSettings('posts', function (Settings $settings): void {
+        $settings->index(['refresh_interval' => -1]);
+    });
+
+    expect(fn () => $fake->assertSettingsPut('posts', fn (): bool => false))
+        ->toThrow(ExpectationFailedException::class);
+});
+
 it('fakes existing indices', function (): void {
     config()->set('opensearch-migrations.index_name_prefix', 'tenant_');