Finish prose tests

Author: prestonvasquez

internal/assert/assertbsoncore/assertions_bsoncore.go

@@ -7,26 +7,41 @@
 package assertbsoncore
 
 import (
+	"errors"
 	"testing"
 
 	"go.mongodb.org/mongo-driver/v2/internal/assert"
+	"go.mongodb.org/mongo-driver/v2/internal/handshake"
 	"go.mongodb.org/mongo-driver/v2/x/bsonx/bsoncore"
 )
 
+// HandshakeClientMetadata compares the client metadata in two wire messages. It
+// extracts the client metadata document from each wire message and compares
+// them. If the document is not found, it assumes the wire message is just the
+// value of the client metadata document itself.
 func HandshakeClientMetadata(t testing.TB, expectedWM, actualWM []byte) bool {
-	command := bsoncore.Document(actualWM)
-
-	// Lookup the "client" field in the command document.
-	clientVal, err := command.LookupErr("client")
+	gotCommand, err := handshake.ParseClientMetadata(actualWM)
 	if err != nil {
-		return assert.Fail(t, "expected command to contain the 'client' field")
+		if errors.Is(err, bsoncore.ErrElementNotFound) {
+			// If the element is not found, the actual wire message may just be the
+			// client metadata document itself.
+			gotCommand = bsoncore.Document(actualWM)
+		} else {
+			return assert.Fail(t, "error parsing actual wire message: %v", err)
+		}
 	}
 
-	GotCommand, ok := clientVal.DocumentOK()
-	if !ok {
-		return assert.Fail(t, "expected client field to be a document, got %s", clientVal.Type)
+	wantCommand, err := handshake.ParseClientMetadata(expectedWM)
+	if err != nil {
+		// If the element is not found, the expected wire message may just be the
+		// client metadata document itself.
+		if errors.Is(err, bsoncore.ErrElementNotFound) {
+			wantCommand = bsoncore.Document(expectedWM)
+		} else {
+			return assert.Fail(t, "error parsing expected wire message: %v", err)
+		}
 	}
 
-	wantCommand := bsoncore.Document(expectedWM)
-	return assert.Equal(t, wantCommand, GotCommand, "want: %v, got: %v", wantCommand, GotCommand)
+	return assert.Equal(t, wantCommand, gotCommand,
+		"expected: %v, got: %v", bsoncore.Document(wantCommand), bsoncore.Document(gotCommand))
 }

internal/handshake/handshake.go

@@ -6,8 +6,29 @@
 
 package handshake
 
+import (
+	"go.mongodb.org/mongo-driver/v2/x/bsonx/bsoncore"
+)
+
 // LegacyHello is the legacy version of the hello command.
 var LegacyHello = "isMaster"
 
 // LegacyHelloLowercase is the lowercase, legacy version of the hello command.
 var LegacyHelloLowercase = "ismaster"
+
+func ParseClientMetadata(msg []byte) ([]byte, error) {
+	command := bsoncore.Document(msg)
+
+	// Lookup the "client" field in the command document.
+	clientMetadataRaw, err := command.LookupErr("client")
+	if err != nil {
+		return nil, err
+	}
+
+	clientMetadata, ok := clientMetadataRaw.DocumentOK()
+	if !ok {
+		return nil, err
+	}
+
+	return clientMetadata, nil
+}

internal/integration/client_test.go

@@ -457,7 +457,7 @@ func TestClient(t *testing.T) {
 		err := mt.Client.Ping(context.Background(), mtest.PrimaryRp)
 		assert.Nil(mt, err, "Ping error: %v", err)
 
-		want := test.EncodeClientMetadata(mt, test.WithClientMentadataAppName("foo"))
+		want := test.EncodeClientMetadata(mt, test.WithClientMetadataAppName("foo"))
 		for i := 0; i < 2; i++ {
 			message := mt.GetProxyCapture().TryNext()
 			require.NotNil(mt, message, "expected handshake message, got nil")