PHPLIB-1153: Add helper FunctionalTestCase::skipIfServerVersion (#1107)

mongodb · Jun 21, 2023 · 5a14dee · 5a14dee
1 parent 53052b6
commit 5a14dee
Show file tree

Hide file tree

Showing 16 changed files with 53 additions and 153 deletions.
diff --git a/tests/Collection/CrudSpecFunctionalTest.php b/tests/Collection/CrudSpecFunctionalTest.php
@@ -13,7 +13,6 @@
 use MongoDB\Operation\FindOneAndReplace;
 use MongoDB\UpdateResult;
 use MultipleIterator;
-use PHPUnit_Framework_SkippedTestError;
 
 use function array_diff_key;
 use function array_key_exists;
@@ -25,7 +24,6 @@
 use function sprintf;
 use function str_replace;
 use function strtolower;
-use function version_compare;
 
 /**
  * CRUD spec functional tests.
@@ -54,8 +52,12 @@ public function setUp(): void
     /** @dataProvider provideSpecificationTests */
     public function testSpecification(array $initialData, array $test, $minServerVersion, $maxServerVersion, $serverless): void
     {
-        if (isset($minServerVersion) || isset($maxServerVersion)) {
-            $this->checkServerVersion($minServerVersion, $maxServerVersion);
+        if (isset($minServerVersion)) {
+            $this->skipIfServerVersion('<', $minServerVersion);
+        }
+
+        if (isset($maxServerVersion)) {
+            $this->skipIfServerVersion('>=', $maxServerVersion);
         }
 
         $this->checkServerlessRequirement($serverless);
@@ -143,24 +145,6 @@ private function checkServerlessRequirement(?string $serverless): void
         }
     }
 
-    /**
-     * Checks that the server version is within the allowed bounds (if any).
-     *
-     * @throws PHPUnit_Framework_SkippedTestError
-     */
-    private function checkServerVersion(?string $minServerVersion, ?string $maxServerVersion): void
-    {
-        $serverVersion = $this->getServerVersion();
-
-        if (isset($minServerVersion) && version_compare($serverVersion, $minServerVersion, '<')) {
-            $this->markTestSkipped(sprintf('Server version "%s" < minServerVersion "%s"', $serverVersion, $minServerVersion));
-        }
-
-        if (isset($maxServerVersion) && version_compare($serverVersion, $maxServerVersion, '>=')) {
-            $this->markTestSkipped(sprintf('Server version "%s" >= maxServerVersion "%s"', $serverVersion, $maxServerVersion));
-        }
-    }
-
     /**
      * Executes an "operation" block.
      *

diff --git a/tests/DocumentationExamplesTest.php b/tests/DocumentationExamplesTest.php
@@ -20,7 +20,6 @@
 use function ob_start;
 use function usleep;
 use function var_dump;
-use function version_compare;
 
 /**
  * Documentation examples to be parsed for inclusion in the MongoDB manual.
@@ -1549,9 +1548,7 @@ public function testCausalConsistency(): void
 
     public function testSnapshotQueries(): void
     {
-        if (version_compare($this->getServerVersion(), '5.0.0', '<')) {
-            $this->markTestSkipped('Snapshot queries outside of transactions are not supported');
-        }
+        $this->skipIfServerVersion('<', '5.0.0', 'Snapshot queries outside of transactions are not supported');
 
         if (! ($this->isReplicaSet() || $this->isShardedClusterUsingReplicasets())) {
             $this->markTestSkipped('Snapshot read concern is only supported with replicasets');
@@ -1682,13 +1679,8 @@ public function testVersionedApi(): void
 
     public function testVersionedApiMigration(): void
     {
-        if (version_compare($this->getServerVersion(), '5.0.0', '<')) {
-            $this->markTestSkipped('Versioned API is not supported');
-        }
-
-        if (version_compare($this->getServerVersion(), '5.0.9', '>=')) {
-            $this->markTestSkipped('The count command was added to API version 1 (SERVER-63850)');
-        }
+        $this->skipIfServerVersion('<', '5.0.0', 'Versioned API is not supported');
+        $this->skipIfServerVersion('>=', '5.0.9', 'The count command was added to API version 1 (SERVER-63850)');
 
         $this->dropCollection($this->getDatabaseName(), 'sales');
         $uriString = static::getUri(true);
@@ -1817,9 +1809,7 @@ public function testQueryableEncryption(): void
             $this->markTestSkipped('Queryable encryption requires replica sets');
         }
 
-        if (version_compare($this->getServerVersion(), '7.0.0', '<')) {
-            $this->markTestSkipped('Explicit encryption tests require MongoDB 7.0 or later');
-        }
+        $this->skipIfServerVersion('<', '7.0.0', 'Explicit encryption tests require MongoDB 7.0 or later');
 
         if (! $this->isEnterprise()) {
             $this->markTestSkipped('Automatic encryption requires MongoDB Enterprise');

diff --git a/tests/FunctionalTestCase.php b/tests/FunctionalTestCase.php
@@ -484,6 +484,13 @@ protected function isShardedClusterUsingReplicasets()
         return preg_match('@^.*/.*:\d+@', $document['host']);
     }
 
