Rework search index support detection by running a $search pipeline

Author: GromNaN

phpunit.xml.dist

@@ -16,7 +16,6 @@
         <ini name="zend.assertions" value="1"/>
         <env name="MONGODB_URI" value="mongodb://127.0.0.1:27017/?serverSelectionTimeoutMS=100"/>
         <env name="MONGODB_DATABASE" value="phplib_test"/>
-        <env name="ATLAS_SUPPORTED" value="0" />
     </php>
 
     <testsuites>

tests/ExamplesTest.php

@@ -229,7 +229,7 @@ public static function provideExamples(): Generator
     #[Group('atlas')]
     public function testAtlasSearch(): void
     {
-        if (! self::isAtlas()) {
+        if (! $this->isAtlas()) {
             $this->markTestSkipped('Atlas Search examples are only supported on MongoDB Atlas');
         }
 

…AtlasSearchNotSupportedExceptionTest.php …tion/SearchNotSupportedExceptionTest.phptests/Exception/AtlasSearchNotSupportedExceptionTest.php renamed to tests/Exception/SearchNotSupportedExceptionTest.php tests/Exception/AtlasSearchNotSupportedExceptionTest.php renamed to tests/Exception/SearchNotSupportedExceptionTest.php

@@ -7,33 +7,34 @@
 use MongoDB\Driver\Exception\ServerException;
 use MongoDB\Exception\AtlasSearchNotSupportedException;
 use MongoDB\Tests\Collection\FunctionalTestCase;
+use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 
 class AtlasSearchNotSupportedExceptionTest extends FunctionalTestCase
 {
+    #[DoesNotPerformAssertions]
     public function testListSearchIndexesNotSupportedException(): void
     {
-        if (self::isAtlas()) {
-            self::markTestSkipped('Atlas Search is supported on Atlas');
-        }
-
         $collection = new Collection($this->manager, $this->getDatabaseName(), $this->getCollectionName());
 
-        $this->expectException(AtlasSearchNotSupportedException::class);
-
-        $collection->listSearchIndexes();
+        try {
+            $collection->listSearchIndexes();
+        } catch (AtlasSearchNotSupportedException) {
+            // If an exception is thrown because Atlas Search is not supported,
+            // then the test is successful because it has the correct exception class.
+        }
     }
 
+    #[DoesNotPerformAssertions]
     public function testCreateSearchIndexNotSupportedException(): void
     {
-        if (self::isAtlas()) {
-            self::markTestSkipped('Atlas Search is supported on Atlas');
-        }
-
         $collection = new Collection($this->manager, $this->getDatabaseName(), $this->getCollectionName());
 
-        $this->expectException(AtlasSearchNotSupportedException::class);
-
-        $collection->createSearchIndex(['mappings' => ['dynamic' => false]], ['name' => 'test-search-index']);
+        try {
+            $collection->createSearchIndex(['mappings' => ['dynamic' => false]], ['name' => 'test-search-index']);
+        } catch (AtlasSearchNotSupportedException) {
+            // If an exception is thrown because Atlas Search is not supported,
+            // then the test is successful because it has the correct exception class.
+        }
     }
 
     public function testOtherStageNotFound(): void

tests/FunctionalTestCase.php

@@ -434,11 +434,17 @@ protected function skipIfServerVersion(string $operator, string $version, ?strin
 
     protected function skipIfAtlasSearchIndexIsNotSupported(): void
     {
-        if (! self::isAtlas()) {
-            self::markTestSkipped('Search Indexes are only supported on MongoDB Atlas 7.0+');
+        try {
+            $this->manager->executeReadCommand($this->getDatabaseName(), new Command([
+                'aggregate' => __METHOD__,
+                'pipeline' => [
+                    ['$search' => ['text' => ['query' => 'test', 'path' => 'field']]],
+                ],
+                'cursor' => new stdClass(),
+            ]));
+        } catch (CommandException $exception) {
+            self::markTestSkipped($exception->getMessage());
         }
-
-        $this->skipIfServerVersion('<', '7.0', 'Search Indexes are only supported on MongoDB Atlas 7.0+');
     }
 
     protected function skipIfChangeStreamIsNotSupported(): void
@@ -516,11 +522,6 @@ protected function isEnterprise(): bool
         throw new UnexpectedValueException('Could not determine server modules');
     }
 
-    public static function isAtlas(?string $uri = null): bool
-    {
-        return (bool) getenv('ATLAS_SUPPORTED');
-    }
-
     /** @see https://www.mongodb.com/docs/manual/core/queryable-encryption/reference/shared-library/ */
     public static function isCryptSharedLibAvailable(): bool
     {

tests/UnifiedSpecTests/UnifiedSpecTest.php

@@ -366,9 +366,7 @@ public static function provideFailingTests(): Generator
     #[DataProvider('provideIndexManagementTests')]
     public function testIndexManagement(UnifiedTestCase $test): void
     {
-        if (self::isAtlas()) {
-            self::markTestSkipped('Search Indexes tests must run on a non-Atlas cluster');
-        }
+        $this->skipIfAtlasSearchIndexIsNotSupported();
 
         if (! self::isEnterprise()) {
             self::markTestSkipped('Specific Atlas error messages are only available on Enterprise server');

tests/UnifiedSpecTests/UnifiedTestRunner.php

@@ -89,7 +89,7 @@ public function __construct(private string $internalClientUri)
          *
          * Atlas Data Lake also does not support killAllSessions.
          */
-        if (FunctionalTestCase::isAtlas($internalClientUri) || $this->isAtlasDataLake()) {
+        if ($this->isAtlas($internalClientUri) || $this->isAtlasDataLake()) {
             $this->allowKillAllSessions = false;
         }
 
@@ -307,6 +307,11 @@ private function getTopology(): string
         };
     }
 
+    private function isAtlas(string $internalClientUri): bool
+    {
+        return preg_match('/\.(mongodb\.net|mongodb-dev\.net)/', $internalClientUri);
+    }
+
     private function isAtlasDataLake(): bool
     {
         $database = $this->internalClient->selectDatabase('admin');