forked from microsoft/retina
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathebpf_windows_test.go
More file actions
931 lines (817 loc) · 27.5 KB
/
Copy pathebpf_windows_test.go
File metadata and controls
931 lines (817 loc) · 27.5 KB
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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
// nolint
package ebpfwindows
import (
"bytes"
"encoding/binary"
"errors"
"fmt"
"net"
"testing"
"time"
"unsafe"
"github.com/cilium/cilium/api/v1/flow"
v1 "github.com/cilium/cilium/pkg/hubble/api/v1"
monitorapi "github.com/cilium/cilium/pkg/monitor/api"
"github.com/cilium/cilium/pkg/types"
"github.com/google/gopacket"
"github.com/google/gopacket/layers"
kcfg "github.com/microsoft/retina/pkg/config"
"github.com/microsoft/retina/pkg/enricher"
"github.com/microsoft/retina/pkg/log"
"github.com/microsoft/retina/pkg/metrics"
"go.uber.org/mock/gomock"
)
const (
pktSizeBytes = 100
)
var errTestFailure = errors.New("test failure")
func makeMockEthernetIPv4TCPPacket() []byte {
eth := &layers.Ethernet{
SrcMAC: net.HardwareAddr{0xde, 0xad, 0xbe, 0xef, 0x00, 0x02},
DstMAC: net.HardwareAddr{0xde, 0xad, 0xbe, 0xef, 0x00, 0x01},
EthernetType: layers.EthernetTypeIPv4,
}
ip := &layers.IPv4{
Version: 4,
IHL: 5,
TTL: 64,
Protocol: layers.IPProtocolTCP,
SrcIP: net.IP{192, 168, 1, 1},
DstIP: net.IP{192, 168, 1, 2},
}
tcp := &layers.TCP{
SrcPort: 12345,
DstPort: 80,
SYN: true,
Window: 65535,
}
err := tcp.SetNetworkLayerForChecksum(ip)
if err != nil {
panic(fmt.Sprintf("failed to set network layer for TCP: %v", err))
}
buf := gopacket.NewSerializeBuffer()
opts := gopacket.SerializeOptions{ComputeChecksums: true, FixLengths: true}
err = gopacket.SerializeLayers(buf, opts, eth, ip, tcp, gopacket.Payload([]byte{0x01, 0x02, 0x03}))
if err != nil {
panic(fmt.Sprintf("failed to serialize layers: %v", err))
}
return buf.Bytes()
}
func makeMockIPv4TCPPacket() []byte {
ip := &layers.IPv4{
Version: 4,
IHL: 5,
TTL: 64,
Protocol: layers.IPProtocolTCP,
SrcIP: net.IP{192, 168, 1, 1},
DstIP: net.IP{192, 168, 1, 2},
}
tcp := &layers.TCP{
SrcPort: 12345,
DstPort: 80,
SYN: true,
Window: 65535,
}
err := tcp.SetNetworkLayerForChecksum(ip)
if err != nil {
panic(fmt.Sprintf("failed to set network layer for TCP: %v", err))
}
buf := gopacket.NewSerializeBuffer()
opts := gopacket.SerializeOptions{ComputeChecksums: true, FixLengths: true}
err = gopacket.SerializeLayers(buf, opts, ip, tcp, gopacket.Payload([]byte{0x01, 0x02, 0x03}))
if err != nil {
panic(fmt.Sprintf("failed to serialize layers: %v", err))
}
return buf.Bytes()
}
func CheckPacketFields(fl *flow.Flow, t *testing.T, checkEthFields bool) {
if checkEthFields {
if fl.GetEthernet().GetSource() != "de:ad:be:ef:00:02" {
t.Errorf("expected source MAC to be de:ad:be:ef:00:02, got %v", fl.GetEthernet().GetSource())
}
if fl.GetEthernet().GetDestination() != "de:ad:be:ef:00:01" {
t.Errorf("expected destination MAC to be de:ad:be:ef:00:01, got %v", fl.GetEthernet().GetDestination())
}
}
if fl.GetIP().GetIpVersion() != flow.IPVersion_IPv4 {
t.Errorf("expected IP version IPv4, got %v", fl.GetIP().GetIpVersion())
}
if fl.GetIP().GetSource() != "192.168.1.1" {
t.Errorf("expected source IP to be 192.168.1.1, got %v", fl.GetIP().GetSource())
}
if fl.GetIP().GetDestination() != "192.168.1.2" {
t.Errorf("expected destination IP to be 192.168.1.2, got %v", fl.GetIP().GetDestination())
}
if fl.GetL4().GetTCP().GetSourcePort() != 12345 {
t.Errorf("expected source port to be 12345, got %v", fl.GetL4().GetTCP().GetSourcePort())
}
if fl.GetL4().GetTCP().GetDestinationPort() != 80 {
t.Errorf("expected destination port to be 80, got %v", fl.GetL4().GetTCP().GetDestinationPort())
}
}
// TestHandleTraceEvent_TraceNotify invokes the handleTraceEvent function for a valid TraceNotify event
// and check if the flow object is created correctly.
func TestHandleTraceEvent_TraceNotify(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
mockEnricher := enricher.NewMockEnricherInterface(ctrl)
mockEnricher.EXPECT().
Write(gomock.Any()).
DoAndReturn(func(event *v1.Event) error {
fl := event.GetFlow()
if fl == nil {
t.Error("expected a flow object, got nil")
}
eventType := fl.GetEventType().GetType()
if eventType != monitorapi.MessageTypeTrace {
t.Errorf("expected event type %v, got %v", monitorapi.MessageTypeTrace, eventType)
}
if fl.GetType() != flow.FlowType_L3_L4 {
t.Errorf("expected flow type L3_L4, got %v", fl.GetType())
}
CheckPacketFields(fl, t, true)
// Add more assertions as needed
return nil
})
_, err := log.SetupZapLogger(log.GetDefaultLogOpts())
if err != nil {
t.Fatalf("failed to setup logger: %v", err)
}
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err = p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
p.enricher = mockEnricher
tn := TraceNotify{
Type: monitorapi.MessageTypeTrace,
Version: TraceNotifyVersion1,
OrigIP: types.IPv6{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, // example IPv6
}
var buf bytes.Buffer
if err = binary.Write(&buf, binary.LittleEndian, tn); err != nil {
t.Fatalf("failed to serialize TraceNotify: %v", err)
}
// Append mock TCP packet as payload
packet := makeMockEthernetIPv4TCPPacket()
buf.Write(packet)
data := buf.Bytes()
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err != nil {
t.Fatalf("expected no error for handleTraceEvent, got: %v", err)
}
}
// TestHandleTraceEvent_DropNotify invokes the handleTraceEvent function for a valid DropNotify event
// and check if the flow object is created correctly.
func TestHandleTraceEvent_DropNotify(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
mockEnricher := enricher.NewMockEnricherInterface(ctrl)
mockEnricher.EXPECT().
Write(gomock.Any()).
DoAndReturn(func(event *v1.Event) error {
fl := event.GetFlow()
if fl == nil {
t.Error("expected a flow object, got nil")
}
subType := fl.GetEventType().GetType()
if subType != monitorapi.MessageTypeDrop {
t.Errorf("expected event type %v, got %v", monitorapi.MessageTypeDrop, subType)
}
if fl.GetType() != flow.FlowType_L3_L4 {
t.Errorf("expected flow type L3_L4, got %v", fl.GetType())
}
CheckPacketFields(fl, t, true)
// Add more assertions as needed
return nil
})
_, err := log.SetupZapLogger(log.GetDefaultLogOpts())
if err != nil {
t.Fatalf("failed to setup logger: %v", err)
}
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err = p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
p.enricher = mockEnricher
dn := DropNotify{
Type: monitorapi.MessageTypeDrop,
Version: DropNotifyVersion1,
}
var buf bytes.Buffer
if err = binary.Write(&buf, binary.LittleEndian, dn); err != nil {
t.Fatalf("failed to serialize DropNotify: %v", err)
}
// Append mock TCP packet as payload
packet := makeMockEthernetIPv4TCPPacket()
buf.Write(packet)
data := buf.Bytes()
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err != nil {
t.Fatalf("expected no error for handleTraceEvent, got: %v", err)
}
}
// TestHandleTraceEvent_UnknownEventType_NoError tests the behavior of the handleTraceEvent function
// when an unknown event type is received.
func TestHandleTraceEvent_UnknownEventType_NoError(t *testing.T) {
_, err := log.SetupZapLogger(log.GetDefaultLogOpts())
if err != nil {
t.Fatalf("failed to setup logger: %v", err)
}
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err = p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
// Create a byte array with one byte set to 4 (Unknown event type)
data := []byte{8} // Neither TraceNotify nor DropNotify
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err != nil {
t.Fatalf("expected no error for unknown event type, got: %v", err)
}
}
// TestHandleTraceEvent_InvalidTraceNotify tests the behavior of the handleTraceEvent function
// when an invalid TraceNotify event is received.
func TestHandleTraceEvent_InvalidTraceNotify(t *testing.T) {
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err := p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
data := []byte{monitorapi.MessageTypeTrace, 0} // Invalid TraceNotify
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err == nil {
t.Fatalf("expected error for invalid TraceNotify, got none")
} else if err.Error() != "invalid size for TraceNotify: 2" {
t.Fatalf("expected error - invalid size for TraceNotify: 2, got: %v", err)
}
}
// TestHandleTraceEvent_InvalidDropNotify tests the behavior of the handleTraceEvent function
// when an invalid DropNotify event is received.
func TestHandleTraceEvent_InvalidDropNotify(t *testing.T) {
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err := p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
data := []byte{monitorapi.MessageTypeDrop, 0} // Invalid DropNotify
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err == nil {
t.Fatalf("expected error for invalid DropNotify, got none")
} else if err.Error() != "invalid size for DropNotify: 2" {
t.Fatalf("expected error - invalid size for DropNotify: 2, got: %v", err)
}
}
// TestHandleTraceEvent_DataNil_SizeNonZero tests the behavior of the handleTraceEvent function
// when the data pointer is nil and size is non-zero.
func TestHandleTraceEvent_DataNil_SizeNonZero(t *testing.T) {
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err := p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
var mockCiliumEventSize uint32 = 100
err = p.handleTraceEvent(nil, mockCiliumEventSize)
if err == nil {
t.Fatalf("expected error - handleTraceEvent data received is nil")
} else if err.Error() != "handleTraceEvent data received is nil" {
t.Fatalf("expected error - handleTraceEvent data received is nil, got %v", err)
}
}
// TestHandleTraceEvent_InvalidSizeZero tests the behavior of the handleTraceEvent function
// when the size is zero.
func TestHandleTraceEvent_InvalidSizeZero(t *testing.T) {
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err := p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
err = p.handleTraceEvent(nil, 0)
if err == nil {
t.Fatalf("expected error - invalid size 0")
} else if err.Error() != "invalid size: 0" {
t.Fatalf("expected error - invalid size: 0, got %v", err)
}
}
// TestMetricsMapIterateCallback_DropEgress tests the behavior of the metricsMapIterateCallback function
// when a drop event is received for egress traffic.
func TestMetricsMapIterateCallback_DropEgress(t *testing.T) {
metrics.InitializeMetrics()
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
keyDrop := &MetricsKey{
Version: 1,
Reason: 2,
Direction: dirEgress,
ExtendedReason: 0, // Extended reason is not used in this test
}
val := &MetricsValue{Count: 1, Bytes: pktSizeBytes}
p.metricsMapIterateCallback(keyDrop, val)
_, err := metrics.DropBytesGauge.GetMetricWithLabelValues("Reason_InvalidPacket", "egress")
if err != nil {
t.Fatalf("expected a dropbyteguage metric with label Reason_InvalidPacket and egress, but got error %v", err)
}
_, err = metrics.DropPacketsGauge.GetMetricWithLabelValues("Reason_InvalidPacket", "egress")
if err != nil {
t.Fatalf("expected a droppktguage metrics with label Reason_InvalidPacket and egress, but got error %v", err)
}
}
// TestMetricsMapIterateCallback_DropIngress tests the behavior of the metricsMapIterateCallback function
// when a drop event is received for ingress traffic.
func TestMetricsMapIterateCallback_DropIngress(t *testing.T) {
metrics.InitializeMetrics()
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
keyDrop := &MetricsKey{
Version: 1,
Reason: 2,
Direction: dirIngress,
ExtendedReason: 0, // Extended reason is not used in this test
}
val := &MetricsValue{Count: 1, Bytes: pktSizeBytes}
p.metricsMapIterateCallback(keyDrop, val)
_, err := metrics.DropBytesGauge.GetMetricWithLabelValues("Reason_InvalidPacket", "ingress")
if err != nil {
t.Fatalf("expected a dropbyteguage metric with label Reason_InvalidPacket and ingress, but got error %v", err)
}
_, err = metrics.DropPacketsGauge.GetMetricWithLabelValues("Reason_InvalidPacket", "ingress")
if err != nil {
t.Fatalf("expected a droppktguage metrics with label Reason_InvalidPacket and ingress, but got error %v", err)
}
}
// TestMetricsMapIterateCallback_ForwardEgress tests the behavior of the metricsMapIterateCallback function
// when a forward event is received for egress traffic.
func TestMetricsMapIterateCallback_ForwardEgress(t *testing.T) {
metrics.InitializeMetrics()
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
keyFwd := &MetricsKey{
Version: 1,
Reason: 0,
Direction: dirEgress,
ExtendedReason: 0, // Extended reason is not used in this test
}
val := &MetricsValue{Count: 1, Bytes: pktSizeBytes}
p.metricsMapIterateCallback(keyFwd, val)
_, err := metrics.ForwardBytesGauge.GetMetricWithLabelValues("egress")
if err != nil {
t.Fatalf("expected a fwdbyteguage metric with label egress, but got error %v", err)
}
_, err = metrics.ForwardPacketsGauge.GetMetricWithLabelValues("egress")
if err != nil {
t.Fatalf("expected a fwdpktguage metrics with label egress, but got error %v", err)
}
}
// TestMetricsMapIterateCallback_ForwardIngress tests the behavior of the metricsMapIterateCallback function
// when a forward event is received for ingress traffic.
func TestMetricsMapIterateCallback_ForwardIngress(t *testing.T) {
metrics.InitializeMetrics()
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
keyFwd := &MetricsKey{
Version: 1,
Reason: 0,
Direction: dirIngress,
ExtendedReason: 0, // Extended reason is not used in this test
}
val := &MetricsValue{Count: 1, Bytes: pktSizeBytes}
p.metricsMapIterateCallback(keyFwd, val)
_, err := metrics.ForwardBytesGauge.GetMetricWithLabelValues("ingress")
if err != nil {
t.Fatalf("expected a fwdbyteguage with label ingress, but got error %v", err)
}
_, err = metrics.ForwardPacketsGauge.GetMetricWithLabelValues("ingress")
if err != nil {
t.Fatalf("expected a fwdpktguage with label ingress, but got error %v", err)
}
}
// TestMetricsMapIterateCallback_NilKey tests the behavior of the metricsMapIterateCallback function
// when the key is nil and value is non-nil.
func TestMetricsMapIterateCallback_NilKey(t *testing.T) {
// it should not panic
defer func() {
if r := recover(); r != nil {
t.Fatalf("unexpected panic: %v", r)
}
}()
metrics.InitializeMetrics()
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
fakeValues := &MetricsValue{}
p.metricsMapIterateCallback(nil, fakeValues)
}
// TestMetricsMapIterateCallback_NilValue tests the behavior of the metricsMapIterateCallback function
// when the value is nil.
func TestMetricsMapIterateCallback_NilValue(t *testing.T) {
// it should not panic
defer func() {
if r := recover(); r != nil {
t.Fatalf("unexpected panic: %v", r)
}
}()
metrics.InitializeMetrics()
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
key := &MetricsKey{}
p.metricsMapIterateCallback(key, nil)
}
// TestIterateWithCallback_Error_NilMetricsValue tests the behavior of the IterateWithCallback function
// when retinaEBPFAPI invokes enumCallBack with nil value.
func TestIterateWithCallback_Error_NilMetricsValue(t *testing.T) {
// Mock the function variable to simulate a successful Windows API call
orig := callEnumMetricsMap
callEnumMetricsMap = func(_ uintptr) (uintptr, uintptr, error) {
return 0, 0, nil
}
defer func() { callEnumMetricsMap = orig }()
m := NewMetricsMap()
logger := log.Logger().Named("test-ebpf")
called := false
err := m.IterateWithCallback(logger, func(_ *MetricsKey, _ *MetricsValue) {
called = true
})
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
fakeKey := &MetricsKey{}
enumCallBack(unsafe.Pointer(fakeKey), nil)
if called {
t.Errorf("expected callback not to be called")
}
}
// TestIterateWithCallback_Error_NilMetricsKey tests the behavior of the IterateWithCallback function
// when retinaEBPFAPI invokes enumCallBack with nil key.
func TestIterateWithCallback_Error_NilMetricsKey(t *testing.T) {
// Mock the function variable to simulate a successful Windows API call
orig := callEnumMetricsMap
callEnumMetricsMap = func(_ uintptr) (uintptr, uintptr, error) {
return 0, 0, nil
}
defer func() { callEnumMetricsMap = orig }()
m := NewMetricsMap()
logger := log.Logger().Named("test-ebpf")
called := false
err := m.IterateWithCallback(logger, func(_ *MetricsKey, _ *MetricsValue) {
called = true
})
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
fakeValues := &MetricsValue{}
enumCallBack(unsafe.Pointer(nil), unsafe.Pointer(fakeValues))
if called {
t.Errorf("expected callback not to be called")
}
}
// TestIterateWithCallback_Error_NilKeyAndValue tests the behavior of the IterateWithCallback function
// when retinaEBPFAPI invokes enumCallBack with nil value.
func TestIterateWithCallback_Error_NilMetricValue(t *testing.T) {
// Mock the function variable to simulate a successful Windows API call
orig := callEnumMetricsMap
callEnumMetricsMap = func(_ uintptr) (uintptr, uintptr, error) {
return 0, 0, nil
}
defer func() { callEnumMetricsMap = orig }()
m := NewMetricsMap()
logger := log.Logger().Named("test-ebpf")
called := false
err := m.IterateWithCallback(logger, func(_ *MetricsKey, _ *MetricsValue) {
called = true
})
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
fakeKey := &MetricsKey{}
enumCallBack(unsafe.Pointer(fakeKey), unsafe.Pointer(nil))
if called {
t.Errorf("expected callback not to be called")
}
}
// TestIterateWithCallback_Success tests the behavior of the IterateWithCallback function
// when retinaEBPFAPI invokes enumCallBack with valid key and value.
func TestIterateWithCallback_Success(t *testing.T) {
// Mock the function variable to simulate a successful Windows API call
orig := callEnumMetricsMap
callEnumMetricsMap = func(_ uintptr) (uintptr, uintptr, error) {
return 0, 0, nil
}
defer func() { callEnumMetricsMap = orig }()
m := NewMetricsMap()
logger := log.Logger().Named("test-ebpf")
called := false
err := m.IterateWithCallback(logger, func(_ *MetricsKey, _ *MetricsValue) {
called = true
})
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
fakeKey := &MetricsKey{}
fakeValues := &MetricsValue{}
enumCallBack(unsafe.Pointer(fakeKey), unsafe.Pointer(fakeValues))
if !called {
t.Errorf("expected callback to be called")
}
}
// TestUnregisterForCallback_Success tests the behavior of the UnregisterForCallback function
// when retinaEBPFAPI successfully unregisters the callback.
func TestUnregisterForCallback_Success(t *testing.T) {
// Mock the function variable
orig := callUnregisterEventsMapCallback
callUnregisterEventsMapCallback = func(_ uintptr) (uintptr, uintptr, error) {
return 0, 0, nil // Simulate success
}
defer func() { callUnregisterEventsMapCallback = orig }()
em := NewEventsMap()
err := em.UnregisterForCallback()
if err != nil {
t.Fatalf("expected no error when unregistering callback with eventmap, got %v", err)
}
}
// TestUnregisterForCallback_Error tests the behavior of the UnregisterForCallback function
// when retinaEBPFAPI fails to unregister the callback.
func TestUnregisterForCallback_Error(t *testing.T) {
// Mock the function variable to simulate an error
orig := callUnregisterEventsMapCallback
callUnregisterEventsMapCallback = func(_ uintptr) (uintptr, uintptr, error) {
return 1, 0, fmt.Errorf("%w", errTestFailure)
}
defer func() { callUnregisterEventsMapCallback = orig }()
em := NewEventsMap()
err := em.UnregisterForCallback()
if err == nil {
t.Fatalf("expected error when unregistering callback with eventmap, got nothing")
}
}
// TestRegisterForCallback_Success tests the behavior of the RegisterForCallback function
// when retinaEBPFAPI successfully registers the callback.
func TestRegisterForCallback_Success(t *testing.T) {
// Mock the function variable, not the LazyProc
orig := callRegisterEventsMapCallback
callRegisterEventsMapCallback = func(_, _ uintptr) (uintptr, uintptr, error) {
return 0, 0, nil // Simulate success
}
defer func() { callRegisterEventsMapCallback = orig }()
logger := log.Logger().Named("test-ebpf")
em := NewEventsMap()
called := false
cb := func(_ unsafe.Pointer, _ uint32) {
called = true
}
err := em.RegisterForCallback(logger, cb)
if err != nil {
t.Fatalf("expected no error when registering callback with eventsmap, got %v", err)
}
// Simulate callback
eventsCallback(nil, 0)
if !called {
t.Errorf("expected callback to be called from eventsmap")
}
}
// TestRegisterForCallback_Error tests the behavior of the RegisterForCallback function
// when retinaEBPFAPI fails to register the callback.
func TestRegisterForCallback_Error(t *testing.T) {
// Mock the function variable to simulate an error
orig := callRegisterEventsMapCallback
callRegisterEventsMapCallback = func(_, _ uintptr) (uintptr, uintptr, error) {
return 1, 0, fmt.Errorf("%w", errTestFailure)
}
defer func() { callRegisterEventsMapCallback = orig }()
logger := log.Logger().Named("test-ebpf")
em := NewEventsMap()
cb := func(_ unsafe.Pointer, _ uint32) {
// nop
}
err := em.RegisterForCallback(logger, cb)
if err == nil {
t.Fatalf("expected error when registering callback with eventsmap, got nothing")
}
}
// TestHandleTraceEventWithEthPacket_PktmonDropNotify invokes the handleTraceEvent function for a valid DropNotify event
// and check if the flow object is created correctly.
func TestHandleTraceEventWithEthPacket_PktmonDropNotify(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
mockEnricher := enricher.NewMockEnricherInterface(ctrl)
mockEnricher.EXPECT().
Write(gomock.Any()).
DoAndReturn(func(event *v1.Event) error {
fl := event.GetFlow()
if fl == nil {
t.Error("expected a flow object, got nil")
}
eventType := fl.GetEventType().GetType()
if eventType != MessageTypePktmonDrop {
t.Errorf("expected event type %v, got %v", MessageTypePktmonDrop, eventType)
}
var testDropReason int32 = 2
testDropReason = testDropReason | (1 << 30)
eventSubType := fl.GetEventType().GetSubType()
if eventSubType != testDropReason {
t.Errorf("expected event type %v, got %v", testDropReason, eventSubType)
}
if fl.GetType() != flow.FlowType_L3_L4 {
t.Errorf("expected flow type L3_L4, got %v", fl.GetType())
}
CheckPacketFields(fl, t, true)
// Add more assertions as needed
return nil
})
_, err := log.SetupZapLogger(log.GetDefaultLogOpts())
if err != nil {
t.Fatalf("failed to setup logger: %v", err)
}
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err = p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
p.enricher = mockEnricher
pdn := [57]uint8{}
// type 100
pdn[0] = 0x64
// version 1
pdn[2] = 0x01
pdn[3] = 0x00
// PacketType 1
pdn[31] = 0x01
pdn[32] = 0x00
// DropReason 0x00000002
pdn[39] = 0x02
pdn[40] = 0x00
pdn[41] = 0x00
pdn[42] = 0x00
var buf bytes.Buffer
if err = binary.Write(&buf, binary.LittleEndian, pdn); err != nil {
t.Fatalf("failed to serialize DropNotify: %v", err)
}
// Append mock TCP packet as payload
packet := makeMockEthernetIPv4TCPPacket()
buf.Write(packet)
data := buf.Bytes()
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err != nil {
t.Fatalf("expected no error for handleTraceEvent, got: %v", err)
}
}
// TestHandleTraceEventWithIpPacket_PktmonDropNotify invokes the handleTraceEvent function for a valid DropNotify event
// and check if the flow object is created correctly.
func TestHandleTraceEventWithIpPacket_PktmonDropNotify(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
mockEnricher := enricher.NewMockEnricherInterface(ctrl)
mockEnricher.EXPECT().
Write(gomock.Any()).
DoAndReturn(func(event *v1.Event) error {
fl := event.GetFlow()
if fl == nil {
t.Error("expected a flow object, got nil")
}
eventType := fl.GetEventType().GetType()
if eventType != MessageTypePktmonDrop {
t.Errorf("expected event type %v, got %v", MessageTypePktmonDrop, eventType)
}
var testDropReason int32 = 2
testDropReason = testDropReason | (1 << 30)
eventSubType := fl.GetEventType().GetSubType()
if eventSubType != testDropReason {
t.Errorf("expected event type %v, got %v", testDropReason, eventSubType)
}
if fl.GetType() != flow.FlowType_L3_L4 {
t.Errorf("expected flow type L3_L4, got %v", fl.GetType())
}
CheckPacketFields(fl, t, false)
// Add more assertions as needed
return nil
})
_, err := log.SetupZapLogger(log.GetDefaultLogOpts())
if err != nil {
t.Fatalf("failed to setup logger: %v", err)
}
p := &Plugin{
cfg: &kcfg.Config{
MetricsInterval: 100 * time.Second,
EnablePodLevel: true,
},
l: log.Logger().Named("test-ebpf"),
}
err = p.Init()
if err != nil {
t.Fatalf("failed to initialize plugin: %v", err)
}
p.enricher = mockEnricher
// Pktmon events use packed structs for the packet headers, manually constructing test packet
pdn := [57]uint8{}
// type 100
pdn[0] = 0x64
// version 1
pdn[2] = 0x01
pdn[3] = 0x00
// PacketType 3
pdn[31] = 0x03
pdn[32] = 0x00
// DropReason 0x00000002
pdn[39] = 0x02
pdn[40] = 0x00
pdn[41] = 0x00
pdn[42] = 0x00
var buf bytes.Buffer
if err = binary.Write(&buf, binary.LittleEndian, pdn); err != nil {
t.Fatalf("failed to serialize DropNotify: %v", err)
}
// Append mock TCP packet as payload
packet := makeMockIPv4TCPPacket()
buf.Write(packet)
data := buf.Bytes()
//nolint:gosec // ignore G115 -- data length is guaranteed to be within uint32 bounds in test context
err = p.handleTraceEvent(unsafe.Pointer(&data[0]), uint32(len(data)))
if err != nil {
t.Fatalf("expected no error for handleTraceEvent, got: %v", err)
}
}