Explicitly drop collection & databases in tests to clean them on tear down

Author: GromNaN

tests/Collection/FunctionalTestCase.php

@@ -21,13 +21,4 @@ public function setUp(): void
 
         $this->dropCollection();
     }
-
-    public function tearDown(): void
-    {
-        if (! $this->hasFailed()) {
-            $this->dropCollection();
-        }
-
-        parent::tearDown();
-    }
 }

tests/DocumentationExamplesTest.php

@@ -31,24 +31,9 @@
  */
 class DocumentationExamplesTest extends FunctionalTestCase
 {
-    public function setUp(): void
-    {
-        parent::setUp();
-
-        $this->dropCollection();
-    }
-
-    public function tearDown(): void
-    {
-        if (! $this->hasFailed()) {
-            $this->dropCollection();
-        }
-
-        parent::tearDown();
-    }
-
     public function testExample_1_2(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 1
@@ -73,6 +58,7 @@ public function testExample_1_2(): void
 
     public function testExample_3(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 3
@@ -108,6 +94,7 @@ public function testExample_3(): void
 
     public function testExample_6_13(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 6
@@ -212,6 +199,7 @@ public function testExample_6_13(): void
 
     public function testExample_14_19(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 14
@@ -293,6 +281,7 @@ public function testExample_14_19(): void
 
     public function testExample_20_28(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 20
@@ -400,6 +389,7 @@ public function testExample_20_28(): void
 
     public function testExample_29_37(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 29
@@ -499,6 +489,7 @@ public function testExample_29_37(): void
 
     public function testExample_38_41(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 38
@@ -536,6 +527,7 @@ public function testExample_38_41(): void
 
     public function testExample_42_50(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 42
@@ -741,6 +733,7 @@ public function testExample_42_50(): void
 
     public function testExample_51_54(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 51
@@ -882,6 +875,7 @@ public function testExample_51_54(): void
 
     public function testExample_55_58(): void
     {
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Example 55
@@ -959,8 +953,8 @@ public function testChangeStreamExample_1_4(): void
             $this->markTestSkipped('Test does not apply on sharded clusters: need more than a single getMore call on the change stream.');
         }
 
+        $this->dropCollection(null, 'inventory');
         $db = new Database($this->manager, $this->getDatabaseName());
-        $db->dropCollection('inventory');
         $db->createCollection('inventory');
 
         // Start Changestream Example 1
@@ -1059,6 +1053,7 @@ public function testChangeStreamExample_1_4(): void
 
     public function testAggregation_example_1(): void
     {
+        $this->dropCollection(null, 'sales');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Aggregation Example 1
@@ -1073,6 +1068,7 @@ public function testAggregation_example_1(): void
 
     public function testAggregation_example_2(): void
     {
+        $this->dropCollection(null, 'sales');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Aggregation Example 2
@@ -1101,6 +1097,7 @@ public function testAggregation_example_2(): void
 
     public function testAggregation_example_3(): void
     {
+        $this->dropCollection(null, 'sales');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Aggregation Example 3
@@ -1139,6 +1136,7 @@ public function testAggregation_example_3(): void
 
     public function testAggregation_example_4(): void
     {
+        $this->dropCollection(null, 'air_airlines');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // phpcs:disable Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
@@ -1191,8 +1189,8 @@ public function testRunCommand_example_1(): void
 
     public function testRunCommand_example_2(): void
     {
+        $this->dropCollection(null, 'restaurants');
         $db = new Database($this->manager, $this->getDatabaseName());
-        $db->dropCollection('restaurants');
         $db->createCollection('restaurants');
 
         // Start runCommand Example 2
@@ -1205,6 +1203,7 @@ public function testRunCommand_example_2(): void
 
     public function testIndex_example_1(): void
     {
+        $this->dropCollection(null, 'records');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Index Example 1
@@ -1216,6 +1215,7 @@ public function testIndex_example_1(): void
 
     public function testIndex_example_2(): void
     {
+        $this->dropCollection(null, 'restaurants');
         $db = new Database($this->manager, $this->getDatabaseName());
 
         // Start Index Example 2
@@ -1234,6 +1234,8 @@ public function testIndex_example_2(): void
     // Start Transactions Intro Example 1
     private function updateEmployeeInfo1(\MongoDB\Client $client, \MongoDB\Driver\Session $session): void
     {
+        $this->dropCollection('hr', 'employees');
+        $this->dropCollection('reporting', 'events');
         $session->startTransaction([
             'readConcern' => new \MongoDB\Driver\ReadConcern('snapshot'),
             'writeConcern' => new \MongoDB\Driver\WriteConcern(\MongoDB\Driver\WriteConcern::MAJORITY),
@@ -1291,8 +1293,8 @@ public function testTransactions_intro_example_1(): void
         $client = static::createTestClient();
 
         /* The WC is required: https://mongodb.com/docs/manual/core/transactions/#transactions-and-locks */
-        $client->hr->dropCollection('employees', ['writeConcern' => new WriteConcern('majority')]);
-        $client->reporting->dropCollection('events', ['writeConcern' => new WriteConcern('majority')]);
+        $this->dropCollection('hr', 'employees');
+        $this->dropCollection('reporting', 'events');
 
         /* Collections need to be created before a transaction starts */
         $client->hr->createCollection('employees', ['writeConcern' => new WriteConcern('majority')]);
@@ -1471,12 +1473,12 @@ public function testTransactions_retry_example_3(): void
         $client = static::createTestClient();
 
         /* The WC is required: https://mongodb.com/docs/manual/core/transactions/#transactions-and-locks */
-        $client->hr->dropCollection('employees', ['writeConcern' => new WriteConcern('majority')]);
-        $client->reporting->dropCollection('events', ['writeConcern' => new WriteConcern('majority')]);
+        $this->dropCollection('hr', 'employees');
+        $this->dropCollection('reporting', 'events');
 
         /* Collections need to be created before a transaction starts */
-        $client->hr->createCollection('employees', ['writeConcern' => new WriteConcern('majority')]);
-        $client->reporting->createCollection('events', ['writeConcern' => new WriteConcern('majority')]);
+        $this->createCollection('hr', 'employees');
+        $this->createCollection('reporting', 'events');
 
         ob_start();
         try {
@@ -1493,13 +1495,12 @@ public function testCausalConsistency(): void
         $this->assertNotNull('This test intentionally performs no assertions');
 
         // Prep
+        $this->dropCollection('test', 'items');
         $client = static::createTestClient();
         $items = $client->selectDatabase(
             'test',
             ['writeConcern' => new WriteConcern(WriteConcern::MAJORITY)]
         )->items;
-
-        $items->drop();
         $items->insertOne(
             ['sku' => '111', 'name' => 'Peanuts', 'start' => new UTCDateTime()]
         );
@@ -1585,17 +1586,19 @@ public function testSnapshotQueries(): void
             $this->markTestSkipped('Snapshot read concern is only supported with replicasets');
         }
 
+        $this->dropCollection('pets', 'cats');
+        $this->dropCollection('pets', 'dogs');
+        $this->dropCollection('retail', 'sales');
+
         $client = static::createTestClient();
 
         $catsCollection = $client->selectCollection('pets', 'cats');
-        $catsCollection->drop();
         $catsCollection->insertMany([
             ['name' => 'Whiskers', 'color' => 'white', 'adoptable' => true],
             ['name' => 'Garfield', 'color' => 'orange', 'adoptable' => false],
         ]);
 
         $dogsCollection = $client->selectCollection('pets', 'dogs');
-        $dogsCollection->drop();
         $dogsCollection->insertMany([
             ['name' => 'Toto', 'color' => 'black',  'adoptable' => true],
             ['name' => 'Milo', 'color' => 'black', 'adoptable' => false],
@@ -1645,7 +1648,6 @@ public function testSnapshotQueries(): void
         $dogsCollection->drop();
 
         $salesCollection = $client->selectCollection('retail', 'sales');
-        $salesCollection->drop();
         $salesCollection->insertMany([
             ['shoeType' => 'boot', 'price' => 30, 'saleDate' => new UTCDateTime()],
         ]);
@@ -1726,13 +1728,13 @@ public function testVersionedApiMigration(): void
             $this->markTestSkipped('The count command was added to API version 1 (SERVER-63850)');
         }
 
+        $this->dropCollection(null, 'sales');
         $uriString = static::getUri(true);
 
         // phpcs:disable SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
         $serverApi = new \MongoDB\Driver\ServerApi('1', true);
         $client = new \MongoDB\Client($uriString, [], ['serverApi' => $serverApi]);
         $db = $client->selectDatabase($this->getDatabaseName());
-        $db->dropCollection('sales');
 
         // Start Versioned API Example 5
         $strtoutc = function (string $datetime) {
@@ -1786,6 +1788,8 @@ public function testWithTransactionExample(): void
         $this->skipIfTransactionsAreNotSupported();
 
         $uriString = static::getUri(true);
+        $this->dropCollection('mydb1', 'foo');
+        $this->dropCollection('mydb2', 'bar');
 
         // phpcs:disable SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
         // Start Transactions withTxn API Example 1
@@ -1865,6 +1869,8 @@ public function testQueryableEncryption(): void
             $this->markTestSkipped('Automatic encryption requires MongoDB Enterprise');
         }
 
+        $this->dropCollection();
+
         // Fetch names for the database and collection under test
         $collectionName = $this->getCollectionName();
         $databaseName = $this->getDatabaseName();
@@ -1950,22 +1956,14 @@ public function testQueryableEncryption(): void
         $this->assertInstanceOf(Binary::class, $result['encryptedUnindexed']);
     }
 
-    /**
-     * Return the test collection name.
-     */
-    protected function getCollectionName(): string
-    {
-        return 'inventory';
-    }
-
     private function assertCursorCount($count, Cursor $cursor): void
     {
         $this->assertCount($count, $cursor->toArray());
     }
 
     private function assertInventoryCount($count): void
     {
-        $this->assertCollectionCount($this->getDatabaseName() . '.' . $this->getCollectionName(), $count);
+        $this->assertCollectionCount($this->getDatabaseName() . '.inventory', $count);
     }
 
     private function waitForSnapshot(string $databaseName, string $collectionName): void