-
Notifications
You must be signed in to change notification settings - Fork 287
/
utils_for_test.go
676 lines (589 loc) · 16 KB
/
utils_for_test.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
// Copyright (c) 2016-2018 Tigera, Inc. All rights reserved.
//
// 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 ipsets_test
import (
"errors"
"fmt"
"io"
"os/exec"
"strconv"
"strings"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
log "github.com/sirupsen/logrus"
"bufio"
"time"
"bytes"
"regexp"
. "github.com/projectcalico/felix/ipsets"
"github.com/projectcalico/libcalico-go/lib/set"
)
// This file contains shared test infrastructure for testing the ipsets package.
var (
transientFailure = errors.New("Simulated transient failure")
permanentFailure = errors.New("Simulated permanent failure")
)
func newMockDataplane() *mockDataplane {
return &mockDataplane{
IPSetMembers: make(map[string]set.Set),
IPSetMetadata: make(map[string]setMetadata),
FailDestroyNames: set.New(),
}
}
type mockDataplane struct {
IPSetMembers map[string]set.Set
IPSetMetadata map[string]setMetadata
Cmds []CmdIface
CmdNames []string
FailAllRestores bool
FailAllLists bool
ListOpFailures []string
RestoreOpFailures []string
FailNextDestroy bool
FailDestroyNames set.Set
// Record when various (expected) error cases are hit.
TriedToDeleteNonExistent bool
TriedToAddExistent bool
AttemptedDestroys []string
CumulativeSleep time.Duration
}
func (d *mockDataplane) ExpectMembers(expected map[string][]string) {
// Input has a slice for each set, convert to a set for comparison.
membersToCompare := map[string]set.Set{}
for name, members := range expected {
memberSet := set.New()
for _, member := range members {
memberSet.Add(member)
}
membersToCompare[name] = memberSet
}
Expect(d.IPSetMembers).To(Equal(membersToCompare))
}
func (d *mockDataplane) newCmd(name string, arg ...string) CmdIface {
if name != "ipset" {
Fail("Unknown command: " + name)
}
var cmd CmdIface
switch arg[0] {
case "restore":
Expect(len(arg)).To(Equal(1))
cmd = &restoreCmd{
Dataplane: d,
resultC: make(chan error),
}
case "destroy":
Expect(len(arg)).To(Equal(2))
name := arg[1]
cmd = &destroyCmd{
Dataplane: d,
SetName: name,
}
case "list":
Expect(len(arg)).To(Equal(1))
cmd = &listCmd{
Dataplane: d,
resultC: make(chan error),
}
default:
Fail(fmt.Sprintf("Unexpected command %v", arg))
}
d.Cmds = append(d.Cmds, cmd)
d.CmdNames = append(d.CmdNames, arg[0])
return cmd
}
func (d *mockDataplane) sleep(t time.Duration) {
d.CumulativeSleep += t
}
func (d *mockDataplane) popListOpFailure(failType string) bool {
if len(d.ListOpFailures) > 0 && d.ListOpFailures[0] == failType {
log.WithField("failureType", failType).Warn("About to simulate list failure")
d.ListOpFailures = d.ListOpFailures[1:]
return true
}
return false
}
func (d *mockDataplane) popRestoreFailure(failType string) bool {
if len(d.RestoreOpFailures) > 0 && d.RestoreOpFailures[0] == failType {
log.WithField("failureType", failType).Warn("About to simulate restore failure")
d.RestoreOpFailures = d.RestoreOpFailures[1:]
return true
}
return false
}
type restoreCmd struct {
Dataplane *mockDataplane
SetName string
Stdin io.Reader
Stderr io.Writer
Stdout io.Writer
resultC chan error
}
func (c *restoreCmd) SetStdin(r io.Reader) {
c.Stdin = r
}
func (c *restoreCmd) SetStderr(r io.Writer) {
c.Stderr = r
}
func (c *restoreCmd) SetStdout(r io.Writer) {
c.Stdout = r
}
func (c *restoreCmd) StdinPipe() (WriteCloserFlusher, error) {
log.Info("Restore command asked for a stdin pipe")
if c.Dataplane.popRestoreFailure("pipe") {
log.Warn("Simulating failure to create pipe")
return nil, transientFailure
}
if c.Dataplane.popRestoreFailure("write") {
log.Warn("Returning a bad pipe that will fail writes")
return &badPipe{}, nil
}
if c.Dataplane.popRestoreFailure("write-ip") {
log.Warn("Returning a bad pipe that will fail when writing an IP")
return &badPipe{
FirstWriteFailRegexp: regexp.MustCompile(`\s*\d+\.\d+\.\d+\.\d+\s*`),
}, nil
}
if c.Dataplane.popRestoreFailure("close") {
log.Warn("Returning a bad pipe that will fail when closedP")
return &badPipe{
CloseFail: true,
}, nil
}
pipeR, pipeW := io.Pipe()
c.Stdin = pipeR
buf := bufio.NewWriter(pipeW)
return &BufferedCloser{
BufWriter: buf,
Closer: pipeW,
}, nil
}
func (c *restoreCmd) StdoutPipe() (io.ReadCloser, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (c *restoreCmd) Start() error {
log.Info("Restore command started")
if c.Dataplane.popRestoreFailure("start") {
return transientFailure
}
go c.main()
return nil
}
func (c *restoreCmd) Wait() error {
return <-c.resultC
}
func (c *restoreCmd) Output() ([]byte, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (c *restoreCmd) main() {
defer GinkgoRecover()
var result error
defer func() {
log.WithField("procResult", result).Info("restore command main is exiting")
if c.Stdin != nil && result != nil {
c.Stdin.(io.Closer).Close()
}
c.resultC <- result
}()
if c.Dataplane.FailAllRestores {
log.Warn("Restore command permanent failure")
result = permanentFailure
return
}
if c.Dataplane.popRestoreFailure("pre-update") {
log.Warn("Restore command simulating pre-update failure")
result = transientFailure
return
}
if c.Stdin == nil {
log.Warn("Restore command has no stdin")
result = transientFailure
return
}
// Process it line by line.
scanner := bufio.NewScanner(c.Stdin)
commitSeen := false
i := 0
for scanner.Scan() {
line := scanner.Text()
i++
if line == "" {
continue
}
parts := strings.Split(line, " ")
subCmd := parts[0]
log.WithFields(log.Fields{
"lineNum": i + 1,
"line": line,
"subCmd": subCmd,
}).Info("Mock dataplane, analysing ipset restore line")
if subCmd != "COMMIT" {
Expect(commitSeen).To(BeFalse())
}
switch subCmd {
case "create":
Expect(len(parts)).To(Equal(7))
name := parts[1]
Expect(len(name)).To(BeNumerically("<=", MaxIPSetNameLength))
Expect(name).To(HavePrefix("cali"))
ipSetType := IPSetType(parts[2])
Expect(ipSetType.IsValid()).To(BeTrue())
Expect(parts[3]).To(Equal("family"))
ipFamily := IPFamily(parts[4])
Expect(ipFamily.IsValid()).To(BeTrue())
Expect(parts[5]).To(Equal("maxelem"))
maxElem, err := strconv.Atoi(parts[6])
Expect(err).NotTo(HaveOccurred())
setMetadata := setMetadata{
Name: name,
Family: ipFamily,
MaxSize: maxElem,
Type: ipSetType,
}
log.WithField("setMetadata", setMetadata).Info("Set created")
if _, ok := c.Dataplane.IPSetMembers[name]; ok {
_, _ = c.Stderr.Write([]byte("set exists"))
result = &exec.ExitError{}
return
}
c.Dataplane.IPSetMembers[name] = set.New()
c.Dataplane.IPSetMetadata[name] = setMetadata
case "destroy":
Expect(len(parts)).To(Equal(2))
name := parts[1]
c.Dataplane.AttemptedDestroys = append(c.Dataplane.AttemptedDestroys, name)
if _, ok := c.Dataplane.IPSetMembers[name]; !ok {
_, _ = c.Stderr.Write([]byte("set doesn't exist"))
result = &exec.ExitError{}
return
}
if c.Dataplane.FailDestroyNames.Contains(name) {
_, _ = c.Stderr.Write([]byte("set is in use"))
result = &exec.ExitError{}
return
}
delete(c.Dataplane.IPSetMembers, name)
log.WithField("setName", name).Info("Set destroyed")
case "add":
Expect(len(parts)).To(Equal(3))
name := parts[1]
newMember := parts[2]
logCxt := log.WithField("setName", name)
if currentMembers, ok := c.Dataplane.IPSetMembers[name]; !ok {
_, _ = c.Stderr.Write([]byte("set doesn't exist"))
result = &exec.ExitError{}
return
} else {
if currentMembers.Contains(newMember) {
c.Dataplane.TriedToAddExistent = true
logCxt.Warn("Add of existing member")
_, _ = c.Stderr.Write([]byte("member already exists"))
result = &exec.ExitError{}
return
}
currentMembers.Add(newMember)
logCxt.WithField("member", newMember).Info("Member added")
}
case "del":
Expect(len(parts)).To(Equal(4))
name := parts[1]
newMember := parts[2]
Expect(parts[3]).To(Equal("--exist"))
logCxt := log.WithField("setName", name)
if currentMembers, ok := c.Dataplane.IPSetMembers[name]; !ok {
_, _ = c.Stderr.Write([]byte("set doesn't exist"))
result = &exec.ExitError{}
return
} else {
existing := currentMembers.Contains(newMember)
if !existing {
c.Dataplane.TriedToDeleteNonExistent = true
}
currentMembers.Discard(newMember)
logCxt.WithFields(log.Fields{
"member": newMember,
"existedBefore": existing},
).Info("Member deleted")
}
if c.Dataplane.popRestoreFailure("post-del") {
log.Warn("Simulating a failure after first deletion.")
result = transientFailure
return
}
case "swap":
Expect(len(parts)).To(Equal(3))
name1 := parts[1]
name2 := parts[2]
log.WithFields(log.Fields{
"name1": name1,
"name2": name2,
}).Info("Swapping IP sets")
if set1, ok := c.Dataplane.IPSetMembers[name1]; !ok {
log.WithField("name", name1).Warn("IP set doesn't exist")
_, _ = c.Stderr.Write([]byte("set doesn't exist"))
result = &exec.ExitError{}
return
} else if set2, ok := c.Dataplane.IPSetMembers[name2]; !ok {
log.WithField("name", name2).Warn("IP set doesn't exist")
_, _ = c.Stderr.Write([]byte("set doesn't exist"))
result = &exec.ExitError{}
return
} else {
c.Dataplane.IPSetMembers[name1] = set2
c.Dataplane.IPSetMembers[name2] = set1
meta1 := c.Dataplane.IPSetMetadata[name1]
meta2 := c.Dataplane.IPSetMetadata[name2]
c.Dataplane.IPSetMetadata[name1] = meta2
c.Dataplane.IPSetMetadata[name2] = meta1
}
case "COMMIT":
commitSeen = true
default:
Fail("Unknown action: " + line)
}
}
Expect(commitSeen).To(BeTrue())
if c.Dataplane.popRestoreFailure("post-update") {
result = transientFailure
return
}
}
func (d *restoreCmd) CombinedOutput() ([]byte, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
type setMetadata struct {
Name string
Family IPFamily
Type IPSetType
MaxSize int
}
type destroyCmd struct {
Dataplane *mockDataplane
SetName string
}
func (d *destroyCmd) SetStdin(_ io.Reader) {
Fail("destroyCommand expects no input")
}
func (d *destroyCmd) SetStderr(r io.Writer) {
Fail("not implemented")
}
func (d *destroyCmd) SetStdout(r io.Writer) {
Fail("not implemented")
}
func (d *destroyCmd) StdinPipe() (WriteCloserFlusher, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (d *destroyCmd) StdoutPipe() (io.ReadCloser, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (d *destroyCmd) Start() error {
return nil
}
func (d *destroyCmd) Wait() error {
return nil
}
func (d *destroyCmd) Output() ([]byte, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (d *destroyCmd) CombinedOutput() ([]byte, error) {
d.Dataplane.AttemptedDestroys = append(d.Dataplane.AttemptedDestroys, d.SetName)
if d.Dataplane.FailDestroyNames.Contains(d.SetName) {
log.WithField("setName", d.SetName).Info(
"Mock dataplane simulating persistent failure to delete IP set")
return nil, &exec.ExitError{}
}
if d.Dataplane.FailNextDestroy {
d.Dataplane.FailNextDestroy = false
return nil, &exec.ExitError{}
}
if _, ok := d.Dataplane.IPSetMembers[d.SetName]; ok {
// IP set exists.
delete(d.Dataplane.IPSetMembers, d.SetName)
return []byte(""), nil // No output on success
} else {
// IP set missing.
d.Dataplane.TriedToDeleteNonExistent = true
return []byte("ipset v6.29: The set with the given name does not exist"),
&exec.ExitError{} // No need to fill, error not parsed by caller.
}
}
type listCmd struct {
Dataplane *mockDataplane
SetName string
Stdout *io.PipeWriter
resultC chan error
}
func (c *listCmd) SetStdin(_ io.Reader) {
Fail("listNamesCmd expects no input")
}
func (c *listCmd) SetStderr(r io.Writer) {
}
func (c *listCmd) SetStdout(r io.Writer) {
Fail("not implemented")
}
func (c *listCmd) StdinPipe() (WriteCloserFlusher, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (c *listCmd) StdoutPipe() (io.ReadCloser, error) {
if c.Dataplane.popListOpFailure("pipe") {
// Fail to create the pipe.
return nil, transientFailure
}
if c.Dataplane.popListOpFailure("read") {
// Fail all reads.
return &badPipe{}, nil
}
if c.Dataplane.popListOpFailure("read-member") {
// Fail in the middle of reading the Members block.
return &badPipe{
data: []byte(
"Name: " + v4MainIPSetName + "\n" +
"Members:\n10.0.0.1\n"),
}, nil
}
if c.Dataplane.popListOpFailure("close") {
// Fail at close time.
return &badPipe{
ReadError: io.EOF,
CloseFail: true,
}, nil
}
pipeR, pipeW := io.Pipe()
c.Stdout = pipeW
return pipeR, nil
}
type badPipe struct {
data []byte
CloseFail bool
FirstWriteFailRegexp *regexp.Regexp
ReadError error
}
func (pipe *badPipe) Read(p []byte) (n int, err error) {
if pipe.data != nil {
log.Info("Bad pipe returning data")
n = copy(p, pipe.data)
if n == len(pipe.data) {
pipe.data = nil
} else {
pipe.data = pipe.data[n:]
}
return
}
log.Info("Bad pipe returning read error")
if pipe.ReadError != nil {
return 0, pipe.ReadError
}
return 0, transientFailure
}
func (p *badPipe) Write(x []byte) (n int, err error) {
if p.FirstWriteFailRegexp != nil {
// Delay failure until we hit the regex.
log.WithField("data", string(x)).Debug("Bad pipe write input")
if !p.FirstWriteFailRegexp.Match(x) {
return len(x), nil
}
log.Info("Bad pipe FirstWriteFailRegexp matches")
p.FirstWriteFailRegexp = nil
}
log.Info("Bad pipe returning write error")
return 0, transientFailure
}
func (p *badPipe) Flush() error {
// Mock out flush so we see every write.
return nil
}
func (p *badPipe) Close() error {
if p.CloseFail {
return transientFailure
}
return nil
}
func (c *listCmd) Start() error {
if c.Dataplane.popListOpFailure("start") {
return transientFailure
}
go c.main()
return nil
}
func (c *listCmd) Wait() error {
log.Info("Waiting for list command to finish.")
return <-c.resultC
}
func (c *listCmd) Output() ([]byte, error) {
if c.Dataplane.FailAllLists {
return nil, permanentFailure
}
var buf bytes.Buffer
pipe, err := c.StdoutPipe()
if err != nil {
return nil, err
}
go c.main()
_, err = io.Copy(&buf, pipe)
return buf.Bytes(), err
}
func (c *listCmd) CombinedOutput() ([]byte, error) {
Fail("Not implemented")
return nil, errors.New("Not implemented")
}
func (c *listCmd) main() {
defer GinkgoRecover()
var result error
defer func() {
log.WithField("result", result).Info("list command main exiting")
if c.Stdout != nil {
c.Stdout.Close()
}
c.resultC <- result
}()
if c.Dataplane.FailAllLists {
log.Info("Simulating persistent failure of ipset list")
result = permanentFailure
return
}
if c.Dataplane.popListOpFailure("force-good-rc") {
log.Info("Forcing a good RC")
return
}
if c.Stdout == nil {
log.Info("stdout is nil, must be testing a failure scenario")
result = transientFailure
return
}
if c.Dataplane.popListOpFailure("rc") {
log.Info("Forcing a bad RC")
result = transientFailure
return
}
first := true
for setName, members := range c.Dataplane.IPSetMembers {
if !first {
fmt.Fprint(c.Stdout, "\n")
}
fmt.Fprintf(c.Stdout, "Name: %s\n", setName)
fmt.Fprint(c.Stdout, "Field: foobar\n") // Dummy field, should get ignored.
fmt.Fprint(c.Stdout, "Members:\n")
members.Iter(func(member interface{}) error {
fmt.Fprintf(c.Stdout, "%s\n", member)
return nil
})
first = false
}
}