JAVA-2778: Test that sessions and bindings have been properly released after every functional test in driver-async

Author: jyemin

driver-async/src/main/com/mongodb/async/client/MongoClientImpl.java

@@ -161,4 +161,7 @@ Cluster getCluster() {
         return cluster;
     }
 
+    ServerSessionPool getServerSessionPool() {
+        return serverSessionPool;
+    }
 }

driver-async/src/test/functional/com/mongodb/async/client/DatabaseTestCase.java

@@ -27,6 +27,7 @@
 import static com.mongodb.async.client.Fixture.drop;
 import static com.mongodb.async.client.Fixture.getDefaultDatabaseName;
 import static com.mongodb.async.client.Fixture.getMongoClient;
+import static com.mongodb.async.client.Fixture.waitForLastServerSessionPoolRelease;
 
 public class DatabaseTestCase {
     //For ease of use and readability, in this specific case we'll allow protected variables
@@ -49,6 +50,8 @@ public void tearDown() {
         if (collection != null) {
             drop(collection.getNamespace());
         }
+
+        waitForLastServerSessionPoolRelease();
     }
 
     public abstract class MongoOperation<TResult> {

driver-async/src/test/functional/com/mongodb/async/client/Fixture.java

@@ -16,9 +16,12 @@
 
 package com.mongodb.async.client;
 
+import com.mongodb.ClusterFixture;
 import com.mongodb.ConnectionString;
 import com.mongodb.MongoCommandException;
+import com.mongodb.MongoInterruptedException;
 import com.mongodb.MongoNamespace;
+import com.mongodb.MongoTimeoutException;
 import com.mongodb.async.FutureResultCallback;
 import com.mongodb.connection.ClusterSettings;
 import com.mongodb.connection.ConnectionPoolSettings;
@@ -28,6 +31,7 @@
 import org.bson.Document;
 
 import static com.mongodb.connection.ClusterType.SHARDED;
+import static java.lang.Thread.sleep;
 import static java.util.concurrent.TimeUnit.SECONDS;
 
 /**
@@ -152,6 +156,29 @@ public static void drop(final MongoNamespace namespace) {
         }
     }
 
+    public static synchronized void waitForLastServerSessionPoolRelease() {
+        if (mongoClient != null) {
+            long startTime = System.currentTimeMillis();
+            int sessionInUseCount = getSessionInUseCount();
+            while (sessionInUseCount > 0) {
+                try {
+                    if (System.currentTimeMillis() > startTime + ClusterFixture.TIMEOUT * 1000) {
+                        throw new MongoTimeoutException("Timed out waiting for server session pool in use count to drop to 0.  Now at: "
+                                + sessionInUseCount);
+                    }
+                    sleep(10);
+                    sessionInUseCount = getSessionInUseCount();
+                } catch (InterruptedException e) {
+                    throw new MongoInterruptedException("Interrupted", e);
+                }
+            }
+        }
+    }
+
+    private static int getSessionInUseCount() {
+        return mongoClient.getServerSessionPool().getInUseCount();
+    }
+
     static class ShutdownHook extends Thread {
         @Override
         public void run() {

driver-async/src/test/functional/com/mongodb/async/client/FunctionalSpecification.groovy

@@ -22,6 +22,7 @@ import spock.lang.Specification
 
 import static Fixture.getDefaultDatabase
 import static Fixture.initializeCollection
+import static com.mongodb.async.client.Fixture.waitForLastServerSessionPoolRelease
 
 class FunctionalSpecification extends Specification {
     protected MongoDatabase database;
@@ -32,6 +33,10 @@ class FunctionalSpecification extends Specification {
         collection = initializeCollection(new MongoNamespace(database.getName(), getClass().getName()))
     }
 
+    def cleanup() {
+        waitForLastServerSessionPoolRelease();
+    }
+
     String getDatabaseName() {
         database.getName();
     }

driver-async/src/test/functional/com/mongodb/async/client/MongoClientSessionSpecification.groovy

@@ -74,6 +74,9 @@ class MongoClientSessionSpecification extends FunctionalSpecification {
         clientSession.getClusterTime() == null
         clientSession.getOperationTime() == null
         clientSession.getServerSession() != null
+
+        cleanup:
+        clientSession.close()
     }
 
     @IgnoreIf({ !serverVersionAtLeast(3, 6) })
@@ -115,6 +118,9 @@ class MongoClientSessionSpecification extends FunctionalSpecification {
 
         then:
         clientSession.getClusterTime() == secondClusterTime
+
+        cleanup:
+        clientSession.close()
     }
 
     @IgnoreIf({ !serverVersionAtLeast(3, 6) })
@@ -153,6 +159,9 @@ class MongoClientSessionSpecification extends FunctionalSpecification {
 
         then:
         clientSession.getOperationTime() == secondOperationTime
+
+        cleanup:
+        clientSession.close()
     }
 
     @IgnoreIf({ !serverVersionAtLeast(3, 6) })
@@ -179,6 +188,9 @@ class MongoClientSessionSpecification extends FunctionalSpecification {
 
         then:
         thrown(IllegalStateException)
+
+        cleanup:
+        clientSession.close()
     }
 
     @IgnoreIf({ !serverVersionAtLeast(3, 6) })
@@ -207,6 +219,9 @@ class MongoClientSessionSpecification extends FunctionalSpecification {
         clientSession != null
         clientSession.isCausallyConsistent() == causallyConsistent
 
+        cleanup:
+        clientSession.close()
+
         where:
         causallyConsistent << [true, false]
     }
@@ -225,6 +240,9 @@ class MongoClientSessionSpecification extends FunctionalSpecification {
         identifier.get('id').isBinary()
         identifier.getBinary('id').getType() == BsonBinarySubType.UUID_STANDARD.value
         identifier.getBinary('id').data.length == 16
+
+        cleanup:
+        clientSession.close()
     }
 
     @IgnoreIf({ !serverVersionAtLeast(3, 6) })

driver-async/src/test/functional/com/mongodb/async/client/SmokeTestSpecification.groovy

@@ -114,6 +114,7 @@ class SmokeTestSpecification extends FunctionalSpecification {
 
         then:
         batchCursor.getBatchSize() == 0
+        batchCursor.close()
 
         when: 'The collection name should be in the collections list'
         def collectionNames = run(database.listCollections().&into, [])