-
Notifications
You must be signed in to change notification settings - Fork 581
/
feature.go
1032 lines (870 loc) · 35.3 KB
/
feature.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
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
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2022 The Knative Authors
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 broker
import (
"context"
"encoding/base64"
"fmt"
"strings"
cloudevents "github.com/cloudevents/sdk-go/v2"
"github.com/cloudevents/sdk-go/v2/binding/spec"
"github.com/cloudevents/sdk-go/v2/test"
"github.com/google/uuid"
duckv1 "knative.dev/eventing/pkg/apis/duck/v1"
eventingv1 "knative.dev/eventing/pkg/apis/eventing/v1"
"knative.dev/eventing/test/rekt/resources/broker"
"knative.dev/eventing/test/rekt/resources/channel"
"knative.dev/eventing/test/rekt/resources/subscription"
"knative.dev/eventing/test/rekt/resources/trigger"
v1 "knative.dev/pkg/apis/duck/v1"
"knative.dev/pkg/ptr"
"knative.dev/reconciler-test/pkg/eventshub"
eventasssert "knative.dev/reconciler-test/pkg/eventshub/assert"
"knative.dev/reconciler-test/pkg/feature"
"knative.dev/reconciler-test/pkg/manifest"
"knative.dev/reconciler-test/pkg/resources/service"
)
func BrokerWithManyTriggers() *feature.Feature {
f := feature.NewFeatureNamed("broker With Many Triggers")
// Construct different type, source and extensions of events
any := eventingv1.TriggerAnyFilter
eventType1 := "type1"
eventType2 := "type2"
eventSource1 := "http://source1.com"
eventSource2 := "http://source2.com"
// Be careful with the length of extension name and values,
// we use extension name and value as a part of the name of resources like subscriber and trigger,
// the maximum characters allowed of resource name is 63
extensionName1 := "extname1"
extensionValue1 := "extval1"
extensionName2 := "extname2"
extensionValue2 := "extvalue2"
nonMatchingExtensionName := "nonmatchingextname"
nonMatchingExtensionValue := "nonmatchingextval"
eventFilters1 := make(map[string]eventTestCase)
eventFilters1["dumper-1"] = neweventTestCase(any, any)
eventFilters1["dumper-12"] = neweventTestCase(eventType1, any)
eventFilters1["dumper-123"] = neweventTestCase(any, eventSource1)
eventFilters1["dumper-1234"] = neweventTestCase(eventType1, eventSource1)
eventFilters2 := make(map[string]eventTestCase)
eventFilters2["dumper-12345"] = neweventTestCaseWithExtensions(any, any, map[string]interface{}{extensionName1: extensionValue1})
eventFilters2["dumper-123456"] = neweventTestCaseWithExtensions(any, any, map[string]interface{}{extensionName1: extensionValue1, extensionName2: extensionValue2})
eventFilters2["dumper-1234567"] = neweventTestCaseWithExtensions(any, any, map[string]interface{}{extensionName2: extensionValue2})
eventFilters2["dumper-654321"] = neweventTestCaseWithExtensions(eventType1, any, map[string]interface{}{extensionName1: extensionValue1})
eventFilters2["dumper-54321"] = neweventTestCaseWithExtensions(any, any, map[string]interface{}{extensionName1: any})
eventFilters2["dumper-4321"] = neweventTestCaseWithExtensions(any, eventSource1, map[string]interface{}{extensionName1: extensionValue1})
eventFilters2["dumper-321"] = neweventTestCaseWithExtensions(any, eventSource1, map[string]interface{}{extensionName1: extensionValue1, extensionName2: extensionValue2})
eventFilters2["dumper-21"] = neweventTestCaseWithExtensions(any, eventSource2, map[string]interface{}{extensionName1: extensionValue1, extensionName2: extensionValue1})
tests := []struct {
name string
// These are the event context attributes and extension attributes that will be send.
eventsToSend []eventTestCase
// These are the event context attributes and extension attributes that triggers will listen to
// This map is to configure sink and corresponding filter to construct trigger
eventFilters map[string]eventTestCase
}{
{
name: "test default broker with many attribute triggers",
eventsToSend: []eventTestCase{
{Type: eventType1, Source: eventSource1},
{Type: eventType1, Source: eventSource2},
{Type: eventType2, Source: eventSource1},
{Type: eventType2, Source: eventSource2},
},
eventFilters: eventFilters1,
},
{
name: "test default broker with many attribute and extension triggers",
eventsToSend: []eventTestCase{
{Type: eventType1, Source: eventSource1, Extensions: map[string]interface{}{extensionName1: extensionValue1}},
{Type: eventType1, Source: eventSource1, Extensions: map[string]interface{}{extensionName1: extensionValue1, extensionName2: extensionValue2}},
{Type: eventType1, Source: eventSource1, Extensions: map[string]interface{}{extensionName2: extensionValue2}},
{Type: eventType1, Source: eventSource2, Extensions: map[string]interface{}{extensionName1: extensionValue1}},
{Type: eventType2, Source: eventSource1, Extensions: map[string]interface{}{extensionName1: nonMatchingExtensionValue}},
{Type: eventType2, Source: eventSource2, Extensions: map[string]interface{}{nonMatchingExtensionName: extensionValue1}},
{Type: eventType2, Source: eventSource2, Extensions: map[string]interface{}{extensionName1: extensionValue1, extensionName2: extensionValue2}},
{Type: eventType2, Source: eventSource2, Extensions: map[string]interface{}{extensionName1: extensionValue1, nonMatchingExtensionName: extensionValue2}},
},
eventFilters: eventFilters2,
},
}
// Map to save the expected matchers per dumper so that we can verify the delivery.
// matcherBySink is to verify the sink and corresponding matcher
matcherBySink := make(map[string][]eventshub.EventInfoMatcher)
// Create the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Setup("broker is ready", broker.IsReady(brokerName))
f.Setup("broker is addressable", broker.IsAddressable(brokerName))
for _, testcase := range tests {
for sink, eventFilter := range testcase.eventFilters {
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
filter := eventingv1.TriggerFilterAttributes{
"type": eventFilter.Type,
"source": eventFilter.Source,
}
// Point the Trigger subscriber to the sink svc.
cfg := []manifest.CfgFn{
trigger.WithSubscriber(service.AsKReference(sink), ""),
trigger.WithFilter(filter),
trigger.WithExtensions(eventFilter.Extensions),
}
// Install the trigger
via := feature.MakeRandomK8sName("via")
f.Setup("install trigger", trigger.Install(via, brokerName, cfg...))
f.Setup("trigger goes ready", trigger.IsReady(via))
}
for _, event := range testcase.eventsToSend {
eventToSend := cloudevents.NewEvent()
eventToSend.SetID(uuid.New().String())
eventToSend.SetType(event.Type)
eventToSend.SetSource(event.Source)
for k, v := range event.Extensions {
eventToSend.SetExtension(k, v)
}
data := fmt.Sprintf(`{"msg":"%s"}`, uuid.New())
eventToSend.SetData(cloudevents.ApplicationJSON, []byte(data))
source := feature.MakeRandomK8sName("source")
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(eventToSend),
))
// Sent event matcher
sentEventMatcher := test.AllOf(
test.HasId(eventToSend.ID()),
event.toEventMatcher(),
)
// Check on every dumper whether we should expect this event or not
for sink, eventFilter := range testcase.eventFilters {
if eventFilter.toEventMatcher()(eventToSend) == nil {
// This filter should match this event
matcherBySink[sink] = append(
matcherBySink[sink],
eventasssert.MatchEvent(sentEventMatcher),
)
}
}
}
// Let's check that all expected matchers are fulfilled
for sink, matchers := range matcherBySink {
for _, matcher := range matchers {
// One match per event is enough
f.Stable("test message without explicit prefer header should have the header").
Must("delivers events",
eventasssert.OnStore(sink).Match(
matcher,
).AtLeast(1))
}
}
}
return f
}
func BrokerWorkFlowWithTransformation() *feature.FeatureSet {
createSubscriberFn := func(ref *v1.KReference, uri string) manifest.CfgFn {
return subscription.WithSubscriber(ref, uri)
}
fs := &feature.FeatureSet{
Name: "Knative Broker - Transformation - Channel flow and Trigger event flow",
Features: []*feature.Feature{
brokerChannelFlowWithTransformation(createSubscriberFn),
brokerEventTransformationForTrigger(),
},
}
return fs
}
/*
BrokerChannelFlowWithTransformation tests the following topology:
------------- ----------------------
| | | |
v | v |
EventSource ---> Broker ---> Trigger1 -------> Sink1(Transformation)
|
|
|-------> Trigger2 -------> Sink2(Logger1)
|
|
|-------> Trigger3 -------> Channel --------> Subscription --------> Sink3(Logger2)
Explanation:
Trigger1 filters the orignal event and transforms it to a new event,
Trigger2 logs all events,
Trigger3 filters the transformed event and sends it to Channel.
*/
func brokerChannelFlowWithTransformation(createSubscriberFn func(ref *v1.KReference, uri string) manifest.CfgFn) *feature.Feature {
f := feature.NewFeatureNamed("Broker topology of transformation")
source := feature.MakeRandomK8sName("source")
sink1 := feature.MakeRandomK8sName("sink1")
sink2 := feature.MakeRandomK8sName("sink2")
sink3 := feature.MakeRandomK8sName("sink3")
trigger1 := feature.MakeRandomK8sName("trigger1")
trigger2 := feature.MakeRandomK8sName("trigger2")
trigger3 := feature.MakeRandomK8sName("trigger3")
// Construct original cloudevent message
eventType := "type1"
eventSource := "http://source1.com"
eventBody := `{"msg":"e2e-brokerchannel-body"}`
// Construct cloudevent message after transformation
transformedEventType := "type2"
transformedEventSource := "http://source2.com"
transformedBody := `{"msg":"transformed body"}`
// Construct eventToSend
eventToSend := cloudevents.NewEvent()
eventToSend.SetID(uuid.New().String())
eventToSend.SetType(eventType)
eventToSend.SetSource(eventSource)
eventToSend.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Setup("broker is ready", broker.IsReady(brokerName))
f.Setup("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink1", eventshub.Install(sink1,
eventshub.ReplyWithTransformedEvent(transformedEventType, transformedEventSource, transformedBody),
eventshub.StartReceiver),
)
f.Setup("install sink2", eventshub.Install(sink2, eventshub.StartReceiver))
f.Setup("install sink3", eventshub.Install(sink3, eventshub.StartReceiver))
// filter1 filters the original events
filter1 := eventingv1.TriggerFilterAttributes{
"type": eventType,
"source": eventSource,
}
// filter2 filters all events
filter2 := eventingv1.TriggerFilterAttributes{
"type": eventingv1.TriggerAnyFilter,
}
// filter3 filters events after transformation
filter3 := eventingv1.TriggerFilterAttributes{
"type": transformedEventType,
"source": transformedEventSource,
}
// Install the trigger1 point to Broker and transform the original events to new events
f.Setup("install trigger1", trigger.Install(
trigger1,
brokerName,
trigger.WithFilter(filter1),
trigger.WithSubscriber(service.AsKReference(sink1), ""),
))
f.Setup("trigger1 goes ready", trigger.IsReady(trigger1))
// Install the trigger2 point to Broker to filter all the events
f.Setup("install trigger2", trigger.Install(
trigger2,
brokerName,
trigger.WithFilter(filter2),
trigger.WithSubscriber(service.AsKReference(sink2), ""),
))
f.Setup("trigger2 goes ready", trigger.IsReady(trigger2))
// Install the channel and corresponding subscription point to sink3
channelName := feature.MakeRandomK8sName("channel")
f.Setup("install channel", channel.Install(channelName,
channel.WithTemplate(),
))
sub := feature.MakeRandomK8sName("subscription")
f.Setup("install subscription", subscription.Install(sub,
subscription.WithChannel(channel.AsRef(channelName)),
createSubscriberFn(service.AsKReference(sink3), ""),
))
f.Setup("subscription is ready", subscription.IsReady(sub))
f.Setup("channel is ready", channel.IsReady(channelName))
// Install the trigger3 point to Broker to filter the events after transformation point to channel
f.Setup("install trigger3", trigger.Install(
trigger3,
brokerName,
trigger.WithFilter(filter3),
trigger.WithSubscriber(channel.AsRef(channelName), ""),
))
f.Setup("trigger3 goes ready", trigger.IsReady(trigger3))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(eventToSend),
))
eventMatcher := eventasssert.MatchEvent(
test.HasSource(eventSource),
test.HasType(eventType),
test.HasData([]byte(eventBody)),
)
transformEventMatcher := eventasssert.MatchEvent(
test.HasSource(transformedEventSource),
test.HasType(transformedEventType),
test.HasData([]byte(transformedBody)),
)
f.Stable("(Trigger1 point to) sink1 has all the events").
Must("delivers original events",
eventasssert.OnStore(sink1).Match(eventMatcher).AtLeast(1))
f.Stable("(Trigger2 point to) sink2 has all the events").
Must("delivers original events",
eventasssert.OnStore(sink2).Match(eventMatcher).AtLeast(1)).
Must("delivers transformation events",
eventasssert.OnStore(sink2).Match(transformEventMatcher).AtLeast(1))
f.Stable("(Trigger3 point to) Channel's subscriber just has events after transformation").
Must("delivers transformation events",
eventasssert.OnStore(sink3).Match(transformEventMatcher).AtLeast(1)).
Must("delivers original events",
eventasssert.OnStore(sink3).Match(eventMatcher).Not())
return f
}
/*
BrokerEventTransformationForTrigger tests the following scenario:
5 4
------------- ----------------------
| | | |
1 v 2 | v 3 |
EventSource ---> Broker ---> Trigger1 -------> Sink1(Transformation)
|
| 6 7
|-------> Trigger2 -------> Sink2(Logger)
Note: the number denotes the sequence of the event that flows in this test case.
*/
func brokerEventTransformationForTrigger() *feature.Feature {
f := feature.NewFeatureNamed("Broker event transformation for trigger")
source := feature.MakeRandomK8sName("source")
sink1 := feature.MakeRandomK8sName("sink1")
sink2 := feature.MakeRandomK8sName("sink2")
trigger1 := feature.MakeRandomK8sName("trigger1")
trigger2 := feature.MakeRandomK8sName("trigger2")
// Construct original cloudevent message
eventType := "type1"
eventSource := "http://source1.com"
eventBody := `{"msg":"e2e-brokerchannel-body"}`
// Construct cloudevent message after transformation
transformedEventType := "type2"
transformedEventSource := "http://source2.com"
transformedBody := `{"msg":"transformed body"}`
// Construct eventToSend
eventToSend := cloudevents.NewEvent()
eventToSend.SetID(uuid.New().String())
eventToSend.SetType(eventType)
eventToSend.SetSource(eventSource)
eventToSend.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Setup("broker is ready", broker.IsReady(brokerName))
f.Setup("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink1", eventshub.Install(sink1,
eventshub.ReplyWithTransformedEvent(transformedEventType, transformedEventSource, transformedBody),
eventshub.StartReceiver),
)
f.Setup("install sink2", eventshub.Install(sink2, eventshub.StartReceiver))
// filter1 filters the original events
filter1 := eventingv1.TriggerFilterAttributes{
"type": eventType,
"source": eventSource,
}
// filter2 filters events after transformation
filter2 := eventingv1.TriggerFilterAttributes{
"type": transformedEventType,
"source": transformedEventSource,
}
// Install the trigger1 point to Broker and transform the original events to new events
f.Setup("install trigger1", trigger.Install(
trigger1,
brokerName,
trigger.WithFilter(filter1),
trigger.WithSubscriber(service.AsKReference(sink1), ""),
))
f.Setup("trigger1 goes ready", trigger.IsReady(trigger1))
// Install the trigger2 point to Broker to filter all the events
f.Setup("install trigger2", trigger.Install(
trigger2,
brokerName,
trigger.WithFilter(filter2),
trigger.WithSubscriber(service.AsKReference(sink2), ""),
))
f.Setup("trigger2 goes ready", trigger.IsReady(trigger2))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(eventToSend),
))
eventMatcher := eventasssert.MatchEvent(
test.HasSource(eventSource),
test.HasType(eventType),
test.HasData([]byte(eventBody)),
)
transformEventMatcher := eventasssert.MatchEvent(
test.HasSource(transformedEventSource),
test.HasType(transformedEventType),
test.HasData([]byte(transformedBody)),
)
f.Stable("Trigger2 has filtered all transformed events").
Must("delivers original events",
eventasssert.OnStore(sink2).Match(transformEventMatcher).AtLeast(1))
f.Stable("Trigger2 has no original events").
Must("delivers original events",
eventasssert.OnStore(sink2).Match(eventMatcher).Not())
return f
}
func BrokerPreferHeaderCheck() *feature.Feature {
f := feature.NewFeatureNamed("Broker PreferHeader Check")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
via := feature.MakeRandomK8sName("via")
eventSource := "source1"
eventType := "type1"
eventBody := `{"msg":"test msg"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
// Point the Trigger subscriber to the sink svc.
cfg := []manifest.CfgFn{trigger.WithSubscriber(service.AsKReference(sink), "")}
// Install the trigger
f.Setup("install trigger", trigger.Install(via, brokerName, cfg...))
f.Setup("trigger goes ready", trigger.IsReady(via))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
))
f.Stable("test message without explicit prefer header should have the header").
Must("delivers events",
eventasssert.OnStore(sink).Match(
eventasssert.HasAdditionalHeader("Prefer", "reply"),
).AtLeast(1))
return f
}
func BrokerRedelivery() *feature.FeatureSet {
fs := &feature.FeatureSet{
Name: "Knative Broker - Redelivery - with different sequences",
Features: []*feature.Feature{
brokerRedeliveryFibonacci(5),
brokerRedeliveryDropN(5, 5),
},
}
return fs
}
func brokerRedeliveryFibonacci(retryNum int32) *feature.Feature {
f := feature.NewFeatureNamed("Broker reply with a bad status code following the fibonacci sequence")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
via := feature.MakeRandomK8sName("via")
eventSource := "source1"
eventType := "type1"
eventBody := `{"msg":"fibonacci"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
exp := duckv1.BackoffPolicyLinear
brokerConfig := append(broker.WithEnvConfig(), broker.WithRetry(retryNum, &exp, ptr.String("PT1S")))
f.Setup("install broker", broker.Install(brokerName, brokerConfig...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
// Point the Trigger subscriber to the sink svc.
cfg := []manifest.CfgFn{trigger.WithSubscriber(service.AsKReference(sink), "")}
// Install the trigger
f.Setup("install trigger", trigger.Install(via, brokerName, cfg...))
f.Setup("trigger goes ready", trigger.IsReady(via))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
eventshub.FibonacciDrop,
))
f.Stable("Broker Redelivery following the fibonacci sequence").
Must("delivers events",
eventasssert.OnStore(sink).Match(
eventasssert.MatchKind(eventasssert.EventReceived),
eventasssert.MatchEvent(
test.HasSource(eventSource),
test.HasType(eventType),
test.HasData([]byte(eventBody)),
),
).AtLeast(1))
return f
}
func brokerRedeliveryDropN(retryNum int32, dropNum uint) *feature.Feature {
f := feature.NewFeatureNamed("Broker reply with a bad status code to the first n events")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
via := feature.MakeRandomK8sName("via")
eventSource := "source2"
eventType := "type2"
eventBody := `{"msg":"DropN"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
exp := duckv1.BackoffPolicyLinear
brokerConfig := append(broker.WithEnvConfig(), broker.WithRetry(retryNum, &exp, ptr.String("PT1S")))
f.Setup("install broker", broker.Install(brokerName, brokerConfig...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
// Point the Trigger subscriber to the sink svc.
cfg := []manifest.CfgFn{trigger.WithSubscriber(service.AsKReference(sink), "")}
// Install the trigger
f.Setup("install trigger", trigger.Install(via, brokerName, cfg...))
f.Setup("trigger goes ready", trigger.IsReady(via))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
eventshub.DropFirstN(dropNum),
))
f.Stable("Broker Redelivery failed the first n events").
Must("delivers events",
eventasssert.OnStore(sink).Match(
eventasssert.MatchKind(eventasssert.EventReceived),
eventasssert.MatchEvent(
test.HasSource(eventSource),
test.HasType(eventType),
test.HasData([]byte(eventBody)),
),
).AtLeast(1))
return f
}
func BrokerDeadLetterSinkExtensions() *feature.FeatureSet {
fs := &feature.FeatureSet{
Name: "Knative Broker - DeadLetterSink - with Extensions",
Features: []*feature.Feature{
brokerSubscriberUnreachable(),
brokerSubscriberErrorNodata(),
brokerSubscriberErrorWithdata(),
},
}
return fs
}
func brokerSubscriberUnreachable() *feature.Feature {
f := feature.NewFeatureNamed("Broker Subscriber Unreachable")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
triggerName := feature.MakeRandomK8sName("triggerName")
eventSource := "source1"
eventType := "type1"
eventBody := `{"msg":"test msg"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
// Install the trigger and Point the Trigger subscriber to the sink svc.
f.Setup("install trigger", trigger.Install(
triggerName,
brokerName,
trigger.WithSubscriber(nil, "http://fake.svc.cluster.local"),
trigger.WithDeadLetterSink(service.AsKReference(sink), ""),
))
f.Setup("trigger goes ready", trigger.IsReady(triggerName))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
))
f.Assert("Receives dls extensions when subscriber is unreachable",
eventasssert.OnStore(sink).
MatchEvent(
test.HasExtension("knativeerrordest", "http://fake.svc.cluster.local"),
).
AtLeast(1),
)
return f
}
func brokerSubscriberErrorNodata() *feature.Feature {
f := feature.NewFeatureNamed("Broker Subscriber Error Nodata")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
failer := feature.MakeRandomK8sName("failer")
triggerName := feature.MakeRandomK8sName("triggerName")
eventSource := "source1"
eventType := "type1"
eventBody := `{"msg":"test msg"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
f.Setup("install failing receiver", eventshub.Install(failer,
eventshub.StartReceiver,
eventshub.DropFirstN(1),
eventshub.DropEventsResponseCode(422),
))
// Install the trigger and Point the Trigger subscriber to the sink svc.
f.Setup("install trigger", trigger.Install(
triggerName,
brokerName,
trigger.WithSubscriber(service.AsKReference(failer), ""),
trigger.WithDeadLetterSink(service.AsKReference(sink), ""),
))
f.Setup("trigger goes ready", trigger.IsReady(triggerName))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
))
f.Assert("Receives dls extensions without errordata", assertEnhancedWithKnativeErrorExtensions(
sink,
func(ctx context.Context) test.EventMatcher {
failerAddress, _ := service.Address(ctx, failer)
return test.HasExtension("knativeerrordest", failerAddress.String())
},
func(ctx context.Context) test.EventMatcher {
return test.HasExtension("knativeerrorcode", "422")
},
))
return f
}
func brokerSubscriberErrorWithdata() *feature.Feature {
f := feature.NewFeatureNamed("Broker Subscriber Error With data encoded")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
failer := feature.MakeRandomK8sName("failer")
triggerName := feature.MakeRandomK8sName("triggerName")
eventSource := "source1"
eventType := "type1"
eventBody := `{"msg":"test msg"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.ApplicationJSON, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
errorData := `{ "message": "catastrophic failure" }`
f.Setup("install failing receiver", eventshub.Install(failer,
eventshub.StartReceiver,
eventshub.DropFirstN(1),
eventshub.DropEventsResponseCode(422),
eventshub.DropEventsResponseBody(errorData),
))
// Install the trigger and Point the Trigger subscriber to the sink svc.
f.Setup("install trigger", trigger.Install(
triggerName,
brokerName,
trigger.WithSubscriber(service.AsKReference(failer), ""),
trigger.WithDeadLetterSink(service.AsKReference(sink), ""),
))
f.Setup("trigger goes ready", trigger.IsReady(triggerName))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
))
f.Assert("Receives dls extensions with errordata", assertEnhancedWithKnativeErrorExtensions(
sink,
func(ctx context.Context) test.EventMatcher {
failerAddress, _ := service.Address(ctx, failer)
return test.HasExtension("knativeerrordest", failerAddress.String())
},
func(ctx context.Context) test.EventMatcher {
return test.HasExtension("knativeerrorcode", "422")
},
func(ctx context.Context) test.EventMatcher {
return test.HasExtension("knativeerrordata", base64.StdEncoding.EncodeToString([]byte(errorData)))
},
))
return f
}
func assertEnhancedWithKnativeErrorExtensions(sinkName string, matcherfns ...func(ctx context.Context) test.EventMatcher) feature.StepFn {
return func(ctx context.Context, t feature.T) {
matchers := make([]test.EventMatcher, len(matcherfns))
for i, fn := range matcherfns {
matchers[i] = fn(ctx)
}
_ = eventshub.StoreFromContext(ctx, sinkName).AssertExact(
t,
1,
eventasssert.MatchKind(eventshub.EventReceived),
eventasssert.MatchEvent(matchers...),
)
}
}
func BrokerDeliverLongMessage() *feature.FeatureSet {
fs := &feature.FeatureSet{
Name: "Knative Broker - DeadLetterSink - with Extensions",
Features: []*feature.Feature{
brokerSubscriberLongMessage(),
},
}
return fs
}
func brokerSubscriberLongMessage() *feature.Feature {
f := feature.NewFeatureNamed("Broker Subscriber with long data message")
source := feature.MakeRandomK8sName("source")
sink := feature.MakeRandomK8sName("sink")
triggerName := feature.MakeRandomK8sName("triggerName")
eventSource := "source1"
eventType := "type1"
eventBody := strings.Repeat("X", 36864)
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType)
event.SetSource(eventSource)
event.SetData(cloudevents.TextPlain, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
f.Setup("install sink", eventshub.Install(sink, eventshub.StartReceiver))
// Install the trigger and Point the Trigger subscriber to the sink svc.
f.Setup("install trigger", trigger.Install(
triggerName,
brokerName,
trigger.WithSubscriber(service.AsKReference(sink), ""),
))
f.Setup("trigger goes ready", trigger.IsReady(triggerName))
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
))
f.Assert("receive long event on sink exactly once",
eventasssert.OnStore(sink).
MatchEvent(test.HasData([]byte(eventBody))).
Exact(1),
)
return f
}
/*
Following test sends an event to the first sink, Sink1, which will send a long response destined to Sink2.
The test will assert that the long response is received by Sink2
EventSource ---> Broker ---> Trigger1 ---> Sink1(Transformation) ---> Trigger2 --> Sink2
*/
func BrokerDeliverLongResponseMessage() *feature.FeatureSet {
fs := &feature.FeatureSet{
Name: "Knative Broker - Long Response Message",
Features: []*feature.Feature{
brokerSubscriberLongResponseMessage(),
},
}
return fs
}
func brokerSubscriberLongResponseMessage() *feature.Feature {
f := feature.NewFeatureNamed("Broker, chain of Triggers, long response message from first subscriber")
source := feature.MakeRandomK8sName("source")
sink1 := feature.MakeRandomK8sName("sink1")
sink2 := feature.MakeRandomK8sName("sink2")
trigger1 := feature.MakeRandomK8sName("trigger1")
trigger2 := feature.MakeRandomK8sName("trigger2")
eventSource1 := "source1"
eventSource2 := "source2"
eventType1 := "type1"
eventType2 := "type2"
eventBody := `{"msg":"eventBody"}`
transformedEventBody := `{"msg":"` + strings.Repeat("X", 36000) + `"}`
event := cloudevents.NewEvent()
event.SetID(uuid.New().String())
event.SetType(eventType1)
event.SetSource(eventSource1)
event.SetData(cloudevents.TextPlain, []byte(eventBody))
//Install the broker
brokerName := feature.MakeRandomK8sName("broker")
f.Setup("install broker", broker.Install(brokerName, broker.WithEnvConfig()...))
f.Requirement("broker is ready", broker.IsReady(brokerName))
f.Requirement("broker is addressable", broker.IsAddressable(brokerName))
// Sink1 will transform the event so it can be filtered by Trigger2
f.Setup("install sink1", eventshub.Install(
sink1,
eventshub.ReplyWithTransformedEvent(eventType2, eventSource2, transformedEventBody),
eventshub.StartReceiver,
))
f.Setup("install sink2", eventshub.Install(sink2, eventshub.StartReceiver))
// Install the Triggers with appropriate Sinks and filters
f.Setup("install trigger1", trigger.Install(
trigger1,
brokerName,
trigger.WithSubscriber(service.AsKReference(sink1), ""),
trigger.WithFilter(map[string]string{"type": eventType1, "source": eventSource1}),
))
f.Setup("trigger1 goes ready", trigger.IsReady(trigger1))
f.Setup("install trigger2", trigger.Install(
trigger2,
brokerName,
trigger.WithSubscriber(service.AsKReference(sink2), ""),
trigger.WithFilter(map[string]string{"type": eventType2, "source": eventSource2}),
))
f.Setup("trigger2 goes ready", trigger.IsReady(trigger2))
// Install the Source
f.Requirement("install source", eventshub.Install(
source,
eventshub.StartSenderToResource(broker.GVR(), brokerName),
eventshub.InputEvent(event),
))
f.Assert("receive long event on sink1 exactly once",
eventasssert.OnStore(sink1).
MatchEvent(test.HasData([]byte(eventBody))).
Exact(1),
)
f.Assert("receive long event on sink2 exactly once",
eventasssert.OnStore(sink2).
MatchEvent(test.HasData([]byte(transformedEventBody))).
Exact(1),
)
return f
}
type eventTestCase struct {
Type string
Source string
Extensions map[string]interface{}
}
func neweventTestCase(tp, source string) eventTestCase {