Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 62 additions & 4 deletions controllers/httproute_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import (
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/predicate"
gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
)

Expand Down Expand Up @@ -42,6 +44,8 @@ func (r *HTTPRouteWatcher) Reconcile(ctx context.Context, req ctrl.Request) (ctr
return ctrl.Result{}, client.IgnoreNotFound(err)
}

base := route.DeepCopy()

// Delete
if !route.DeletionTimestamp.IsZero() {
if controllerutil.ContainsFinalizer(&route, finalizerName) {
Expand All @@ -57,7 +61,7 @@ func (r *HTTPRouteWatcher) Reconcile(ctx context.Context, req ctrl.Request) (ctr

// Remove finalizer so k8s can complete deletion
controllerutil.RemoveFinalizer(&route, finalizerName)
if err := r.Update(ctx, &route); err != nil {
if err := r.Patch(ctx, &route, client.MergeFrom(base)); err != nil {
return ctrl.Result{}, err
}
}
Expand All @@ -68,15 +72,15 @@ func (r *HTTPRouteWatcher) Reconcile(ctx context.Context, req ctrl.Request) (ctr
if route.Annotations[triggerAnnotation] != "true" {
if controllerutil.ContainsFinalizer(&route, finalizerName) {
controllerutil.RemoveFinalizer(&route, finalizerName)
return ctrl.Result{}, r.Update(ctx, &route)
return ctrl.Result{}, r.Patch(ctx, &route, client.MergeFrom(base))
}
return ctrl.Result{}, nil
}

// Ensure finalizer is registered before syncing
if !controllerutil.ContainsFinalizer(&route, finalizerName) {
controllerutil.AddFinalizer(&route, finalizerName)
if err := r.Update(ctx, &route); err != nil {
if err := r.Patch(ctx, &route, client.MergeFrom(base)); err != nil {
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
Expand Down Expand Up @@ -114,7 +118,7 @@ func (r *HTTPRouteWatcher) Reconcile(ctx context.Context, req ctrl.Request) (ctr
route.Annotations = make(map[string]string)
}
route.Annotations[checksumAnnotation] = currentHash
if err := r.Update(ctx, &route); err != nil {
if err := r.Patch(ctx, &route, client.MergeFrom(base)); err != nil {
return ctrl.Result{}, err
}

Expand Down Expand Up @@ -169,5 +173,59 @@ func computeSpecHash(spec gatewayv1.HTTPRouteSpec) (string, error) {
func (r *HTTPRouteWatcher) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&gatewayv1.HTTPRoute{}).
WithEventFilter(routeEventFilter()).
Complete(r)
}

func routeEventFilter() predicate.Predicate {
isTracked := func(obj client.Object) bool {
if obj == nil {
return false
}
return obj.GetAnnotations()[triggerAnnotation] == "true" ||
controllerutil.ContainsFinalizer(obj, finalizerName)
}

return predicate.Funcs{

CreateFunc: func(e event.CreateEvent) bool {
return isTracked(e.Object)
},
UpdateFunc: func(e event.UpdateEvent) bool {
// ignore routes without the annotation/finalizer
if !isTracked(e.ObjectOld) && !isTracked(e.ObjectNew) {
return false
}

// reconcile if deletion started
if e.ObjectNew.GetDeletionTimestamp() != nil && e.ObjectOld.GetDeletionTimestamp() == nil {
return true
}

// reconcile if spec changed (generation incremented on spec updates)
if e.ObjectNew.GetGeneration() != e.ObjectOld.GetGeneration() {
return true
}

oldTrigger := e.ObjectOld.GetAnnotations()[triggerAnnotation]
newTrigger := e.ObjectNew.GetAnnotations()[triggerAnnotation]
if oldTrigger != newTrigger {
return true
}

oldHasFin := controllerutil.ContainsFinalizer(e.ObjectOld, finalizerName)
newHasFin := controllerutil.ContainsFinalizer(e.ObjectNew, finalizerName)
return oldHasFin != newHasFin
},
DeleteFunc: func(e event.DeleteEvent) bool {
// finalizer deletion is handled via UpdateEvent when
// DeletionTimestamp is set.
// This is a placeholder in case fallback cleanup is needed.
return false
},
GenericFunc: func(e event.GenericEvent) bool {
return isTracked(e.Object)
},
}

}
109 changes: 109 additions & 0 deletions controllers/httproute_controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ import (
"sync"
"testing"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
)
Expand Down Expand Up @@ -383,3 +385,110 @@ func TestHTTPRouteWatcher_SetupWithManager(t *testing.T) {
t.Fatalf("SetupWithManager() unexpected error = %v", err)
}
}

func TestRouteEventFilter(t *testing.T) {
pred := routeEventFilter()
now := metav1.Now()

untracked := &gatewayv1.HTTPRoute{
Name: "untracked",
Generation: 1,
}
untrackedUpdated := untracked.DeepCopy()
untrackedUpdated.Generation = 2

tracked := &gatewayv1.HTTPRoute{
Name: "tracked",
Generation: 1,
Annotations: map[string]string{triggerAnnotation: "true"},
}

trackedStatusOnly := tracked.DeepCopy()
trackedStatusOnly.Status.Parents = []gatewayv1.RouteParentStatus{
{ParentRef: gatewayv1.ParentReference{Name: "gw"}},
}

trackedDeleting := tracked.DeepCopy()
trackedDeleting.DeletionTimestamp = &now

trackedGenBumped := tracked.DeepCopy()
trackedGenBumped.Generation = 2

trackedAnnotationRemoved := tracked.DeepCopy()
delete(trackedAnnotationRemoved.Annotations, triggerAnnotation)

trackedWithFinalizer := tracked.DeepCopy()
trackedWithFinalizer.Finalizers = []string{finalizerName}

if pred.Create(event.CreateEvent{Object: nil}) {
t.Error("expected nil CreateEvent to be filtered out")
}
if pred.Create(event.CreateEvent{Object: untracked}) {
t.Error("expected untracked CreateEvent to be filtered out")
}
if !pred.Create(event.CreateEvent{Object: tracked}) {
t.Error("expected tracked CreateEvent to pass")
}
if pred.Delete(event.DeleteEvent{Object: tracked}) {
t.Error("expected DeleteEvent to be skipped")
}
if !pred.Generic(event.GenericEvent{Object: tracked}) {
t.Error("expected tracked GenericEvent to pass")
}

updateTests := []struct {
name string
oldObj *gatewayv1.HTTPRoute
newObj *gatewayv1.HTTPRoute
want bool
}{
{
name: "ignores untracked route changes",
oldObj: untracked,
newObj: untrackedUpdated,
want: false,
},
{
name: "ignores status-only update on tracked route",
oldObj: tracked,
newObj: trackedStatusOnly,
want: false,
},
{
name: "passes when deletion timestamp is set",
oldObj: tracked,
newObj: trackedDeleting,
want: true,
},
{
name: "passes when generation increments",
oldObj: tracked,
newObj: trackedGenBumped,
want: true,
},
{
name: "passes when trigger annotation is removed",
oldObj: tracked,
newObj: trackedAnnotationRemoved,
want: true,
},
{
name: "passes when finalizer is added",
oldObj: tracked,
newObj: trackedWithFinalizer,
want: true,
},
}

for _, tc := range updateTests {
t.Run(tc.name, func(t *testing.T) {
got := pred.Update(event.UpdateEvent{
ObjectOld: tc.oldObj,
ObjectNew: tc.newObj,
})
if got != tc.want {
t.Errorf("Update() = %v, want %v", got, tc.want)
}
})
}
}
Loading