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 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
|
// 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 topology
import (
"context"
"fmt"
"io/ioutil"
"net"
"path"
"sync"
"testing"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/event"
"go.mongodb.org/mongo-driver/internal/testutil/assert"
testhelpers "go.mongodb.org/mongo-driver/internal/testutil/helpers"
"go.mongodb.org/mongo-driver/mongo/address"
"go.mongodb.org/mongo-driver/mongo/description"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
"go.mongodb.org/mongo-driver/x/mongo/driver"
"go.mongodb.org/mongo-driver/x/mongo/driver/connstring"
)
type response struct {
Host string
Hello Hello
}
type Hello struct {
Arbiters []string `bson:"arbiters,omitempty"`
ArbiterOnly bool `bson:"arbiterOnly,omitempty"`
ClusterTime bson.Raw `bson:"$clusterTime,omitempty"`
Compression []string `bson:"compression,omitempty"`
ElectionID primitive.ObjectID `bson:"electionId,omitempty"`
Hidden bool `bson:"hidden,omitempty"`
Hosts []string `bson:"hosts,omitempty"`
HelloOK bool `bson:"helloOk,omitempty"`
IsWritablePrimary bool `bson:"isWritablePrimary,omitempty"`
IsReplicaSet bool `bson:"isreplicaset,omitempty"`
LastWrite *lastWriteDate `bson:"lastWrite,omitempty"`
LogicalSessionTimeoutMinutes uint32 `bson:"logicalSessionTimeoutMinutes,omitempty"`
MaxBSONObjectSize uint32 `bson:"maxBsonObjectSize,omitempty"`
MaxMessageSizeBytes uint32 `bson:"maxMessageSizeBytes,omitempty"`
MaxWriteBatchSize uint32 `bson:"maxWriteBatchSize,omitempty"`
Me string `bson:"me,omitempty"`
MaxWireVersion int32 `bson:"maxWireVersion,omitempty"`
MinWireVersion int32 `bson:"minWireVersion,omitempty"`
Msg string `bson:"msg,omitempty"`
OK int32 `bson:"ok"`
Passives []string `bson:"passives,omitempty"`
Primary string `bson:"primary,omitempty"`
ReadOnly bool `bson:"readOnly,omitempty"`
SaslSupportedMechs []string `bson:"saslSupportedMechs,omitempty"`
Secondary bool `bson:"secondary,omitempty"`
SetName string `bson:"setName,omitempty"`
SetVersion uint32 `bson:"setVersion,omitempty"`
Tags map[string]string `bson:"tags,omitempty"`
TopologyVersion *topologyVersion `bson:"topologyVersion,omitempty"`
}
type lastWriteDate struct {
LastWriteDate time.Time `bson:"lastWriteDate"`
}
type server struct {
Type string
SetName string
SetVersion uint32
ElectionID *primitive.ObjectID `bson:"electionId"`
MinWireVersion *int32
MaxWireVersion *int32
TopologyVersion *topologyVersion
Pool *testPool
}
type topologyVersion struct {
ProcessID primitive.ObjectID `bson:"processId"`
Counter int64
}
type testPool struct {
Generation uint64
}
type applicationError struct {
Address string
Generation *uint64
MaxWireVersion *int32
When string
Type string
Response bsoncore.Document
}
type topologyDescription struct {
TopologyType string `bson:"topologyType"`
Servers []serverDescription `bson:"servers"`
SetName string `bson:"setName,omitempty"`
}
type serverDescription struct {
Address string `bson:"address"`
Arbiters []string `bson:"arbiters"`
Hosts []string `bson:"hosts"`
Passives []string `bson:"passives"`
Primary string `bson:"primary,omitempty"`
SetName string `bson:"setName,omitempty"`
Type string `bson:"type"`
}
type topologyOpeningEvent struct {
TopologyID string `bson:"topologyId"`
}
type serverOpeningEvent struct {
Address string `bson:"address"`
TopologyID string `bson:"topologyId"`
}
type topologyDescriptionChangedEvent struct {
TopologyID string `bson:"topologyId"`
PreviousDescription topologyDescription `bson:"previousDescription"`
NewDescription topologyDescription `bson:"newDescription"`
}
type serverDescriptionChangedEvent struct {
Address string `bson:"address"`
TopologyID string `bson:"topologyId"`
PreviousDescription serverDescription `bson:"previousDescription"`
NewDescription serverDescription `bson:"newDescription"`
}
type serverClosedEvent struct {
Address string `bson:"address"`
TopologyID string `bson:"topologyId"`
}
type monitoringEvent struct {
TopologyOpeningEvent *topologyOpeningEvent `bson:"topology_opening_event,omitempty"`
ServerOpeningEvent *serverOpeningEvent `bson:"server_opening_event,omitempty"`
TopologyDescriptionChangedEvent *topologyDescriptionChangedEvent `bson:"topology_description_changed_event,omitempty"`
ServerDescriptionChangedEvent *serverDescriptionChangedEvent `bson:"server_description_changed_event,omitempty"`
ServerClosedEvent *serverClosedEvent `bson:"server_closed_event,omitempty"`
}
type outcome struct {
Servers map[string]server
TopologyType string
SetName string
LogicalSessionTimeoutMinutes uint32
MaxSetVersion uint32
MaxElectionID primitive.ObjectID `bson:"maxElectionId"`
Compatible *bool
Events []monitoringEvent
}
type phase struct {
Description string
Responses []response
ApplicationErrors []applicationError
Outcome outcome
}
type testCase struct {
Description string
URI string
Phases []phase
}
func serverDescriptionChanged(e *event.ServerDescriptionChangedEvent) {
lock.Lock()
publishedEvents = append(publishedEvents, *e)
lock.Unlock()
}
func serverOpening(e *event.ServerOpeningEvent) {
lock.Lock()
publishedEvents = append(publishedEvents, *e)
lock.Unlock()
}
func topologyDescriptionChanged(e *event.TopologyDescriptionChangedEvent) {
lock.Lock()
publishedEvents = append(publishedEvents, *e)
lock.Unlock()
}
func topologyOpening(e *event.TopologyOpeningEvent) {
lock.Lock()
publishedEvents = append(publishedEvents, *e)
lock.Unlock()
}
func serverClosed(e *event.ServerClosedEvent) {
lock.Lock()
publishedEvents = append(publishedEvents, *e)
lock.Unlock()
}
const testsDir string = "../../../../data/server-discovery-and-monitoring/"
var publishedEvents []interface{}
var lock sync.Mutex
func (r *response) UnmarshalBSON(buf []byte) error {
doc := bson.Raw(buf)
if err := doc.Index(0).Value().Unmarshal(&r.Host); err != nil {
return fmt.Errorf("error unmarshalling Host: %v", err)
}
if err := doc.Index(1).Value().Unmarshal(&r.Hello); err != nil {
return fmt.Errorf("error unmarshalling Hello: %v", err)
}
return nil
}
func setUpTopology(t *testing.T, uri string) *Topology {
cs, err := connstring.ParseAndValidate(uri)
assert.Nil(t, err, "Parse error: %v", err)
sdam := &event.ServerMonitor{
ServerDescriptionChanged: serverDescriptionChanged,
ServerOpening: serverOpening,
TopologyDescriptionChanged: topologyDescriptionChanged,
TopologyOpening: topologyOpening,
ServerClosed: serverClosed,
}
// Disable server monitoring because the hosts in the SDAM spec tests don't actually exist, so the server monitor
// can race with the test and mark the server Unknown when it fails to connect, which causes tests to fail.
serverOpts := []ServerOption{
withMonitoringDisabled(func(bool) bool {
return true
}),
WithServerMonitor(func(*event.ServerMonitor) *event.ServerMonitor { return sdam }),
}
topo, err := New(
WithConnString(func(connstring.ConnString) connstring.ConnString {
return cs
}),
WithServerOptions(func(opts ...ServerOption) []ServerOption {
return append(opts, serverOpts...)
}),
WithTopologyServerMonitor(func(*event.ServerMonitor) *event.ServerMonitor {
return sdam
}),
)
assert.Nil(t, err, "topology.New error: %v", err)
err = topo.Connect()
assert.Nil(t, err, "topology.Connect error: %v", err)
return topo
}
func applyResponses(t *testing.T, topo *Topology, responses []response, sub *driver.Subscription) {
select {
case <-sub.Updates:
default:
}
for _, response := range responses {
doc, err := bson.Marshal(response.Hello)
assert.Nil(t, err, "Marshal error: %v", err)
addr := address.Address(response.Host)
desc := description.NewServer(addr, doc)
server, ok := topo.servers[addr]
if ok {
server.updateDescription(desc)
} else {
// for tests that check that server descriptions that aren't in the topology aren't applied
topo.apply(context.Background(), desc)
}
select {
case <-sub.Updates:
default:
return
}
}
}
type netErr struct {
timeout bool
}
func (n netErr) Error() string {
return "error"
}
func (n netErr) Timeout() bool {
return n.timeout
}
func (n netErr) Temporary() bool {
return false
}
var _ net.Error = (*netErr)(nil)
func applyErrors(t *testing.T, topo *Topology, errors []applicationError) {
for _, appErr := range errors {
var currError error
switch appErr.Type {
case "command":
currError = driver.ExtractErrorFromServerResponse(appErr.Response)
case "network":
currError = driver.Error{
Labels: []string{driver.NetworkError},
Wrapped: ConnectionError{Wrapped: netErr{false}},
}
case "timeout":
currError = driver.Error{
Labels: []string{driver.NetworkError},
Wrapped: ConnectionError{Wrapped: netErr{true}},
}
default:
t.Fatalf("unrecognized error type: %v", appErr.Type)
}
server, ok := topo.servers[address.Address(appErr.Address)]
assert.True(t, ok, "server not found: %v", appErr.Address)
desc := server.Description()
versionRange := description.NewVersionRange(0, *appErr.MaxWireVersion)
desc.WireVersion = &versionRange
generation := server.pool.generation.getGeneration(nil)
if appErr.Generation != nil {
generation = *appErr.Generation
}
//use generation number to check conn stale
innerConn := connection{
desc: desc,
generation: generation,
pool: server.pool,
}
conn := Connection{connection: &innerConn}
switch appErr.When {
case "beforeHandshakeCompletes":
server.ProcessHandshakeError(currError, generation, nil)
case "afterHandshakeCompletes":
_ = server.ProcessError(currError, &conn)
default:
t.Fatalf("unrecognized applicationError.When value: %v", appErr.When)
}
}
}
func compareServerDescriptions(t *testing.T,
expected serverDescription, actual description.Server, idx int) {
t.Helper()
assert.Equal(t, expected.Address, actual.Addr.String(),
"%v: expected server address %s, got %s", idx, expected.Address, actual.Addr)
assert.Equal(t, len(expected.Hosts), len(actual.Hosts),
"%v: expected %d hosts, got %d", idx, len(expected.Hosts), len(actual.Hosts))
for idx, expectedHost := range expected.Hosts {
actualHost := actual.Hosts[idx]
assert.Equal(t, expectedHost, actualHost, "%v: expected host %s, got %s", idx, expectedHost, actualHost)
}
assert.Equal(t, len(expected.Passives), len(actual.Passives),
"%v: expected %d hosts, got %d", idx, len(expected.Passives), len(actual.Passives))
for idx, expectedPassive := range expected.Passives {
actualPassive := actual.Passives[idx]
assert.Equal(t, expectedPassive, actualPassive, "%v: expected passive %s, got %s", idx, expectedPassive, actualPassive)
}
assert.Equal(t, expected.Primary, string(actual.Primary),
"%v: expected primary %s, got %s", idx, expected.Primary, actual.Primary)
assert.Equal(t, expected.SetName, actual.SetName,
"%v: expected set name %s, got %s", idx, expected.SetName, actual.SetName)
// PossiblePrimary is only relevant to single-threaded drivers.
if expected.Type == "PossiblePrimary" {
expected.Type = "Unknown"
}
assert.Equal(t, expected.Type, actual.Kind.String(),
"%v: expected server kind %s, got %s", idx, expected.Type, actual.Kind.String())
}
func compareTopologyDescriptions(t *testing.T,
expected topologyDescription, actual description.Topology, idx int) {
t.Helper()
assert.Equal(t, expected.TopologyType, actual.Kind.String(),
"%v: expected topology kind %s, got %s", idx, expected.TopologyType, actual.Kind.String())
assert.Equal(t, len(expected.Servers), len(actual.Servers),
"%v: expected %d servers, got %d", idx, len(expected.Servers), len(actual.Servers))
for idx, es := range expected.Servers {
as := actual.Servers[idx]
compareServerDescriptions(t, es, as, idx)
}
assert.Equal(t, expected.SetName, actual.SetName,
"%v: expected set name %s, got %s", idx, expected.SetName, actual.SetName)
}
func compareEvents(t *testing.T, events []monitoringEvent) {
t.Helper()
lock.Lock()
defer lock.Unlock()
assert.Equal(t, len(events), len(publishedEvents),
"expected %d published events, got %d\n",
len(events), len(publishedEvents))
for idx, me := range events {
if me.TopologyOpeningEvent != nil {
actual, ok := publishedEvents[idx].(event.TopologyOpeningEvent)
assert.True(t, ok, "%v: expected type %T, got %T", idx, event.TopologyOpeningEvent{}, publishedEvents[idx])
assert.False(t, actual.TopologyID.IsZero(), "%v: expected topology id", idx)
}
if me.ServerOpeningEvent != nil {
actual, ok := publishedEvents[idx].(event.ServerOpeningEvent)
assert.True(t, ok, "%v: expected type %T, got %T", idx, event.ServerOpeningEvent{}, publishedEvents[idx])
evt := me.ServerOpeningEvent
assert.Equal(t, evt.Address, string(actual.Address),
"%v: expected address %s, got %s", idx, evt.Address, actual.Address)
assert.False(t, actual.TopologyID.IsZero(), "%v: expected topology id", idx)
}
if me.TopologyDescriptionChangedEvent != nil {
actual, ok := publishedEvents[idx].(event.TopologyDescriptionChangedEvent)
assert.True(t, ok, "%v: expected type %T, got %T", idx, event.TopologyDescriptionChangedEvent{}, publishedEvents[idx])
evt := me.TopologyDescriptionChangedEvent
compareTopologyDescriptions(t, evt.PreviousDescription, actual.PreviousDescription, idx)
compareTopologyDescriptions(t, evt.NewDescription, actual.NewDescription, idx)
assert.False(t, actual.TopologyID.IsZero(), "%v: expected topology id", idx)
}
if me.ServerDescriptionChangedEvent != nil {
actual, ok := publishedEvents[idx].(event.ServerDescriptionChangedEvent)
assert.True(t, ok, "%v: expected type %T, got %T", idx, event.ServerDescriptionChangedEvent{}, publishedEvents[idx])
evt := me.ServerDescriptionChangedEvent
assert.Equal(t, evt.Address, string(actual.Address),
"%v: expected server address %s, got %s", idx, evt.Address, actual.Address)
compareServerDescriptions(t, evt.PreviousDescription, actual.PreviousDescription, idx)
compareServerDescriptions(t, evt.NewDescription, actual.NewDescription, idx)
assert.False(t, actual.TopologyID.IsZero(), "%v: expected topology id", idx)
}
if me.ServerClosedEvent != nil {
actual, ok := publishedEvents[idx].(event.ServerClosedEvent)
assert.True(t, ok, "%v: expected type %T, got %T", idx, event.ServerClosedEvent{}, publishedEvents[idx])
evt := me.ServerClosedEvent
assert.Equal(t, evt.Address, string(actual.Address),
"%v: expected server address %s, got %s", idx, evt.Address, actual.Address)
assert.False(t, actual.TopologyID.IsZero(), "%v: expected topology id", idx)
}
}
}
func findServerInTopology(topo description.Topology, addr address.Address) (description.Server, bool) {
for _, server := range topo.Servers {
if server.Addr.String() == addr.String() {
return server, true
}
}
return description.Server{}, false
}
func runTest(t *testing.T, directory string, filename string) {
filepath := path.Join(testsDir, directory, filename)
content, err := ioutil.ReadFile(filepath)
assert.Nil(t, err, "ReadFile error: %v", err)
// Remove ".json" from filename.
filename = filename[:len(filename)-5]
testName := directory + "/" + filename + ":"
t.Run(testName, func(t *testing.T) {
var test testCase
err = bson.UnmarshalExtJSON(content, false, &test)
assert.Nil(t, err, "Unmarshal error: %v", err)
topo := setUpTopology(t, test.URI)
sub, err := topo.Subscribe()
assert.Nil(t, err, "subscribe error: %v", err)
for _, phase := range test.Phases {
applyResponses(t, topo, phase.Responses, sub)
applyErrors(t, topo, phase.ApplicationErrors)
if phase.Outcome.Events != nil {
compareEvents(t, phase.Outcome.Events)
publishedEvents = nil
continue
}
publishedEvents = nil
if phase.Outcome.Compatible == nil || *phase.Outcome.Compatible {
assert.True(t, topo.fsm.compatible.Load().(bool), "Expected servers to be compatible")
assert.Nil(t, topo.fsm.compatibilityErr, "expected fsm.compatiblity to be nil, got %v",
topo.fsm.compatibilityErr)
} else {
assert.False(t, topo.fsm.compatible.Load().(bool), "Expected servers to not be compatible")
assert.NotNil(t, topo.fsm.compatibilityErr, "expected fsm.compatiblity error to be non-nil")
continue
}
desc := topo.Description()
assert.Equal(t, phase.Outcome.TopologyType, desc.Kind.String(),
"expected TopologyType to be %v, got %v", phase.Outcome.TopologyType, desc.Kind.String())
assert.Equal(t, phase.Outcome.SetName, topo.fsm.SetName,
"expected SetName to be %v, got %v", phase.Outcome.SetName, topo.fsm.SetName)
assert.Equal(t, len(phase.Outcome.Servers), len(desc.Servers),
"expected %v servers, got %v", len(phase.Outcome.Servers), len(desc.Servers))
assert.Equal(t, phase.Outcome.LogicalSessionTimeoutMinutes, desc.SessionTimeoutMinutes,
"expected SessionTimeoutMinutes to be %v, got %v", phase.Outcome.LogicalSessionTimeoutMinutes, desc.SessionTimeoutMinutes)
assert.Equal(t, phase.Outcome.MaxSetVersion, topo.fsm.maxSetVersion,
"expected maxSetVersion to be %v, got %v", phase.Outcome.MaxSetVersion, topo.fsm.maxSetVersion)
assert.Equal(t, phase.Outcome.MaxElectionID, topo.fsm.maxElectionID,
"expected maxElectionID to be %v, got %v", phase.Outcome.MaxElectionID, topo.fsm.maxElectionID)
for addr, server := range phase.Outcome.Servers {
fsmServer, ok := findServerInTopology(desc, address.Address(addr))
assert.True(t, ok, "Couldn't find server %v", addr)
assert.Equal(t, address.Address(addr), fsmServer.Addr,
"expected server address to be %v, got %v", address.Address(addr), fsmServer.Addr)
assert.Equal(t, server.SetName, fsmServer.SetName,
"expected server SetName to be %v, got %v", server.SetName, fsmServer.SetName)
assert.Equal(t, server.SetVersion, fsmServer.SetVersion,
"expected server SetVersion to be %v, got %v", server.SetVersion, fsmServer.SetVersion)
if server.ElectionID != nil {
assert.Equal(t, *server.ElectionID, fsmServer.ElectionID,
"expected server ElectionID to be %v, got %v", *server.ElectionID, fsmServer.ElectionID)
}
if server.TopologyVersion != nil {
assert.NotNil(t, fsmServer.TopologyVersion, "expected server TopologyVersion not to be nil")
assert.Equal(t, server.TopologyVersion.ProcessID, fsmServer.TopologyVersion.ProcessID,
"expected server TopologyVersion ProcessID to be %v, got %v", server.TopologyVersion.ProcessID, fsmServer.TopologyVersion.ProcessID)
assert.Equal(t, server.TopologyVersion.Counter, fsmServer.TopologyVersion.Counter,
"expected server TopologyVersion Counter to be %v, got %v", server.TopologyVersion.Counter, fsmServer.TopologyVersion.Counter)
} else {
assert.Nil(t, fsmServer.TopologyVersion, "expected server TopologyVersion to be nil")
}
// PossiblePrimary is only relevant to single-threaded drivers.
if server.Type == "PossiblePrimary" {
server.Type = "Unknown"
}
assert.Equal(t, server.Type, fsmServer.Kind.String(),
"expected server Type to be %v, got %v", server.Type, fsmServer.Kind.String())
if server.Pool != nil {
topo.serversLock.Lock()
actualServer := topo.servers[address.Address(addr)]
topo.serversLock.Unlock()
actualGeneration := actualServer.pool.generation.getGeneration(nil)
assert.Equal(t, server.Pool.Generation, actualGeneration,
"expected server pool generation to be %v, got %v", server.Pool.Generation, actualGeneration)
}
}
}
})
}
// Test case for all SDAM spec tests.
func TestSDAMSpec(t *testing.T) {
for _, subdir := range []string{"single", "rs", "sharded", "load-balanced", "errors", "monitoring"} {
for _, file := range testhelpers.FindJSONFilesInDir(t, path.Join(testsDir, subdir)) {
runTest(t, subdir, file)
}
}
}
|