-
Notifications
You must be signed in to change notification settings - Fork 2
/
script.go
684 lines (622 loc) · 17.4 KB
/
script.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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium
package statedb
import (
"bytes"
"encoding/json"
"errors"
"flag"
"fmt"
"io"
"iter"
"maps"
"os"
"regexp"
"slices"
"strings"
"text/tabwriter"
"time"
"github.com/cilium/hive"
"github.com/cilium/hive/script"
"gopkg.in/yaml.v3"
)
func ScriptCommands(db *DB) hive.ScriptCmdOut {
subCmds := map[string]script.Cmd{
"tables": TablesCmd(db),
"show": ShowCmd(db),
"cmp": CompareCmd(db),
"insert": InsertCmd(db),
"delete": DeleteCmd(db),
"get": GetCmd(db),
"prefix": PrefixCmd(db),
"list": ListCmd(db),
"lowerbound": LowerBoundCmd(db),
"initialized": InitializedCmd(db),
}
subCmdsList := strings.Join(slices.Collect(maps.Keys(subCmds)), ", ")
return hive.NewScriptCmd(
"db",
script.Command(
script.CmdUsage{
Summary: "Inspect and manipulate StateDB",
Args: "cmd args...",
Detail: []string{
"Supported commands: " + subCmdsList,
},
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
if len(args) < 1 {
return nil, fmt.Errorf("expected command (%s)", subCmdsList)
}
cmd, ok := subCmds[args[0]]
if !ok {
return nil, fmt.Errorf("command not found, expected one of %s", subCmdsList)
}
wf, err := cmd.Run(s, args[1:]...)
if errors.Is(err, errUsage) {
s.Logf("usage: db %s %s\n", args[0], cmd.Usage().Args)
}
return wf, err
},
),
)
}
var errUsage = errors.New("bad arguments")
func TablesCmd(db *DB) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "Show StateDB tables",
Args: "table",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
txn := db.ReadTxn()
tbls := db.GetTables(txn)
w := tabwriter.NewWriter(s.LogWriter(), 5, 4, 3, ' ', 0)
fmt.Fprintf(w, "Name\tObject count\tDeleted objects\tIndexes\tInitializers\tGo type\tLast WriteTxn\n")
for _, tbl := range tbls {
idxs := strings.Join(tbl.Indexes(), ", ")
fmt.Fprintf(w, "%s\t%d\t%d\t%s\t%v\t%T\t%s\n",
tbl.Name(), tbl.NumObjects(txn), tbl.numDeletedObjects(txn), idxs, tbl.PendingInitializers(txn), tbl.proto(), tbl.getAcquiredInfo())
}
w.Flush()
return nil, nil
},
)
}
func newCmdFlagSet() *flag.FlagSet {
return &flag.FlagSet{
// Disable showing the normal usage.
Usage: func() {},
}
}
func InitializedCmd(db *DB) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "Wait until all or specific tables have been initialized",
Args: "(-timeout=<duration>) table...",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
txn := db.ReadTxn()
allTbls := db.GetTables(txn)
tbls := allTbls
flags := newCmdFlagSet()
timeout := flags.Duration("timeout", 5*time.Second, "Maximum amount of time to wait for the table contents to match")
if err := flags.Parse(args); err != nil {
return nil, fmt.Errorf("%w: %s", errUsage, err)
}
timeoutChan := time.After(*timeout)
args = flags.Args()
if len(args) > 0 {
// Specific tables requested, look them up.
tbls = make([]TableMeta, 0, len(args))
for _, tableName := range args {
found := false
for _, tbl := range allTbls {
if tableName == tbl.Name() {
tbls = append(tbls, tbl)
found = true
break
}
}
if !found {
return nil, fmt.Errorf("table %q not found", tableName)
}
}
}
for _, tbl := range tbls {
init, watch := tbl.Initialized(txn)
if init {
s.Logf("%s initialized\n", tbl.Name())
continue
}
s.Logf("Waiting for %s to initialize (%v)...\n", tbl.Name(), tbl.PendingInitializers(txn))
select {
case <-s.Context().Done():
return nil, s.Context().Err()
case <-timeoutChan:
return nil, fmt.Errorf("timed out")
case <-watch:
s.Logf("%s initialized\n", tbl.Name())
}
}
return nil, nil
},
)
}
func ShowCmd(db *DB) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "Show table",
Args: "(-o=<file>) (-columns=col1,...) (-format={table,yaml,json}) table",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
flags := newCmdFlagSet()
file := flags.String("o", "", "File to write to instead of stdout")
columns := flags.String("columns", "", "Comma-separated list of columns to write")
format := flags.String("format", "table", "Format to write in (table, yaml, json)")
if err := flags.Parse(args); err != nil {
return nil, fmt.Errorf("%w: %s", errUsage, err)
}
var cols []string
if len(*columns) > 0 {
cols = strings.Split(*columns, ",")
}
args = flags.Args()
if len(args) < 1 {
return nil, fmt.Errorf("%w: missing table name", errUsage)
}
tableName := args[0]
return func(*script.State) (stdout, stderr string, err error) {
var buf strings.Builder
var w io.Writer
if *file == "" {
w = &buf
} else {
f, err := os.OpenFile(s.Path(*file), os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
if err != nil {
return "", "", fmt.Errorf("OpenFile(%s): %w", *file, err)
}
defer f.Close()
w = f
}
tbl, txn, err := getTable(db, tableName)
if err != nil {
return "", "", err
}
err = writeObjects(tbl, tbl.All(txn), w, cols, *format)
return buf.String(), "", err
}, nil
})
}
func CompareCmd(db *DB) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "Compare table",
Args: "table file (-timeout=<dur>) (-grep=<pattern>)",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
flags := newCmdFlagSet()
timeout := flags.Duration("timeout", time.Second, "Maximum amount of time to wait for the table contents to match")
grep := flags.String("grep", "", "Grep the result rows and only compare matching ones")
err := flags.Parse(args)
args = flags.Args()
if err != nil || len(args) != 2 {
return nil, fmt.Errorf("%w: %s", errUsage, err)
}
var grepRe *regexp.Regexp
if *grep != "" {
grepRe, err = regexp.Compile(*grep)
if err != nil {
return nil, fmt.Errorf("bad grep: %w", err)
}
}
tableName := args[0]
txn := db.ReadTxn()
meta := db.GetTable(txn, tableName)
if meta == nil {
return nil, fmt.Errorf("table %q not found", tableName)
}
tbl := AnyTable{Meta: meta}
header := tbl.TableHeader()
data, err := os.ReadFile(s.Path(args[1]))
if err != nil {
return nil, fmt.Errorf("ReadFile(%s): %w", args[1], err)
}
lines := strings.Split(string(data), "\n")
lines = slices.DeleteFunc(lines, func(line string) bool {
return strings.TrimSpace(line) == ""
})
if len(lines) < 1 {
return nil, fmt.Errorf("%q missing header line, e.g. %q", args[1], strings.Join(header, " "))
}
columnNames, columnPositions := splitHeaderLine(lines[0])
columnIndexes, err := getColumnIndexes(columnNames, header)
if err != nil {
return nil, err
}
lines = lines[1:]
origLines := lines
timeoutChan := time.After(*timeout)
for {
lines = origLines
// Create the diff between 'lines' and the rows in the table.
equal := true
var diff bytes.Buffer
w := tabwriter.NewWriter(&diff, 5, 4, 3, ' ', 0)
fmt.Fprintf(w, " %s\n", joinByPositions(columnNames, columnPositions))
objs, watch := tbl.AllWatch(db.ReadTxn())
for obj := range objs {
rowRaw := takeColumns(obj.(TableWritable).TableRow(), columnIndexes)
row := joinByPositions(rowRaw, columnPositions)
if grepRe != nil && !grepRe.Match([]byte(row)) {
continue
}
if len(lines) == 0 {
equal = false
fmt.Fprintf(w, "- %s\n", row)
continue
}
line := lines[0]
splitLine := splitByPositions(line, columnPositions)
if slices.Equal(rowRaw, splitLine) {
fmt.Fprintf(w, " %s\n", row)
} else {
fmt.Fprintf(w, "- %s\n", row)
fmt.Fprintf(w, "+ %s\n", line)
equal = false
}
lines = lines[1:]
}
for _, line := range lines {
fmt.Fprintf(w, "+ %s\n", line)
equal = false
}
if equal {
return nil, nil
}
w.Flush()
select {
case <-s.Context().Done():
return nil, s.Context().Err()
case <-timeoutChan:
return nil, fmt.Errorf("table mismatch:\n%s", diff.String())
case <-watch:
}
}
})
}
func InsertCmd(db *DB) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "Insert object into a table",
Args: "table path...",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
return insertOrDelete(true, db, s, args...)
},
)
}
func DeleteCmd(db *DB) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: "Delete an object from the table",
Args: "table path...",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
return insertOrDelete(false, db, s, args...)
},
)
}
func getTable(db *DB, tableName string) (*AnyTable, ReadTxn, error) {
txn := db.ReadTxn()
meta := db.GetTable(txn, tableName)
if meta == nil {
return nil, nil, fmt.Errorf("table %q not found", tableName)
}
return &AnyTable{Meta: meta}, txn, nil
}
func insertOrDelete(insert bool, db *DB, s *script.State, args ...string) (script.WaitFunc, error) {
if len(args) < 2 {
return nil, fmt.Errorf("%w: expected table and path(s)", errUsage)
}
tbl, _, err := getTable(db, args[0])
if err != nil {
return nil, err
}
wtxn := db.WriteTxn(tbl.Meta)
defer wtxn.Commit()
for _, arg := range args[1:] {
data, err := os.ReadFile(s.Path(arg))
if err != nil {
return nil, fmt.Errorf("ReadFile(%s): %w", arg, err)
}
parts := strings.Split(string(data), "---")
for _, part := range parts {
obj, err := tbl.UnmarshalYAML([]byte(part))
if err != nil {
return nil, fmt.Errorf("Unmarshal(%s): %w", arg, err)
}
if insert {
_, _, err = tbl.Insert(wtxn, obj)
if err != nil {
return nil, fmt.Errorf("Insert(%s): %w", arg, err)
}
} else {
_, _, err = tbl.Delete(wtxn, obj)
if err != nil {
return nil, fmt.Errorf("Delete(%s): %w", arg, err)
}
}
}
}
return nil, nil
}
func PrefixCmd(db *DB) script.Cmd {
return queryCmd(db, queryCmdPrefix, "Query table by prefix")
}
func LowerBoundCmd(db *DB) script.Cmd {
return queryCmd(db, queryCmdLowerBound, "Query table by lower bound search")
}
func ListCmd(db *DB) script.Cmd {
return queryCmd(db, queryCmdList, "List objects in the table")
}
func GetCmd(db *DB) script.Cmd {
return queryCmd(db, queryCmdGet, "Get the first matching object")
}
const (
queryCmdList = iota
queryCmdPrefix
queryCmdLowerBound
queryCmdGet
)
func queryCmd(db *DB, query int, summary string) script.Cmd {
return script.Command(
script.CmdUsage{
Summary: summary,
Args: "(-o=<file>) (-columns=col1,...) (-format={table*,yaml,json}) (-index=<index>) table key",
},
func(s *script.State, args ...string) (script.WaitFunc, error) {
return runQueryCmd(query, db, s, args)
},
)
}
func runQueryCmd(query int, db *DB, s *script.State, args []string) (script.WaitFunc, error) {
flags := newCmdFlagSet()
file := flags.String("o", "", "File to write results to instead of stdout")
index := flags.String("index", "", "Index to query")
format := flags.String("format", "table", "Format to write in (table, yaml, json)")
columns := flags.String("columns", "", "Comma-separated list of columns to write")
delete := flags.Bool("delete", false, "Delete all matching objects")
if err := flags.Parse(args); err != nil {
return nil, fmt.Errorf("%w: %s", errUsage, err)
}
var cols []string
if len(*columns) > 0 {
cols = strings.Split(*columns, ",")
}
args = flags.Args()
if len(args) < 2 {
return nil, fmt.Errorf("%w: expected table and key", errUsage)
}
return func(*script.State) (stdout, stderr string, err error) {
tbl, txn, err := getTable(db, args[0])
if err != nil {
return "", "", err
}
var buf strings.Builder
var w io.Writer
if *file == "" {
w = &buf
} else {
f, err := os.OpenFile(s.Path(*file), os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
if err != nil {
return "", "", fmt.Errorf("OpenFile(%s): %s", *file, err)
}
defer f.Close()
w = f
}
var it iter.Seq2[any, uint64]
switch query {
case queryCmdList:
it, err = tbl.List(txn, *index, args[1])
case queryCmdLowerBound:
it, err = tbl.LowerBound(txn, *index, args[1])
case queryCmdPrefix:
it, err = tbl.Prefix(txn, *index, args[1])
case queryCmdGet:
it, err = tbl.List(txn, *index, args[1])
if err == nil {
it = firstOfSeq2(it)
}
default:
panic("unknown query enum")
}
if err != nil {
return "", "", fmt.Errorf("query: %w", err)
}
err = writeObjects(tbl, it, w, cols, *format)
if err != nil {
return "", "", err
}
if *delete {
wtxn := db.WriteTxn(tbl.Meta)
count := 0
for obj := range it {
_, hadOld, err := tbl.Delete(wtxn, obj)
if err != nil {
wtxn.Abort()
return "", "", err
}
if hadOld {
count++
}
}
s.Logf("Deleted %d objects\n", count)
wtxn.Commit()
}
return buf.String(), "", err
}, nil
}
func firstOfSeq2[A, B any](it iter.Seq2[A, B]) iter.Seq2[A, B] {
return func(yield func(a A, b B) bool) {
for a, b := range it {
yield(a, b)
break
}
}
}
func writeObjects(tbl *AnyTable, it iter.Seq2[any, Revision], w io.Writer, columns []string, format string) error {
if len(columns) > 0 && format != "table" {
return fmt.Errorf("-columns not supported with non-table formats")
}
switch format {
case "yaml":
sep := []byte("---\n")
first := true
for obj := range it {
if !first {
w.Write(sep)
}
first = false
out, err := yaml.Marshal(obj)
if err != nil {
return fmt.Errorf("yaml.Marshal: %w", err)
}
if _, err := w.Write(out); err != nil {
return err
}
}
return nil
case "json":
sep := []byte("\n")
first := true
for obj := range it {
if !first {
w.Write(sep)
}
first = false
out, err := json.Marshal(obj)
if err != nil {
return fmt.Errorf("json.Marshal: %w", err)
}
if _, err := w.Write(out); err != nil {
return err
}
}
return nil
case "table":
header := tbl.TableHeader()
if header == nil {
return fmt.Errorf("objects in table %q not TableWritable", tbl.Meta.Name())
}
var idxs []int
var err error
if len(columns) > 0 {
idxs, err = getColumnIndexes(columns, header)
header = columns
} else {
idxs, err = getColumnIndexes(header, header)
}
if err != nil {
return err
}
tw := tabwriter.NewWriter(w, 5, 4, 3, ' ', 0)
fmt.Fprintf(tw, "%s\n", strings.Join(header, "\t"))
for obj := range it {
row := takeColumns(obj.(TableWritable).TableRow(), idxs)
fmt.Fprintf(tw, "%s\n", strings.Join(row, "\t"))
}
return tw.Flush()
}
return fmt.Errorf("unknown format %q, expected table, yaml or json", format)
}
func takeColumns[T any](xs []T, idxs []int) []T {
// Invariant: idxs is sorted so can set in-place.
for i, idx := range idxs {
xs[i] = xs[idx]
}
return xs[:len(idxs)]
}
func getColumnIndexes(names []string, header []string) ([]int, error) {
columnIndexes := make([]int, 0, len(header))
loop:
for _, name := range names {
for i, name2 := range header {
if strings.EqualFold(name, name2) {
columnIndexes = append(columnIndexes, i)
continue loop
}
}
return nil, fmt.Errorf("column %q not part of %v", name, header)
}
return columnIndexes, nil
}
// splitHeaderLine takes a header of column names separated by any
// number of whitespaces and returns the names and their starting positions.
// e.g. "Foo Bar Baz" would result in ([Foo,Bar,Baz],[0,5,9]).
// With this information we can take a row in the database and format it
// the same way as our test data.
func splitHeaderLine(line string) (names []string, pos []int) {
start := 0
skip := true
for i, r := range line {
switch r {
case ' ', '\t':
if !skip {
names = append(names, line[start:i])
pos = append(pos, start)
start = -1
}
skip = true
default:
skip = false
if start == -1 {
start = i
}
}
}
if start >= 0 && start < len(line) {
names = append(names, line[start:])
pos = append(pos, start)
}
return
}
// splitByPositions takes a "row" line and the positions of the header columns
// and extracts the values.
// e.g. if we have the positions [0,5,9] (from header "Foo Bar Baz") and
// line is "1 a b", then we'd extract [1,a,b].
// The whitespace on the right of the start position (e.g. "1 \t") is trimmed.
// This of course requires that the table is properly formatted in a way that the
// header columns are indented to fit the data exactly.
func splitByPositions(line string, positions []int) []string {
out := make([]string, 0, len(positions))
start := 0
for _, pos := range positions[1:] {
if start >= len(line) {
out = append(out, "")
start = len(line)
continue
}
out = append(out, strings.TrimRight(line[start:min(pos, len(line))], " \t"))
start = pos
}
out = append(out, strings.TrimRight(line[min(start, len(line)):], " \t"))
return out
}
// joinByPositions is the reverse of splitByPositions, it takes the columns of a
// row and the starting positions of each and joins into a single line.
// e.g. [1,a,b] and positions [0,5,9] expands to "1 a b".
// NOTE: This does not deal well with mixing tabs and spaces. The test input
// data should preferably just use spaces.
func joinByPositions(row []string, positions []int) string {
var w strings.Builder
prev := 0
for i, pos := range positions {
for pad := pos - prev; pad > 0; pad-- {
w.WriteByte(' ')
}
w.WriteString(row[i])
prev = pos + len(row[i])
}
return w.String()
}