+    protected function skipIfServerVersion(string $operator, string $version, ?string $message = null): void
+    {
+        if (version_compare($this->getServerVersion(), $version, $operator)) {
+            $this->markTestSkipped($message ?? sprintf('Server version is %s %s', $operator, $version));
+        }
+    }
+
     protected function skipIfChangeStreamIsNotSupported(): void
     {
         switch ($this->getPrimaryServer()->getType()) {

diff --git a/tests/Operation/BulkWriteFunctionalTest.php b/tests/Operation/BulkWriteFunctionalTest.php
@@ -15,7 +15,6 @@
 use stdClass;
 
 use function is_array;
-use function version_compare;
 
 class BulkWriteFunctionalTest extends FunctionalTestCase
 {
@@ -200,8 +199,8 @@ function (array $event) use ($expectedReplacement): void {
      */
     public function testUpdateDocuments($update, $expectedUpdate): void
     {
-        if (is_array($expectedUpdate) && version_compare($this->getServerVersion(), '4.2.0', '<')) {
-            $this->markTestSkipped('Pipeline-style updates are not supported');
+        if (is_array($expectedUpdate)) {
+            $this->skipIfServerVersion('<', '4.2.0', 'Pipeline-style updates are not supported');
         }
 
         (new CommandObserver())->observe(
@@ -425,9 +424,7 @@ function (array $event): void {
 
     public function testBulkWriteWithPipelineUpdates(): void
     {
-        if (version_compare($this->getServerVersion(), '4.2.0', '<')) {
-            $this->markTestSkipped('Pipeline-style updates are not supported');
-        }
+        $this->skipIfServerVersion('<', '4.2.0', 'Pipeline-style updates are not supported');
 
         $this->createFixtures(4);
 

diff --git a/tests/Operation/CreateEncryptedCollectionFunctionalTest.php b/tests/Operation/CreateEncryptedCollectionFunctionalTest.php
@@ -16,7 +16,6 @@
 use function getenv;
 use function is_executable;
 use function is_readable;
-use function version_compare;
 
 use const DIRECTORY_SEPARATOR;
 use const PATH_SEPARATOR;
@@ -42,9 +41,7 @@ public function setUp(): void
             $this->markTestSkipped('Queryable Encryption requires replica sets');
         }
 
-        if (version_compare($this->getServerVersion(), '6.0.0', '<')) {
-            $this->markTestSkipped('Queryable Encryption requires MongoDB 6.0 or later');
-        }
+        $this->skipIfServerVersion('<', '6.0.0', 'Queryable Encryption requires MongoDB 6.0 or later');
 
         $client = static::createTestClient();
 

diff --git a/tests/Operation/CreateIndexesFunctionalTest.php b/tests/Operation/CreateIndexesFunctionalTest.php
@@ -16,7 +16,6 @@
 use function call_user_func;
 use function is_callable;
 use function sprintf;
-use function version_compare;
 
 class CreateIndexesFunctionalTest extends FunctionalTestCase
 {
@@ -189,9 +188,7 @@ function (array $event): void {
 
     public function testCommitQuorumOption(): void
     {
-        if (version_compare($this->getServerVersion(), '4.3.4', '<')) {
-            $this->markTestSkipped('commitQuorum is not supported');
-        }
+        $this->skipIfServerVersion('<', '4.3.4', 'commitQuorum is not supported');
 
         if ($this->getPrimaryServer()->getType() !== Server::TYPE_RS_PRIMARY) {
             $this->markTestSkipped('commitQuorum is only supported on replica sets');
@@ -216,9 +213,7 @@ function (array $event): void {
 
     public function testCommitQuorumUnsupported(): void
     {
-        if (version_compare($this->getServerVersion(), '4.3.4', '>=')) {
-            $this->markTestSkipped('commitQuorum is supported');
-        }
+        $this->skipIfServerVersion('>=', '4.3.4', 'commitQuorum is supported');
 
         $operation = new CreateIndexes(
             $this->getDatabaseName(),

diff --git a/tests/Operation/DeleteFunctionalTest.php b/tests/Operation/DeleteFunctionalTest.php
@@ -12,8 +12,6 @@
 use MongoDB\Tests\CommandObserver;
 use stdClass;
 
-use function version_compare;
-
 class DeleteFunctionalTest extends FunctionalTestCase
 {
     /** @var Collection */
@@ -87,9 +85,7 @@ public function testDeleteMany(): void
 
     public function testHintOptionAndUnacknowledgedWriteConcernUnsupportedClientSideError(): void
     {
-        if (version_compare($this->getServerVersion(), '4.4.0', '>=')) {
-            $this->markTestSkipped('hint is supported');
-        }
+        $this->skipIfServerVersion('>=', '4.4.0', 'hint is supported');
 
         $operation = new Delete(
             $this->getDatabaseName(),

diff --git a/tests/Operation/ExplainFunctionalTest.php b/tests/Operation/ExplainFunctionalTest.php
@@ -21,8 +21,6 @@
 use MongoDB\Operation\UpdateOne;
 use MongoDB\Tests\CommandObserver;
 
-use function version_compare;
-
 class ExplainFunctionalTest extends FunctionalTestCase
 {
     /** @dataProvider provideVerbosityInformation */
@@ -329,9 +327,7 @@ public function testUpdateOne($verbosity, $executionStatsExpected, $allPlansExec
 
     public function testAggregate(): void
     {
-        if (version_compare($this->getServerVersion(), '4.0.0', '<')) {
-            $this->markTestSkipped('Explaining aggregate command requires server version >= 4.0');
-        }
+        $this->skipIfServerVersion('<', '4.0.0', 'Explaining aggregate command requires server version >= 4.0');
 
         $this->createFixtures(3);
 
@@ -348,9 +344,7 @@ public function testAggregate(): void
     /** @dataProvider provideVerbosityInformation */
     public function testAggregateOptimizedToQuery($verbosity, $executionStatsExpected, $allPlansExecutionExpected): void
     {
-        if (version_compare($this->getServerVersion(), '4.2.0', '<')) {
-            $this->markTestSkipped('MongoDB < 4.2 does not optimize simple aggregation pipelines');
-        }
+        $this->skipIfServerVersion('<', '4.2.0', 'MongoDB < 4.2 does not optimize simple aggregation pipelines');
 
         $this->createFixtures(3);
 

diff --git a/tests/Operation/FindAndModifyFunctionalTest.php b/tests/Operation/FindAndModifyFunctionalTest.php
@@ -12,8 +12,6 @@
 use MongoDB\Tests\CommandObserver;
 use stdClass;
 
-use function version_compare;
-
 class FindAndModifyFunctionalTest extends FunctionalTestCase
 {
     /** @dataProvider provideQueryDocuments */
@@ -129,9 +127,7 @@ function (array $event): void {
 
     public function testHintOptionUnsupportedClientSideError(): void
     {
-        if (version_compare($this->getServerVersion(), '4.2.0', '>=')) {
-            $this->markTestSkipped('server reports error for unsupported findAndModify options');
-        }
+        $this->skipIfServerVersion('>=', '4.2.0', 'server reports error for unsupported findAndModify options');
 
         $operation = new FindAndModify(
             $this->getDatabaseName(),
@@ -147,9 +143,7 @@ public function testHintOptionUnsupportedClientSideError(): void
 
     public function testHintOptionAndUnacknowledgedWriteConcernUnsupportedClientSideError(): void
     {
-        if (version_compare($this->getServerVersion(), '4.4.0', '>=')) {
-            $this->markTestSkipped('hint is supported');
-        }
+        $this->skipIfServerVersion('>=', '4.4.0', 'hint is supported');
 
         $operation = new FindAndModify(
             $this->getDatabaseName(),

diff --git a/tests/Operation/MapReduceFunctionalTest.php b/tests/Operation/MapReduceFunctionalTest.php
@@ -107,9 +107,7 @@ public function testResult(): void
 
     public function testResultIncludesTimingWithVerboseOption(): void
     {
-        if (version_compare($this->getServerVersion(), '4.3.0', '>=')) {
-            $this->markTestSkipped('mapReduce statistics are no longer exposed');
-        }
+        $this->skipIfServerVersion('>=', '4.3.0', 'mapReduce statistics are no longer exposed');
 
         $this->createFixtures(3);
 
@@ -128,9 +126,7 @@ public function testResultIncludesTimingWithVerboseOption(): void
 
     public function testResultDoesNotIncludeTimingWithoutVerboseOption(): void
     {
-        if (version_compare($this->getServerVersion(), '4.3.0', '>=')) {
-            $this->markTestSkipped('mapReduce statistics are no longer exposed');
-        }
+        $this->skipIfServerVersion('>=', '4.3.0', 'mapReduce statistics are no longer exposed');
 
         $this->createFixtures(3);
 

diff --git a/tests/Operation/UpdateFunctionalTest.php b/tests/Operation/UpdateFunctionalTest.php
@@ -14,7 +14,6 @@
 use stdClass;
 
 use function is_array;
-use function version_compare;
 
 class UpdateFunctionalTest extends FunctionalTestCase
 {
@@ -56,8 +55,8 @@ function (array $event) use ($expectedFilter): void {
      */
     public function testUpdateDocuments($update, $expectedUpdate): void
     {
-        if (is_array($expectedUpdate) && version_compare($this->getServerVersion(), '4.2.0', '<')) {
-            $this->markTestSkipped('Pipeline-style updates are not supported');
+        if (is_array($expectedUpdate)) {
+            $this->skipIfServerVersion('<', '4.2.0', 'Pipeline-style updates are not supported');
         }
 
         (new CommandObserver())->observe(
@@ -152,9 +151,7 @@ function (array $event): void {
 
     public function testHintOptionAndUnacknowledgedWriteConcernUnsupportedClientSideError(): void
     {
-        if (version_compare($this->getServerVersion(), '4.2.0', '>=')) {
-            $this->markTestSkipped('hint is supported');
-        }
+        $this->skipIfServerVersion('>=', '4.2.0', 'hint is supported');
 
         $operation = new Update(
             $this->getDatabaseName(),