-
Notifications
You must be signed in to change notification settings - Fork 8
/
cmd.go
479 lines (418 loc) · 13.2 KB
/
cmd.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
// Copyright 2023 Greenmask
//
// 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 transformers
import (
"context"
"errors"
"fmt"
"io"
"os"
"os/exec"
"time"
"github.com/rs/zerolog/log"
"golang.org/x/sync/errgroup"
"github.com/greenmaskio/greenmask/internal/db/postgres/transformers/utils"
"github.com/greenmaskio/greenmask/pkg/toolkit"
)
const (
cmdRowDriverTextName = "text"
cmdRowDriverJsonName = "json"
cmdRowDriverCsvName = "csv"
)
const (
skipOnAny = iota
skipOnAll
)
const (
skipOnAnyName = "any"
skipOnAllName = "all"
)
var defaultRowDriverParams = &toolkit.DriverParams{
Name: toolkit.JsonModeName,
JsonDataFormat: toolkit.JsonTextDataFormatName,
JsonAttributesFormat: toolkit.JsonAttributesNamesFormatName,
CsvAttributesFormat: toolkit.CsvAttributesConfigNumeratingFormatName,
}
var cmdTransformerName = "Cmd"
var CmdTransformerDefinition = utils.NewDefinition(
utils.NewTransformerProperties(
cmdTransformerName,
"Transform data via external program using stdin and stdout interaction",
),
NewCmd,
toolkit.MustNewParameter(
"columns",
"affected column names. If empty use the whole tuple."+
"The structure:"+
`{`+
`"name": "type:string, required:true, description: column Name",`+
`"not_affected": "type:bool, required:false, description: is column affected in transformation", `+
`"skip_original_data": "type:bool, required:false, description: is original data required for transformer",`+
`"skip_on_null_input": "type:bool, required:false, description: skip transformation on null input"`+
`}`,
).SetDefaultValue([]byte("[]")).
SetIsColumnContainer(true),
toolkit.MustNewParameter(
"executable",
"path to executable file",
).SetRequired(true),
toolkit.MustNewParameter(
"args",
"list of parameters for executable file",
).SetDefaultValue([]byte("[]")),
toolkit.MustNewParameter(
"driver",
"row driver with parameters that is used for interacting with cmd. The default is csv. "+
`The structure is:`+
`{"name": "text|csv|json", "params": { "format": "[text|bytes]"} }`,
).SetDefaultValue([]byte(`{"name": "csv"}`)),
toolkit.MustNewParameter(
"validate",
"try to encode-decode data received from cmd",
).SetDefaultValue([]byte("false")),
toolkit.MustNewParameter(
"timeout",
"timeout for sending and receiving data from cmd",
).SetDefaultValue([]byte("2s")),
toolkit.MustNewParameter(
"expected_exit_code",
"expected exit code",
).SetDefaultValue([]byte("0")),
toolkit.MustNewParameter(
"skip_on_behaviour",
"skip transformation call if one of the provided columns has null value (any) or each of the provided"+
" column has null values (all). This option works together with skip_on_null_input parameter on columns."+
`Possible values: "all", "any"`,
).SetDefaultValue([]byte("all")).
SetRawValueValidator(cmdValidateSkipBehaviour),
)
type Column struct {
Name string `json:"name"`
NotAffected bool `json:"not_affected"`
SkipOnNullInput bool `json:"skip_on_null_input"`
SkipOriginalData bool `json:"skip_original_data"`
}
type Cmd struct {
*utils.CmdTransformerBase
Columns []*Column
name string
executable string
args []string
validateOutput bool
timeout time.Duration
expectedExitCode int
affectedColumns map[int]string
affectedColumnsIdx []*toolkit.Column
transferringColumnsIdx []*toolkit.Column
allColumnsIdx []int
skipOnBehaviour int
checkSkip bool
rowDriverParams *toolkit.DriverParams
driver *toolkit.Driver
t *time.Ticker
eg *errgroup.Group
}
func NewCmd(
ctx context.Context, driver *toolkit.Driver, parameters map[string]*toolkit.Parameter,
) (utils.Transformer, toolkit.ValidationWarnings, error) {
name := cmdTransformerName
var columns []*Column
var executable string
var args []string
var validate bool
var timeout time.Duration
var expectedExitCode int
var skipOnBehaviourName string
var skipOnBehaviour = skipOnAll
var checkSkip bool
rowDriverParams := &(*defaultRowDriverParams)
p := parameters["columns"]
if _, err := p.Scan(&columns); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "columns" param: %w`, err)
}
p = parameters["executable"]
if _, err := p.Scan(&executable); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "executable" param: %w`, err)
}
p = parameters["args"]
if _, err := p.Scan(&args); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "args" param: %w`, err)
}
p = parameters["driver"]
if _, err := p.Scan(rowDriverParams); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "mode" param: %w`, err)
}
if err := rowDriverParams.Validate(); err != nil {
return nil, nil, fmt.Errorf("error validating driver params: %w", err)
}
p = parameters["validate"]
if _, err := p.Scan(&validate); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "validate" param: %w`, err)
}
p = parameters["timeout"]
if _, err := p.Scan(&timeout); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "timeout" param: %w`, err)
}
p = parameters["expected_exit_code"]
if _, err := p.Scan(&expectedExitCode); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "expected_exit_code" param: %w`, err)
}
p = parameters["skip_on_behaviour"]
if _, err := p.Scan(&skipOnBehaviourName); err != nil {
return nil, nil, fmt.Errorf(`unable to scan "skip_on_behaviour" param: %w`, err)
}
if skipOnBehaviourName == skipOnAnyName {
skipOnBehaviour = skipOnAny
}
affectedColumns := make(map[int]string)
var warnings toolkit.ValidationWarnings
var affectedColumnsIdx []*toolkit.Column
var transferringColumnsIdx []*toolkit.Column
var allColumnsIdx []int
if len(columns) > 0 {
for num, c := range columns {
var added bool
if c.SkipOnNullInput {
checkSkip = true
}
idx, column, ok := driver.GetColumnByName(c.Name)
if !ok {
warnings = append(warnings, toolkit.NewValidationWarning().
AddMeta("ElementNum", num).
AddMeta("ColumnName", c.Name).
SetSeverity(toolkit.ErrorValidationSeverity).
SetMsg("column not found"))
continue
}
allColumnsIdx = append(allColumnsIdx, idx)
if !c.NotAffected {
added = true
affectedColumns[idx] = c.Name
affectedColumnsIdx = append(affectedColumnsIdx, column)
warns := utils.ValidateSchema(driver.Table, column, nil)
warnings = append(warnings, warns...)
}
if !c.SkipOriginalData {
added = true
transferringColumnsIdx = append(transferringColumnsIdx, column)
}
if !added {
warnings = append(warnings, toolkit.NewValidationWarning().
AddMeta("ElementNum", num).
AddMeta("ColumnName", c.Name).
SetSeverity(toolkit.ErrorValidationSeverity).
SetMsg("column not added either into transferred list or affected list"))
continue
}
}
} else {
for _, c := range driver.Table.Columns {
transferringColumnsIdx = append(transferringColumnsIdx, c)
affectedColumnsIdx = append(affectedColumnsIdx, c)
}
}
if warnings.IsFatal() {
return nil, warnings, nil
}
api, err := toolkit.NewApi(rowDriverParams, transferringColumnsIdx, affectedColumnsIdx, driver)
if err != nil {
return nil, nil, fmt.Errorf("error creating InteractionApi: %w", err)
}
cct := utils.NewCmdTransformerBase(name, expectedExitCode, timeout, driver, api)
ct := &Cmd{
CmdTransformerBase: cct,
driver: driver,
name: name,
Columns: columns,
executable: executable,
args: args,
rowDriverParams: rowDriverParams,
validateOutput: validate,
timeout: timeout,
expectedExitCode: expectedExitCode,
affectedColumns: affectedColumns,
affectedColumnsIdx: affectedColumnsIdx,
transferringColumnsIdx: transferringColumnsIdx,
allColumnsIdx: allColumnsIdx,
skipOnBehaviour: skipOnBehaviour,
checkSkip: checkSkip,
}
return ct, warnings, nil
}
func (c *Cmd) GetAffectedColumns() map[int]string {
return c.affectedColumns
}
func (c *Cmd) Init(ctx context.Context) error {
if err := c.BaseInit(c.executable, c.args); err != nil {
return err
}
c.eg = &errgroup.Group{}
c.eg.Go(func() error {
return c.stderrForwarder(ctx)
})
c.eg.Go(func() error {
if err := c.Cmd.Wait(); err != nil {
var exitErr *exec.ExitError
if errors.As(err, &exitErr) {
if exitErr.ExitCode() != c.expectedExitCode {
log.Warn().
Str("TableSchema", c.driver.Table.Schema).
Str("TableName", c.driver.Table.Name).
Str("TransformerName", c.name).
Int("TransformerExitCode", c.Cmd.ProcessState.ExitCode()).
Msg("unexpected exit code")
return fmt.Errorf("unexpeted command exit code: exepected %d received %d",
c.expectedExitCode, c.Cmd.ProcessState.ExitCode())
}
return nil
} else {
log.Error().
Err(err).
Str("TableSchema", c.driver.Table.Schema).
Str("TableName", c.driver.Table.Name).
Str("TransformerName", c.name).
Int("TransformerPid", c.Cmd.Process.Pid).
Msg("cmd transformer exited with error")
return fmt.Errorf("transformer exited with error: %w", err)
}
}
log.Debug().
Str("TableSchema", c.driver.Table.Schema).
Str("TableName", c.driver.Table.Name).
Str("TransformerName", c.name).
Int("TransformerPid", c.Cmd.Process.Pid).
Msg("transformer exited normally")
return nil
})
return nil
}
func (c *Cmd) Done(ctx context.Context) error {
if err := c.BaseDone(); err != nil {
return err
}
if err := c.eg.Wait(); err != nil {
log.Warn().
Err(err).
Str("TableSchema", c.driver.Table.Schema).
Str("TableName", c.driver.Table.Name).
Str("TransformerName", c.name).
Msg("cmd transformer goroutine exited with error")
return fmt.Errorf("cmd transformer goroutine exited with error: %w", err)
}
return nil
}
func (c *Cmd) stderrForwarder(ctx context.Context) error {
for {
line, err := c.ReceiveStderrLine(ctx)
if err != nil {
if errors.Is(err, io.EOF) || errors.Is(err, os.ErrClosed) {
return nil
}
log.Debug().Err(err).Msg("line reader error")
return err
}
log.Warn().
Str("TableSchema", c.driver.Table.Schema).
Str("TableName", c.driver.Table.Name).
Str("TransformerName", c.name).
Int("TransformerPid", c.Cmd.Process.Pid).
Msg("stderr forwarding")
fmt.Printf("\tDATA: %s\n", string(line))
select {
case <-ctx.Done():
return nil
default:
}
}
}
func (c *Cmd) needSkip(r *toolkit.Record) (bool, error) {
var score int
for _, idx := range c.allColumnsIdx {
v, err := r.GetRawColumnValueByIdx(idx)
if err != nil {
return false, fmt.Errorf("error getting raw attribute value: %w", err)
}
if v.IsNull {
score++
}
}
if score == len(c.allColumnsIdx) && skipOnAll == c.skipOnBehaviour {
return true, nil
} else if score > 0 && skipOnAny == c.skipOnBehaviour {
return true, nil
}
return false, nil
}
func (c *Cmd) validate(r *toolkit.Record) error {
for _, col := range c.affectedColumnsIdx {
_, err := r.GetColumnValueByIdx(col.Idx)
if err != nil {
return fmt.Errorf("error validating received attribute \"%s\" value from cmd: %w", r.Driver.Table.Columns[col.Idx].Name, err)
}
}
return nil
}
func (c *Cmd) Transform(ctx context.Context, r *toolkit.Record) (*toolkit.Record, error) {
var err error
if c.checkSkip {
var skip bool
skip, err = c.needSkip(r)
if err != nil {
return nil, err
}
if skip {
c.CmdTransformerBase.ProcessedLines++
return r, nil
}
}
r, err = c.CmdTransformerBase.Transform(ctx, r)
if err != nil {
return nil, err
}
if c.validateOutput {
if err = c.validate(r); err != nil {
return nil, fmt.Errorf("tuple validation error: %w", err)
}
}
return r, nil
}
func cmdValidateFormat(p *toolkit.Parameter, v toolkit.ParamsValue) (toolkit.ValidationWarnings, error) {
value := string(v)
if value != cmdRowDriverCsvName && value != cmdRowDriverTextName &&
value != cmdRowDriverJsonName {
return toolkit.ValidationWarnings{
toolkit.NewValidationWarning().
AddMeta("ParameterName", p.Name).
AddMeta("ParameterValue", value).
SetSeverity(toolkit.ErrorValidationSeverity).
SetMsg("unsupported format type: must be one of csv, json, text"),
}, nil
}
return nil, nil
}
func cmdValidateSkipBehaviour(p *toolkit.Parameter, v toolkit.ParamsValue) (toolkit.ValidationWarnings, error) {
value := string(v)
if value != skipOnAnyName && value != skipOnAllName {
return toolkit.ValidationWarnings{
toolkit.NewValidationWarning().
SetSeverity(toolkit.ErrorValidationSeverity).
AddMeta("ParameterValue", value).
SetMsg(`unsupported skip_on type: must be one of "all" or "any"`),
}, nil
}
return nil, nil
}
func init() {
utils.DefaultTransformerRegistry.MustRegister(CmdTransformerDefinition)
}