Move assertCollectionDoesNotExist() and assertCollectionExists() to FunctionalTestCase

tanlisu · tanlisu · commit 07262f833b91 · 2021-07-09T11:46:08.000-04:00
diff --git a/tests/Collection/CollectionFunctionalTest.php b/tests/Collection/CollectionFunctionalTest.php
@@ -345,6 +345,8 @@ public function testRename(): void
 
         $commandResult = $this->collection->rename($this->getDatabaseName() . '.' . $renamedCollection);
         $this->assertCommandSucceeded($commandResult);
+        $this->assertCollectionDoesNotExist($this->getCollectionName());
+        $this->assertCollectionExists($renamedCollection);
 
         $operation = new FindOne($this->getDatabaseName(), $renamedCollection, []);
         $cursor = $operation->execute($this->getPrimaryServer());
diff --git a/tests/Database/CollectionManagementFunctionalTest.php b/tests/Database/CollectionManagementFunctionalTest.php
@@ -2,15 +2,10 @@
 
 namespace MongoDB\Tests\Database;
 
-use InvalidArgumentException;
 use MongoDB\Driver\BulkWrite;
 use MongoDB\Model\CollectionInfo;
 use MongoDB\Model\CollectionInfoIterator;
 
-use function call_user_func;
-use function is_callable;
-use function sprintf;
-
 /**
  * Functional tests for collection management methods.
  */
@@ -112,38 +107,4 @@ public function testListCollectionNamesWithFilter(): void
             $this->assertEquals($collectionName, $collection);
         }
     }
-
-    /**
-     * Asserts that a collection with the given name exists in the database.
-     *
-     * An optional $callback may be provided, which should take a CollectionInfo
-     * argument as its first and only parameter. If a CollectionInfo matching
-     * the given name is found, it will be passed to the callback, which may
-     * perform additional assertions.
-     *
-     * @param callable $callback
-     */
-    private function assertCollectionExists($collectionName, ?callable $callback = null): void
-    {
-        if ($callback !== null && ! is_callable($callback)) {
-            throw new InvalidArgumentException('$callback is not a callable');
-        }
-
-        $collections = $this->database->listCollections();
-
-        $foundCollection = null;
-
-        foreach ($collections as $collection) {
-            if ($collection->getName() === $collectionName) {
-                $foundCollection = $collection;
-                break;
-            }
-        }
-
-        $this->assertNotNull($foundCollection, sprintf('Found %s collection in the database', $collectionName));
-
-        if ($callback !== null) {
-            call_user_func($callback, $foundCollection);
-        }
-    }
 }
diff --git a/tests/FunctionalTestCase.php b/tests/FunctionalTestCase.php
@@ -16,16 +16,19 @@
 use MongoDB\Operation\CreateCollection;
 use MongoDB\Operation\DatabaseCommand;
 use MongoDB\Operation\DropCollection;
+use MongoDB\Operation\ListCollections;
 use stdClass;
 use UnexpectedValueException;
 
 use function array_merge;
+use function call_user_func;
 use function count;
 use function current;
 use function explode;
 use function getenv;
 use function implode;
 use function is_array;
+use function is_callable;
 use function is_object;
 use function is_string;
 use function key;
@@ -147,6 +150,64 @@ protected function assertCollectionCount($namespace, $count): void
         $this->assertEquals($count, $document['n']);
     }
 
+    /**
+     * Asserts that a collection with the given name does not exist on the
+     * server.
+     *
+     * @param string $collectionName
+     */
+    protected function assertCollectionDoesNotExist(string $collectionName): void
+    {
+        $operation = new ListCollections($this->getDatabaseName());
+        $collections = $operation->execute($this->getPrimaryServer());
+
+        $foundCollection = null;
+
+        foreach ($collections as $collection) {
+            if ($collection->getName() === $collectionName) {
+                $foundCollection = $collection;
+                break;
+            }
+        }
+
+        $this->assertNull($foundCollection, sprintf('Collection %s exists', $collectionName));
+    }
+
+    /**
+     * Asserts that a collection with the given name exists on the server.
+     *
+     * An optional $callback may be provided, which should take a CollectionInfo
+     * argument as its first and only parameter. If a CollectionInfo matching
+     * the given name is found, it will be passed to the callback, which may
+     * perform additional assertions.
+     *
+     * @param callable $callback
+     */
+    protected function assertCollectionExists($collectionName, ?callable $callback = null): void
+    {
+        if ($callback !== null && ! is_callable($callback)) {
+            throw new InvalidArgumentException('$callback is not a callable');
+        }
+
+        $operation = new ListCollections($this->getDatabaseName());
+        $collections = $operation->execute($this->getPrimaryServer());
+
+        $foundCollection = null;
+
+        foreach ($collections as $collection) {
+            if ($collection->getName() === $collectionName) {
+                $foundCollection = $collection;
+                break;
+            }
+        }
+
+        $this->assertNotNull($foundCollection, sprintf('Found %s collection in the database', $collectionName));
+
+        if ($callback !== null) {
+            call_user_func($callback, $foundCollection);
+        }
+    }
+
     protected function assertCommandSucceeded($document): void
     {
         $document = is_object($document) ? (array) $document : $document;
diff --git a/tests/GridFS/BucketFunctionalTest.php b/tests/GridFS/BucketFunctionalTest.php
@@ -13,7 +13,6 @@
 use MongoDB\GridFS\Exception\StreamException;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\IndexInfo;
-use MongoDB\Operation\ListCollections;
 use MongoDB\Operation\ListIndexes;
 use PHPUnit\Framework\Error\Warning;
 
@@ -773,29 +772,6 @@ public function testDanglingOpenWritableStream(): void
         $this->assertSame('', $output);
     }
 
