Refine fake testing APIs

Author: stevebauman

src/Search/SearchResponse.php

@@ -15,7 +15,7 @@ class SearchResponse implements RawResponseInterface
      * @param  array<string, mixed>  $response
      */
     public function __construct(
-        protected array $response,
+        protected array $response = [],
     ) {}
 
     /**
@@ -47,7 +47,7 @@ public static function fake(array $hits = [], string $index = 'test'): static
      */
     public function hits(): array
     {
-        $hits = $this->response['hits']['hits'];
+        $hits = $this->response['hits']['hits'] ?? [];
 
         return array_map(fn (array $hit) => new Hit($hit), $hits);
     }

src/Testing/Fakes/FakeDocumentManager.php

@@ -46,23 +46,9 @@ class FakeDocumentManager implements DocumentManagerInterface
      * Create a new fake document manager instance.
      */
     public function __construct(
-        protected SearchResponse $response = new SearchResponse([
-            'hits' => [
-                'hits' => [],
-            ],
-        ]),
+        protected SearchResponse $response = new SearchResponse,
     ) {}
 
-    /**
-     * Set the search response returned by the fake.
-     */
-    public function respondWith(SearchResponse $response): static
-    {
-        $this->response = $response;
-
-        return $this;
-    }
-
     /**
      * Index the given documents into OpenSearch.
      *

src/Testing/Fakes/FakeIndexManager.php

@@ -14,13 +14,6 @@
  */
 class FakeIndexManager implements IndexManagerInterface
 {
-    /**
-     * The index names that should exist.
-     *
-     * @var array<int, string>
-     */
-    protected array $existing = [];
-
     /**
      * The opened index names.
      *
@@ -85,14 +78,13 @@ class FakeIndexManager implements IndexManagerInterface
     protected array $deletedAliases = [];
 
     /**
-     * Seed the fake with an existing index.
+     * Create a new fake index manager instance.
+     *
+     * @param  array<int, string>  $existing
      */
-    public function withIndex(string $index): static
-    {
-        $this->existing[] = $index;
-
-        return $this;
-    }
+    public function __construct(
+        protected array $existing = [],
+    ) {}
 
     /**
      * Open the given index.
@@ -130,7 +122,7 @@ public function exists(string $index): bool
     public function create(IndexBlueprint $index): static
     {
         $this->created[] = $index;
-        $this->withIndex($index->name());
+        $this->existing[] = $index->name();
 
         return $this;
     }

tests/Unit/Documents/FakeDocumentManagerTest.php

@@ -51,7 +51,6 @@
 });
 
 test('fake document manager records searches and returns configured responses', function () {
-    $documents = new FakeDocumentManager;
     $request = new SearchRequest([
         'match' => [
             'title' => 'OpenSearch',
@@ -76,9 +75,9 @@
         ],
     ]);
 
-    $result = $documents
-        ->respondWith($response)
-        ->search('posts', $request);
+    $documents = new FakeDocumentManager($response);
+
+    $result = $documents->search('posts', $request);
 
     expect($result)->toBe($response);
 

tests/Unit/Indices/FakeIndexManagerTest.php

@@ -16,9 +16,9 @@
 
     expect($indices->exists('posts'))->toBeFalse();
 
-    $indices
-        ->withIndex('posts')
-        ->assertChecked('posts');
+    $indices->assertChecked('posts');
+
+    $indices = new FakeIndexManager(existing: ['posts']);
 
     expect($indices->exists('posts'))->toBeTrue();
 });
@@ -64,7 +64,7 @@
 });
 
 test('fake index manager records deleted indices', function () {
-    $indices = (new FakeIndexManager)->withIndex('posts');
+    $indices = new FakeIndexManager(existing: ['posts']);
 
     $indices->delete('posts');
 

tests/Unit/Search/SearchResponseTest.php

@@ -10,6 +10,14 @@
 use DirectoryTree\OpenSearchAdapter\Search\Suggestion;
 use DirectoryTree\OpenSearchAdapter\Search\TotalHits;
 
+test('empty response can be created', function () {
+    $searchResponse = new SearchResponse;
+
+    expect($searchResponse->hits())->toBe([])
+        ->and($searchResponse->total())->toBeNull()
+        ->and($searchResponse->raw())->toBe([]);
+});
+
 test('hits can be retrieved', function () {
     $searchResponse = new SearchResponse([
         'hits' => [