forked from vitessio/vitess
-
Notifications
You must be signed in to change notification settings - Fork 1
/
local_cluster.go
517 lines (433 loc) · 13.9 KB
/
local_cluster.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
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
/*
Copyright 2017 GitHub Inc.
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 (
"bufio"
"bytes"
"context"
"encoding/json"
"fmt"
"io/ioutil"
"os"
"os/exec"
"path"
"path/filepath"
"strings"
"unicode"
"vitess.io/vitess/go/mysql"
"vitess.io/vitess/go/sqltypes"
"vitess.io/vitess/go/vt/log"
vschemapb "vitess.io/vitess/go/vt/proto/vschema"
vttestpb "vitess.io/vitess/go/vt/proto/vttest"
)
// Config are the settings used to configure the self-contained Vitess cluster.
// The LocalCluster struct embeds Config so it's possible to either initialize
// a LocalCluster with the given settings, or set the settings directly after
// initialization.
// All settings must be set before LocalCluster.Setup() is called.
type Config struct {
// Topology defines the fake cluster's topology. This field is mandatory.
// See: vt/proto/vttest.VTTestTopology
Topology *vttestpb.VTTestTopology
// Seed can be set with a SeedConfig struct to enable
// auto-initialization of the database cluster with random data.
// If nil, no random initialization will be performed.
// See: SeedConfig
Seed *SeedConfig
// SchemaDir is the directory for schema files. Within this dir,
// there should be a subdir for each keyspace. Within each keyspace
// dir, each file is executed as SQL after the database is created on
// each shard.
// If the directory contains a `vschema.json`` file, it will be used
// as the VSchema for the V3 API
SchemaDir string
// DefaultSchemaDir is the default directory for initial schema files.
// If no schema is found in SchemaDir, default to this location.
DefaultSchemaDir string
// DataDir is the directory where the data files will be placed.
// If no directory is specified a random directory will be used
// under VTDATAROOT.
DataDir string
// Charset is the default charset used by MySQL
Charset string
// WebDir is the location of the vtcld web server files
WebDir string
// WebDir2 is the location of the vtcld2 web server files
WebDir2 string
// ExtraMyCnf are the extra .CNF files to be added to the MySQL config
ExtraMyCnf []string
// OnlyMySQL can be set so only MySQL is initialized as part of the
// local cluster configuration. The rest of the Vitess components will
// not be started.
OnlyMySQL bool
// MySQL protocol bind address.
// vtcombo will bind to this address when exposing the mysql protocol socket
MySQLBindHost string
// SnapshotFile is the path to the MySQL Snapshot that will be used to
// initialize the mysqld instance in the cluster. Note that some environments
// do not suppport initialization through snapshot files.
SnapshotFile string
// TransactionMode is SINGLE, MULTI or TWOPC
TransactionMode string
}
// InitSchemas is a shortcut for tests that just want to setup a single
// keyspace with a single SQL file, and/or a vschema.
// It creates a temporary directory, and puts the schema/vschema in there.
// It then sets the right value for cfg.SchemaDir.
// At the end of the test, the caller should os.RemoveAll(cfg.SchemaDir).
func (cfg *Config) InitSchemas(keyspace, schema string, vschema *vschemapb.Keyspace) error {
if cfg.SchemaDir != "" {
return fmt.Errorf("SchemaDir is already set to %v", cfg.SchemaDir)
}
// Create a base temporary directory.
tempSchemaDir, err := ioutil.TempDir("", "vttest")
if err != nil {
return err
}
// Write the schema if set.
if schema != "" {
ksDir := path.Join(tempSchemaDir, keyspace)
err = os.Mkdir(ksDir, os.ModeDir|0775)
if err != nil {
return err
}
fileName := path.Join(ksDir, "schema.sql")
err = ioutil.WriteFile(fileName, []byte(schema), 0666)
if err != nil {
return err
}
}
// Write in the vschema if set.
if vschema != nil {
vschemaFilePath := path.Join(tempSchemaDir, "vschema.json")
vschemaJSON, err := json.Marshal(vschema)
if err != nil {
return err
}
if err := ioutil.WriteFile(vschemaFilePath, vschemaJSON, 0644); err != nil {
return err
}
}
cfg.SchemaDir = tempSchemaDir
return nil
}
// DbName returns the default name for a database in this cluster.
// If OnlyMySQL is set, this will be the name of the single database
// created in MySQL. Otherwise, this will be the database that stores
// the first keyspace in the topology.
func (cfg *Config) DbName() string {
ns := cfg.Topology.GetKeyspaces()
if len(ns) > 0 {
return ns[0].Name
}
return ""
}
// LocalCluster controls a local Vitess setup for testing, containing
// a MySQL instance and one or more vtgate-equivalent access points.
// To use, simply create a new LocalCluster instance and either pass in
// the desired Config, or manually set each field on the struct itself.
// Once the struct is configured, call LocalCluster.Setup() to instantiate
// the cluster.
// See: Config for configuration settings on the cluster
type LocalCluster struct {
Config
// Env is the Environment which will be used for unning this local cluster.
// It can be set by the user before calling Setup(). If not set, Setup() will
// use the NewDefaultEnv callback to instantiate an environment with the system
// default settings
Env Environment
mysql MySQLManager
vt *VtProcess
}
// MySQLConnParams returns a mysql.ConnParams struct that can be used
// to connect directly to the mysqld service in the self-contained cluster
// This connection should be used for debug/introspection purposes; normal
// cluster access should be performed through the vtgate port.
func (db *LocalCluster) MySQLConnParams() mysql.ConnParams {
return db.mysql.Params(db.DbName())
}
// MySQLAppDebugConnParams returns a mysql.ConnParams struct that can be used
// to connect directly to the mysqld service in the self-contained cluster,
// using the appdebug user. It's valid only if you used MySQLOnly option.
func (db *LocalCluster) MySQLAppDebugConnParams() mysql.ConnParams {
connParams := db.MySQLConnParams()
connParams.Uname = "vt_appdebug"
return connParams
}
// Setup brings up the self-contained Vitess cluster by spinning up
// MySQL and Vitess instances. The spawned processes will be running
// until the TearDown() method is called.
// Please ensure to `defer db.TearDown()` after calling this method
func (db *LocalCluster) Setup() error {
var err error
if db.Env == nil {
log.Info("No environment in cluster settings. Creating default...")
db.Env, err = NewDefaultEnv()
if err != nil {
return err
}
}
log.Infof("LocalCluster environment: %+v", db.Env)
db.mysql, err = db.Env.MySQLManager(db.ExtraMyCnf, db.SnapshotFile)
if err != nil {
return err
}
log.Infof("Initializing MySQL Manager (%T)...", db.mysql)
if err := db.mysql.Setup(); err != nil {
log.Errorf("Mysqlctl failed to start: %s", err)
if err, ok := err.(*exec.ExitError); ok {
log.Errorf("stderr: %s", err.Stderr)
}
return err
}
mycfg, _ := json.Marshal(db.mysql.Params(""))
log.Infof("MySQL up: %s", mycfg)
if err := db.createDatabases(); err != nil {
return err
}
if err := db.loadSchema(); err != nil {
return err
}
if db.Seed != nil {
if err := db.populateWithRandomData(); err != nil {
return err
}
}
if !db.OnlyMySQL {
log.Infof("Starting vtcombo...")
db.vt = VtcomboProcess(db.Env, &db.Config, db.mysql)
if err := db.vt.WaitStart(); err != nil {
return err
}
log.Infof("vtcombo up: %s", db.vt.Address())
}
return nil
}
// TearDown shuts down all the processes in the local cluster
// and cleans up any temporary on-disk data.
// If an error is returned, some of the running processes may not
// have been shut down cleanly and may need manual cleanup.
func (db *LocalCluster) TearDown() error {
var errors []string
if db.vt != nil {
if err := db.vt.WaitTerminate(); err != nil {
errors = append(errors, fmt.Sprintf("vtprocess: %s", err))
}
}
if err := db.mysql.TearDown(); err != nil {
errors = append(errors, fmt.Sprintf("mysql: %s", err))
log.Errorf("failed to shutdown MySQL: %s", err)
if err, ok := err.(*exec.ExitError); ok {
log.Errorf("stderr: %s", err.Stderr)
}
}
if err := db.Env.TearDown(); err != nil {
errors = append(errors, fmt.Sprintf("environment: %s", err))
}
if len(errors) > 0 {
return fmt.Errorf("failed to teardown LocalCluster:\n%s",
strings.Join(errors, "\n"))
}
return nil
}
func (db *LocalCluster) shardNames(keyspace *vttestpb.Keyspace) (names []string) {
for _, spb := range keyspace.Shards {
dbname := spb.DbNameOverride
if dbname == "" {
dbname = fmt.Sprintf("vt_%s_%s", keyspace.Name, spb.Name)
}
names = append(names, dbname)
}
return
}
func isDir(path string) bool {
info, err := os.Stat(path)
return err == nil && info.IsDir()
}
func (db *LocalCluster) loadSchema() error {
if db.SchemaDir == "" {
return nil
}
log.Info("Loading custom schema...")
if !isDir(db.SchemaDir) {
return fmt.Errorf("LoadSchema(): SchemaDir does not exist")
}
for _, kpb := range db.Topology.Keyspaces {
if kpb.ServedFrom != "" {
// redirected keyspaces have no underlying database
continue
}
keyspace := kpb.Name
keyspaceDir := path.Join(db.SchemaDir, keyspace)
schemaDir := keyspaceDir
if !isDir(schemaDir) {
schemaDir = db.DefaultSchemaDir
if schemaDir == "" || !isDir(schemaDir) {
return fmt.Errorf("LoadSchema: schema dir for ks `%s` does not exist (%s)", keyspace, schemaDir)
}
}
glob, _ := filepath.Glob(path.Join(schemaDir, "*.sql"))
for _, filepath := range glob {
cmds, err := LoadSQLFile(filepath, schemaDir)
if err != nil {
return err
}
for _, dbname := range db.shardNames(kpb) {
if err := db.Execute(cmds, dbname); err != nil {
return err
}
}
}
}
return nil
}
func (db *LocalCluster) createDatabases() error {
log.Info("Creating databases in cluster...")
var sql []string
for _, kpb := range db.Topology.Keyspaces {
if kpb.ServedFrom != "" {
continue
}
for _, dbname := range db.shardNames(kpb) {
sql = append(sql, fmt.Sprintf("create database `%s`", dbname))
}
}
return db.Execute(sql, "")
}
// Execute runs a series of SQL statements on the MySQL instance backing
// this local cluster. This is provided for debug/introspection purposes;
// normal cluster access should be performed through the Vitess GRPC interface.
func (db *LocalCluster) Execute(sql []string, dbname string) error {
params := db.mysql.Params(dbname)
conn, err := mysql.Connect(context.Background(), ¶ms)
if err != nil {
return err
}
defer conn.Close()
_, err = conn.ExecuteFetch("START TRANSACTION", 0, false)
if err != nil {
return err
}
for _, cmd := range sql {
log.Infof("Execute(%s): \"%s\"", dbname, cmd)
_, err := conn.ExecuteFetch(cmd, 0, false)
if err != nil {
return err
}
}
_, err = conn.ExecuteFetch("COMMIT", 0, false)
return err
}
// Query runs a SQL query on the MySQL instance backing this local cluster and returns
// its result. This is provided for debug/introspection purposes;
// normal cluster access should be performed through the Vitess GRPC interface.
func (db *LocalCluster) Query(sql, dbname string, limit int) (*sqltypes.Result, error) {
params := db.mysql.Params(dbname)
conn, err := mysql.Connect(context.Background(), ¶ms)
if err != nil {
return nil, err
}
defer conn.Close()
return conn.ExecuteFetch(sql, limit, false)
}
// JSONConfig returns a key/value object with the configuration
// settings for the local cluster. It should be serialized with
// `json.Marshal`
func (db *LocalCluster) JSONConfig() interface{} {
if db.OnlyMySQL {
return db.mysql.Params("")
}
config := map[string]interface{}{
"port": db.vt.Port,
"socket": db.mysql.UnixSocket(),
"vtcombo_mysql_port": db.Env.PortForProtocol("vtcombo_mysql_port", ""),
"mysql": db.Env.PortForProtocol("mysql", ""),
}
if grpc := db.vt.PortGrpc; grpc != 0 {
config["grpc_port"] = grpc
}
return config
}
// LoadSQLFile loads a parses a .sql file from disk, removing all the
// different comments that mysql/mysqldump inserts in these, and returning
// each individual SQL statement as its own string.
// If sourceroot is set, that directory will be used when resolving `source `
// statements in the SQL file.
func LoadSQLFile(filename, sourceroot string) ([]string, error) {
var (
cmd bytes.Buffer
sql []string
inSQ bool
inDQ bool
)
file, err := os.Open(filename)
if err != nil {
return nil, err
}
defer file.Close()
scanner := bufio.NewScanner(file)
for scanner.Scan() {
line := scanner.Text()
line = strings.TrimRightFunc(line, unicode.IsSpace)
if !inSQ && !inDQ && strings.HasPrefix(line, "--") {
continue
}
var i, next int
for {
i = next
if i >= len(line) {
break
}
next = i + 1
if line[i] == '\\' {
next = i + 2
} else if line[i] == '\'' && !inDQ {
inSQ = !inSQ
} else if line[i] == '"' && !inSQ {
inDQ = !inDQ
} else if !inSQ && !inDQ {
if line[i] == '#' || strings.HasPrefix(line[i:], "-- ") {
line = line[:i]
break
}
if line[i] == ';' {
cmd.WriteString(line[:i])
sql = append(sql, cmd.String())
cmd.Reset()
line = line[i+1:]
next = 0
}
}
}
if strings.TrimSpace(line) != "" {
if sourceroot != "" && cmd.Len() == 0 && strings.HasPrefix(line, "source ") {
srcfile := path.Join(sourceroot, line[7:])
sql2, err := LoadSQLFile(srcfile, sourceroot)
if err != nil {
return nil, err
}
sql = append(sql, sql2...)
} else {
cmd.WriteString(line)
cmd.WriteByte('\n')
}
}
}
if cmd.Len() != 0 {
sql = append(sql, cmd.String())
}
if err := scanner.Err(); err != nil {
return nil, err
}
return sql, nil
}