Update tests.

JAVA-5870

Author: vbabanin

driver-kotlin-coroutine/src/test/kotlin/com/mongodb/kotlin/client/coroutine/MongoClientTest.kt

@@ -19,9 +19,6 @@ import com.mongodb.ClientSessionOptions
 import com.mongodb.MongoNamespace
 import com.mongodb.client.model.bulk.ClientBulkWriteOptions
 import com.mongodb.client.model.bulk.ClientNamespacedWriteModel
-import com.mongodb.reactivestreams.client.MongoClient as JMongoClient
-import kotlin.reflect.full.declaredFunctions
-import kotlin.test.assertEquals
 import kotlinx.coroutines.runBlocking
 import org.bson.BsonDocument
 import org.bson.Document
@@ -36,6 +33,9 @@ import org.mockito.kotlin.verify
 import org.mockito.kotlin.verifyNoMoreInteractions
 import org.mockito.kotlin.whenever
 import reactor.core.publisher.Mono
+import kotlin.reflect.full.declaredFunctions
+import kotlin.test.assertEquals
+import com.mongodb.reactivestreams.client.MongoClient as JMongoClient
 
 class MongoClientTest {
 
@@ -44,7 +44,10 @@ class MongoClientTest {
 
     @Test
     fun shouldHaveTheSameMethods() {
-        val jMongoClientFunctions = JMongoClient::class.declaredFunctions.map { it.name }.toSet()
+        val jMongoClientFunctions = JMongoClient::class.declaredFunctions.map { it.name }
+            // TODO-JAVA-5871 remove .filterNot { it == "updateMetadata" }
+            .filterNot { it == "updateMetadata" }
+            .toSet()
         val kMongoClientFunctions = MongoClient::class.declaredFunctions.map { it.name }.toSet()
 
         assertEquals(jMongoClientFunctions, kMongoClientFunctions)

driver-sync/src/test/functional/com/mongodb/client/AbstractClientMetadataProseTest.java

@@ -38,6 +38,7 @@
 import static com.mongodb.ClusterFixture.sleep;
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assumptions.assumeFalse;
 
 /**
@@ -92,12 +93,16 @@ void shouldAppendToPreviousMetadataWhenUpdatedAfterInitialization() {
 
             //then
             //TODO change get() to orElseThrow
-            clientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
-            driverInformation = clientMetadata.getDocument("driver");
+            BsonDocument updatedClientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
+            BsonDocument updatedDriverInformation = updatedClientMetadata.getDocument("driver");
 
-            assertThat(driverInformation.getString("name").getValue()).isEqualTo(generatedDriverName + "|Framework");
-            assertThat(driverInformation.getString("version").getValue()).isEqualTo(generatedVersionName + "|1.0");
-            assertThat(clientMetadata.getString("platform").getValue()).isEqualTo(generatedPlatformName + "|Framework Platform");
+            assertThat(updatedDriverInformation.getString("name").getValue()).isEqualTo(generatedDriverName + "|Framework");
+            assertThat(updatedDriverInformation.getString("version").getValue()).isEqualTo(generatedVersionName + "|1.0");
+            assertThat(updatedClientMetadata.getString("platform").getValue()).isEqualTo(generatedPlatformName + "|Framework Platform");
+
+            assertThat(withRemovedKeys(updatedClientMetadata, "driver", "platform"))
+                    .usingRecursiveAssertion()
+                    .isEqualTo(withRemovedKeys(clientMetadata, "driver", "platform"));
         }
     }
 
@@ -110,12 +115,12 @@ void shouldAppendToDefaultClientMetadataWhenUpdatedAfterInitialization() {
                 .build())) {
 
             //TODO change get() to orElseThrow
-            BsonDocument clientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
+            BsonDocument initialClientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
 
-            BsonDocument generatedDriverInformation = clientMetadata.getDocument("driver");
+            BsonDocument generatedDriverInformation = initialClientMetadata.getDocument("driver");
             String generatedDriverName = generatedDriverInformation.get("name").asString().getValue();
             String generatedVersionName = generatedDriverInformation.get("version").asString().getValue();
-            String generatedPlatformName = clientMetadata.get("platform").asString().getValue();
+            String generatedPlatformName = initialClientMetadata.get("platform").asString().getValue();
 
             //when
             sleep(5); // wait for connection to become idle
@@ -127,12 +132,16 @@ void shouldAppendToDefaultClientMetadataWhenUpdatedAfterInitialization() {
 
             //then
             //TODO change get() to orElseThrow
-            clientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
-            generatedDriverInformation = clientMetadata.getDocument("driver");
+            BsonDocument updatedClientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
+            BsonDocument updatedDriverInformation = initialClientMetadata.getDocument("driver");
+
+            assertThat(updatedDriverInformation.getString("name").getValue()).isEqualTo(generatedDriverName + "|Framework");
+            assertThat(updatedDriverInformation.getString("version").getValue()).endsWith(generatedVersionName + "|1.0");
+            assertThat(updatedClientMetadata.getString("platform").getValue()).endsWith(generatedPlatformName + "|Framework Platform");
 
-            assertThat(generatedDriverInformation.getString("name").getValue()).isEqualTo(generatedDriverName + "|Framework");
-            assertThat(generatedDriverInformation.getString("version").getValue()).endsWith(generatedVersionName + "|1.0");
-            assertThat(clientMetadata.getString("platform").getValue()).endsWith(generatedPlatformName + "|Framework Platform");
+            assertThat(withRemovedKeys(updatedClientMetadata, "driver", "platform"))
+                    .usingRecursiveAssertion()
+                    .isEqualTo(withRemovedKeys(initialClientMetadata, "driver", "platform"));
         }
     }
 
@@ -151,26 +160,42 @@ void shouldNotCloseExistingConnectionsToUpdateMetadata() {
             //TODO change get() to orElseThrow
             BsonDocument clientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
             BsonDocument driverInformation = clientMetadata.getDocument("driver");
-            String generatedDriverName = driverInformation.get("name").asString().getValue();
-            String generatedVersionName = driverInformation.get("version").asString().getValue();
-            String generatedPlatformName = clientMetadata.get("platform").asString().getValue();
+            assertNotNull(driverInformation);
 
             //when
             mongoClient.updateMetadata(initialWrappingLibraryDriverInformation);
 
             //then
             assertThat(executePingAndCaptureMetadataHandshake(mongoClient)).isEmpty();
-            driverInformation = clientMetadata.getDocument("driver");
-
-            assertThat(driverInformation.getString("name").getValue()).isEqualTo(generatedDriverName);
-            assertThat(driverInformation.getString("version").getValue()).isEqualTo(generatedVersionName);
-            assertThat(clientMetadata.getString("platform").getValue()).isEqualTo(generatedPlatformName);
-
             assertFalse(connectionPoolListener.getEvents().stream().anyMatch(ConnectionClosedEvent.class::isInstance),
                     "Expected no connection closed events");
         }
     }
 
+    @Test
+    void shouldAppendAppendProvidedMetadatDuringInitialization() {
+        //given
+        MongoDriverInformation initialWrappingLibraryDriverInformation = MongoDriverInformation.builder()
+                .driverName("library")
+                .driverVersion("1.2")
+                .driverPlatform("Library Platform")
+                .build();
+
+        try (MongoClient mongoClient = createMongoClient(initialWrappingLibraryDriverInformation, getMongoClientSettingsBuilder()
+                .build())) {
+
+            //when
+            //TODO change get() to orElseThrow
+            BsonDocument clientMetadata = executePingAndCaptureMetadataHandshake(mongoClient).get();
+            BsonDocument driverInformation = clientMetadata.getDocument("driver");
+
+            //then
+            assertThat(driverInformation.get("name").asString().getValue()).endsWith("|library");
+            assertThat(driverInformation.get("version").asString().getValue()).endsWith("|1.2");
+            assertThat(clientMetadata.get("platform").asString().getValue()).endsWith("|Library Platform");
+        }
+    }
+
     private Optional<BsonDocument> executePingAndCaptureMetadataHandshake(final MongoClient mongoClient) {
         commandListener.reset();
         mongoClient.getDatabase("admin")
@@ -197,5 +222,14 @@ protected MongoClientSettings.Builder getMongoClientSettingsBuilder() {
     public void tearDown() {
         InternalStreamConnection.setRecordEverything(false);
     }
+
+    private static BsonDocument withRemovedKeys(final BsonDocument updatedClientMetadata,
+                                                final String... keysToFilter) {
+        BsonDocument clone = updatedClientMetadata.clone();
+        for (String keyToRemove : keysToFilter) {
+            clone.remove(keyToRemove);
+        }
+        return clone;
+    }
 }