Add OpenSearch integration tests

Author: stevebauman

.github/workflows/run-tests.yml

@@ -6,6 +6,16 @@ on:
 jobs:
   test:
     runs-on: ${{ matrix.os }}
+    services:
+      opensearch:
+        image: opensearchproject/opensearch:2.13.0
+        env:
+          discovery.type: single-node
+          plugins.security.disabled: true
+          OPENSEARCH_JAVA_OPTS: -Xms512m -Xmx512m
+        ports:
+          - 9200:9200
+
     strategy:
       fail-fast: true
       matrix:
@@ -42,5 +52,21 @@ jobs:
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
           composer update --prefer-dist --no-interaction
 
+      - name: Wait for OpenSearch
+        run: |
+          for attempt in {1..60}; do
+            if curl --fail --silent http://127.0.0.1:9200 > /dev/null; then
+              exit 0
+            fi
+
+            sleep 1
+          done
+
+          echo "OpenSearch did not become available in time."
+          docker logs "${{ job.services.opensearch.id }}"
+          exit 1
+
       - name: Execute tests
-        run: vendor/bin/pest --ci
+        run: vendor/bin/pest tests/Feature tests/Integration tests/Unit --ci
+        env:
+          OPENSEARCH_HOST: http://127.0.0.1:9200

tests/Integration/OpenSearchScoutDriverTest.php

@@ -0,0 +1,72 @@
+<?php
+
+use DirectoryTree\OpenSearchAdapter\Indices\IndexManager;
+use DirectoryTree\OpenSearchScoutDriver\Tests\Fixtures\Client;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Laravel\Scout\EngineManager;
+
+beforeEach(function (): void {
+    config()->set('scout.prefix', sprintf('scout_integration_%s_', bin2hex(random_bytes(4))));
+
+    Schema::create('clients', function (Blueprint $table): void {
+        $table->id();
+        $table->string('name');
+        $table->string('email');
+        $table->timestamp('deleted_at')->nullable();
+    });
+
+    Client::query()->insert([
+        ['id' => 1, 'name' => 'John Smith', 'email' => 'john@example.com'],
+        ['id' => 2, 'name' => 'Jane Smith', 'email' => 'jane@example.com'],
+        ['id' => 3, 'name' => 'Taylor Otwell', 'email' => 'taylor@example.com'],
+    ]);
+
+    $this->indexName = (new Client)->searchableAs();
+    $this->indexManager = app(IndexManager::class);
+
+    if ($this->indexManager->exists($this->indexName)) {
+        $this->indexManager->drop($this->indexName);
+    }
+
+    app(EngineManager::class)->engine('opensearch')->createIndex($this->indexName);
+
+    $this->indexManager->putMappingRaw($this->indexName, [
+        'properties' => [
+            'name' => [
+                'type' => 'text',
+                'fielddata' => true,
+            ],
+            'email' => [
+                'type' => 'keyword',
+            ],
+        ],
+    ]);
+});
+
+afterEach(function (): void {
+    if (isset($this->indexManager, $this->indexName) && $this->indexManager->exists($this->indexName)) {
+        $this->indexManager->drop($this->indexName);
+    }
+
+    Schema::dropIfExists('clients');
+});
+
+it('indexes searches paginates deletes and flushes models against opensearch', function (): void {
+    $engine = app(EngineManager::class)->engine('opensearch');
+
+    $engine->update(Client::query()->orderBy('id')->get());
+
+    expect(Client::search('Smith')->get()->pluck('id')->all())->toBe([1, 2])
+        ->and(Client::search('')->where('email', 'jane@example.com')->get()->pluck('id')->all())->toBe([2])
+        ->and(Client::search('')->whereIn('email', ['john@example.com', 'taylor@example.com'])->get()->pluck('id')->all())->toBe([1, 3])
+        ->and(Client::search('')->orderBy('name', 'asc')->paginate(2)->pluck('id')->all())->toBe([2, 1]);
+
+    $engine->delete(Client::query()->whereKey(1)->get());
+
+    expect(Client::search('John')->get())->toHaveCount(0);
+
+    $engine->flush(new Client);
+
+    expect(Client::search('')->get())->toHaveCount(0);
+});

tests/Pest.php

@@ -2,4 +2,4 @@
 
 use DirectoryTree\OpenSearchScoutDriver\Tests\TestCase;
 
-uses(TestCase::class)->in('Feature', 'Unit');
+uses(TestCase::class)->in('Feature', 'Integration', 'Unit');

tests/TestCase.php

@@ -30,7 +30,7 @@ protected function defineEnvironment($app): void
         $app['config']->set('opensearch.scout.refresh_documents', true);
         $app['config']->set('opensearch.client.default', 'default');
         $app['config']->set('opensearch.client.connections.default', [
-            'base_uri' => 'http://127.0.0.1:9200',
+            'base_uri' => env('OPENSEARCH_HOST', 'http://127.0.0.1:9200'),
         ]);
     }
 }