/
fake-rcl.go
382 lines (339 loc) · 12 KB
/
fake-rcl.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
package fakereconciler
import (
"context"
"fmt"
"strconv"
"sync"
"time"
"github.com/google/uuid"
"github.com/thoas/go-funk"
k8t "github.com/xenolog/k8s-utils/pkg/types"
k8u "github.com/xenolog/k8s-utils/pkg/utils"
"github.com/xenolog/k8s-utils/pkg/utils/jsonpatch"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
apimTypes "k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/watch"
klog "k8s.io/klog/v2"
controllerRTclient "sigs.k8s.io/controller-runtime/pkg/client"
controllerRTreconcile "sigs.k8s.io/controller-runtime/pkg/reconcile"
)
const (
BasePauseTime = 373 * time.Millisecond
ControlChanBuffSize = 255
MsgUnableToWatch = "Unable to watch"
MsgMainLoopIsNotStarted = "MainLoop is not started"
)
type reconcileRequest struct {
Key string
RespChan chan *ReconcileResponce
}
type reconcileStatus struct {
log []ReconcileResponce
nName apimTypes.NamespacedName
}
type kindWatcherData struct {
sync.Mutex
gvk *schema.GroupVersionKind
kind string
askToReconcile chan *reconcileRequest
reconciler controllerRTreconcile.Reconciler
processedObjs map[string]*reconcileStatus
}
type fakeReconciler struct {
sync.Mutex
scheme *runtime.Scheme
kinds map[string]*kindWatcherData
client controllerRTclient.WithWatch
mainloopContext context.Context //nolint: containedctx
watchersWG sync.WaitGroup
userTasksWG sync.WaitGroup
pauseTime time.Duration
}
func (r *fakeReconciler) GetClient() controllerRTclient.WithWatch {
return r.client
}
func (r *fakeReconciler) GetScheme() *runtime.Scheme {
return r.scheme
}
func (r *fakeReconciler) getKindStruct(kind string) (*kindWatcherData, error) {
r.Lock()
defer r.Unlock()
rv, ok := r.kinds[kind]
if !ok {
return nil, fmt.Errorf("Kind '%s' does not served by this reconcile loop, %w", kind, k8t.ErrDoNothing)
}
return rv, nil
}
func (r *kindWatcherData) GetObj(key string) (*reconcileStatus, bool) {
r.Lock()
defer r.Unlock()
rv, ok := r.processedObjs[key]
return rv, ok
}
func (r *kindWatcherData) DeleteObj(key string) error {
r.Lock()
defer r.Unlock()
if _, ok := r.processedObjs[key]; !ok {
return fmt.Errorf("%s '%s' %w", r.kind, key, k8t.ErrNotFound)
}
delete(r.processedObjs, key)
return nil
}
func (r *fakeReconciler) doReconcile(ctx context.Context, kindName string, obj controllerRTclient.Object) *ReconcileResponce {
var (
err error
res controllerRTreconcile.Result
startTime time.Time
endTime time.Time
)
kindWatcherData, err := r.getKindStruct(kindName)
if err != nil {
return &ReconcileResponce{Err: err, StartFinishTime: k8t.TimeInterval{startTime, time.Now()}}
}
nName, err := k8u.GetRuntimeObjectNamespacedName(obj)
if err != nil {
return &ReconcileResponce{Err: err, StartFinishTime: k8t.TimeInterval{startTime, time.Now()}}
}
objRec, ok := kindWatcherData.GetObj(nName.String())
if !ok {
kindWatcherData.Lock()
objRec = &reconcileStatus{}
kindWatcherData.processedObjs[nName.String()] = objRec
kindWatcherData.Unlock()
}
startTime = time.Now().UTC()
objRec.nName = nName
ensureRequiredMetaFields(ctx, r.client, obj)
res, err = kindWatcherData.reconciler.Reconcile(ctx, controllerRTreconcile.Request{NamespacedName: nName})
endTime = time.Now().UTC()
rResponse := ReconcileResponce{
Result: res,
Err: err,
StartFinishTime: k8t.TimeInterval{startTime, endTime},
}
objRec.log = append(objRec.log, rResponse)
return &rResponse
}
// Watch C/R/M/D events from fakeClient or user request.
// run one instance per Kind type
func (r *fakeReconciler) doWatch(ctx context.Context, watcher watch.Interface, kind string) {
defer r.watchersWG.Done()
r.Lock()
kindWD := r.kinds[kind]
r.Unlock()
if kindWD.reconciler == nil {
panic(fmt.Sprintf("Native reconciler for %s undefined.", kind))
}
for {
select {
case <-ctx.Done():
watcher.Stop()
klog.Infof("RCL: Watcher for %s finished", kind)
return
case req := <-kindWD.askToReconcile:
var rv *ReconcileResponce
if req.RespChan == nil {
klog.Errorf("RCL: Unable to process reconcile request for %s '%s': empty response chan given", kind, req.Key)
break
}
klog.Infof("RCL: %s '%s' going to reconcile", kind, req.Key)
nName := k8u.KeyToNamespacedName(req.Key)
obj := &unstructured.Unstructured{}
obj.SetGroupVersionKind(*kindWD.gvk)
if err := r.client.Get(ctx, nName, obj); err != nil {
klog.Errorf("RCL: Unable to process reconcile request for %s '%s': %s", kind, req.Key, err)
now := time.Now()
rv = &ReconcileResponce{Err: err, StartFinishTime: k8t.TimeInterval{now, now}}
} else {
// object fetched, call Reconcile(...)
rv = r.doReconcile(ctx, kind, obj)
msg := fmt.Sprintf("RCL: %s '%s' Reconcile result: %s", kind, req.Key, rv)
if rv.Err != nil {
klog.Errorf(msg)
} else {
klog.Infof(msg)
}
}
req.RespChan <- rv // should
close(req.RespChan) // be together
case in := <-watcher.ResultChan():
nName, err := k8u.GetRuntimeObjectNamespacedName(in.Object)
if err != nil {
panic("Wrong object passed from watcher")
}
k8sObj, ok := in.Object.(controllerRTclient.Object)
if !ok {
panic("Wrong object passed from watcher")
}
klog.Infof("RCL-ev: %s %s '%s'", in.Type, kindWD.kind, nName)
switch in.Type {
case watch.Deleted:
if len(k8sObj.GetFinalizers()) == 0 {
// no finalizers, object will be deleted by fake controllerRTclient
// fakeReconciler should to forget about deleted object
kwd, err := r.getKindStruct(nName.String())
if err == nil {
if err := kwd.DeleteObj(nName.String()); err != nil {
klog.Errorf("RCL: Unable to delete object record: %s", err)
}
}
klog.Infof("RCL: deletion of [%s] '%s' done, no finalizers.", kindWD.kind, nName)
} else {
// at least one finalizer found, DeletionTimestamp of the object should be set if absent
klog.Infof("RCL: deletion of [%s] '%s' done, there are %v finalizers found.", kindWD.kind, nName, k8sObj.GetFinalizers())
if k8sObj.GetDeletionTimestamp().IsZero() {
patch := jsonpatch.Patch{jsonpatch.NewOperation("add", "/metadata/deletionTimestamp", metav1.Now())}
obj := &unstructured.Unstructured{}
obj.SetGroupVersionKind(k8sObj.GetObjectKind().GroupVersionKind())
obj.SetNamespace(k8sObj.GetNamespace())
obj.SetName(k8sObj.GetName())
if err := r.client.Patch(ctx, obj, controllerRTclient.RawPatch(apimTypes.JSONPatchType, patch.Bytes())); err != nil && !k8u.IsNotFound(err) {
klog.Errorf("RCL: Obj '%s' deletion error: %s", nName, err)
}
// MODIFY event will initiate Reconcile automatically
klog.Infof("RCL: DeletionTimestamp of [%s] '%s' is set.", kindWD.kind, nName)
} else {
klog.Infof("RCL: DeletionTimestamp of [%s] '%s' is already found, the object was planned to delete earlier, try to reconcile.", kindWD.kind, nName)
// Reconcile(...) should be initiated explicitly
if _, err := r.reconcile(kind, nName.String()); err != nil {
klog.Errorf("RCL error: %s", err)
}
}
}
case watch.Added, watch.Modified:
if _, err := r.reconcile(kind, nName.String()); err != nil {
klog.Errorf("RCL error: %s", err)
}
case watch.Bookmark, watch.Error:
fallthrough //nolint: gocritic
default:
klog.Warning("RCL: unsupported event")
}
}
}
}
func (r *fakeReconciler) reconcile(kind, key string) (chan *ReconcileResponce, error) {
var respChan chan *ReconcileResponce
if r.mainloopContext == nil {
return nil, fmt.Errorf("Unable to reconcile, MainLoop is not started")
}
if err := r.mainloopContext.Err(); err != nil {
return nil, fmt.Errorf("Unable to reconcile: %w", err)
}
rr, err := r.getKindStruct(kind)
if err != nil {
return nil, err
}
respChan = make(chan *ReconcileResponce, 1) // buffered to push-and-close result
rr.askToReconcile <- &reconcileRequest{
Key: key,
RespChan: respChan,
}
return respChan, nil
}
func (r *fakeReconciler) Run(ctx context.Context) error {
if err := ctx.Err(); err != nil {
return fmt.Errorf("Unable to run fakeReconciler: %w", err)
}
deadline, ok := ctx.Deadline()
if !ok {
return fmt.Errorf("Unable to run fakeReconciler: context deadline not set")
}
klog.Infof(" ") // klog, sometime, eats 1st line of log. why not .
klog.Infof("RCL-LOOP: running, deadline expired in %v", time.Until(deadline).Round(time.Second))
r.Lock()
defer r.Unlock()
r.mainloopContext = ctx
for kind := range r.kinds {
list := &unstructured.UnstructuredList{}
list.SetKind(kind)
list.SetGroupVersionKind(*r.kinds[kind].gvk)
watcher, err := r.client.Watch(ctx, list)
if err != nil {
panic(err)
}
r.watchersWG.Add(1)
go r.doWatch(ctx, watcher, kind)
}
return nil
}
// todo(sv): will be better to implement in the future
// RunAndDeferWaitToFinish -- run fakeReconciler loop and defer
// Wait(...) function with infinity time to wait.
// may be used as `defer rcl.RunAndDeferWaitToFinish(ctx)()` call
// func (r *fakeReconciler) RunAndDeferWaitToFinish(ctx context.Context) func() {
// r.Run(ctx)
// klog.Warningf("RCL: deffered waiting of finishing loops is not implementing now.")
// return func() {}
// }
// Wait -- wait to finish all running fake reconcile loops
// and user requested create/reconcile calls. Like sync.Wait()
// context, passed to Run(...) will be used to cancel all waiters.
func (r *fakeReconciler) Wait() {
r.userTasksWG.Wait() // should be before watchersWG.Wait() !!!
r.watchersWG.Wait()
}
func (r *fakeReconciler) AddControllerByType(m schema.ObjectKind, rcl controllerRTreconcile.Reconciler) error {
gvk := m.GroupVersionKind()
return r.AddController(&gvk, rcl)
}
func (r *fakeReconciler) AddController(gvk *schema.GroupVersionKind, rcl controllerRTreconcile.Reconciler) error {
kind := gvk.Kind
if k, ok := r.kinds[kind]; ok {
return fmt.Errorf("Kind '%s' already set up (%s)", kind, k.gvk.String())
}
r.kinds[kind] = &kindWatcherData{
kind: kind,
askToReconcile: make(chan *reconcileRequest, ControlChanBuffSize),
processedObjs: map[string]*reconcileStatus{},
gvk: gvk,
reconciler: rcl,
}
return nil
}
func NewFakeReconciler(fakeClient controllerRTclient.WithWatch, scheme *runtime.Scheme) FakeReconciler {
rv := &fakeReconciler{
kinds: map[string]*kindWatcherData{},
scheme: scheme,
client: fakeClient,
pauseTime: BasePauseTime,
}
return rv
}
func (r *ReconcileResponce) String() string {
return fmt.Sprintf("{Err:%v Requeue:%v/%v Took:%v}", r.Err, r.Result.Requeue, r.Result.RequeueAfter, r.StartFinishTime[1].Sub(r.StartFinishTime[0]))
}
func ensureRequiredMetaFields(ctx context.Context, cl controllerRTclient.WithWatch, obj controllerRTclient.Object) {
const (
op = "add"
pathPrefix = "/metadata/"
)
objType := obj.GetObjectKind().GroupVersionKind().Kind
patch := jsonpatch.Patch{}
if obj.GetUID() == "" {
patch = append(patch, jsonpatch.NewOperation(op, pathPrefix+"uid", uuid.NewString()))
}
if ts := obj.GetCreationTimestamp(); ts.IsZero() {
patch = append(patch, jsonpatch.NewOperation(op, pathPrefix+"creationTimestamp", time.Now().UTC()))
}
if obj.GetGeneration() < 1 {
patch = append(patch, jsonpatch.NewOperation(op, pathPrefix+"generation", int64(1)))
}
if g, err := strconv.Atoi(obj.GetResourceVersion()); err != nil || g < 1 {
patch = append(patch, jsonpatch.NewOperation(op, pathPrefix+"resourceVersion", funk.RandomInt(6000, 6999))) //revive:disable:add-constant
}
if len(patch) > 0 {
pObj := &unstructured.Unstructured{}
pObj.SetGroupVersionKind(obj.GetObjectKind().GroupVersionKind())
pObj.SetNamespace(obj.GetNamespace())
pObj.SetName(obj.GetName())
if err := cl.Patch(ctx, pObj, controllerRTclient.RawPatch(apimTypes.JSONPatchType, patch.Bytes())); err != nil {
klog.Errorf("RCL: unable to fix Meta fields for %s '%s/%s': %s", objType, obj.GetNamespace(), obj.GetName(), err)
} else {
klog.Warningf("RCL: fixed Meta fields for %s '%s/%s'", objType, obj.GetNamespace(), obj.GetName())
}
}
}