tests: add KongServiceFacade integration test (#5264)

Co-authored-by: Jakub Warczarek <jakub.warczarek@konghq.com>

Makefile

@@ -248,8 +248,8 @@ generate.clientsets: client-gen
 		--logtostderr \
 		--clientset-name clientset \
 		--input-base $(REPO_URL)/$(GO_MOD_MAJOR_VERSION)/pkg/apis/ \
-		--input configuration/v1,configuration/v1beta1,configuration/v1alpha1 \
-		--input-dirs $(REPO_URL)/pkg/apis/configuration/v1alpha1/,$(REPO_URL)/pkg/apis/configuration/v1beta1/,$(REPO_URL)/pkg/apis/configuration/v1/ \
+		--input configuration/v1,configuration/v1beta1,configuration/v1alpha1,incubator/v1alpha1 \
+		--input-dirs $(REPO_URL)/pkg/apis/configuration/v1alpha1/,$(REPO_URL)/pkg/apis/configuration/v1beta1/,$(REPO_URL)/pkg/apis/configuration/v1/,$(REPO_URL)/pkg/apis/incubator/v1alpha1 \
 		--output-base pkg/ \
 		--output-package $(REPO_URL)/$(GO_MOD_MAJOR_VERSION)/pkg/ \
 		--trim-path-prefix pkg/$(REPO_URL)/$(GO_MOD_MAJOR_VERSION)/

config/dev/manager_dev.yaml

@@ -17,7 +17,7 @@ spec:
       containers:
       - name: ingress-controller
         args:
-          - --feature-gates=GatewayAlpha=true
+          - --feature-gates=GatewayAlpha=true,KongServiceFacade=true
           - --anonymous-reports=false
         env:
         - name: CONTROLLER_LOG_LEVEL

internal/dataplane/translator/ingressrules.go

@@ -303,6 +303,10 @@ func resolveKubernetesServiceForBackend(storer store.Storer, ingressNamespace st
 
 	// Merge the annotations from the KongServiceFacade with the annotations from the Service.
 	// KongServiceFacade overrides the Service annotations if they have the same key.
+	// We make a copy of the Kubernetes Service to avoid mutating the cache (the k8sService we
+	// get from the storer is a pointer).
+	k8sService = k8sService.DeepCopy()
+
 	for k, v := range serviceFacadeAnnotations {
 		if k8sService.Annotations == nil {
 			k8sService.Annotations = make(map[string]string)

internal/dataplane/translator/ingressrules_test.go

@@ -820,3 +820,50 @@ func TestResolveKubernetesServiceForBackend(t *testing.T) {
 		})
 	}
 }
+
+func TestResolveKubernetesServiceForBackend_DoesNotModifyCache(t *testing.T) {
+	svc := &corev1.Service{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "test-service",
+			Namespace: "test-namespace",
+			Annotations: map[string]string{
+				"service": "from-service",
+			},
+		},
+	}
+	// Preserve a copy to compare against later.
+	svcCopy := svc.DeepCopy()
+
+	kongServiceFacade := &incubatorv1alpha1.KongServiceFacade{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "test-service-facade",
+			Namespace: "test-namespace",
+			Annotations: map[string]string{
+				"facade": "from-facade",
+			},
+		},
+		Spec: incubatorv1alpha1.KongServiceFacadeSpec{
+			Backend: incubatorv1alpha1.KongServiceFacadeBackend{
+				Name: "test-service",
+				Port: 80,
+			},
+		},
+	}
+	fakeStore := lo.Must(store.NewFakeStore(store.FakeObjects{
+		Services:           []*corev1.Service{svc},
+		KongServiceFacades: []*incubatorv1alpha1.KongServiceFacade{kongServiceFacade},
+	}))
+	backend := builder.NewKongstateServiceBackend("test-service-facade").
+		WithNamespace("test-namespace").
+		WithPortNumber(80).
+		WithType(kongstate.ServiceBackendTypeKongServiceFacade).
+		Build()
+
+	resolvedService, err := resolveKubernetesServiceForBackend(fakeStore, "test-namespace", backend)
+	require.NoError(t, err)
+	require.Equal(t, svcCopy, svc, "service stored in cache should not be modified")
+	require.Equal(t, resolvedService.Annotations, map[string]string{
+		"service": "from-service",
+		"facade":  "from-facade",
+	}, "annotations should be merged in the returned service")
+}

internal/dataplane/translator/testdata/golden/kong-service-facade/in.yaml

@@ -71,7 +71,7 @@ kind: KongServiceFacade
 metadata:
   annotations:
     kubernetes.io/ingress.class: kong
-    konghq.com/plugin: auth-alpha
+    konghq.com/plugins: auth-alpha
   name: svc-facade-alpha
   namespace: default
 spec:

internal/util/builder/ingress.go

@@ -53,3 +53,14 @@ func (b *IngressBuilder) WithNamespace(namespace string) *IngressBuilder {
 	b.ingress.ObjectMeta.Namespace = namespace
 	return b
 }
+
+func (b *IngressBuilder) WithAnnotations(annotations map[string]string) *IngressBuilder {
+	if b.ingress.Annotations == nil {
+		b.ingress.Annotations = annotations
+		return b
+	}
+	for k, v := range annotations {
+		b.ingress.Annotations[k] = v
+	}
+	return b
+}

internal/util/test/crds.go

@@ -27,6 +27,10 @@ func DeployCRDsForCluster(ctx context.Context, cluster clusters.Cluster) error {
 	if err := clusters.KustomizeDeployForCluster(ctx, cluster, kongCRDsKustomize); err != nil {
 		return err
 	}
+	fmt.Printf("INFO: deploying Kong incubator CRDs to cluster\n")
+	if err := clusters.KustomizeDeployForCluster(ctx, cluster, kongIncubatorCRDsKustomize); err != nil {
+		return err
+	}
 
 	fmt.Printf("INFO: deploying Gateway CRDs to cluster\n")
 	if err := clusters.KustomizeDeployForCluster(ctx, cluster, consts.GatewayExperimentalCRDsKustomizeURL); err != nil {

internal/util/test/kustomize_consts.go

@@ -11,12 +11,19 @@ import (
 )
 
 var (
-	kongRBACsKustomize        = initKongRBACsKustomizePath()
-	kongGatewayRBACsKustomize = initKongGatewayRBACsKustomizePath()
-	kongCRDsRBACsKustomize    = initKongCRDsRBACsKustomizePath()
-	kongCRDsKustomize         = initCRDsKustomizePath()
+	kongRBACsKustomize         = initKongRBACsKustomizePath()
+	kongGatewayRBACsKustomize  = initKongGatewayRBACsKustomizePath()
+	kongCRDsRBACsKustomize     = initKongCRDsRBACsKustomizePath()
+	kongCRDsKustomize          = initCRDsKustomizePath()
+	kongIncubatorCRDsKustomize = initIncubatorCRDsKustomizePath()
 )
 
+func initIncubatorCRDsKustomizePath() string {
+	dir := filepath.Join(lo.Must(getRepoRoot()), "config/crd/incubator")
+	ensureDirExists(dir)
+	return dir
+}
+
 func initKongRBACsKustomizePath() string {
 	dir := filepath.Join(lo.Must(getRepoRoot()), "config/rbac/")
 	ensureDirExists(dir)