Make ServerSelectionLoggingTest pass when run against a load balanced cluster, or when using Unix domain socket

JAVA-4754

Author: stIncMale

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

@@ -313,10 +313,12 @@ private static boolean serverDescriptionChangedEventMatches(final BsonDocument e
             return true;
         }
         String newType = expectedEventContents.getDocument("newDescription").getString("type").getValue();
-        //noinspection SwitchStatementWithTooFewBranches
         switch (newType) {
             case "Unknown":
                 return event.getNewDescription().getType() == ServerType.UNKNOWN;
+            case "LoadBalancer": {
+                return event.getNewDescription().getType() == ServerType.LOAD_BALANCER;
+            }
             default:
                 throw new UnsupportedOperationException();
         }

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

@@ -16,9 +16,11 @@
 
 package com.mongodb.client.unified;
 
+import com.mongodb.Function;
 import com.mongodb.MongoCommandException;
 import com.mongodb.internal.ExceptionUtils.MongoCommandExceptionUtils;
 import com.mongodb.internal.logging.LogMessage;
+import com.mongodb.lang.Nullable;
 import org.bson.BsonArray;
 import org.bson.BsonBoolean;
 import org.bson.BsonDocument;
@@ -44,19 +46,20 @@ final class LogMatcher {
         this.context = context;
     }
 
-    void assertLogMessageEquality(final String client, final BsonArray expectedMessages, final List<LogMessage> actualMessages) {
+    void assertLogMessageEquality(final String client, final BsonArray expectedMessages, final List<LogMessage> actualMessages,
+            final Iterable<Tweak> tweaks) {
         context.push(ContextElement.ofLogMessages(client, expectedMessages, actualMessages));
 
         assertEquals(context.getMessage("Number of log messages must be the same"), expectedMessages.size(), actualMessages.size());
 
         for (int i = 0; i < expectedMessages.size(); i++) {
-            BsonDocument expectedMessageAsDocument = expectedMessages.get(i).asDocument().clone();
-            // `LogMessage.Entry.Name.OPERATION` is not supported, therefore we skip matching its value
-            BsonValue expectedDataDocument = expectedMessageAsDocument.get("data");
-            if (expectedDataDocument != null) {
-                expectedDataDocument.asDocument().remove(LogMessage.Entry.Name.OPERATION.getValue());
+            BsonDocument expectedMessage = expectedMessages.get(i).asDocument().clone();
+            for (Tweak tweak : tweaks) {
+                expectedMessage = tweak.apply(expectedMessage);
+            }
+            if (expectedMessage != null) {
+                valueMatcher.assertValuesMatch(expectedMessage, asDocument(actualMessages.get(i)));
             }
-            valueMatcher.assertValuesMatch(expectedMessageAsDocument, asDocument(actualMessages.get(i)));
         }
 
         context.pop();
@@ -108,4 +111,27 @@ private static BsonValue asBsonValue(final Object value) {
         }
     }
 
+    interface Tweak extends Function<BsonDocument, BsonDocument> {
+        /**
+         * @param expectedMessage May be {@code null}, in which case the method simply returns {@code null}.
+         * This method may mutate {@code expectedMessage}.
+         * @return {@code null} iff matching {@code expectedMessage} with the actual message must be skipped.
+         */
+        @Nullable
+        BsonDocument apply(@Nullable BsonDocument expectedMessage);
+
+        static Tweak skip(final LogMessage.Entry.Name name) {
+            return expectedMessage -> {
+                if (expectedMessage == null) {
+                    return null;
+                } else {
+                    BsonDocument expectedData = expectedMessage.getDocument("data", null);
+                    if (expectedData != null) {
+                        expectedData.remove(name.getValue());
+                    }
+                    return expectedMessage;
+                }
+            };
+        }
+    }
 }

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

@@ -20,6 +20,8 @@
 import com.mongodb.MongoClientSettings;
 import com.mongodb.MongoNamespace;
 import com.mongodb.ReadPreference;
+import com.mongodb.UnixServerAddress;
+import com.mongodb.internal.logging.LogMessage;
 import com.mongodb.logging.TestLoggingInterceptor;
 import com.mongodb.WriteConcern;
 import com.mongodb.client.ClientSession;
@@ -72,6 +74,7 @@
 import static com.mongodb.client.Fixture.getMongoClient;
 import static com.mongodb.client.Fixture.getMongoClientSettings;
 import static com.mongodb.client.unified.RunOnRequirementsMatcher.runOnRequirementsMet;
+import static java.util.Collections.singletonList;
 import static java.util.stream.Collectors.toList;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
@@ -242,7 +245,14 @@ public void shouldPassAllOutcomes() {
         }
 
         if (definition.containsKey("expectLogMessages")) {
-            compareLogMessages(rootContext, definition);
+            ArrayList<LogMatcher.Tweak> tweaks = new ArrayList<>(singletonList(
+                    // `LogMessage.Entry.Name.OPERATION` is not supported, therefore we skip matching its value
+                    LogMatcher.Tweak.skip(LogMessage.Entry.Name.OPERATION)));
+            if (getMongoClientSettings().getClusterSettings()
+                    .getHosts().stream().anyMatch(serverAddress -> serverAddress instanceof UnixServerAddress)) {
+                tweaks.add(LogMatcher.Tweak.skip(LogMessage.Entry.Name.SERVER_PORT));
+            }
+            compareLogMessages(rootContext, definition, tweaks);
         }
     }
 
@@ -266,14 +276,15 @@ private void compareEvents(final UnifiedTestContext context, final BsonDocument
         }
     }
 
-    private void compareLogMessages(final UnifiedTestContext rootContext, final BsonDocument definition) {
+    private void compareLogMessages(final UnifiedTestContext rootContext, final BsonDocument definition,
+            final Iterable<LogMatcher.Tweak> tweaks) {
         for (BsonValue cur : definition.getArray("expectLogMessages")) {
             BsonDocument curLogMessagesForClient = cur.asDocument();
             String clientId = curLogMessagesForClient.getString("client").getValue();
             TestLoggingInterceptor loggingInterceptor =
                     entities.getClientLoggingInterceptor(clientId);
             rootContext.getLogMatcher().assertLogMessageEquality(clientId, curLogMessagesForClient.getArray("messages"),
-                    loggingInterceptor.getMessages());
+                    loggingInterceptor.getMessages(), tweaks);
         }
     }