Support runOnRequirement.csfle

Author: jmikola

tests/FunctionalTestCase.php

@@ -284,6 +284,21 @@ public function configureFailPoint($command, ?Server $server = null): void
         $this->configuredFailPoints[] = [$command->configureFailPoint, $failPointServer];
     }
 
+    public static function getModuleInfo(string $row): ?string
+    {
+        ob_start();
+        phpinfo(INFO_MODULES);
+        $info = ob_get_clean();
+
+        $pattern = sprintf('/^%s([\w ]+)$/m', preg_quote($row . ' => '));
+
+        if (preg_match($pattern, $info, $matches) !== 1) {
+            return null;
+        }
+
+        return $matches[1];
+    }
+
     /**
      * Creates the test collection with the specified options.
      *
@@ -512,7 +527,7 @@ protected function skipIfClientSideEncryptionIsNotSupported(): void
             $this->markTestSkipped('Client Side Encryption only supported on FCV 4.2 or higher');
         }
 
-        if ($this->getModuleInfo('libmongocrypt') === 'disabled') {
+        if (static::getModuleInfo('libmongocrypt') === 'disabled') {
             $this->markTestSkipped('Client Side Encryption is not enabled in the MongoDB extension');
         }
     }
@@ -598,21 +613,6 @@ private function disableFailPoints(): void
         }
     }
 
-    private function getModuleInfo(string $row): ?string
-    {
-        ob_start();
-        phpinfo(INFO_MODULES);
-        $info = ob_get_clean();
-
-        $pattern = sprintf('/^%s([\w ]+)$/m', preg_quote($row . ' => '));
-
-        if (preg_match($pattern, $info, $matches) !== 1) {
-            return null;
-        }
-
-        return $matches[1];
-    }
-
     /**
      * Checks if the failCommand command is supported on this server version
      *

tests/UnifiedSpecTests/RunOnRequirement.php

@@ -49,6 +49,9 @@ class RunOnRequirement
     /** @var string */
     private $serverless;
 
+    /** @var bool */
+    private $csfle;
+
     /** @var array */
     private static $supportedTopologies = [
         self::TOPOLOGY_SINGLE,
@@ -67,7 +70,7 @@ class RunOnRequirement
 
     public function __construct(stdClass $o)
     {
-        Util::assertHasOnlyKeys($o, ['minServerVersion', 'maxServerVersion', 'topologies', 'serverParameters', 'auth', 'serverless']);
+        Util::assertHasOnlyKeys($o, ['minServerVersion', 'maxServerVersion', 'topologies', 'serverParameters', 'auth', 'serverless', 'csfle']);
 
         if (isset($o->minServerVersion)) {
             assertIsString($o->minServerVersion);
@@ -103,9 +106,14 @@ public function __construct(stdClass $o)
             assertContains($o->serverless, self::$supportedServerless);
             $this->serverless = $o->serverless;
         }
+
+        if (isset($o->csfle)) {
+            assertIsBool($o->csfle);
+            $this->csfle = $o->csfle;
+        }
     }
 
-    public function isSatisfied(string $serverVersion, string $topology, stdClass $serverParameters, bool $isAuthenticated, bool $isServerless): bool
+    public function isSatisfied(string $serverVersion, string $topology, stdClass $serverParameters, bool $isAuthenticated, bool $isServerless, bool $isClientSideEncryptionSupported): bool
     {
         if (isset($this->minServerVersion) && version_compare($serverVersion, $this->minServerVersion, '<')) {
             return false;
@@ -140,6 +148,10 @@ public function isSatisfied(string $serverVersion, string $topology, stdClass $s
             }
         }
 
+        if (isset($this->csfle) && $isClientSideEncryptionSupported !== $this->csfle) {
+            return false;
+        }
+
         return true;
     }
 

tests/UnifiedSpecTests/UnifiedTestRunner.php

@@ -25,6 +25,8 @@
 use function getenv;
 use function implode;
 use function in_array;
+use function is_executable;
+use function is_readable;
 use function is_string;
 use function parse_url;
 use function PHPUnit\Framework\assertContainsOnly;
@@ -43,7 +45,9 @@
 use function substr_replace;
 use function version_compare;
 
+use const DIRECTORY_SEPARATOR;
 use const FILTER_VALIDATE_BOOLEAN;
+use const PATH_SEPARATOR;
 use const PHP_URL_HOST;
 
 /**
@@ -60,7 +64,7 @@ final class UnifiedTestRunner
 
     public const MIN_SCHEMA_VERSION = '1.0';
 
-    public const MAX_SCHEMA_VERSION = '1.7';
+    public const MAX_SCHEMA_VERSION = '1.8';
 
     /** @var MongoDB\Client */
     private $internalClient;
@@ -247,6 +251,7 @@ private function checkRunOnRequirements(array $runOnRequirements): void
                 $this->getServerParameters(),
                 $this->isAuthenticated(),
                 $this->isServerless(),
+                $this->isClientSideEncryptionSupported(),
             ];
         }
 
@@ -349,6 +354,48 @@ private function isAuthenticated(): bool
         throw new UnexpectedValueException('Could not determine authentication status');
     }
 
+    /**
+     * Return whether client-side encryption is supported.
+     */
+    private function isClientSideEncryptionSupported(): bool
+    {
+        /* CSFLE technically requires FCV 4.2+ but this is sufficient since we
+         * do not test on mixed-version clusters. */
+        if (version_compare($this->getServerVersion(), '4.2', '<')) {
+            return false;
+        }
+
+        if (FunctionalTestCase::getModuleInfo('libmongocrypt') === 'disabled') {
+            return false;
+        }
+
+        return static::isCryptSharedLibAvailable() || static::isMongocryptdAvailable();
+    }
+
+    private static function isCryptSharedLibAvailable(): bool
+    {
+        $cryptSharedLibPath = getenv('CRYPT_SHARED_LIB_PATH');
+
+        if ($cryptSharedLibPath === false) {
+            return false;
+        }
+
+        return is_readable($cryptSharedLibPath);
+    }
+
+    private static function isMongocryptdAvailable(): bool
+    {
+        $paths = explode(PATH_SEPARATOR, getenv("PATH"));
+
+        foreach ($paths as $path) {
+            if (is_executable($path . DIRECTORY_SEPARATOR . 'mongocryptd')) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * Return whether serverless (i.e. proxy as mongos) is being utilized.
      */