forked from mongodb/mongo-go-driver
/
setup.go
237 lines (206 loc) · 7.08 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
// 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/mongo"
"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/connstring"
"go.mongodb.org/mongo-driver/x/mongo/driver/description"
"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
client *mongo.Client // client used for setup and teardown
serverVersion string
authEnabled bool
enterpriseServer bool
}
func setupClient(cs connstring.ConnString, opts *options.ClientOptions) (*mongo.Client, error) {
wcMajority := writeconcern.New(writeconcern.WMajority())
return mongo.Connect(Background, opts.ApplyURI(cs.Original).SetWriteConcern(wcMajority))
}
// Setup initializes the current testing context.
// This function must only be called one time and must be called before any tests run.
func Setup() error {
var err error
testContext.connString, err = getConnString()
if err != nil {
return fmt.Errorf("error getting connection string: %v", err)
}
testContext.topo, err = topology.New(topology.WithConnString(func(connstring.ConnString) connstring.ConnString {
return testContext.connString
}))
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(testContext.connString, options.Client())
if err != nil {
return fmt.Errorf("error connecting test client: %v", err)
}
pingCtx, cancel := context.WithTimeout(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
}
if testContext.topoKind == ReplicaSet && compareVersions(testContext.serverVersion, "4.0") >= 0 {
err = testContext.client.Database("admin").RunCommand(Background, bson.D{
{"setParameter", 1},
{"transactionLifetimeLimitSeconds", 3},
}).Err()
if err != nil {
return fmt.Errorf("error setting transactionLifetimeLimitSeconds: %v", err)
}
}
testContext.authEnabled = len(os.Getenv("MONGO_GO_DRIVER_CA_FILE")) != 0
biRes, err := testContext.client.Database("admin").RunCommand(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
}
}
}
return nil
}
// Teardown cleans up resources initialized by Setup.
// This function must be called once after all tests have finished running.
func Teardown() error {
if err := testContext.client.Database(TestDb).Drop(Background); err != nil {
return fmt.Errorf("error dropping test database: %v", err)
}
if err := testContext.client.Disconnect(Background); err != nil {
return fmt.Errorf("error disconnecting test client: %v", err)
}
if err := testContext.topo.Disconnect(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(
Background,
bson.D{{"serverStatus", 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 {
caFile := os.Getenv("MONGO_GO_DRIVER_CA_FILE")
if len(caFile) == 0 {
return uri
}
return addOptions(uri, "ssl=true&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)
}
// ConnString gets the globally configured connection string.
func getConnString() (connstring.ConnString, error) {
uri := os.Getenv("MONGODB_URI")
if uri == "" {
uri = "mongodb://localhost:27017"
}
uri = addTLSConfig(uri)
uri = addCompressors(uri)
return connstring.Parse(uri)
}
// compareVersions 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 compareVersions(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
}