Run unified index management tests

Author: GromNaN

src/Collection.php

@@ -399,15 +399,15 @@ public function createIndexes(array $indexes, array $options = [])
      *
      * @see https://www.mongodb.com/docs/manual/reference/command/createSearchIndexes/
      * @see https://mongodb.com/docs/manual/reference/method/db.collection.createSearchIndex/
-     * @param string $name       List of search index specifications
-     * @param array  $definition Atlas Search index definition
-     * @param array  $options    Command options
+     * @param string       $name       List of search index specifications
+     * @param array|object $definition Atlas Search index definition
+     * @param array        $options    Command options
      * @return string The name of the created search index
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function createSearchIndex(string $name, array $definition, array $options): string
+    public function createSearchIndex(string $name, $definition, array $options = []): string
     {
         $names = $this->createSearchIndexes([['name' => $name, 'definition' => $definition]], $options);
 
@@ -1022,6 +1022,10 @@ public function listIndexes(array $options = [])
      */
     public function listSearchIndexes(string $name, array $aggregationOptions = [], array $listIndexOptions = [])
     {
+        if ($name) {
+            $listIndexOptions += ['name' => $name];
+        }
+
         $operation = new ListSearchIndexes($this->databaseName, $this->collectionName, $aggregationOptions, $listIndexOptions);
         $server = select_server($this->manager, $listIndexOptions);
 
@@ -1191,16 +1195,16 @@ public function updateOne($filter, $update, array $options = [])
     /**
      * Update a single Atlas Search index in the collection.
      *
-     * @param string $name       Search index name
-     * @param array  $definition Atlas Search index definition
-     * @param array  $options    Command options
+     * @param string       $name       Search index name
+     * @param array|object $definition Atlas Search index definition
+     * @param array        $options    Command options
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function updateSearchIndex(string $name, array $definition, array $options = []): void
+    public function updateSearchIndex(string $name, $definition, array $options = []): void
     {
-        $operation = new UpdateSearchIndex($this->databaseName, $this->collectionName, $name, $definition, $options);
+        $operation = new UpdateSearchIndex($this->databaseName, $this->collectionName, $name, $definition);
         $server = select_server($this->manager, $options);
 
         $operation->execute($server);

src/Operation/ListSearchIndexes.php

@@ -91,13 +91,14 @@ public function execute(Server $server)
     private function executeCommand(Server $server): IndexInfoIteratorIterator
     {
         $cmd = [
-            'listSearchIndexes' => $this->collectionName,
+            'aggregate' => $this->collectionName,
+            'pipeline' => [
+                ['$listSearchIndexes' => (object) $this->listIndexOptions],
+            ],
         ];
 
-        foreach (['id', 'name'] as $option) {
-            if (isset($this->listIndexOptions[$option])) {
-                $cmd[$option] = $this->listIndexOptions[$option];
-            }
+        if (! empty($this->aggregationOptions)) {
+            $cmd['cursor'] = (object) $this->aggregationOptions;
         }
 
         try {

src/Operation/UpdateSearchIndex.php

@@ -23,6 +23,9 @@
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Exception\UnsupportedException;
 
+use function is_array;
+use function is_object;
+
 /**
  * Operation for the createIndexes command.
  *
@@ -41,24 +44,28 @@ class UpdateSearchIndex implements Executable
     /** @var string */
     private $name;
 
-    /** @var array */
+    /** @var array|object */
     private $definition;
 
     /**
      * Constructs a createSearchIndexes command.
      *
-     * @param string $databaseName   Database name
-     * @param string $collectionName Collection name
-     * @param string $name           Search index name
-     * @param array  $definition     Atlas Search index definition
+     * @param string       $databaseName   Database name
+     * @param string       $collectionName Collection name
+     * @param string       $name           Search index name
+     * @param array|object $definition     Atlas Search index definition
      * @throws InvalidArgumentException for parameter parsing errors
      */
-    public function __construct(string $databaseName, string $collectionName, string $name, array $definition)
+    public function __construct(string $databaseName, string $collectionName, string $name, $definition)
     {
         if ($name === '') {
             throw new InvalidArgumentException('Index name cannot be empty');
         }
 
+        if (! is_array($definition) || ! is_object($definition)) {
+            throw InvalidArgumentException::invalidType('$definition', $definition, 'array or object');
+        }
+
         $this->databaseName = $databaseName;
         $this->collectionName = $collectionName;
         $this->name = $name;

tests/UnifiedSpecTests/Operation.php

@@ -36,6 +36,7 @@
 use function hex2bin;
 use function iterator_to_array;
 use function key;
+use function MongoDB\document_to_array;
 use function MongoDB\with_transaction;
 use function PHPUnit\Framework\assertArrayHasKey;
 use function PHPUnit\Framework\assertContains;
@@ -557,6 +558,29 @@ function (IndexInfo $info) {
                     array_diff_key($args, ['to' => 1])
                 );
 
+            case 'createSearchIndex':
+                return $collection->createSearchIndex($args['model']->name ?? '', $args['model']->definition);
+
+            case 'createSearchIndexes':
+                return $collection->createSearchIndexes($args['models']);
+
+            case 'dropSearchIndex':
+                assertArrayHasKey('name', $args);
+                assertIsString($args['name']);
+
+                return $collection->dropSearchIndex($args['name']);
+
+            case 'updateSearchIndex':
+                assertArrayHasKey('name', $args);
+                assertArrayHasKey('definition', $args);
+                assertIsString($args['name']);
+                assertInstanceOf(stdClass::class, $args['definition']);
+
+                return $collection->updateSearchIndex($args['name'], $args['definition']);
+
+            case 'listSearchIndexes':
+                return $collection->listSearchIndexes($args['name'] ?? '', document_to_array($args['aggregationOptions'] ?? []), document_to_array(($args['listIndexOptions'] ?? [])));
+
             default:
                 Assert::fail('Unsupported collection operation: ' . $this->name);
         }

tests/UnifiedSpecTests/UnifiedSpecTest.php

@@ -275,6 +275,17 @@ public function provideFailingTests()
         yield from $this->provideTests(__DIR__ . '/valid-fail/*.json');
     }
 
+    /** @dataProvider provideIndexManagementTests */
+    public function testIndexManagement(UnifiedTestCase $test): void
+    {
+        self::$runner->run($test);
+    }
+
+    public function provideIndexManagementTests()
+    {
+        yield from $this->provideTests(__DIR__ . '/index-management/*.json');
+    }
+
     private function provideTests(string $pattern): Generator
     {
         foreach (glob($pattern) as $filename) {

tests/UnifiedSpecTests/Util.php

@@ -88,6 +88,8 @@ final class Util
             'createChangeStream' => ['pipeline', 'session', 'fullDocument', 'fullDocumentBeforeChange', 'resumeAfter', 'startAfter', 'startAtOperationTime', 'batchSize', 'collation', 'maxAwaitTimeMS', 'comment', 'showExpandedEvents'],
             'createFindCursor' => ['filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'limit', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
             'createIndex' => ['keys', 'comment', 'commitQuorum', 'maxTimeMS', 'name', 'session', 'unique'],
+            'createSearchIndex' => ['model'],
+            'createSearchIndexes' => ['models'],
             'dropIndex' => ['name', 'session', 'maxTimeMS', 'comment'],
             'count' => ['filter', 'session', 'collation', 'hint', 'limit', 'maxTimeMS', 'skip', 'comment'],
             'countDocuments' => ['filter', 'session', 'limit', 'skip', 'collation', 'hint', 'maxTimeMS', 'comment'],
@@ -97,6 +99,7 @@ final class Util
             'findOneAndDelete' => ['let', 'filter', 'session', 'projection', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'new', 'sort', 'update', 'upsert', 'comment'],
             'distinct' => ['fieldName', 'filter', 'session', 'collation', 'maxTimeMS', 'comment'],
             'drop' => ['session', 'comment'],
+            'dropSearchIndex' => ['name'],
             'find' => ['let', 'filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'limit', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
             'findOne' => ['let', 'filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
             'findOneAndReplace' => ['let', 'returnDocument', 'filter', 'replacement', 'session', 'projection', 'returnDocument', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'new', 'remove', 'sort', 'comment'],
@@ -105,9 +108,11 @@ final class Util
             'findOneAndUpdate' => ['let', 'returnDocument', 'filter', 'update', 'session', 'upsert', 'projection', 'remove', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'sort', 'comment'],
             'updateMany' => ['let', 'filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment'],
             'updateOne' => ['let', 'filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'comment'],
+            'updateSearchIndex' => ['name', 'definition'],
             'insertMany' => ['documents', 'session', 'ordered', 'bypassDocumentValidation', 'comment'],
             'insertOne' => ['document', 'session', 'bypassDocumentValidation', 'comment'],
             'listIndexes' => ['session', 'maxTimeMS', 'comment'],
+            'listSearchIndexes' => ['name', 'aggregationOptions'],
             'mapReduce' => ['map', 'reduce', 'out', 'session', 'bypassDocumentValidation', 'collation', 'finalize', 'jsMode', 'limit', 'maxTimeMS', 'query', 'scope', 'sort', 'verbose', 'comment'],
         ],
         ChangeStream::class => [