-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
environment.go
320 lines (271 loc) · 10 KB
/
environment.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
/*
Copyright 2019 The Vitess Authors.
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
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package vttest
import (
"fmt"
"math/rand/v2"
"net"
"os"
"path"
"strconv"
"strings"
"vitess.io/vitess/go/vt/proto/vttest"
// we use gRPC everywhere, so import the vtgate client.
_ "vitess.io/vitess/go/vt/vtgate/grpcvtgateconn"
)
// Environment is the interface that customizes the global settings for
// the test cluster. Usually the same environment settings are shared by
// all the LocalCluster instances in a given test suite, with each instance
// receiving a different Config for specific tests.
// For Environments that create temporary data on-disk and clean it up on
// termination, a brand new instance of Environment should be passed to
// each LocalCluster.
type Environment interface {
// BinaryPath returns the full path to the given executable
BinaryPath(bin string) string
// MySQLManager is the constructor for the MySQL manager that will
// be used by the cluster. The manager must take care of initializing
// and destructing the MySQL instance(s) that will be used by the cluster.
// See: vttest.MySQLManager for the interface the manager must implement
MySQLManager(mycnf []string, snapshot string) (MySQLManager, error)
// TopoManager is the constructor for the Topology manager that will
// be used by the cluster. It's only used when we run the local cluster with
// a remote topo server instead of in-memory topo server within vtcombo process
// See: vttest.TopoManager for the interface of topo manager
TopoManager(topoImplementation, topoServerAddress, topoRoot string, topology *vttest.VTTestTopology) TopoManager
// Directory is the path where the local cluster will store all its
// data and metadata. For local testing, this should probably be an
// unique temporary directory.
Directory() string
// LogDirectory is the directory where logs for all services in the
// cluster will be stored.
LogDirectory() string
// VtcomoboArguments are the extra commandline arguments that will be
// passed to `vtcombo`
VtcomboArguments() []string
// ProcessHealthCheck returns a HealthChecker for the given service.
// The HealthChecker takes an address and attempts to check whether
// the service is up and healthy.
// If a given service does not require any custom health checks,
// nil can be returned.
ProcessHealthCheck(name string) HealthChecker
// DefaultProtocol is the protocol used to communicate with the
// Vitess cluster. This is usually "grpc".
DefaultProtocol() string
// PortForProtocol returns the listening port for a given service
// on the given protocol. If protocol is empty, the default protocol
// for each service is assumed.
PortForProtocol(name, protocol string) int
// EnvVars returns the environment variables that will be passed
// to all Vitess processes spawned by the local cluster. These variables
// always take precedence over the variables inherited from the current
// process.
EnvVars() []string
// TearDown is called during LocalCluster.TearDown() to cleanup
// any temporary data in the environment. Environments that can
// last through several test runs do not need to implement it.
TearDown() error
}
// LocalTestEnv is an Environment implementation for local testing
// See: NewLocalTestEnv()
type LocalTestEnv struct {
BasePort int
TmpPath string
DefaultMyCnf []string
InitDBFile string
Env []string
EnableToxiproxy bool
}
// DefaultMySQLFlavor is the MySQL flavor used by vttest when no explicit
// flavor is given.
const DefaultMySQLFlavor = "MySQL56"
// GetMySQLOptions returns the set of MySQL CNF files and any errors.
func GetMySQLOptions() ([]string, error) {
mycnf := []string{}
mycnf = append(mycnf, "config/mycnf/test-suite.cnf")
for i, cnf := range mycnf {
mycnf[i] = path.Join(os.Getenv("VTROOT"), cnf)
}
return mycnf, nil
}
// EnvVars implements EnvVars for LocalTestEnv
func (env *LocalTestEnv) EnvVars() []string {
return env.Env
}
// BinaryPath implements BinaryPath for LocalTestEnv
func (env *LocalTestEnv) BinaryPath(binary string) string {
return path.Join(os.Getenv("VTROOT"), "bin", binary)
}
// MySQLManager implements MySQLManager for LocalTestEnv
func (env *LocalTestEnv) MySQLManager(mycnf []string, snapshot string) (MySQLManager, error) {
mysqlctl := &Mysqlctl{
Binary: env.BinaryPath("mysqlctl"),
InitFile: env.InitDBFile,
Directory: env.TmpPath,
Port: env.PortForProtocol("mysql", ""),
MyCnf: append(env.DefaultMyCnf, mycnf...),
Env: env.EnvVars(),
UID: 1,
}
if !env.EnableToxiproxy {
return mysqlctl, nil
}
return NewToxiproxyctl(
env.BinaryPath("toxiproxy-server"),
env.PortForProtocol("toxiproxy", ""),
env.PortForProtocol("mysql_behind_toxiproxy", ""),
mysqlctl,
path.Join(env.LogDirectory(), "toxiproxy.log"),
)
}
// TopoManager implements TopoManager for LocalTestEnv
func (env *LocalTestEnv) TopoManager(topoImplementation, topoServerAddress, topoRoot string, topology *vttest.VTTestTopology) TopoManager {
return &Topoctl{
TopoImplementation: topoImplementation,
TopoGlobalServerAddress: topoServerAddress,
TopoGlobalRoot: topoRoot,
Topology: topology,
}
}
// DefaultProtocol implements DefaultProtocol for LocalTestEnv.
// It is always GRPC.
func (env *LocalTestEnv) DefaultProtocol() string {
return "grpc"
}
// PortForProtocol implements PortForProtocol for LocalTestEnv.
func (env *LocalTestEnv) PortForProtocol(name, proto string) int {
switch name {
case "vtcombo":
if proto == "grpc" {
return env.BasePort + 1
}
return env.BasePort
case "mysql":
return env.BasePort + 2
case "vtcombo_mysql_port":
return env.BasePort + 3
case "toxiproxy":
return env.BasePort + 4
case "mysql_behind_toxiproxy":
return env.BasePort + 5
default:
panic("unknown service name: " + name)
}
}
// ProcessHealthCheck implements ProcessHealthCheck for LocalTestEnv.
// By default, it performs no service-specific health checks
func (env *LocalTestEnv) ProcessHealthCheck(name string) HealthChecker {
return nil
}
// VtcomboArguments implements VtcomboArguments for LocalTestEnv.
func (env *LocalTestEnv) VtcomboArguments() []string {
return []string{
"--service_map", strings.Join(
[]string{"grpc-vtgateservice", "grpc-vtctl", "grpc-vtctld"}, ",",
),
}
}
// LogDirectory implements LogDirectory for LocalTestEnv.
func (env *LocalTestEnv) LogDirectory() string {
return path.Join(env.TmpPath, "logs")
}
// Directory implements Directory for LocalTestEnv.
func (env *LocalTestEnv) Directory() string {
return env.TmpPath
}
// TearDown implements TearDown for LocalTestEnv
func (env *LocalTestEnv) TearDown() error {
return os.RemoveAll(env.TmpPath)
}
func tmpdir(dataroot string) (dir string, err error) {
dir, err = os.MkdirTemp(dataroot, "vttest")
return
}
// randomPort gets a random port that is available for a TCP connection.
// After we generate a random port, we try to establish tcp connections on it and the next 5 values.
// If any of them fail, then we try a different port.
func randomPort() int {
for {
port := int(rand.Int32N(20000) + 10000)
portInUse := false
for i := 0; i < 6; i++ {
ln, err := net.Listen("tcp", net.JoinHostPort("127.0.0.1", strconv.Itoa(port+i)))
if err != nil {
portInUse = true
break
}
ln.Close()
}
if portInUse {
continue
}
return port
}
}
// NewLocalTestEnv returns an instance of the default test environment used
// for local testing Vitess. The defaults are as follows:
// - Directory() is a random temporary directory in VTDATAROOT, which is cleaned
// up when closing the Environment.
// - LogDirectory() is the `logs` subdir inside Directory()
// - The MySQL flavor is set to `flavor`. If the argument is not set, it will
// default DefaultMySQLFlavor
// - PortForProtocol() will return ports based off the given basePort. If basePort
// is zero, a random port between 10000 and 20000 will be chosen.
// - DefaultProtocol() is always "grpc"
// - ProcessHealthCheck() performs no service-specific health checks
// - BinaryPath() will look up the default Vitess binaries in VTROOT
// - MySQLManager() will return a vttest.Mysqlctl instance, configured with the
// given MySQL flavor. This will use the `mysqlctl` command to initialize and
// teardown a single mysqld instance.
func NewLocalTestEnv(basePort int) (*LocalTestEnv, error) {
directory, err := tmpdir(os.Getenv("VTDATAROOT"))
if err != nil {
return nil, err
}
return NewLocalTestEnvWithDirectory(basePort, directory)
}
// NewLocalTestEnvWithDirectory returns a new instance of the default test
// environment with a directory explicitly specified.
func NewLocalTestEnvWithDirectory(basePort int, directory string) (*LocalTestEnv, error) {
if _, err := os.Stat(path.Join(directory, "logs")); os.IsNotExist(err) {
err := os.Mkdir(path.Join(directory, "logs"), 0700)
if err != nil {
return nil, err
}
}
mycnf, err := GetMySQLOptions()
if err != nil {
return nil, err
}
if basePort == 0 {
basePort = randomPort()
}
return &LocalTestEnv{
BasePort: basePort,
TmpPath: directory,
DefaultMyCnf: mycnf,
InitDBFile: path.Join(os.Getenv("VTROOT"), "config/init_db.sql"),
Env: []string{
fmt.Sprintf("VTDATAROOT=%s", directory),
"VTTEST=endtoend",
},
}, nil
}
func defaultEnvFactory() (Environment, error) {
return NewLocalTestEnv(0)
}
// NewDefaultEnv is an user-configurable callback that returns a new Environment
// instance with the default settings.
// This callback is only used in cases where the user hasn't explicitly set
// the Env variable when initializing a LocalCluster
var NewDefaultEnv = defaultEnvFactory