Skip to content

add service event handler for targetGroupBinding #1678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 21, 2020
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
180 changes: 180 additions & 0 deletions controllers/elbv2/eventhandlers/endpoints_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
package eventhandlers

import (
"context"
"github.com/golang/mock/gomock"
"github.com/google/go-cmp/cmp"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
elbv2api "sigs.k8s.io/aws-load-balancer-controller/apis/elbv2/v1beta1"
mock_client "sigs.k8s.io/aws-load-balancer-controller/mocks/controller-runtime/client"
"sigs.k8s.io/aws-load-balancer-controller/pkg/testutils"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllertest"
"sigs.k8s.io/controller-runtime/pkg/log"
"testing"
)

func Test_enqueueRequestsForEndpointsEvent_enqueueImpactedTargetGroupBindings(t *testing.T) {
instanceTargetType := elbv2api.TargetTypeInstance
ipTargetType := elbv2api.TargetTypeIP

type tgbListCall struct {
opts []client.ListOption
tgbs []*elbv2api.TargetGroupBinding
err error
}
type fields struct {
tgbListCalls []tgbListCall
}
type args struct {
eps *corev1.Endpoints
}
tests := []struct {
name string
fields fields
args args
wantRequests []ctrl.Request
}{
{
name: "service event should enqueue impacted ip TargetType TGBs",
fields: fields{
tgbListCalls: []tgbListCall{
{
opts: []client.ListOption{
client.InNamespace("awesome-ns"),
client.MatchingFields{"spec.serviceRef.name": "awesome-svc"},
},
tgbs: []*elbv2api.TargetGroupBinding{
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-1",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &ipTargetType,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-2",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &instanceTargetType,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-3",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &ipTargetType,
},
},
},
},
},
},
args: args{
eps: &corev1.Endpoints{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-svc",
},
},
},
wantRequests: []ctrl.Request{
{
NamespacedName: types.NamespacedName{Namespace: "awesome-ns", Name: "tgb-1"},
},
{
NamespacedName: types.NamespacedName{Namespace: "awesome-ns", Name: "tgb-3"},
},
},
},
{
name: "service event should enqueue impacted ip TargetType TGBs - ignore nil TargetType",
fields: fields{
tgbListCalls: []tgbListCall{
{
opts: []client.ListOption{
client.InNamespace("awesome-ns"),
client.MatchingFields{"spec.serviceRef.name": "awesome-svc"},
},
tgbs: []*elbv2api.TargetGroupBinding{
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-1",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: &ipTargetType,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "tgb-2",
},
Spec: elbv2api.TargetGroupBindingSpec{
TargetType: nil,
},
},
},
},
},
},
args: args{
eps: &corev1.Endpoints{
ObjectMeta: metav1.ObjectMeta{
Namespace: "awesome-ns",
Name: "awesome-svc",
},
},
},
wantRequests: []ctrl.Request{
{
NamespacedName: types.NamespacedName{Namespace: "awesome-ns", Name: "tgb-1"},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()

k8sClient := mock_client.NewMockClient(ctrl)
for _, call := range tt.fields.tgbListCalls {
var extraMatchers []interface{}
for _, opt := range call.opts {
extraMatchers = append(extraMatchers, testutils.NewListOptionEquals(opt))
}
k8sClient.EXPECT().List(gomock.Any(), gomock.Any(), extraMatchers...).DoAndReturn(
func(ctx context.Context, tgbList *elbv2api.TargetGroupBindingList, opts ...client.ListOption) error {
for _, tgb := range call.tgbs {
tgbList.Items = append(tgbList.Items, *(tgb.DeepCopy()))
}
return call.err
},
)
}

h := &enqueueRequestsForEndpointsEvent{
k8sClient: k8sClient,
logger: &log.NullLogger{},
}
queue := controllertest.Queue{Interface: workqueue.New()}
h.enqueueImpactedTargetGroupBindings(queue, tt.args.eps)
gotRequests := testutils.ExtractCTRLRequestsFromQueue(queue)
assert.True(t, cmp.Equal(tt.wantRequests, gotRequests),
"diff", cmp.Diff(tt.wantRequests, gotRequests))
})
}
}
86 changes: 86 additions & 0 deletions controllers/elbv2/eventhandlers/service.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
package eventhandlers

import (
"context"
"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
elbv2api "sigs.k8s.io/aws-load-balancer-controller/apis/elbv2/v1beta1"
"sigs.k8s.io/aws-load-balancer-controller/pkg/k8s"
"sigs.k8s.io/aws-load-balancer-controller/pkg/targetgroupbinding"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

// NewEnqueueRequestsForServiceEvent constructs new enqueueRequestsForServiceEvent.
func NewEnqueueRequestsForServiceEvent(k8sClient client.Client, logger logr.Logger) handler.EventHandler {
return &enqueueRequestsForServiceEvent{
k8sClient: k8sClient,
logger: logger,
}
}

type enqueueRequestsForServiceEvent struct {
k8sClient client.Client
logger logr.Logger
}

// Create is called in response to an create event - e.g. Pod Creation.
func (h *enqueueRequestsForServiceEvent) Create(e event.CreateEvent, queue workqueue.RateLimitingInterface) {
svcNew := e.Object.(*corev1.Service)
h.enqueueImpactedTargetGroupBindings(queue, svcNew)
}

// Update is called in response to an update event - e.g. Pod Updated.
func (h *enqueueRequestsForServiceEvent) Update(e event.UpdateEvent, queue workqueue.RateLimitingInterface) {
svcOld := e.ObjectOld.(*corev1.Service)
svcNew := e.ObjectNew.(*corev1.Service)
if !equality.Semantic.DeepEqual(svcOld.Spec.Ports, svcNew.Spec.Ports) {
h.enqueueImpactedTargetGroupBindings(queue, svcNew)
}
}

// Delete is called in response to a delete event - e.g. Pod Deleted.
func (h *enqueueRequestsForServiceEvent) Delete(e event.DeleteEvent, queue workqueue.RateLimitingInterface) {
svcOld := e.Object.(*corev1.Service)
h.enqueueImpactedTargetGroupBindings(queue, svcOld)
}

// Generic is called in response to an event of an unknown type or a synthetic event triggered as a cron or
// external trigger request - e.g. reconcile AutoScaling, or a WebHook.
func (h *enqueueRequestsForServiceEvent) Generic(e event.GenericEvent, queue workqueue.RateLimitingInterface) {
// nothing to do here
}

// enqueueImpactedEndpointBindings will enqueue all impacted TargetGroupBindings for service events.
func (h *enqueueRequestsForServiceEvent) enqueueImpactedTargetGroupBindings(queue workqueue.RateLimitingInterface, svc *corev1.Service) {
tgbList := &elbv2api.TargetGroupBindingList{}
if err := h.k8sClient.List(context.Background(), tgbList,
client.InNamespace(svc.Namespace),
client.MatchingFields{targetgroupbinding.IndexKeyServiceRefName: svc.Name}); err != nil {
h.logger.Error(err, "failed to fetch targetGroupBindings")
return
}

svcKey := k8s.NamespacedName(svc)
for _, tgb := range tgbList.Items {
if tgb.Spec.TargetType == nil || (*tgb.Spec.TargetType) != elbv2api.TargetTypeInstance {
continue
}

h.logger.V(1).Info("enqueue targetGroupBinding for service event",
"service", svcKey,
"targetGroupBinding", k8s.NamespacedName(&tgb),
)
queue.Add(reconcile.Request{
NamespacedName: types.NamespacedName{
Namespace: tgb.Namespace,
Name: tgb.Name,
},
})
}
}
Loading