1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
|
// Copyright (C) MongoDB, Inc. 2017-present.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
package mongo
import (
"context"
"errors"
"math"
"os"
"testing"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/event"
"go.mongodb.org/mongo-driver/internal/assert"
"go.mongodb.org/mongo-driver/internal/integtest"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/mongo/readconcern"
"go.mongodb.org/mongo-driver/mongo/readpref"
"go.mongodb.org/mongo-driver/mongo/writeconcern"
"go.mongodb.org/mongo-driver/tag"
"go.mongodb.org/mongo-driver/x/mongo/driver/mongocrypt"
"go.mongodb.org/mongo-driver/x/mongo/driver/session"
"go.mongodb.org/mongo-driver/x/mongo/driver/topology"
)
var bgCtx = context.Background()
func setupClient(opts ...*options.ClientOptions) *Client {
if len(opts) == 0 {
clientOpts := options.Client().ApplyURI("mongodb://localhost:27017")
integtest.AddTestServerAPIVersion(clientOpts)
opts = append(opts, clientOpts)
}
client, _ := NewClient(opts...)
return client
}
func TestClient(t *testing.T) {
t.Run("new client", func(t *testing.T) {
client := setupClient()
assert.NotNil(t, client.deployment, "expected valid deployment, got nil")
})
t.Run("database", func(t *testing.T) {
dbName := "foo"
client := setupClient()
db := client.Database(dbName)
assert.Equal(t, dbName, db.Name(), "expected db name %v, got %v", dbName, db.Name())
assert.Equal(t, client, db.Client(), "expected client %v, got %v", client, db.Client())
})
t.Run("replace topology error", func(t *testing.T) {
client := setupClient()
_, err := client.StartSession()
assert.Equal(t, ErrClientDisconnected, err, "expected error %v, got %v", ErrClientDisconnected, err)
_, err = client.ListDatabases(bgCtx, bson.D{})
assert.Equal(t, ErrClientDisconnected, err, "expected error %v, got %v", ErrClientDisconnected, err)
err = client.Ping(bgCtx, nil)
assert.Equal(t, ErrClientDisconnected, err, "expected error %v, got %v", ErrClientDisconnected, err)
err = client.Disconnect(bgCtx)
assert.Equal(t, ErrClientDisconnected, err, "expected error %v, got %v", ErrClientDisconnected, err)
_, err = client.Watch(bgCtx, []bson.D{})
assert.Equal(t, ErrClientDisconnected, err, "expected error %v, got %v", ErrClientDisconnected, err)
})
t.Run("nil document error", func(t *testing.T) {
// manually set session pool to non-nil because Watch will return ErrClientDisconnected
client := setupClient()
client.sessionPool = &session.Pool{}
_, err := client.Watch(bgCtx, nil)
watchErr := errors.New("can only marshal slices and arrays into aggregation pipelines, but got invalid")
assert.Equal(t, watchErr, err, "expected error %v, got %v", watchErr, err)
_, err = client.ListDatabases(bgCtx, nil)
assert.Equal(t, ErrNilDocument, err, "expected error %v, got %v", ErrNilDocument, err)
_, err = client.ListDatabaseNames(bgCtx, nil)
assert.Equal(t, ErrNilDocument, err, "expected error %v, got %v", ErrNilDocument, err)
})
t.Run("read preference", func(t *testing.T) {
t.Run("absent", func(t *testing.T) {
client := setupClient()
gotMode := client.readPreference.Mode()
wantMode := readpref.PrimaryMode
assert.Equal(t, gotMode, wantMode, "expected mode %v, got %v", wantMode, gotMode)
_, flag := client.readPreference.MaxStaleness()
assert.False(t, flag, "expected max staleness to not be set but was")
})
t.Run("specified", func(t *testing.T) {
tags := []tag.Set{
{
tag.Tag{
Name: "one",
Value: "1",
},
},
{
tag.Tag{
Name: "two",
Value: "2",
},
},
}
cs := "mongodb://localhost:27017/"
cs += "?readpreference=secondary&readPreferenceTags=one:1&readPreferenceTags=two:2&maxStaleness=5"
client := setupClient(options.Client().ApplyURI(cs))
gotMode := client.readPreference.Mode()
assert.Equal(t, gotMode, readpref.SecondaryMode, "expected mode %v, got %v", readpref.SecondaryMode, gotMode)
gotTags := client.readPreference.TagSets()
assert.Equal(t, gotTags, tags, "expected tags %v, got %v", tags, gotTags)
gotStaleness, flag := client.readPreference.MaxStaleness()
assert.True(t, flag, "expected max staleness to be set but was not")
wantStaleness := time.Duration(5) * time.Second
assert.Equal(t, gotStaleness, wantStaleness, "expected staleness %v, got %v", wantStaleness, gotStaleness)
})
})
t.Run("localThreshold", func(t *testing.T) {
testCases := []struct {
name string
opts *options.ClientOptions
expectedThreshold time.Duration
}{
{"default", options.Client(), defaultLocalThreshold},
{"custom", options.Client().SetLocalThreshold(10 * time.Second), 10 * time.Second},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
client := setupClient(tc.opts)
assert.Equal(t, tc.expectedThreshold, client.localThreshold,
"expected localThreshold %v, got %v", tc.expectedThreshold, client.localThreshold)
})
}
})
t.Run("read concern", func(t *testing.T) {
rc := readconcern.Majority()
client := setupClient(options.Client().SetReadConcern(rc))
assert.Equal(t, rc, client.readConcern, "expected read concern %v, got %v", rc, client.readConcern)
})
t.Run("min pool size from Set*PoolSize()", func(t *testing.T) {
testCases := []struct {
name string
opts *options.ClientOptions
err error
}{
{
name: "minPoolSize < default maxPoolSize",
opts: options.Client().SetMinPoolSize(64),
err: nil,
},
{
name: "minPoolSize > default maxPoolSize",
opts: options.Client().SetMinPoolSize(128),
err: errors.New("minPoolSize must be less than or equal to maxPoolSize, got minPoolSize=128 maxPoolSize=100"),
},
{
name: "minPoolSize < maxPoolSize",
opts: options.Client().SetMinPoolSize(128).SetMaxPoolSize(256),
err: nil,
},
{
name: "minPoolSize == maxPoolSize",
opts: options.Client().SetMinPoolSize(128).SetMaxPoolSize(128),
err: nil,
},
{
name: "minPoolSize > maxPoolSize",
opts: options.Client().SetMinPoolSize(64).SetMaxPoolSize(32),
err: errors.New("minPoolSize must be less than or equal to maxPoolSize, got minPoolSize=64 maxPoolSize=32"),
},
{
name: "maxPoolSize == 0",
opts: options.Client().SetMinPoolSize(128).SetMaxPoolSize(0),
err: nil,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
_, err := NewClient(tc.opts)
assert.Equal(t, tc.err, err, "expected error %v, got %v", tc.err, err)
})
}
})
t.Run("min pool size from ApplyURI()", func(t *testing.T) {
testCases := []struct {
name string
opts *options.ClientOptions
err error
}{
{
name: "minPoolSize < default maxPoolSize",
opts: options.Client().ApplyURI("mongodb://localhost:27017/?minPoolSize=64"),
err: nil,
},
{
name: "minPoolSize > default maxPoolSize",
opts: options.Client().ApplyURI("mongodb://localhost:27017/?minPoolSize=128"),
err: errors.New("minPoolSize must be less than or equal to maxPoolSize, got minPoolSize=128 maxPoolSize=100"),
},
{
name: "minPoolSize < maxPoolSize",
opts: options.Client().ApplyURI("mongodb://localhost:27017/?minPoolSize=128&maxPoolSize=256"),
err: nil,
},
{
name: "minPoolSize == maxPoolSize",
opts: options.Client().ApplyURI("mongodb://localhost:27017/?minPoolSize=128&maxPoolSize=128"),
err: nil,
},
{
name: "minPoolSize > maxPoolSize",
opts: options.Client().ApplyURI("mongodb://localhost:27017/?minPoolSize=64&maxPoolSize=32"),
err: errors.New("minPoolSize must be less than or equal to maxPoolSize, got minPoolSize=64 maxPoolSize=32"),
},
{
name: "maxPoolSize == 0",
opts: options.Client().ApplyURI("mongodb://localhost:27017/?minPoolSize=128&maxPoolSize=0"),
err: nil,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
_, err := NewClient(tc.opts)
assert.Equal(t, tc.err, err, "expected error %v, got %v", tc.err, err)
})
}
})
t.Run("retry writes", func(t *testing.T) {
retryWritesURI := "mongodb://localhost:27017/?retryWrites=false"
retryWritesErrorURI := "mongodb://localhost:27017/?retryWrites=foobar"
testCases := []struct {
name string
opts *options.ClientOptions
expectErr bool
expectedRetry bool
}{
{"default", options.Client(), false, true},
{"custom options", options.Client().SetRetryWrites(false), false, false},
{"custom URI", options.Client().ApplyURI(retryWritesURI), false, false},
{"custom URI error", options.Client().ApplyURI(retryWritesErrorURI), true, false},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
client, err := NewClient(tc.opts)
if tc.expectErr {
assert.NotNil(t, err, "expected error, got nil")
return
}
assert.Nil(t, err, "configuration error: %v", err)
assert.Equal(t, tc.expectedRetry, client.retryWrites, "expected retryWrites %v, got %v",
tc.expectedRetry, client.retryWrites)
})
}
})
t.Run("retry reads", func(t *testing.T) {
retryReadsURI := "mongodb://localhost:27017/?retryReads=false"
retryReadsErrorURI := "mongodb://localhost:27017/?retryReads=foobar"
testCases := []struct {
name string
opts *options.ClientOptions
expectErr bool
expectedRetry bool
}{
{"default", options.Client(), false, true},
{"custom options", options.Client().SetRetryReads(false), false, false},
{"custom URI", options.Client().ApplyURI(retryReadsURI), false, false},
{"custom URI error", options.Client().ApplyURI(retryReadsErrorURI), true, false},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
client, err := NewClient(tc.opts)
if tc.expectErr {
assert.NotNil(t, err, "expected error, got nil")
return
}
assert.Nil(t, err, "configuration error: %v", err)
assert.Equal(t, tc.expectedRetry, client.retryReads, "expected retryReads %v, got %v",
tc.expectedRetry, client.retryReads)
})
}
})
t.Run("write concern", func(t *testing.T) {
wc := writeconcern.New(writeconcern.WMajority())
client := setupClient(options.Client().SetWriteConcern(wc))
assert.Equal(t, wc, client.writeConcern, "mismatch; expected write concern %v, got %v", wc, client.writeConcern)
})
t.Run("server monitor", func(t *testing.T) {
monitor := &event.ServerMonitor{}
client := setupClient(options.Client().SetServerMonitor(monitor))
assert.Equal(t, monitor, client.serverMonitor, "expected sdam monitor %v, got %v", monitor, client.serverMonitor)
})
t.Run("GetURI", func(t *testing.T) {
t.Run("ApplyURI not called", func(t *testing.T) {
opts := options.Client().SetHosts([]string{"localhost:27017"})
uri := opts.GetURI()
assert.Equal(t, "", uri, "expected GetURI to return empty string, got %v", uri)
})
t.Run("ApplyURI called with empty string", func(t *testing.T) {
opts := options.Client().ApplyURI("")
uri := opts.GetURI()
assert.Equal(t, "", uri, "expected GetURI to return empty string, got %v", uri)
})
t.Run("ApplyURI called with non-empty string", func(t *testing.T) {
uri := "mongodb://localhost:27017/foobar"
opts := options.Client().ApplyURI(uri)
got := opts.GetURI()
assert.Equal(t, uri, got, "expected GetURI to return %v, got %v", uri, got)
})
})
t.Run("endSessions", func(t *testing.T) {
cs := integtest.ConnString(t)
originalBatchSize := endSessionsBatchSize
endSessionsBatchSize = 2
defer func() {
endSessionsBatchSize = originalBatchSize
}()
testCases := []struct {
name string
numSessions int
eventBatchSizes []int
}{
{"number of sessions divides evenly", endSessionsBatchSize * 2, []int{endSessionsBatchSize, endSessionsBatchSize}},
{"number of sessions does not divide evenly", endSessionsBatchSize + 1, []int{endSessionsBatchSize, 1}},
}
for _, tc := range testCases {
if testing.Short() {
t.Skip("skipping integration test in short mode")
}
if os.Getenv("DOCKER_RUNNING") != "" {
t.Skip("skipping test in docker environment")
}
t.Run(tc.name, func(t *testing.T) {
// Setup a client and skip the test based on server version.
var started []*event.CommandStartedEvent
var failureReasons []string
cmdMonitor := &event.CommandMonitor{
Started: func(_ context.Context, evt *event.CommandStartedEvent) {
if evt.CommandName == "endSessions" {
started = append(started, evt)
}
},
Failed: func(_ context.Context, evt *event.CommandFailedEvent) {
if evt.CommandName == "endSessions" {
failureReasons = append(failureReasons, evt.Failure)
}
},
}
clientOpts := options.Client().ApplyURI(cs.Original).SetReadPreference(readpref.Primary()).
SetWriteConcern(writeconcern.New(writeconcern.WMajority())).SetMonitor(cmdMonitor)
integtest.AddTestServerAPIVersion(clientOpts)
client, err := Connect(bgCtx, clientOpts)
assert.Nil(t, err, "Connect error: %v", err)
defer func() {
_ = client.Disconnect(bgCtx)
}()
serverVersion, err := getServerVersion(client.Database("admin"))
assert.Nil(t, err, "getServerVersion error: %v", err)
if compareVersions(serverVersion, "3.6.0") < 1 {
t.Skip("skipping server version < 3.6")
}
coll := client.Database("foo").Collection("bar")
defer func() {
_ = coll.Drop(bgCtx)
}()
// Do an application operation and create the number of sessions specified by the test.
_, err = coll.CountDocuments(bgCtx, bson.D{})
assert.Nil(t, err, "CountDocuments error: %v", err)
var sessions []Session
for i := 0; i < tc.numSessions; i++ {
sess, err := client.StartSession()
assert.Nil(t, err, "StartSession error at index %d: %v", i, err)
sessions = append(sessions, sess)
}
for _, sess := range sessions {
sess.EndSession(bgCtx)
}
client.endSessions(bgCtx)
divisionResult := float64(tc.numSessions) / float64(endSessionsBatchSize)
numEventsExpected := int(math.Ceil(divisionResult))
assert.Equal(t, len(started), numEventsExpected, "expected %d started events, got %d", numEventsExpected,
len(started))
assert.Equal(t, len(failureReasons), 0, "endSessions errors: %v", failureReasons)
for i := 0; i < numEventsExpected; i++ {
sentArray := started[i].Command.Lookup("endSessions").Array()
values, _ := sentArray.Values()
expectedNumValues := tc.eventBatchSizes[i]
assert.Equal(t, len(values), expectedNumValues,
"batch size mismatch at index %d; expected %d sessions in batch, got %d", i, expectedNumValues,
len(values))
}
})
}
})
t.Run("serverAPI version", func(t *testing.T) {
getServerAPIOptions := func() *options.ServerAPIOptions {
return options.ServerAPI(options.ServerAPIVersion1).
SetStrict(false).SetDeprecationErrors(false)
}
t.Run("success with all options", func(t *testing.T) {
serverAPIOptions := getServerAPIOptions()
client, err := NewClient(options.Client().SetServerAPIOptions(serverAPIOptions))
assert.Nil(t, err, "unexpected error from NewClient: %v", err)
convertedAPIOptions := topology.ConvertToDriverAPIOptions(serverAPIOptions)
assert.Equal(t, convertedAPIOptions, client.serverAPI,
"mismatch in serverAPI; expected %v, got %v", convertedAPIOptions, client.serverAPI)
})
t.Run("failure with unsupported version", func(t *testing.T) {
serverAPIOptions := options.ServerAPI("badVersion")
_, err := NewClient(options.Client().SetServerAPIOptions(serverAPIOptions))
assert.NotNil(t, err, "expected error from NewClient, got nil")
errmsg := `api version "badVersion" not supported; this driver version only supports API version "1"`
assert.Equal(t, errmsg, err.Error(), "expected error %v, got %v", errmsg, err.Error())
})
t.Run("cannot modify options after client creation", func(t *testing.T) {
serverAPIOptions := getServerAPIOptions()
client, err := NewClient(options.Client().SetServerAPIOptions(serverAPIOptions))
assert.Nil(t, err, "unexpected error from NewClient: %v", err)
expectedServerAPIOptions := getServerAPIOptions()
// modify passed-in options
serverAPIOptions.SetStrict(true).SetDeprecationErrors(true)
convertedAPIOptions := topology.ConvertToDriverAPIOptions(expectedServerAPIOptions)
assert.Equal(t, convertedAPIOptions, client.serverAPI,
"unexpected modification to serverAPI; expected %v, got %v", convertedAPIOptions, client.serverAPI)
})
})
t.Run("mongocryptd or crypt_shared", func(t *testing.T) {
cryptSharedLibPath := os.Getenv("CRYPT_SHARED_LIB_PATH")
if cryptSharedLibPath == "" {
t.Skip("CRYPT_SHARED_LIB_PATH not set, skipping")
}
if len(mongocrypt.Version()) == 0 {
t.Skip("Not built with cse flag")
}
testCases := []struct {
description string
useCryptSharedLib bool
}{
{
description: "when crypt_shared is loaded, should not attempt to spawn mongocryptd",
useCryptSharedLib: true,
},
{
description: "when crypt_shared is not loaded, should attempt to spawn mongocryptd",
useCryptSharedLib: false,
},
}
for _, tc := range testCases {
t.Run(tc.description, func(t *testing.T) {
extraOptions := map[string]interface{}{
// Set a mongocryptd path that does not exist. If Connect() attempts to start
// mongocryptd, it will cause an error.
"mongocryptdPath": "/does/not/exist",
}
// If we're using the crypt_shared library, set the "cryptSharedLibRequired" option
// to true and the "cryptSharedLibPath" option to the crypt_shared library path from
// the CRYPT_SHARED_LIB_PATH environment variable. If we're not using the
// crypt_shared library, explicitly disable loading the crypt_shared library.
if tc.useCryptSharedLib {
extraOptions["cryptSharedLibRequired"] = true
extraOptions["cryptSharedLibPath"] = cryptSharedLibPath
} else {
extraOptions["__cryptSharedLibDisabledForTestOnly"] = true
}
_, err := NewClient(options.Client().
SetAutoEncryptionOptions(options.AutoEncryption().
SetKmsProviders(map[string]map[string]interface{}{
"local": {"key": make([]byte, 96)},
}).
SetExtraOptions(extraOptions)))
// If we're using the crypt_shared library, expect that Connect() doesn't attempt to spawn
// mongocryptd and no error is returned. If we're not using the crypt_shared library,
// expect that Connect() tries to spawn mongocryptd and returns an error.
if tc.useCryptSharedLib {
assert.Nil(t, err, "Connect() error: %v", err)
} else {
assert.NotNil(t, err, "expected Connect() error, but got nil")
}
})
}
})
}
|