PHPLIB-688 Check serverless requirement in legacy spec test runner

Author: alcaeus

tests/FunctionalTestCase.php

@@ -26,6 +26,7 @@
 use function count;
 use function current;
 use function explode;
+use function filter_var;
 use function getenv;
 use function implode;
 use function is_array;
@@ -43,6 +44,7 @@
 use function sprintf;
 use function version_compare;
 
+use const FILTER_VALIDATE_BOOLEAN;
 use const INFO_MODULES;
 
 abstract class FunctionalTestCase extends TestCase
@@ -394,6 +396,16 @@ protected function isReplicaSet()
         return $this->getPrimaryServer()->getType() == Server::TYPE_RS_PRIMARY;
     }
 
+    /**
+     * Return whether serverless (i.e. proxy as mongos) is being utilized.
+     */
+    protected static function isServerless(): bool
+    {
+        $isServerless = getenv('MONGODB_IS_SERVERLESS');
+
+        return $isServerless !== false ? filter_var($isServerless, FILTER_VALIDATE_BOOLEAN) : false;
+    }
+
     protected function isShardedCluster()
     {
         return $this->getPrimaryServer()->getType() == Server::TYPE_MONGOS;

tests/SpecTests/FunctionalTestCase.php

@@ -30,6 +30,10 @@ class FunctionalTestCase extends BaseFunctionalTestCase
     public const TOPOLOGY_REPLICASET = 'replicaset';
     public const TOPOLOGY_SHARDED = 'sharded';
 
+    public const SERVERLESS_ALLOW = 'allow';
+    public const SERVERLESS_FORBID = 'forbid';
+    public const SERVERLESS_REQUIRE = 'require';
+
     /** @var Context|null */
     private $context;
 
@@ -137,8 +141,9 @@ protected function checkServerRequirements(array $runOn): void
             $minServerVersion = $req->minServerVersion ?? null;
             $maxServerVersion = $req->maxServerVersion ?? null;
             $topologies = $req->topology ?? null;
+            $serverlessMode = $req->serverless ?? null;
 
-            if ($this->isServerRequirementSatisifed($minServerVersion, $maxServerVersion, $topologies)) {
+            if ($this->isServerRequirementSatisifed($minServerVersion, $maxServerVersion, $topologies, $serverlessMode)) {
                 return;
             }
         }
@@ -268,7 +273,27 @@ private function getTopology(): string
             return $topologyTypeMap[$primaryType];
         }
 
-        throw new UnexpectedValueException('Toplogy is neither single nor RS nor sharded');
+        throw new UnexpectedValueException(sprintf('Cannot find topology for primary of type "%s".', $primaryType));
+    }
+
+    private function isServerlessRequirementSatisfied(?string $serverlessMode): bool
+    {
+        if ($serverlessMode === null) {
+            return true;
+        }
+
+        switch ($serverlessMode) {
+            case self::SERVERLESS_ALLOW:
+                return true;
+
+            case self::SERVERLESS_FORBID:
+                return ! static::isServerless();
+
+            case self::SERVERLESS_REQUIRE:
+                return static::isServerless();
+        }
+
+        throw new UnexpectedValueException(sprintf('Invalid serverless requirement "%s" found.', $serverlessMode));
     }
 
     /**
@@ -279,7 +304,7 @@ private function getTopology(): string
      * @param array|null  $topologies
      * @return boolean
      */
-    private function isServerRequirementSatisifed(?string $minServerVersion, ?string $maxServerVersion, ?array $topologies = null): bool
+    private function isServerRequirementSatisifed(?string $minServerVersion, ?string $maxServerVersion, ?array $topologies = null, ?string $serverlessMode = null): bool
     {
         $serverVersion = $this->getServerVersion();
 
@@ -297,6 +322,10 @@ private function isServerRequirementSatisifed(?string $minServerVersion, ?string
             return false;
         }
 
+        if (! $this->isServerlessRequirementSatisfied($serverlessMode)) {
+            return false;
+        }
+
         return true;
     }
 }