-
Notifications
You must be signed in to change notification settings - Fork 882
/
setup.go
367 lines (321 loc) · 12 KB
/
setup.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
// 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 mtest
import (
"context"
"errors"
"fmt"
"math"
"os"
"strconv"
"strings"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/internal/testutil"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/description"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/mongo/readpref"
"go.mongodb.org/mongo-driver/mongo/writeconcern"
"go.mongodb.org/mongo-driver/x/mongo/driver"
"go.mongodb.org/mongo-driver/x/mongo/driver/connstring"
"go.mongodb.org/mongo-driver/x/mongo/driver/topology"
)
const (
// TestDb specifies the name of default test database.
TestDb = "test"
)
// testContext holds the global context for the integration tests. The testContext members should only be initialized
// once during the global setup in TestMain. These variables should only be accessed indirectly through MongoTest
// instances.
var testContext struct {
connString connstring.ConnString
topo *topology.Topology
topoKind TopologyKind
// shardedReplicaSet will be true if we're connected to a sharded cluster and each shard is backed by a replica set.
// We track this as a separate boolean rather than setting topoKind to ShardedReplicaSet because a general
// "Sharded" constraint in a test should match both Sharded and ShardedReplicaSet.
shardedReplicaSet bool
client *mongo.Client // client used for setup and teardown
serverVersion string
authEnabled bool
sslEnabled bool
enterpriseServer bool
dataLake bool
requireAPIVersion bool
serverParameters bson.Raw
singleMongosLoadBalancerURI string
multiMongosLoadBalancerURI string
serverless bool
}
func setupClient(opts *options.ClientOptions) (*mongo.Client, error) {
wcMajority := writeconcern.New(writeconcern.WMajority())
// set ServerAPIOptions to latest version if required
if opts.ServerAPIOptions == nil && testContext.requireAPIVersion {
opts.SetServerAPIOptions(options.ServerAPI(driver.TestServerAPIVersion))
}
// for sharded clusters, pin to one host. Due to how the cache is implemented on 4.0 and 4.2, behavior
// can be inconsistent when multiple mongoses are used
return mongo.Connect(context.Background(), opts.SetWriteConcern(wcMajority).SetHosts(opts.Hosts[:1]))
}
// Setup initializes the current testing context.
// This function must only be called one time and must be called before any tests run.
func Setup(setupOpts ...*SetupOptions) error {
opts := MergeSetupOptions(setupOpts...)
var uri string
var err error
switch {
case opts.URI != nil:
uri = *opts.URI
default:
var err error
uri, err = testutil.MongoDBURI()
if err != nil {
return fmt.Errorf("error getting uri: %v", err)
}
}
testContext.connString, err = connstring.ParseAndValidate(uri)
if err != nil {
return fmt.Errorf("error parsing and validating connstring: %v", err)
}
testContext.dataLake = os.Getenv("ATLAS_DATA_LAKE_INTEGRATION_TEST") == "true"
testContext.requireAPIVersion = os.Getenv("REQUIRE_API_VERSION") == "true"
clientOpts := options.Client().ApplyURI(uri)
testutil.AddTestServerAPIVersion(clientOpts)
cfg, err := topology.NewConfig(clientOpts, nil)
if err != nil {
return fmt.Errorf("error constructing topology config: %v", err)
}
testContext.topo, err = topology.New(cfg)
if err != nil {
return fmt.Errorf("error creating topology: %v", err)
}
if err = testContext.topo.Connect(); err != nil {
return fmt.Errorf("error connecting topology: %v", err)
}
testContext.client, err = setupClient(options.Client().ApplyURI(uri))
if err != nil {
return fmt.Errorf("error connecting test client: %v", err)
}
pingCtx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
if err := testContext.client.Ping(pingCtx, readpref.Primary()); err != nil {
return fmt.Errorf("ping error: %v; make sure the deployment is running on URI %v", err,
testContext.connString.Original)
}
if testContext.serverVersion, err = getServerVersion(); err != nil {
return fmt.Errorf("error getting server version: %v", err)
}
switch testContext.topo.Kind() {
case description.Single:
testContext.topoKind = Single
case description.ReplicaSet, description.ReplicaSetWithPrimary, description.ReplicaSetNoPrimary:
testContext.topoKind = ReplicaSet
case description.Sharded:
testContext.topoKind = Sharded
case description.LoadBalanced:
testContext.topoKind = LoadBalanced
default:
return fmt.Errorf("could not detect topology kind; current topology: %s", testContext.topo.String())
}
// If we're connected to a sharded cluster, determine if the cluster is backed by replica sets.
if testContext.topoKind == Sharded {
// Run a find against config.shards and get each document in the collection.
cursor, err := testContext.client.Database("config").Collection("shards").Find(context.Background(), bson.D{})
if err != nil {
return fmt.Errorf("error running find against config.shards: %v", err)
}
defer cursor.Close(context.Background())
var shards []struct {
Host string `bson:"host"`
}
if err := cursor.All(context.Background(), &shards); err != nil {
return fmt.Errorf("error getting results find against config.shards: %v", err)
}
// Each document's host field will contain a single hostname if the shard is a standalone. If it's a replica
// set, the host field will be in the format "replicaSetName/host1,host2,...". Therefore, we can determine that
// the shard is a standalone if the "/" character isn't present.
var foundStandalone bool
for _, shard := range shards {
if !strings.Contains(shard.Host, "/") {
foundStandalone = true
break
}
}
if !foundStandalone {
testContext.shardedReplicaSet = true
}
}
// For non-serverless, load balanced clusters, retrieve the required LB URIs and add additional information (e.g. TLS options) to
// them if necessary.
testContext.serverless = os.Getenv("SERVERLESS") == "serverless"
if !testContext.serverless && testContext.topoKind == LoadBalanced {
singleMongosURI := os.Getenv("SINGLE_MONGOS_LB_URI")
if singleMongosURI == "" {
return errors.New("SINGLE_MONGOS_LB_URI must be set when running against load balanced clusters")
}
testContext.singleMongosLoadBalancerURI, err = addNecessaryParamsToURI(singleMongosURI)
if err != nil {
return fmt.Errorf("error getting single mongos load balancer uri: %v", err)
}
multiMongosURI := os.Getenv("MULTI_MONGOS_LB_URI")
if multiMongosURI == "" {
return errors.New("MULTI_MONGOS_LB_URI must be set when running against load balanced clusters")
}
testContext.multiMongosLoadBalancerURI, err = addNecessaryParamsToURI(multiMongosURI)
if err != nil {
return fmt.Errorf("error getting multi mongos load balancer uri: %v", err)
}
}
testContext.authEnabled = os.Getenv("AUTH") == "auth"
testContext.sslEnabled = os.Getenv("SSL") == "ssl"
biRes, err := testContext.client.Database("admin").RunCommand(context.Background(), bson.D{{"buildInfo", 1}}).DecodeBytes()
if err != nil {
return fmt.Errorf("buildInfo error: %v", err)
}
modulesRaw, err := biRes.LookupErr("modules")
if err == nil {
// older server versions don't report "modules" field in buildInfo result
modules, _ := modulesRaw.Array().Values()
for _, module := range modules {
if module.StringValue() == "enterprise" {
testContext.enterpriseServer = true
break
}
}
}
// Get server parameters if test is not running against ADL; ADL does not have "getParameter" command.
if !testContext.dataLake {
db := testContext.client.Database("admin")
testContext.serverParameters, err = db.RunCommand(context.Background(), bson.D{{"getParameter", "*"}}).DecodeBytes()
if err != nil {
return fmt.Errorf("error getting serverParameters: %v", err)
}
}
return nil
}
// Teardown cleans up resources initialized by Setup.
// This function must be called once after all tests have finished running.
func Teardown() error {
// Dropping the test database causes an error against Atlas Data Lake.
if !testContext.dataLake {
if err := testContext.client.Database(TestDb).Drop(context.Background()); err != nil {
return fmt.Errorf("error dropping test database: %v", err)
}
}
if err := testContext.client.Disconnect(context.Background()); err != nil {
return fmt.Errorf("error disconnecting test client: %v", err)
}
if err := testContext.topo.Disconnect(context.Background()); err != nil {
return fmt.Errorf("error disconnecting test topology: %v", err)
}
return nil
}
func getServerVersion() (string, error) {
var serverStatus bson.Raw
err := testContext.client.Database(TestDb).RunCommand(
context.Background(),
bson.D{{"buildInfo", 1}},
).Decode(&serverStatus)
if err != nil {
return "", err
}
version, err := serverStatus.LookupErr("version")
if err != nil {
return "", errors.New("no version string in serverStatus response")
}
return version.StringValue(), nil
}
// addOptions appends connection string options to a URI.
func addOptions(uri string, opts ...string) string {
if !strings.ContainsRune(uri, '?') {
if uri[len(uri)-1] != '/' {
uri += "/"
}
uri += "?"
} else {
uri += "&"
}
for _, opt := range opts {
uri += opt
}
return uri
}
// addTLSConfig checks for the environmental variable indicating that the tests are being run
// on an SSL-enabled server, and if so, returns a new URI with the necessary configuration.
func addTLSConfig(uri string) string {
if os.Getenv("SSL") == "ssl" {
uri = addOptions(uri, "ssl=", "true")
}
caFile := os.Getenv("MONGO_GO_DRIVER_CA_FILE")
if len(caFile) == 0 {
return uri
}
return addOptions(uri, "sslCertificateAuthorityFile=", caFile)
}
// addCompressors checks for the environment variable indicating that the tests are being run with compression
// enabled. If so, it returns a new URI with the necessary configuration
func addCompressors(uri string) string {
comp := os.Getenv("MONGO_GO_DRIVER_COMPRESSOR")
if len(comp) == 0 {
return uri
}
return addOptions(uri, "compressors=", comp)
}
func addServerlessAuthCredentials(uri string) (string, error) {
if os.Getenv("SERVERLESS") != "serverless" {
return uri, nil
}
user := os.Getenv("SERVERLESS_ATLAS_USER")
if user == "" {
return "", fmt.Errorf("serverless expects SERVERLESS_ATLAS_USER to be set")
}
password := os.Getenv("SERVERLESS_ATLAS_PASSWORD")
if password == "" {
return "", fmt.Errorf("serverless expects SERVERLESS_ATLAS_PASSWORD to be set")
}
var scheme string
// remove the scheme
if strings.HasPrefix(uri, "mongodb+srv://") {
scheme = "mongodb+srv://"
} else if strings.HasPrefix(uri, "mongodb://") {
scheme = "mongodb://"
} else {
return "", fmt.Errorf("scheme must be \"mongodb\" or \"mongodb+srv\"")
}
uri = scheme + user + ":" + password + "@" + uri[len(scheme):]
return uri, nil
}
func addNecessaryParamsToURI(uri string) (string, error) {
uri = addTLSConfig(uri)
uri = addCompressors(uri)
return addServerlessAuthCredentials(uri)
}
// CompareServerVersions compares two version number strings (i.e. positive integers separated by
// periods). Comparisons are done to the lesser precision of the two versions. For example, 3.2 is
// considered equal to 3.2.11, whereas 3.2.0 is considered less than 3.2.11.
//
// Returns a positive int if version1 is greater than version2, a negative int if version1 is less
// than version2, and 0 if version1 is equal to version2.
func CompareServerVersions(v1 string, v2 string) int {
n1 := strings.Split(v1, ".")
n2 := strings.Split(v2, ".")
for i := 0; i < int(math.Min(float64(len(n1)), float64(len(n2)))); i++ {
i1, err := strconv.Atoi(n1[i])
if err != nil {
return 1
}
i2, err := strconv.Atoi(n2[i])
if err != nil {
return -1
}
difference := i1 - i2
if difference != 0 {
return difference
}
}
return 0
}