-
Notifications
You must be signed in to change notification settings - Fork 883
/
event_verification.go
381 lines (327 loc) · 13.5 KB
/
event_verification.go
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
// 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 (
"bytes"
"context"
"fmt"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/bson/bsontype"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/event"
)
var (
connectionClosedReasons = map[string]string{
"stale": event.ReasonStale,
"idle": event.ReasonIdle,
"error": event.ReasonConnectionErrored,
"poolClosed": event.ReasonPoolClosed,
}
checkOutFailedReasons = map[string]string{
"poolClosed": event.ReasonPoolClosed,
"timeout": event.ReasonTimedOut,
"connectionError": event.ReasonConnectionErrored,
}
)
type commandMonitoringEvent struct {
CommandStartedEvent *struct {
Command bson.Raw `bson:"command"`
CommandName *string `bson:"commandName"`
DatabaseName *string `bson:"databaseName"`
HasServiceID *bool `bson:"hasServiceId"`
} `bson:"commandStartedEvent"`
CommandSucceededEvent *struct {
CommandName *string `bson:"commandName"`
Reply bson.Raw `bson:"reply"`
HasServiceID *bool `bson:"hasServiceId"`
} `bson:"commandSucceededEvent"`
CommandFailedEvent *struct {
CommandName *string `bson:"commandName"`
HasServiceID *bool `bson:"hasServiceId"`
} `bson:"commandFailedEvent"`
}
type cmapEvent struct {
ConnectionCreatedEvent *struct{} `bson:"connectionCreatedEvent"`
ConnectionReadyEvent *struct{} `bson:"connectionReadyEvent"`
ConnectionClosedEvent *struct {
Reason *string `bson:"reason"`
} `bson:"connectionClosedEvent"`
ConnectionCheckedOutEvent *struct{} `bson:"connectionCheckedOutEvent"`
ConnectionCheckOutFailedEvent *struct {
Reason *string `bson:"reason"`
} `bson:"connectionCheckOutFailedEvent"`
ConnectionCheckedInEvent *struct{} `bson:"connectionCheckedInEvent"`
PoolClearedEvent *struct {
HasServiceID *bool `bson:"hasServiceId"`
} `bson:"poolClearedEvent"`
}
type expectedEvents struct {
ClientID string `bson:"client"`
CommandEvents []commandMonitoringEvent
CMAPEvents []cmapEvent
}
var _ bson.Unmarshaler = (*expectedEvents)(nil)
func (e *expectedEvents) UnmarshalBSON(data []byte) error {
// The data to be unmarshalled looks like {client: <client ID>, eventType: <string>, events: [event0, event1, ...]}.
// We use the "eventType" value to determine which struct field should be used to deserialize the "events" array.
var temp struct {
ClientID string `bson:"client"`
EventType string `bson:"eventType"`
Events bson.RawValue `bson:"events"`
Extra map[string]interface{} `bson:",inline"`
}
if err := bson.Unmarshal(data, &temp); err != nil {
return fmt.Errorf("error unmarshalling to temporary expectedEvents object: %v", err)
}
if len(temp.Extra) > 0 {
return fmt.Errorf("unrecognized fields for expectedEvents: %v", temp.Extra)
}
e.ClientID = temp.ClientID
if temp.Events.Type != bsontype.Array {
return fmt.Errorf("expected 'events' to be an array but got a %q", temp.Events.Type)
}
var target interface{}
switch temp.EventType {
case "command", "":
target = &e.CommandEvents
case "cmap":
target = &e.CMAPEvents
default:
return fmt.Errorf("unrecognized 'eventType' value for expectedEvents: %q", temp.EventType)
}
if err := temp.Events.Unmarshal(target); err != nil {
return fmt.Errorf("error unmarshalling events array: %v", err)
}
return nil
}
func verifyEvents(ctx context.Context, expectedEvents *expectedEvents) error {
client, err := entities(ctx).client(expectedEvents.ClientID)
if err != nil {
return err
}
switch {
case expectedEvents.CommandEvents != nil:
return verifyCommandEvents(ctx, client, expectedEvents.CommandEvents)
case expectedEvents.CMAPEvents != nil:
return verifyCMAPEvents(client, expectedEvents.CMAPEvents)
}
return nil
}
func verifyCommandEvents(ctx context.Context, client *clientEntity, expectedEvents []commandMonitoringEvent) error {
started := client.startedEvents()
succeeded := client.succeededEvents()
failed := client.failedEvents()
// If the Events array is nil, verify that no events were sent.
if len(expectedEvents) == 0 && (len(started)+len(succeeded)+len(failed) != 0) {
return fmt.Errorf("expected no events to be sent but got %s", stringifyEventsForClient(client))
}
for idx, evt := range expectedEvents {
switch {
case evt.CommandStartedEvent != nil:
if len(started) == 0 {
return newEventVerificationError(idx, client, "no CommandStartedEvent published")
}
actual := started[0]
started = started[1:]
expected := evt.CommandStartedEvent
if expected.CommandName != nil && *expected.CommandName != actual.CommandName {
return newEventVerificationError(idx, client, "expected command name %q, got %q", *expected.CommandName,
actual.CommandName)
}
if expected.DatabaseName != nil && *expected.DatabaseName != actual.DatabaseName {
return newEventVerificationError(idx, client, "expected database name %q, got %q", *expected.DatabaseName,
actual.DatabaseName)
}
if expected.Command != nil {
expectedDoc := documentToRawValue(expected.Command)
actualDoc := documentToRawValue(actual.Command)
// If actual.Command is empty, as is the case with redacted commands,
// verifyValuesMatch will return an error from DocumentOK() because
// there are not enough bytes to read a document from bson.RawValue{}.
// In the case of an empty Command, hardcode an empty bson.RawValue document.
if len(actual.Command) == 0 {
emptyDoc := []byte{5, 0, 0, 0, 0}
actualDoc = bson.RawValue{Type: bsontype.EmbeddedDocument, Value: emptyDoc}
}
if err := verifyValuesMatch(ctx, expectedDoc, actualDoc, true); err != nil {
return newEventVerificationError(idx, client, "error comparing command documents: %v", err)
}
}
if expected.HasServiceID != nil {
if err := verifyServiceID(*expected.HasServiceID, actual.ServiceID); err != nil {
return newEventVerificationError(idx, client, "error verifying serviceID: %v", err)
}
}
case evt.CommandSucceededEvent != nil:
if len(succeeded) == 0 {
return newEventVerificationError(idx, client, "no CommandSucceededEvent published")
}
actual := succeeded[0]
succeeded = succeeded[1:]
expected := evt.CommandSucceededEvent
if expected.CommandName != nil && *expected.CommandName != actual.CommandName {
return newEventVerificationError(idx, client, "expected command name %q, got %q", *expected.CommandName,
actual.CommandName)
}
if expected.Reply != nil {
expectedDoc := documentToRawValue(expected.Reply)
actualDoc := documentToRawValue(actual.Reply)
// If actual.Reply is empty, as is the case with redacted replies,
// verifyValuesMatch will return an error from DocumentOK() because
// there are not enough bytes to read a document from bson.RawValue{}.
// In the case of an empty Reply, hardcode an empty bson.RawValue document.
if len(actual.Reply) == 0 {
emptyDoc := []byte{5, 0, 0, 0, 0}
actualDoc = bson.RawValue{Type: bsontype.EmbeddedDocument, Value: emptyDoc}
}
if err := verifyValuesMatch(ctx, expectedDoc, actualDoc, true); err != nil {
return newEventVerificationError(idx, client, "error comparing reply documents: %v", err)
}
}
if expected.HasServiceID != nil {
if err := verifyServiceID(*expected.HasServiceID, actual.ServiceID); err != nil {
return newEventVerificationError(idx, client, "error verifying serviceID: %v", err)
}
}
case evt.CommandFailedEvent != nil:
if len(failed) == 0 {
return newEventVerificationError(idx, client, "no CommandFailedEvent published")
}
actual := failed[0]
failed = failed[1:]
expected := evt.CommandFailedEvent
if expected.CommandName != nil && *expected.CommandName != actual.CommandName {
return newEventVerificationError(idx, client, "expected command name %q, got %q", *expected.CommandName,
actual.CommandName)
}
if expected.HasServiceID != nil {
if err := verifyServiceID(*expected.HasServiceID, actual.ServiceID); err != nil {
return newEventVerificationError(idx, client, "error verifying serviceID: %v", err)
}
}
default:
return newEventVerificationError(idx, client, "no expected event set on commandMonitoringEvent instance")
}
}
// Verify that there are no remaining events.
if len(started) > 0 || len(succeeded) > 0 || len(failed) > 0 {
return fmt.Errorf("extra events published; all events for client: %s", stringifyEventsForClient(client))
}
return nil
}
func verifyCMAPEvents(client *clientEntity, expected []cmapEvent) error {
pooled := client.poolEvents()
if len(expected) == 0 && len(pooled) != 0 {
return fmt.Errorf("expected no cmap events to be sent but got %s", stringifyEventsForClient(client))
}
for idx, evt := range expected {
var err error
switch {
case evt.ConnectionCreatedEvent != nil:
if _, pooled, err = getNextPoolEvent(pooled, event.ConnectionCreated); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
case evt.ConnectionReadyEvent != nil:
if _, pooled, err = getNextPoolEvent(pooled, event.ConnectionReady); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
case evt.ConnectionClosedEvent != nil:
var actual *event.PoolEvent
if actual, pooled, err = getNextPoolEvent(pooled, event.ConnectionClosed); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
if reason := evt.ConnectionClosedEvent.Reason; reason != nil {
expectedReason, ok := connectionClosedReasons[*reason]
if !ok {
return newEventVerificationError(idx, client, "unrecognized reason %q", *reason)
}
if expectedReason != actual.Reason {
return newEventVerificationError(idx, client, "expected reason %q, got %q", expectedReason, actual.Reason)
}
}
case evt.ConnectionCheckedOutEvent != nil:
if _, pooled, err = getNextPoolEvent(pooled, event.GetSucceeded); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
case evt.ConnectionCheckOutFailedEvent != nil:
var actual *event.PoolEvent
if actual, pooled, err = getNextPoolEvent(pooled, event.GetFailed); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
if reason := evt.ConnectionCheckOutFailedEvent.Reason; reason != nil {
expectedReason, ok := checkOutFailedReasons[*reason]
if !ok {
return newEventVerificationError(idx, client, "unrecognized reason %q", *reason)
}
if expectedReason != actual.Reason {
return newEventVerificationError(idx, client, "expected reason %q, got %q", expectedReason, actual.Reason)
}
}
case evt.ConnectionCheckedInEvent != nil:
if _, pooled, err = getNextPoolEvent(pooled, event.ConnectionReturned); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
case evt.PoolClearedEvent != nil:
var actual *event.PoolEvent
if actual, pooled, err = getNextPoolEvent(pooled, event.PoolCleared); err != nil {
return newEventVerificationError(idx, client, err.Error())
}
if expectServiceID := evt.PoolClearedEvent.HasServiceID; expectServiceID != nil {
if err := verifyServiceID(*expectServiceID, actual.ServiceID); err != nil {
return newEventVerificationError(idx, client, "error verifying serviceID: %v", err)
}
}
default:
return newEventVerificationError(idx, client, "no expected event set on cmapEvent instance")
}
}
// Verify that there are no remaining events.
if len(pooled) > 0 {
return fmt.Errorf("extra events published; all events for client: %s", stringifyEventsForClient(client))
}
return nil
}
func getNextPoolEvent(events []*event.PoolEvent, expectedType string) (*event.PoolEvent, []*event.PoolEvent, error) {
if len(events) == 0 {
return nil, nil, fmt.Errorf("no %q event published", expectedType)
}
evt := events[0]
if evt.Type != expectedType {
return nil, nil, fmt.Errorf("expected pool event of type %q, got %q", expectedType, evt.Type)
}
return evt, events[1:], nil
}
func verifyServiceID(expectServiceID bool, serviceID *primitive.ObjectID) error {
if eventHasID := serviceID != nil; expectServiceID != eventHasID {
return fmt.Errorf("expected event to have server ID: %v, event has server ID %v", expectServiceID, serviceID)
}
return nil
}
func newEventVerificationError(idx int, client *clientEntity, msg string, args ...interface{}) error {
fullMsg := fmt.Sprintf(msg, args...)
return fmt.Errorf("event comparison failed at index %d: %s; all events found for client: %s", idx, fullMsg,
stringifyEventsForClient(client))
}
func stringifyEventsForClient(client *clientEntity) string {
str := bytes.NewBuffer(nil)
str.WriteString("\n\nStarted Events\n\n")
for _, evt := range client.startedEvents() {
str.WriteString(fmt.Sprintf("[%s] %s\n", evt.ConnectionID, evt.Command))
}
str.WriteString("\nSucceeded Events\n\n")
for _, evt := range client.succeededEvents() {
str.WriteString(fmt.Sprintf("[%s] CommandName: %s, Reply: %s\n", evt.ConnectionID, evt.CommandName, evt.Reply))
}
str.WriteString("\nFailed Events\n\n")
for _, evt := range client.failedEvents() {
str.WriteString(fmt.Sprintf("[%s] CommandName: %s, Failure: %s\n", evt.ConnectionID, evt.CommandName, evt.Failure))
}
str.WriteString("\nPool Events\n\n")
for _, evt := range client.poolEvents() {
str.WriteString(fmt.Sprintf("[%s] Event Type: %q\n", evt.Address, evt.Type))
}
return str.String()
}