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
|
// 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 unified
import (
"context"
"fmt"
"strings"
"sync/atomic"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/event"
"go.mongodb.org/mongo-driver/internal"
"go.mongodb.org/mongo-driver/internal/testutil"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/integration/mtest"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/mongo/readconcern"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
)
// Security-sensitive commands that should be ignored in command monitoring by default.
var securitySensitiveCommands = []string{"authenticate", "saslStart", "saslContinue", "getnonce",
"createUser", "updateUser", "copydbgetnonce", "copydbsaslstart", "copydb"}
// clientEntity is a wrapper for a mongo.Client object that also holds additional information required during test
// execution.
type clientEntity struct {
*mongo.Client
recordEvents atomic.Value
started []*event.CommandStartedEvent
succeeded []*event.CommandSucceededEvent
failed []*event.CommandFailedEvent
pooled []*event.PoolEvent
ignoredCommands map[string]struct{}
observeSensitiveCommands *bool
numConnsCheckedOut int32
// These should not be changed after the clientEntity is initialized
observedEvents map[monitoringEventType]struct{}
storedEvents map[monitoringEventType][]string // maps an entity type to an array of entityIDs for entities that store it
entityMap *EntityMap
}
func newClientEntity(ctx context.Context, em *EntityMap, entityOptions *entityOptions) (*clientEntity, error) {
// The "configureFailPoint" command should always be ignored.
ignoredCommands := map[string]struct{}{
"configureFailPoint": {},
}
// If not observing sensitive commands, add security-sensitive commands
// to ignoredCommands by default.
if entityOptions.ObserveSensitiveCommands == nil || !*entityOptions.ObserveSensitiveCommands {
for _, cmd := range securitySensitiveCommands {
ignoredCommands[cmd] = struct{}{}
}
}
entity := &clientEntity{
ignoredCommands: ignoredCommands,
observedEvents: make(map[monitoringEventType]struct{}),
storedEvents: make(map[monitoringEventType][]string),
entityMap: em,
observeSensitiveCommands: entityOptions.ObserveSensitiveCommands,
}
entity.setRecordEvents(true)
// Construct a ClientOptions instance by first applying the cluster URI and then the URIOptions map to ensure that
// the options specified in the test file take precedence.
uri := getURIForClient(entityOptions)
clientOpts := options.Client().ApplyURI(uri)
if entityOptions.URIOptions != nil {
if err := setClientOptionsFromURIOptions(clientOpts, entityOptions.URIOptions); err != nil {
return nil, fmt.Errorf("error parsing URI options: %v", err)
}
}
// UseMultipleMongoses requires validation when connecting to a sharded cluster. Options changes and validation are
// only required if the option is explicitly set. If it's unset, we make no changes because the cluster URI already
// includes all nodes and we don't enforce any limits on the number of nodes.
if mtest.ClusterTopologyKind() == mtest.Sharded && entityOptions.UseMultipleMongoses != nil {
if err := evaluateUseMultipleMongoses(clientOpts, *entityOptions.UseMultipleMongoses); err != nil {
return nil, err
}
}
if entityOptions.ObserveEvents != nil || entityOptions.StoreEventsAsEntities != nil {
// Configure a command monitor that listens for the specified event types. We don't take the IgnoredCommands
// option into account here because it can be overridden at the test level after the entity has already been
// created, so we store the events for now but account for it when iterating over them later.
commandMonitor := &event.CommandMonitor{
Started: entity.processStartedEvent,
Succeeded: entity.processSucceededEvent,
Failed: entity.processFailedEvent,
}
poolMonitor := &event.PoolMonitor{
Event: entity.processPoolEvent,
}
clientOpts.SetMonitor(commandMonitor).SetPoolMonitor(poolMonitor)
for _, eventTypeStr := range entityOptions.ObserveEvents {
eventType, ok := monitoringEventTypeFromString(eventTypeStr)
if !ok {
return nil, fmt.Errorf("unrecognized observed event type %q", eventTypeStr)
}
entity.observedEvents[eventType] = struct{}{}
}
for _, eventsAsEntity := range entityOptions.StoreEventsAsEntities {
for _, eventTypeStr := range eventsAsEntity.Events {
eventType, ok := monitoringEventTypeFromString(eventTypeStr)
if !ok {
return nil, fmt.Errorf("unrecognized stored event type %q", eventTypeStr)
}
entity.storedEvents[eventType] = append(entity.storedEvents[eventType], eventsAsEntity.EventListID)
}
}
}
if entityOptions.ServerAPIOptions != nil {
if err := entityOptions.ServerAPIOptions.ServerAPIVersion.Validate(); err != nil {
return nil, err
}
clientOpts.SetServerAPIOptions(entityOptions.ServerAPIOptions.ServerAPIOptions)
} else {
testutil.AddTestServerAPIVersion(clientOpts)
}
for _, cmd := range entityOptions.IgnoredCommands {
entity.ignoredCommands[cmd] = struct{}{}
}
client, err := mongo.Connect(ctx, clientOpts)
if err != nil {
return nil, fmt.Errorf("error creating mongo.Client: %v", err)
}
entity.Client = client
return entity, nil
}
func getURIForClient(opts *entityOptions) string {
if mtest.ClusterTopologyKind() != mtest.LoadBalanced {
return mtest.ClusterURI()
}
// For load-balanced deployments, UseMultipleMongoses is used to determine the load balancer URI. If set to false,
// the LB fronts a single server. If unset or explicitly true, the LB fronts multiple mongos servers.
switch {
case opts.UseMultipleMongoses != nil && !*opts.UseMultipleMongoses:
return mtest.SingleMongosLoadBalancerURI()
default:
return mtest.MultiMongosLoadBalancerURI()
}
}
func (c *clientEntity) stopListeningForEvents() {
c.setRecordEvents(false)
}
func (c *clientEntity) isIgnoredEvent(commandName string, eventDoc bson.Raw) bool {
// Check if command is in ignoredCommands.
if _, ok := c.ignoredCommands[commandName]; ok {
return true
}
if commandName == "hello" || strings.ToLower(commandName) == internal.LegacyHelloLowercase {
// If observeSensitiveCommands is false (or unset) and hello command has been
// redacted at operation level, hello command should be ignored as it contained
// speculativeAuthenticate.
sensitiveCommandsIgnored := c.observeSensitiveCommands == nil || !*c.observeSensitiveCommands
redacted := len(eventDoc) == 0
if sensitiveCommandsIgnored && redacted {
return true
}
}
return false
}
func (c *clientEntity) startedEvents() []*event.CommandStartedEvent {
var events []*event.CommandStartedEvent
for _, evt := range c.started {
if !c.isIgnoredEvent(evt.CommandName, evt.Command) {
events = append(events, evt)
}
}
return events
}
func (c *clientEntity) succeededEvents() []*event.CommandSucceededEvent {
var events []*event.CommandSucceededEvent
for _, evt := range c.succeeded {
if !c.isIgnoredEvent(evt.CommandName, evt.Reply) {
events = append(events, evt)
}
}
return events
}
func (c *clientEntity) failedEvents() []*event.CommandFailedEvent {
var events []*event.CommandFailedEvent
for _, evt := range c.failed {
if _, ok := c.ignoredCommands[evt.CommandName]; !ok {
events = append(events, evt)
}
}
return events
}
func (c *clientEntity) poolEvents() []*event.PoolEvent {
return c.pooled
}
func (c *clientEntity) numberConnectionsCheckedOut() int32 {
return c.numConnsCheckedOut
}
func getSecondsSinceEpoch() float64 {
return float64(time.Now().UnixNano()) / float64(time.Second/time.Nanosecond)
}
func (c *clientEntity) processStartedEvent(_ context.Context, evt *event.CommandStartedEvent) {
if !c.getRecordEvents() {
return
}
if _, ok := c.observedEvents[commandStartedEvent]; ok {
c.started = append(c.started, evt)
}
eventListIDs, ok := c.storedEvents[commandStartedEvent]
if !ok {
return
}
bsonBuilder := bsoncore.NewDocumentBuilder().
AppendString("name", "CommandStartedEvent").
AppendDouble("observedAt", getSecondsSinceEpoch()).
AppendString("databaseName", evt.DatabaseName).
AppendString("commandName", evt.CommandName).
AppendInt64("requestId", evt.RequestID).
AppendString("connectionId", evt.ConnectionID)
if evt.ServiceID != nil {
bsonBuilder.AppendString("serviceId", evt.ServiceID.String())
}
doc := bson.Raw(bsonBuilder.Build())
for _, id := range eventListIDs {
c.entityMap.appendEventsEntity(id, doc)
}
}
func (c *clientEntity) processSucceededEvent(_ context.Context, evt *event.CommandSucceededEvent) {
if !c.getRecordEvents() {
return
}
if _, ok := c.observedEvents[commandSucceededEvent]; ok {
c.succeeded = append(c.succeeded, evt)
}
eventListIDs, ok := c.storedEvents["CommandSucceededEvent"]
if !ok {
return
}
bsonBuilder := bsoncore.NewDocumentBuilder().
AppendString("name", "CommandSucceededEvent").
AppendDouble("observedAt", getSecondsSinceEpoch()).
AppendString("commandName", evt.CommandName).
AppendInt64("requestId", evt.RequestID).
AppendString("connectionId", evt.ConnectionID)
if evt.ServiceID != nil {
bsonBuilder.AppendString("serviceId", evt.ServiceID.String())
}
doc := bson.Raw(bsonBuilder.Build())
for _, id := range eventListIDs {
c.entityMap.appendEventsEntity(id, doc)
}
}
func (c *clientEntity) processFailedEvent(_ context.Context, evt *event.CommandFailedEvent) {
if !c.getRecordEvents() {
return
}
if _, ok := c.observedEvents[commandFailedEvent]; ok {
c.failed = append(c.failed, evt)
}
eventListIDs, ok := c.storedEvents["CommandFailedEvent"]
if !ok {
return
}
bsonBuilder := bsoncore.NewDocumentBuilder().
AppendString("name", "CommandFailedEvent").
AppendDouble("observedAt", getSecondsSinceEpoch()).
AppendInt64("durationNanos", evt.DurationNanos).
AppendString("commandName", evt.CommandName).
AppendInt64("requestId", evt.RequestID).
AppendString("connectionId", evt.ConnectionID).
AppendString("failure", evt.Failure)
if evt.ServiceID != nil {
bsonBuilder.AppendString("serviceId", evt.ServiceID.String())
}
doc := bson.Raw(bsonBuilder.Build())
for _, id := range eventListIDs {
c.entityMap.appendEventsEntity(id, doc)
}
}
func getPoolEventDocument(evt *event.PoolEvent, eventType monitoringEventType) bson.Raw {
bsonBuilder := bsoncore.NewDocumentBuilder().
AppendString("name", string(eventType)).
AppendDouble("observedAt", getSecondsSinceEpoch()).
AppendString("address", evt.Address)
if evt.ConnectionID != 0 {
bsonBuilder.AppendString("connectionId", fmt.Sprint(evt.ConnectionID))
}
if evt.PoolOptions != nil {
optionsDoc := bsoncore.NewDocumentBuilder().
AppendString("maxPoolSize", fmt.Sprint(evt.PoolOptions.MaxPoolSize)).
AppendString("minPoolSize", fmt.Sprint(evt.PoolOptions.MinPoolSize)).
AppendString("maxIdleTimeMS", fmt.Sprint(evt.PoolOptions.WaitQueueTimeoutMS)).
Build()
bsonBuilder.AppendDocument("poolOptions", optionsDoc)
}
if evt.Reason != "" {
bsonBuilder.AppendString("reason", evt.Reason)
}
if evt.ServiceID != nil {
bsonBuilder.AppendString("serviceId", evt.ServiceID.String())
}
return bson.Raw(bsonBuilder.Build())
}
func (c *clientEntity) processPoolEvent(evt *event.PoolEvent) {
if !c.getRecordEvents() {
return
}
// Update the connection counter. This happens even if we're not storing any events.
switch evt.Type {
case event.GetSucceeded:
c.numConnsCheckedOut++
case event.ConnectionReturned:
c.numConnsCheckedOut--
}
eventType := monitoringEventTypeFromPoolEvent(evt)
if _, ok := c.observedEvents[eventType]; ok {
c.pooled = append(c.pooled, evt)
}
if eventListIDs, ok := c.storedEvents[eventType]; ok {
eventBSON := getPoolEventDocument(evt, eventType)
for _, id := range eventListIDs {
c.entityMap.appendEventsEntity(id, eventBSON)
}
}
}
func (c *clientEntity) setRecordEvents(record bool) {
c.recordEvents.Store(record)
}
func (c *clientEntity) getRecordEvents() bool {
return c.recordEvents.Load().(bool)
}
func setClientOptionsFromURIOptions(clientOpts *options.ClientOptions, uriOpts bson.M) error {
// A write concern can be constructed across multiple URI options (e.g. "w", "j", and "wTimeoutMS") so we declare an
// empty writeConcern instance here that can be populated in the loop below.
var wc writeConcern
var wcSet bool
for key, value := range uriOpts {
switch key {
case "appname":
clientOpts.SetAppName(value.(string))
case "heartbeatFrequencyMS":
clientOpts.SetHeartbeatInterval(time.Duration(value.(int32)) * time.Millisecond)
case "loadBalanced":
clientOpts.SetLoadBalanced(value.(bool))
case "maxPoolSize":
clientOpts.SetMaxPoolSize(uint64(value.(int32)))
case "readConcernLevel":
clientOpts.SetReadConcern(readconcern.New(readconcern.Level(value.(string))))
case "retryReads":
clientOpts.SetRetryReads(value.(bool))
case "retryWrites":
clientOpts.SetRetryWrites(value.(bool))
case "w":
wc.W = value
wcSet = true
case "waitQueueTimeoutMS":
return newSkipTestError("the waitQueueTimeoutMS client option is not supported")
default:
return fmt.Errorf("unrecognized URI option %s", key)
}
}
if wcSet {
converted, err := wc.toWriteConcernOption()
if err != nil {
return fmt.Errorf("error creating write concern: %v", err)
}
clientOpts.SetWriteConcern(converted)
}
return nil
}
func evaluateUseMultipleMongoses(clientOpts *options.ClientOptions, useMultipleMongoses bool) error {
hosts := mtest.ClusterConnString().Hosts
if !useMultipleMongoses {
clientOpts.SetHosts(hosts[:1])
return nil
}
if len(hosts) < 2 {
return fmt.Errorf("multiple mongoses required but cluster URI %q only contains one host", mtest.ClusterURI())
}
return nil
}
|