-    /**
-     * Asserts that a collection with the given name does not exist on the
-     * server.
-     *
-     * @param string $collectionName
-     */
-    private function assertCollectionDoesNotExist(string $collectionName): void
-    {
-        $operation = new ListCollections($this->getDatabaseName());
-        $collections = $operation->execute($this->getPrimaryServer());
-
-        $foundCollection = null;
-
-        foreach ($collections as $collection) {
-            if ($collection->getName() === $collectionName) {
-                $foundCollection = $collection;
-                break;
-            }
-        }
-
-        $this->assertNull($foundCollection, sprintf('Collection %s exists', $collectionName));
-    }
-
     /**
      * Asserts that an index with the given name exists for the collection.
      *
diff --git a/tests/Operation/DropCollectionFunctionalTest.php b/tests/Operation/DropCollectionFunctionalTest.php
@@ -4,10 +4,8 @@
 
 use MongoDB\Operation\DropCollection;
 use MongoDB\Operation\InsertOne;
-use MongoDB\Operation\ListCollections;
 use MongoDB\Tests\CommandObserver;
 
-use function sprintf;
 use function version_compare;
 
 class DropCollectionFunctionalTest extends FunctionalTestCase
@@ -81,27 +79,4 @@ function (array $event): void {
             }
         );
     }
-
-    /**
-     * Asserts that a collection with the given name does not exist on the
-     * server.
-     *
-     * @param string $collectionName
-     */
-    private function assertCollectionDoesNotExist(string $collectionName): void
-    {
-        $operation = new ListCollections($this->getDatabaseName());
-        $collections = $operation->execute($this->getPrimaryServer());
-
-        $foundCollection = null;
-
-        foreach ($collections as $collection) {
-            if ($collection->getName() === $collectionName) {
-                $foundCollection = $collection;
-                break;
-            }
-        }
-
-        $this->assertNull($foundCollection, sprintf('Collection %s exists', $collectionName));
-    }
 }
diff --git a/tests/Operation/RenameCollectionFunctionalTest.php b/tests/Operation/RenameCollectionFunctionalTest.php
@@ -6,13 +6,9 @@
 use MongoDB\Operation\DropCollection;
 use MongoDB\Operation\FindOne;
 use MongoDB\Operation\InsertOne;
-use MongoDB\Operation\ListCollections;
 use MongoDB\Operation\RenameCollection;
 use MongoDB\Tests\CommandObserver;
 
-use function call_user_func;
-use function is_callable;
-use function sprintf;
 use function version_compare;
 
 class RenameCollectionFunctionalTest extends FunctionalTestCase
@@ -132,62 +128,4 @@ public function tearDown(): void
 
         parent::tearDown();
     }
-
-    /**
-     * Asserts that a collection with the given name does not exist on the
-     * server.
-     *
-     * @param string $collectionName
-     */
-    private function assertCollectionDoesNotExist(string $collectionName): void
-    {
-        $operation = new ListCollections($this->getDatabaseName());
-        $collections = $operation->execute($this->getPrimaryServer());
-
-        $foundCollection = null;
-
-        foreach ($collections as $collection) {
-            if ($collection->getName() === $collectionName) {
-                $foundCollection = $collection;
-                break;
-            }
-        }
-
-        $this->assertNull($foundCollection, sprintf('Collection %s exists', $collectionName));
-    }
-
-    /**
-     * Asserts that a collection with the given name exists on the server.
-     *
-     * An optional $callback may be provided, which should take a CollectionInfo
-     * argument as its first and only parameter. If a CollectionInfo matching
-     * the given name is found, it will be passed to the callback, which may
-     * perform additional assertions.
-     *
-     * @param callable $callback
-     */
-    private function assertCollectionExists($collectionName, ?callable $callback = null): void
-    {
-        if ($callback !== null && ! is_callable($callback)) {
-            throw new InvalidArgumentException('$callback is not a callable');
-        }
-
-        $operation = new ListCollections($this->getDatabaseName());
-        $collections = $operation->execute($this->getPrimaryServer());
-
-        $foundCollection = null;
-
-        foreach ($collections as $collection) {
-            if ($collection->getName() === $collectionName) {
-                $foundCollection = $collection;
-                break;
-            }
-        }
-
-        $this->assertNotNull($foundCollection, sprintf('Found %s collection in the database', $collectionName));
-
-        if ($callback !== null) {
-            call_user_func($callback, $foundCollection);
-        }
-    }
 }
