/
eventtype.go
167 lines (140 loc) · 5.62 KB
/
eventtype.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
/*
Copyright 2019 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 eventtype
import (
"context"
"fmt"
"k8s.io/apimachinery/pkg/api/equality"
"github.com/knative/eventing-contrib/pkg/reconciler/eventtype/resources"
eventingv1alpha1 "github.com/knative/eventing/pkg/apis/eventing/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
)
// Reconciler is a helper struct that can be used by any source in order to reconcile its EventTypes.
type Reconciler struct {
Client client.Client
Scheme *runtime.Scheme
}
// ReconcilerArgs are the arguments needed to reconcile EventTypes.
type ReconcilerArgs struct {
Specs []eventingv1alpha1.EventTypeSpec
Namespace string
Labels map[string]string
Kind string
}
// Reconcile reconciles the EventTypes taken from 'args', and sets 'owner' as the controller.
func (r *Reconciler) Reconcile(ctx context.Context, owner metav1.Object, args *ReconcilerArgs) error {
current, err := r.getEventTypes(ctx, args.Namespace, args.Labels, owner)
if err != nil {
return err
}
expected, err := r.makeEventTypes(args, owner)
if err != nil {
return err
}
toCreate, toDelete := r.computeDiff(current, expected)
for _, eventType := range toDelete {
err = r.Client.Delete(ctx, &eventType)
if err != nil {
return err
}
}
for _, eventType := range toCreate {
err = r.Client.Create(ctx, &eventType)
if err != nil {
return err
}
}
return nil
}
// getEventTypes returns the EventTypes controlled by 'owner'.
func (r *Reconciler) getEventTypes(ctx context.Context, namespace string, lbs map[string]string, owner metav1.Object) ([]eventingv1alpha1.EventType, error) {
eventTypes := make([]eventingv1alpha1.EventType, 0)
opts := &client.ListOptions{
Namespace: namespace,
LabelSelector: labels.SelectorFromSet(lbs),
}
el := &eventingv1alpha1.EventTypeList{}
if err := r.Client.List(ctx, opts, el); err != nil {
return nil, err
}
for _, e := range el.Items {
if metav1.IsControlledBy(&e, owner) {
eventTypes = append(eventTypes, e)
}
}
return eventTypes, nil
}
// makeEventTypes creates the in-memory representation of the EventTypes.
func (r *Reconciler) makeEventTypes(args *ReconcilerArgs, owner metav1.Object) ([]eventingv1alpha1.EventType, error) {
eventTypes := make([]eventingv1alpha1.EventType, 0)
// Only create EventTypes for Broker sinks.
// We add this check here in case the Source was changed from a Broker to non-Broker sink.
// If so, we need to delete the existing EventTypes, thus we return empty expected.
if args.Kind != "Broker" {
return eventTypes, nil
}
for _, spec := range args.Specs {
eventType := resources.MakeEventType(spec, args.Namespace, args.Labels)
// Setting the reference to delete the EventType upon uninstalling the source.
if err := controllerutil.SetControllerReference(owner, &eventType, r.Scheme); err != nil {
return nil, err
}
eventTypes = append(eventTypes, eventType)
}
return eventTypes, nil
}
// computeDiff computes the EventTypes that need to be created and/or deleted based on the difference between
// 'expected' and 'current'. It does so using all the EventType.Spec fields but Description as "primary key" of the EventTypes.
func (r *Reconciler) computeDiff(current []eventingv1alpha1.EventType, expected []eventingv1alpha1.EventType) ([]eventingv1alpha1.EventType, []eventingv1alpha1.EventType) {
toCreate := make([]eventingv1alpha1.EventType, 0)
toDelete := make([]eventingv1alpha1.EventType, 0)
currentMap := asMap(current, keyFromEventType)
expectedMap := asMap(expected, keyFromEventType)
// Iterate over the slices instead of the maps for predictable UT expectations.
for _, e := range expected {
// If it's not in the currentMap, we need to create it.
if c, ok := currentMap[keyFromEventType(&e)]; !ok {
toCreate = append(toCreate, e)
} else {
// If it is but the spec differs, then we need to delete it and create it again.
if !equality.Semantic.DeepEqual(e.Spec, c.Spec) {
toDelete = append(toDelete, c)
toCreate = append(toCreate, e)
}
}
}
// Need to check whether the current EventTypes are not in the expected map. If so, we have to delete them.
// This could happen when sources COs are edited, e.g., changing the topics in a Kafka CO.
for _, c := range current {
if _, ok := expectedMap[keyFromEventType(&c)]; !ok {
toDelete = append(toDelete, c)
}
}
return toCreate, toDelete
}
// asMap returns a map representation of 'eventTypes' list, by using the key given by 'keyFunc'.
func asMap(eventTypes []eventingv1alpha1.EventType, keyFunc func(*eventingv1alpha1.EventType) string) map[string]eventingv1alpha1.EventType {
eventTypesAsMap := make(map[string]eventingv1alpha1.EventType, 0)
for _, eventType := range eventTypes {
key := keyFunc(&eventType)
eventTypesAsMap[key] = eventType
}
return eventTypesAsMap
}
func keyFromEventType(eventType *eventingv1alpha1.EventType) string {
return fmt.Sprintf("%s_%s_%s_%s", eventType.Spec.Type, eventType.Spec.Source, eventType.Spec.Schema, eventType.Spec.Broker)
}