-
Notifications
You must be signed in to change notification settings - Fork 373
/
migrator.go
493 lines (429 loc) · 13.8 KB
/
migrator.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
// Copyright (c) 2021 Terminus, Inc.
//
// This program is free software: you can use, redistribute, and/or modify
// it under the terms of the GNU Affero General Public License, version 3
// or later ("AGPL"), as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package migrator
import (
"database/sql"
"path/filepath"
"strings"
"time"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"gorm.io/gorm"
"github.com/erda-project/erda/pkg/database/sqlparser/ddlreverser"
"github.com/erda-project/erda/pkg/database/sqlparser/pygrator"
"github.com/erda-project/erda/pkg/database/sqlparser/snapshot"
)
// installing type
const (
firstTimeInstall installType = "first_time_install"
normalUpdate installType = "normal_update"
firstTimeUpdate installType = "first_time_update"
)
type installType string
type Migrator struct {
Parameters
snap *snapshot.Snapshot
LocalScripts *Scripts
reversing []string
installingType installType
dbSettings *pygrator.Settings // database settings
sandboxSettings *pygrator.Settings // sandbox settings
db *gorm.DB
sandbox *gorm.DB
}
func New(parameters Parameters) (mig *Migrator, err error) {
if parameters == nil {
return nil, errors.New("parameters is nil")
}
if parameters.MySQLParameters() == nil {
return nil, errors.New("MySQL DSN is invalid, did you set the right DSN ?")
}
if parameters.SandboxParameters() == nil {
return nil, errors.New("sandbox DSN is invalid, did you set the right DSN ?")
}
// init parameters
mig = new(Migrator)
mig.Parameters = parameters
mig.dbSettings = &pygrator.Settings{
Engine: pygrator.DjangoMySQLEngine,
User: mig.MySQLParameters().Username,
Password: mig.MySQLParameters().Password,
Host: mig.MySQLParameters().Host,
Port: mig.MySQLParameters().Port,
Name: mig.MySQLParameters().Database,
TimeZone: pygrator.TimeZoneAsiaShanghai,
}
mig.sandboxSettings = &pygrator.Settings{
Engine: pygrator.DjangoMySQLEngine,
User: mig.SandboxParameters().Username,
Password: mig.SandboxParameters().Password,
Host: mig.SandboxParameters().Host,
Port: mig.SandboxParameters().Port,
Name: mig.SandboxParameters().Database,
TimeZone: pygrator.TimeZoneAsiaShanghai,
}
// load scripts
mig.LocalScripts, err = NewScripts(parameters)
if err != nil {
return nil, errors.Wrap(err, "failed to NewScripts")
}
return mig, nil
}
func (mig *Migrator) Run() (err error) {
// snapshot database schema structure
mig.snap, err = snapshot.From(mig.DB(), SchemaMigrationHistory)
if err != nil {
return err
}
// if there is no table then goto new installation
if !mig.snap.HasAnyTable() {
logrus.Infoln("there is not any table, it is the first time installation...")
mig.installingType = firstTimeInstall
return mig.newInstallation()
}
// if there is any history record then goto normal update,
// otherwise goto first time update
tx := mig.DB().Find(new([]HistoryModel))
if tx.Error == nil && tx.RowsAffected > 0 {
logrus.Infoln("found migration histries, it is the normal update installation...")
mig.installingType = normalUpdate
return mig.normalUpdate()
}
if tx.Error != nil {
logrus.WithError(tx.Error).Warnln("failed to Find HistoryModel records")
}
logrus.Infoln("there are some tables but no migration histories, it is the first time update installation by Erda MySQL Migration...")
mig.installingType = firstTimeUpdate
return mig.firstTimeUpdate()
}
func (mig *Migrator) newInstallation() (err error) {
new(HistoryModel).CreateTable(mig.DB())
mig.LocalScripts.MarkPending(mig.DB())
// Erda mysql lint
if mig.NeedErdaMySQLLint() {
logrus.Infoln("DO ERDA MYSQL LINT...")
if err = mig.LocalScripts.Lint(); err != nil {
return err
}
logrus.Infoln("ERDA MYSQL LINT OK")
}
// alter permission lint
logrus.Infoln("DO ALTER PERMISSION LINT...")
if err = mig.LocalScripts.AlterPermissionLint(); err != nil {
return err
}
logrus.Infoln("ALTER PERMISSION LINT OK")
// execute in sandbox
logrus.Infoln("DO MIGRATION IN SANDBOX...")
if err = mig.migrateSandbox(); err != nil {
return err
}
logrus.Infoln("MIGRATE IN SANDBOX OK")
// migrate schema SQLs
logrus.Infoln("DO PRE-MIGRATION...")
if err = mig.preMigrate(); err != nil {
return err
}
logrus.Infoln("PRE-MIGRATE OK")
// migrate data SQLs
logrus.Infoln("DO MIGRATION...")
if err = mig.migrate(); err != nil {
return err
}
logrus.Infoln("MIGRATE OK")
return nil
}
func (mig *Migrator) normalUpdate() (err error) {
// Erda mysql lint
mig.LocalScripts.MarkPending(mig.DB())
if mig.NeedErdaMySQLLint() {
logrus.Infoln("DO ERDA MYSQL LINT....")
if err = mig.LocalScripts.Lint(); err != nil {
return err
}
logrus.Infoln("ERDA MYSQL LINT OK")
}
// same name lint
logrus.Infoln("DO SAME NAME LINT....")
if err = mig.LocalScripts.SameNameLint(); err != nil {
return err
}
logrus.Infoln("SAME NAME LINT OK")
// alter permission lint
logrus.Infoln("DO ALTER PERMISSION LINT....")
if err = mig.LocalScripts.AlterPermissionLint(); err != nil {
return err
}
logrus.Infoln("ALTER PERMISSION LINT OK")
// installed script changes lint
logrus.Infoln("DO INSTALLED CHANGES LINT....")
if err = mig.LocalScripts.InstalledChangesLint(); err != nil {
return err
}
logrus.Infoln("INSTALLED CHANGES LINT OK")
// copy database snapshot to sandbox
logrus.Infoln("COPY CURRENT DATABASE STRUCTURE TO SANDBOX....")
if err = mig.snap.RecoverTo(mig.SandBox()); err != nil {
return err
}
logrus.Infoln("COPY CURRENT DATABASE STRUCTURE TO SANDBOX OK")
// migrate in sandbox
logrus.Infoln("DO MIGRATION IN SANDBOX....")
if err = mig.migrateSandbox(); err != nil {
return err
}
logrus.Infoln("MIGRATE IN SANDBOX OK")
// pre migrate data
logrus.Infoln("DO PRE-MIGRATION....")
if err = mig.preMigrate(); err != nil {
return err
}
logrus.Infoln("PRE-MIGRATE OK")
// migrate data
logrus.Infoln("DO MIGRATION....")
if err = mig.migrate(); err != nil {
return err
}
logrus.Infoln("MIGRATE OK")
return nil
}
func (mig *Migrator) firstTimeUpdate() (err error) {
// the correct state in this time is db.Schema == baseScriptsSchema,
// if not, returns error, manual intervention.
// marks all baseScripts !pending, marks others pending
// compare local base schema and cloud base schema for every service
logrus.Infoln("COMPARE LOCAL SCHEMA AND CLOUD SCHEMA FOR EVERY SERVICE... ..")
for _, service := range mig.LocalScripts.Services {
if equal := service.BaselineEqualCloud(mig.DB()); !equal.Equal() {
return errors.Errorf("local base schema is not equal with cloud schema: %s", equal.Reason())
}
}
// record base
logrus.Infoln("RECORD BASE... ..")
new(HistoryModel).CreateTable(mig.DB())
now := time.Now()
for moduleName, module := range mig.LocalScripts.Services {
for i := range module.Scripts {
if module.Scripts[i].IsBaseline() {
module.Scripts[i].Pending = false
record := HistoryModel{
ID: 0,
CreatedAt: now,
UpdatedAt: now,
ServiceName: moduleName,
Filename: filepath.Base(module.Scripts[i].GetName()),
Checksum: module.Scripts[i].Checksum(),
InstalledBy: "",
InstalledOn: "",
LanguageType: string(module.Scripts[i].Type),
Reversed: ddlreverser.ReverseCreateTableStmts(module.Scripts[i]),
}
if err := mig.DB().Create(&record).Error; err != nil {
return err
}
}
}
}
return mig.normalUpdate()
}
func (mig *Migrator) reverse(reversing []string, reverseSlice bool) error {
if len(reversing) == 0 {
return nil
}
if reverseSlice {
ddlreverser.ReverseSlice(reversing)
}
for _, s := range mig.reversing {
if err := mig.DB().Exec(s).Error; err != nil {
return errors.Errorf("failed to exec reversing SQL: %s", s)
}
}
return nil
}
func (mig *Migrator) migrateSandbox() (err error) {
if err = mig.destructiveLint(); err != nil {
return err
}
// install every module
for moduleName, module := range mig.LocalScripts.Services {
for _, script := range module.Scripts {
if !script.Pending {
continue
}
switch script.Type {
case ScriptTypeSQL:
after := func(tx *gorm.DB, err error) {
tx.Commit()
}
if err := mig.installSQL(script, mig.SandBox, mig.SandBox().Begin, after); err != nil {
return errors.Wrapf(err, "failed to migrate in sandbox: %+v",
map[string]interface{}{"moduleName": moduleName, "filename": script.GetName(), "type": ScriptTypeSQL})
}
case ScriptTypePython:
if err := mig.installPy(script, module, mig.sandboxSettings, true); err != nil {
return errors.Wrapf(err, "failed to migrate in sandbox: %+v",
map[string]interface{}{"moduleName": moduleName, "filename": script.GetName(), "type": ScriptTypePython})
}
}
}
}
return err
}
// pre migrate data SQLs, all applied in this runtime will be rollback
func (mig *Migrator) preMigrate() (err error) {
if err = mig.destructiveLint(); err != nil {
return err
}
// finally roll all DDL back
defer func() {
logrus.Infoln(" REVERSE PRE-MIGRATIONS: all schema migration")
if err := mig.reverse(mig.reversing, true); err != nil {
logrus.Fatalln(err)
}
}()
mig.reversing = nil
// install every module
for moduleName, module := range mig.LocalScripts.Services {
for _, script := range module.Scripts {
if !script.Pending {
continue
}
switch script.Type {
case ScriptTypeSQL:
after := func(tx *gorm.DB, err error) {
logrus.WithField("module name", moduleName).
WithField("script name", script.GetName()).
Infoln(" ROLLBACK PRE-MIGRATIONS: current script data migration")
tx.Rollback()
}
if err := mig.installSQL(script, mig.DB, mig.DB().Begin, after); err != nil {
return errors.Wrapf(err, "failed to pre-migrate: %+v",
map[string]interface{}{"module name": moduleName, "script name": script.GetName(), "type": ScriptTypeSQL})
}
case ScriptTypePython:
if err := mig.installPy(script, module, mig.dbSettings, false); err != nil {
return errors.Wrapf(err, "failed to pre-migrate: %+v",
map[string]interface{}{"module name": moduleName, "script name": script.GetName(), "type": ScriptTypePython})
}
}
}
}
return nil
}
func (mig *Migrator) migrate() error {
now := time.Now()
// install every service
for moduleName, module := range mig.LocalScripts.Services {
logrus.WithField("module", moduleName).Infoln()
for _, script := range module.Scripts {
if !script.Pending {
continue
}
logrus.WithField("script name", script.GetName()).Infoln("install")
switch script.Type {
case ScriptTypeSQL:
after := func(tx *gorm.DB, err error) {
if err != nil {
tx.Rollback()
mig.reverse(script.Reversing, true)
} else {
tx.Commit()
}
}
if err := mig.installSQL(script, mig.DB, mig.DB().Begin, after); err != nil {
return errors.Wrapf(err, "failed to migrate: %+v",
map[string]interface{}{"module name": moduleName, "script name": script.GetName(), "type": ScriptTypeSQL})
}
case ScriptTypePython:
if err := mig.installPy(script, module, mig.dbSettings, true); err != nil {
return errors.Wrapf(err, "failed to migrate: %+v",
map[string]interface{}{"module name": moduleName, "script name": script.GetName(), "type": ScriptTypePython})
}
}
// record it
ddlreverser.ReverseSlice(script.Reversing)
record := HistoryModel{
ID: 0,
CreatedAt: now,
UpdatedAt: now,
ServiceName: moduleName,
Filename: script.GetName(),
Checksum: script.Checksum(),
InstalledBy: "",
InstalledOn: "",
LanguageType: string(script.Type),
Reversed: strings.Join(script.Reversing, "\n"),
}
if err := mig.DB().Create(&record).Error; err != nil {
return errors.Wrapf(err, "internal error: failed to record migration")
}
}
}
return nil
}
func (mig *Migrator) installSQL(s *Script, exec func() *gorm.DB, begin func(opts ...*sql.TxOptions) *gorm.DB, after func(tx *gorm.DB, err error)) (err error) {
tx := begin()
defer after(tx, err)
defer func() {
mig.reversing = append(mig.reversing, s.Reversing...)
}()
s.Reversing = nil
for _, node := range s.DDLNodes() {
var (
reverse string
ok bool
)
reverse, ok, err = ddlreverser.ReverseDDLWithSnapshot(exec(), node)
if err != nil {
return errors.Wrapf(err, "failed to generate reversed DDL: %+v",
map[string]string{"scritpName": s.GetName(), "SQL": node.Text()})
}
if ok {
s.Reversing = append(s.Reversing, reverse)
}
if err = exec().Exec(node.Text()).Error; err != nil {
return errors.Wrapf(err, "failed to do schema migration: %+v",
map[string]string{"scriptName": s.GetName(), "SQL": node.Text()})
}
}
for _, node := range s.DMLNodes() {
if err = tx.Exec(node.Text()).Error; err != nil {
return errors.Wrapf(err, "failed to do data migration: %+v",
map[string]string{"scriptName": s.GetName(), "SQL": node.Text()})
}
}
return nil
}
func (mig *Migrator) installPy(s *Script, module *Module, settings *pygrator.Settings, commit bool) error {
var p = pygrator.Package{
DeveloperScript: s,
Requirements: module.PythonRequirementsText,
Settings: *settings,
Commit: commit,
}
if len(p.Requirements) == 0 {
p.Requirements = []byte(pygrator.BaseRequirements)
}
if err := p.Make(); err != nil {
return err
}
defer p.Remove()
return p.Run()
}
func (mig *Migrator) destructiveLint() error {
text, ok := mig.LocalScripts.HasDestructiveOperationInPending()
if ok {
return errors.Errorf("there is desctructive SQL in pending scripts, SQL: %s", text)
}
return nil
}