-
Notifications
You must be signed in to change notification settings - Fork 451
/
operationannotation.go
79 lines (68 loc) · 2.95 KB
/
operationannotation.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
// Copyright 2023 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 operationannotation
import (
"context"
"fmt"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
)
// Reconciler is a reconciler that removes operation annotations from objects.
// This is useful for integration testing against an envtest control plane, which doesn't run the responsible
// controller. Hence, if the tested controller must wait for the annotation to be removed, it will be stuck forever.
type Reconciler struct {
Client client.Client
ForObject func() client.Object
}
// AddToManager adds Reconciler to the given manager.
func (r *Reconciler) AddToManager(mgr manager.Manager) error {
if r.Client == nil {
r.Client = mgr.GetClient()
}
return builder.ControllerManagedBy(mgr).
Named("operationannotation").
For(r.ForObject(), builder.WithPredicates(r.hasOperationAnnotation())).
WithOptions(controller.Options{
MaxConcurrentReconciles: 5,
}).
Complete(r)
}
// Reconcile removes the operation annotation from the object.
func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
log := logf.FromContext(ctx)
obj := r.ForObject()
if err := r.Client.Get(ctx, req.NamespacedName, obj); err != nil {
if apierrors.IsNotFound(err) {
log.V(1).Info("Object is gone, stop reconciling")
return reconcile.Result{}, nil
}
return reconcile.Result{}, fmt.Errorf("error retrieving object from store: %w", err)
}
log.V(1).Info("Removing operation annotation")
patch := client.MergeFrom(obj.DeepCopyObject().(client.Object))
delete(obj.GetAnnotations(), v1beta1constants.GardenerOperation)
return reconcile.Result{}, r.Client.Patch(ctx, obj, patch)
}
func (r *Reconciler) hasOperationAnnotation() predicate.Predicate {
return predicate.NewPredicateFuncs(func(obj client.Object) bool {
return obj.GetAnnotations()[v1beta1constants.GardenerOperation] != ""
})
}