Merge pull request #318 from fluxcd/gc-e2e-to-go

Move GC test to Go test suite

.github/workflows/e2e.yaml

@@ -68,11 +68,6 @@ jobs:
           kubectl -n kustomize-system wait kustomizations/common --for=condition=ready --timeout=4m
           kubectl -n kustomize-system wait kustomizations/backend --for=condition=ready --timeout=4m
           kubectl -n kustomize-system wait kustomizations/frontend --for=condition=ready --timeout=4m
-      - name: Run GC tests
-        run: |
-          kubectl get ns
-          kubectl -n kustomize-system delete -k ./config/testdata/overlays
-          until kubectl get ns staging 2>&1 | grep NotFound ; do sleep 2; done
       - name: Run impersonation tests
         run: |
           kubectl -n impersonation apply -f ./config/testdata/impersonation

controllers/kustomization_controller_gc_test.go

@@ -0,0 +1,175 @@
+/*
+Copyright 2021 The Flux authors
+
+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 controllers
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"time"
+
+	sourcev1 "github.com/fluxcd/source-controller/api/v1beta1"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	corev1 "k8s.io/api/core/v1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	apimeta "k8s.io/apimachinery/pkg/api/meta"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	"github.com/fluxcd/pkg/apis/meta"
+	"github.com/fluxcd/pkg/testserver"
+
+	kustomizev1 "github.com/fluxcd/kustomize-controller/api/v1beta1"
+)
+
+var _ = Describe("KustomizationReconciler", func() {
+	var (
+		artifactServer *testserver.ArtifactServer
+	)
+
+	BeforeEach(func() {
+		var err error
+		artifactServer, err = testserver.NewTempArtifactServer()
+		Expect(err).ToNot(HaveOccurred())
+		artifactServer.Start()
+	})
+
+	AfterEach(func() {
+		artifactServer.Stop()
+		os.RemoveAll(artifactServer.Root())
+	})
+
+	Context("Garbage collection", func() {
+		var (
+			namespace     *corev1.Namespace
+			kubeconfig    *kustomizev1.KubeConfig
+			gitRepo       *sourcev1.GitRepository
+			kustomization *kustomizev1.Kustomization
+		)
+
+		BeforeEach(func() {
+			namespace = &corev1.Namespace{}
+			namespace.Name = "gc-" + randStringRunes(5)
+			Expect(k8sClient.Create(context.Background(), namespace)).To(Succeed())
+
+			kubecfgSecret, err := kubeConfigSecret()
+			Expect(err).ToNot(HaveOccurred())
+			kubecfgSecret.Namespace = namespace.Name
+			Expect(k8sClient.Create(context.Background(), kubecfgSecret)).To(Succeed())
+			kubeconfig = &kustomizev1.KubeConfig{
+				SecretRef: meta.LocalObjectReference{
+					Name: kubecfgSecret.Name,
+				},
+			}
+
+			gitRepoKey := client.ObjectKey{
+				Name:      fmt.Sprintf("gc-%s", randStringRunes(5)),
+				Namespace: namespace.Name,
+			}
+			gitRepo = readyGitRepository(gitRepoKey, "", "", "")
+
+			kustomizationKey := types.NamespacedName{
+				Name:      "gc-" + randStringRunes(5),
+				Namespace: namespace.Name,
+			}
+			kustomization = &kustomizev1.Kustomization{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      kustomizationKey.Name,
+					Namespace: kustomizationKey.Namespace,
+				},
+				Spec: kustomizev1.KustomizationSpec{
+					Path:       "./",
+					KubeConfig: kubeconfig,
+					SourceRef: kustomizev1.CrossNamespaceSourceReference{
+						Name:      gitRepoKey.Name,
+						Namespace: gitRepoKey.Namespace,
+						Kind:      sourcev1.GitRepositoryKind,
+					},
+					TargetNamespace: namespace.Name,
+					Prune:           true,
+				},
+			}
+		})
+
+		AfterEach(func() {
+			Expect(k8sClient.Delete(context.Background(), namespace)).To(Succeed())
+		})
+
+		It("garbage collects removed workloads", func() {
+			configMapManifest := func(name string) string {
+				return fmt.Sprintf(`---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: %[1]s
+data:
+  value: %[1]s
+`, name)
+			}
+			manifest := testserver.File{Name: "configmap.yaml", Body: configMapManifest("first")}
+			artifact, err := artifactServer.ArtifactFromFiles([]testserver.File{manifest})
+			Expect(err).ToNot(HaveOccurred())
+			artifactURL, err := artifactServer.URLForFile(artifact)
+			Expect(err).ToNot(HaveOccurred())
+
+			gitRepo.Status.Artifact.URL = artifactURL
+			gitRepo.Status.Artifact.Revision = "first"
+
+			Expect(k8sClient.Create(context.Background(), gitRepo)).To(Succeed())
+			Expect(k8sClient.Status().Update(context.Background(), gitRepo)).To(Succeed())
+			Expect(k8sClient.Create(context.Background(), kustomization)).To(Succeed())
+
+			var got kustomizev1.Kustomization
+			Eventually(func() bool {
+				_ = k8sClient.Get(context.Background(), ObjectKey(kustomization), &got)
+				c := apimeta.FindStatusCondition(got.Status.Conditions, meta.ReadyCondition)
+				return c != nil && c.Reason == meta.ReconciliationSucceededReason
+			}, timeout, time.Second).Should(BeTrue())
+
+			var configMap corev1.ConfigMap
+			Expect(k8sClient.Get(context.Background(), client.ObjectKey{Name: "first", Namespace: namespace.Name}, &configMap)).To(Succeed())
+			Expect(configMap.Labels[fmt.Sprintf("%s/checksum", kustomizev1.GroupVersion.Group)]).NotTo(BeEmpty())
+
+			manifest.Body = configMapManifest("second")
+			artifact, err = artifactServer.ArtifactFromFiles([]testserver.File{manifest})
+			Expect(err).ToNot(HaveOccurred())
+			artifactURL, err = artifactServer.URLForFile(artifact)
+			Expect(err).ToNot(HaveOccurred())
+
+			gitRepo.Status.Artifact.URL = artifactURL
+			gitRepo.Status.Artifact.Revision = "second"
+			Expect(k8sClient.Status().Update(context.Background(), gitRepo)).To(Succeed())
+
+			Eventually(func() bool {
+				_ = k8sClient.Get(context.Background(), ObjectKey(kustomization), &got)
+				return got.Status.LastAppliedRevision == gitRepo.Status.Artifact.Revision
+			}, timeout, time.Second).Should(BeTrue())
+			err = k8sClient.Get(context.Background(), client.ObjectKey{Name: "first", Namespace: namespace.Name}, &configMap)
+			Expect(apierrors.IsNotFound(err)).To(BeTrue())
+			Expect(k8sClient.Get(context.Background(), client.ObjectKey{Name: "second", Namespace: namespace.Name}, &configMap)).To(Succeed())
+			Expect(configMap.Labels[fmt.Sprintf("%s/checksum", kustomizev1.GroupVersion.Group)]).NotTo(BeEmpty())
+
+			Expect(k8sClient.Delete(context.Background(), kustomization)).To(Succeed())
+			Eventually(func() bool {
+				err = k8sClient.Get(context.Background(), client.ObjectKey{Name: "second", Namespace: namespace.Name}, &configMap)
+				return apierrors.IsNotFound(err)
+			}, timeout, time.Second).Should(BeTrue())
+		})
+	})
+})

controllers/kustomization_controller_patch_test.go

@@ -67,6 +67,7 @@ var _ = Describe("KustomizationReconciler", func() {
 			artifactURL      string
 			kustomization    *kustomizev1.Kustomization
 		)
+
 		BeforeEach(func() {
 			namespace = &corev1.Namespace{}
 			namespace.Name = "patch-" + randStringRunes(5)

controllers/kustomization_controller_sops_test.go

@@ -61,6 +61,7 @@ var _ = Describe("KustomizationReconciler", func() {
 			artifactChecksum string
 			artifactURL      string
 		)
+
 		BeforeEach(func() {
 			namespace = &corev1.Namespace{}
 			namespace.Name = "sops-" + randStringRunes(5)