-
Notifications
You must be signed in to change notification settings - Fork 8
/
validate.go
488 lines (412 loc) · 12.7 KB
/
validate.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
package cmd
import (
"bufio"
"compress/gzip"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"slices"
"strconv"
"strings"
"time"
"github.com/rs/zerolog/log"
"github.com/greenmaskio/greenmask/internal/db/postgres/cmd/validate_utils"
runtimeContext "github.com/greenmaskio/greenmask/internal/db/postgres/context"
"github.com/greenmaskio/greenmask/internal/db/postgres/entries"
"github.com/greenmaskio/greenmask/internal/db/postgres/pgcopy"
storageDto "github.com/greenmaskio/greenmask/internal/db/postgres/storage"
"github.com/greenmaskio/greenmask/internal/db/postgres/toc"
"github.com/greenmaskio/greenmask/internal/db/postgres/transformers/custom"
"github.com/greenmaskio/greenmask/internal/db/postgres/transformers/utils"
"github.com/greenmaskio/greenmask/internal/domains"
"github.com/greenmaskio/greenmask/internal/storages"
"github.com/greenmaskio/greenmask/internal/utils/reader"
"github.com/greenmaskio/greenmask/pkg/toolkit"
)
const (
JsonFormat string = "json"
TextFormat string = "text"
)
const (
VerticalTableFormat = "vertical"
HorizontalTableFormat = "horizontal"
)
const (
nonZeroExitCode = 1
zeroExitCode = 0
)
type closeFunc func()
type Validate struct {
*Dump
tmpDir string
mainSt storages.Storager
exitCode int
}
func NewValidate(cfg *domains.Config, registry *utils.TransformerRegistry, st storages.Storager) (*Validate, error) {
mainSt := st
tmpDirName := strconv.FormatInt(time.Now().UnixMilli(), 10)
st = st.SubStorage(tmpDirName, true)
d := NewDump(cfg, st, registry)
d.dumpIdSequence = toc.NewDumpSequence(0)
d.validate = true
return &Validate{
Dump: d,
tmpDir: tmpDirName,
exitCode: zeroExitCode,
mainSt: mainSt,
}, nil
}
func (v *Validate) Run(ctx context.Context) (int, error) {
defer func() {
if !v.config.Validate.Diff {
return
}
if err := v.mainSt.Delete(ctx, v.tmpDir); err != nil {
log.Warn().Err(err).Msg("error deleting temporary directory")
}
}()
if err := custom.BootstrapCustomTransformers(ctx, v.registry, v.config.CustomTransformers); err != nil {
return nonZeroExitCode, fmt.Errorf("error bootstraping custom transformers: %w", err)
}
dsn, err := v.pgDumpOptions.GetPgDSN()
if err != nil {
return nonZeroExitCode, fmt.Errorf("cannot build connection string: %w", err)
}
conn, err := v.connect(ctx, dsn)
if err != nil {
return nonZeroExitCode, err
}
defer func() {
if err := conn.Close(ctx); err != nil {
log.Warn().Err(err)
}
}()
tx, err := v.startMainTx(ctx, conn)
if err != nil {
return nonZeroExitCode, fmt.Errorf("cannot prepare backup transaction: %w", err)
}
defer func() {
if err := tx.Rollback(ctx); err != nil {
log.Warn().Err(err)
}
}()
if err = v.gatherPgFacts(ctx, tx); err != nil {
return nonZeroExitCode, fmt.Errorf("error gathering facts: %w", err)
}
// Get list of tables to validate
tablesToValidate, err := v.getTablesToValidate()
if err != nil {
return nonZeroExitCode, err
}
v.config.Dump.Transformation = tablesToValidate
v.context, err = runtimeContext.NewRuntimeContext(ctx, tx, v.config.Dump.Transformation, v.registry,
v.pgDumpOptions, v.version)
if err != nil {
return nonZeroExitCode, fmt.Errorf("unable to build runtime context: %w", err)
}
if err = v.printValidationWarnings(); err != nil {
return nonZeroExitCode, err
}
if err = v.diffWithPreviousSchema(ctx); err != nil {
return nonZeroExitCode, err
}
if !v.config.Validate.Data {
return v.exitCode, nil
}
if err = v.dumpTables(ctx); err != nil {
return nonZeroExitCode, err
}
if err = v.print(ctx); err != nil {
return nonZeroExitCode, err
}
return v.exitCode, nil
}
func (v *Validate) print(ctx context.Context) error {
for _, e := range v.dataEntries {
idx := slices.IndexFunc(v.context.DataSectionObjects, func(entry entries.Entry) bool {
t := entry.(*entries.Table)
return t.DumpId == e.DumpId
})
t := v.context.DataSectionObjects[idx].(*entries.Table)
doc, err := v.createDocument(ctx, t)
if err != nil {
return fmt.Errorf("unable to create validation document: %w", err)
}
if err = doc.Print(os.Stdout); err != nil {
return fmt.Errorf("unable to print validation document: %w", err)
}
}
return nil
}
func (v *Validate) getDocument(table *entries.Table) validate_utils.Documenter {
switch v.config.Validate.Format {
case JsonFormat:
return validate_utils.NewJsonDocument(table, v.config.Validate.Diff, v.config.Validate.OnlyTransformed)
case TextFormat:
return validate_utils.NewTextDocument(
table, v.config.Validate.Diff, v.config.Validate.OnlyTransformed, v.config.Validate.TableFormat,
)
default:
panic(fmt.Sprintf("unknown format %s", v.config.Validate.Format))
}
}
func (v *Validate) getReader(ctx context.Context, table *entries.Table) (closeFunc, *bufio.Reader, error) {
tableData, err := v.st.GetObject(ctx, fmt.Sprintf("%d.dat.gz", table.DumpId))
if err != nil {
return nil, nil, fmt.Errorf("unable to get object from storage: %w", err)
}
gz, err := gzip.NewReader(tableData)
if err != nil {
tableData.Close()
return nil, nil, fmt.Errorf("cannot create gzip reader: %w", err)
}
f := func() {
if err := tableData.Close(); err != nil {
log.Warn().Err(err).Msg("caused error when closing reader object")
}
if err := gz.Close(); err != nil {
log.Warn().Err(err).Msg("caused error when closing gzip reader")
}
}
return f, bufio.NewReader(gz), nil
}
func (v *Validate) readRecords(r *bufio.Reader, t *entries.Table) (original, transformed *pgcopy.Row, err error) {
var originalLine, transformedLine []byte
var originalRow, transformedRow *pgcopy.Row
originalRow = pgcopy.NewRow(len(t.Columns))
transformedRow = pgcopy.NewRow(len(t.Columns))
originalLine, err = reader.ReadLine(r)
if err != nil {
if errors.Is(err, io.EOF) {
return nil, nil, err
}
return nil, nil, fmt.Errorf("unable to read line: %w", err)
}
// Handle end of dump_objects file seq
if validate_utils.LineIsEndOfData(originalLine) {
return nil, nil, io.EOF
}
transformedLine, err = reader.ReadLine(r)
if err != nil {
return nil, nil, fmt.Errorf("unable to read line: %w", err)
}
if err = originalRow.Decode(originalLine); err != nil {
return nil, nil, fmt.Errorf("error decoding copy line: %w", err)
}
if err = transformedRow.Decode(transformedLine); err != nil {
return nil, nil, fmt.Errorf("error decoding copy line: %w", err)
}
return originalRow, transformedRow, nil
}
func (v *Validate) createDocument(ctx context.Context, t *entries.Table) (validate_utils.Documenter, error) {
doc := v.getDocument(t)
closeReader, r, err := v.getReader(ctx, t)
if err != nil {
return nil, err
}
defer closeReader()
var line int
for {
original, transformed, err := v.readRecords(r, t)
if err != nil {
if errors.Is(err, io.EOF) {
break
}
return nil, err
}
if err := doc.Append(original, transformed); err != nil {
return nil, fmt.Errorf("unable to append line %d to document: %w", line, err)
}
line++
}
return doc, nil
}
func (v *Validate) dumpTables(ctx context.Context) error {
var tablesWithTransformers []entries.Entry
for _, item := range v.context.DataSectionObjects {
if t, ok := item.(*entries.Table); ok && len(t.Transformers) > 0 {
t.ValidateLimitedRecords = v.config.Validate.RowsLimit
tablesWithTransformers = append(tablesWithTransformers, t)
}
}
v.context.DataSectionObjects = tablesWithTransformers
if err := v.dataDump(ctx); err != nil {
return fmt.Errorf("data stage dumping error: %w", err)
}
return nil
}
func (v *Validate) printValidationWarnings() error {
// TODO: Implement warnings hook, such as logging and HTTP sender
for _, w := range v.context.Warnings {
w.MakeHash()
if idx := slices.Index(v.config.Validate.ResolvedWarnings, w.Hash); idx != -1 {
log.Debug().Str("hash", w.Hash).Msg("resolved warning has been excluded")
if w.Severity == toolkit.ErrorValidationSeverity {
return fmt.Errorf("warning with hash %s cannot be excluded because it is an error", w.Hash)
}
continue
}
if w.Severity == toolkit.ErrorValidationSeverity {
// The warnings with error severity must be printed anyway
log.Error().Any("ValidationWarning", w).Msg("")
} else {
// Print warnings with severity level lower than ErrorValidationSeverity only if requested
if v.config.Validate.Warnings {
log.Warn().Any("ValidationWarning", w).Msg("")
}
}
}
if v.context.IsFatal() {
return fmt.Errorf("fatal validation error")
}
return nil
}
func (v *Validate) getTablesToValidate() ([]*domains.Table, error) {
var tablesToValidate []*domains.Table
for _, tv := range v.config.Validate.Tables {
schemaName, tableName, err := parseTableName(tv)
if err != nil {
return nil, err
}
foundTable, err := findTableBySchemaAndName(v.config.Dump.Transformation, schemaName, tableName)
if err != nil {
return nil, err
}
if foundTable != nil {
tablesToValidate = append(tablesToValidate, foundTable)
}
}
if len(tablesToValidate) == 0 {
return v.config.Dump.Transformation, nil
}
return tablesToValidate, nil
}
func (v *Validate) diffWithPreviousSchema(ctx context.Context) error {
if !v.config.Validate.Schema {
return nil
}
dumpId, err := v.getPreviousDumpId(ctx)
if err != nil {
return fmt.Errorf("cannot get previous dump id: %w", err)
}
if dumpId == "" {
return nil
}
md, err := v.getPreviousMetadata(ctx, dumpId)
if err != nil {
return fmt.Errorf("cannot get previous metadata: %w", err)
}
diff := md.DatabaseSchema.Diff(v.context.DatabaseSchema)
if len(diff) > 0 {
v.exitCode = nonZeroExitCode
err = v.printSchemaDiff(diff, dumpId)
if err != nil {
return fmt.Errorf("cannot print schema diff: %w", err)
}
}
return nil
}
func (v *Validate) printSchemaDiff(diff []*toolkit.DiffNode, previousDumpId string) error {
if v.config.Validate.Format == JsonFormat {
data, err := json.Marshal(diff)
if err != nil {
return fmt.Errorf("cannot encode diff node: %w", err)
}
log.Warn().
Str("PreviousDumpId", previousDumpId).
RawJSON("Diff", data).
Str("Hint", "Check schema changes before making new dump").
Msg("Database schema has been changed")
return nil
}
log.Warn().
Str("PreviousDumpId", previousDumpId).
Str("Hint", "Check schema changes before making new dump").
Msg("Database schema has been changed")
for _, node := range diff {
log.Warn().
Str("Event", node.Event).
Any("Signature", node.Signature).
Msg(toolkit.DiffEventMsgs[node.Event])
}
return nil
}
func (v *Validate) getPreviousDumpId(ctx context.Context) (string, error) {
var backupNames []string
_, dirs, err := v.mainSt.ListDir(ctx)
if err != nil {
return "", fmt.Errorf("cannot walk through directory: %w", err)
}
for _, dir := range dirs {
exists, err := dir.Exists(ctx, "metadata.json")
if err != nil {
return "", fmt.Errorf("cannot check file existence: %w", err)
}
if exists {
backupNames = append(backupNames, dir.Dirname())
}
}
slices.SortFunc(
backupNames, func(a, b string) int {
if a > b {
return -1
}
return 1
},
)
if len(backupNames) > 0 {
return backupNames[0], nil
}
return "", nil
}
func (v *Validate) getPreviousMetadata(ctx context.Context, dumpId string) (*storageDto.Metadata, error) {
st := v.mainSt.SubStorage(dumpId, true)
f, err := st.GetObject(ctx, MetadataJsonFileName)
if err != nil {
return nil, fmt.Errorf("cannot open metadata file: %w", err)
}
defer f.Close()
previousMetadata := &storageDto.Metadata{}
if err = json.NewDecoder(f).Decode(&previousMetadata); err != nil {
return nil, fmt.Errorf("cannot decode metadata file: %w", err)
}
return previousMetadata, nil
}
func findTableBySchemaAndName(Transformations []*domains.Table, schemaName, tableName string) (*domains.Table, error) {
var foundTable *domains.Table
for _, t := range Transformations {
if t.Schema == schemaName && t.Name == tableName {
foundTable = t
break
}
if schemaName == "" && t.Name == tableName {
if foundTable != nil {
return nil, fmt.Errorf("wrong \"validate_table\" value: unable uniqually identify table \"%s\": sepcify schema name", tableName)
}
foundTable = t
}
}
if foundTable == nil {
errMsg := fmt.Sprintf("table %s is not found in transformation config", tableName)
if schemaName != "" && tableName != "" {
errMsg = fmt.Sprintf("table %s.%s is not found in transformation config", schemaName, tableName)
}
return nil, fmt.Errorf("unable to find table from \"validate_table\" parameter: %s", errMsg)
}
return foundTable, nil
}
func parseTableName(name string) (tableName string, schemaName string, err error) {
parts := strings.Split(name, ".")
if len(parts) > 2 {
return "", "", fmt.Errorf("wrong \"validate_table\" format \"%s\": value has %d coma symbols (.)", name, len(parts))
} else if len(parts) == 2 {
schemaName = parts[0]
tableName = parts[1]
} else {
tableName = parts[0]
}
return
}