CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project are documented in this file.
 
+## 0.14.0
+
+**Release date:** 2021-08-26
+
+This prerelease comes with improvements to garbage collection.
+When pruning is enabled, the controller will skip the deletion of objects with
+[ownerReference.BlockOwnerDeletion=true](https://v1-18.docs.kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/#controlling-how-the-garbage-collector-deletes-dependents),
+as they are subject to Kubernetes GC.
+
+The controller dependencies has been updated to match
+kustomize [v4.3.0](https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.3.0).
+
+Improvements:
+* Update controller to kustomize v4.3.0
+  [#416](https://github.com/fluxcd/kustomize-controller/pull/416)
+* Skip garbage collection of objects with owner references
+  [#411](https://github.com/fluxcd/kustomize-controller/pull/411)
+* Add tests for various kustomize transformers
+  [#408](https://github.com/fluxcd/kustomize-controller/pull/408)
+
 ## 0.13.3
 
 **Release date:** 2021-08-05

api/v1beta1/kustomization_types.go

@@ -358,14 +358,9 @@ func init() {
 }
 
 func trimString(str string, limit int) string {
-	result := str
-	chars := 0
-	for i := range str {
-		if chars >= limit {
-			result = str[:i] + "..."
-			break
-		}
-		chars++
+	if len(str) <= limit {
+		return str
 	}
-	return result
+
+	return str[0:limit] + "..."
 }

config/manager/kustomization.yaml

@@ -5,4 +5,4 @@ resources:
 images:
   - name: fluxcd/kustomize-controller
     newName: fluxcd/kustomize-controller
-    newTag: v0.13.3
+    newTag: v0.14.0

controllers/kustomization_controller_gc_test.go

@@ -112,7 +112,7 @@ var _ = Describe("KustomizationReconciler", func() {
 			Expect(k8sClient.Delete(context.Background(), namespace)).To(Succeed())
 		})
 
-		It("garbage collects deleted manifests", func() {
+		It("collects deleted manifests", func() {
 			configMapManifest := func(name string) string {
 				return fmt.Sprintf(`---
 apiVersion: v1
@@ -176,6 +176,163 @@ data:
 			Expect(apierrors.IsNotFound(err)).To(BeTrue())
 		})
 
+		It("skips objects with blockOwnerDeletion=true", 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(), client.ObjectKeyFromObject(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())
+
+			owner := &corev1.ServiceAccount{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: namespace.Name,
+				},
+			}
+			Expect(k8sClient.Create(context.Background(), owner)).To(Succeed())
+
+			sa := &corev1.ServiceAccount{}
+			objName := types.NamespacedName{Name: "test", Namespace: namespace.Name}
+			Expect(k8sClient.Get(context.Background(), objName, sa)).To(Succeed())
+
+			blockOwnerDeletion := true
+			owned := &corev1.ConfigMap{
+				TypeMeta: metav1.TypeMeta{},
+				ObjectMeta: metav1.ObjectMeta{
+					Name:        "test",
+					Namespace:   namespace.Name,
+					Labels:      configMap.GetLabels(),
+					Annotations: configMap.GetAnnotations(),
+					OwnerReferences: []metav1.OwnerReference{
+						{
+							APIVersion:         "v1",
+							Kind:               "ServiceAccount",
+							Name:               sa.Name,
+							UID:                sa.UID,
+							Controller:         &blockOwnerDeletion,
+							BlockOwnerDeletion: &blockOwnerDeletion,
+						},
+					},
+				},
+			}
+			Expect(k8sClient.Create(context.Background(), owned)).To(Succeed())
+
+			Expect(k8sClient.Delete(context.Background(), kustomization)).To(Succeed())
+			Eventually(func() bool {
+				err = k8sClient.Get(context.Background(), client.ObjectKey{Name: kustomization.Name, Namespace: namespace.Name}, kustomization)
+				return apierrors.IsNotFound(err)
+			}, timeout, time.Second).Should(BeTrue())
+
+			cf := &corev1.ConfigMap{}
+			Expect(k8sClient.Get(context.Background(), objName, cf)).To(Succeed())
+		})
+
+		It("deletes objects with blockOwnerDeletion=false", 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(), client.ObjectKeyFromObject(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())
+
+			owner := &corev1.ServiceAccount{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "test",
+					Namespace: namespace.Name,
+				},
+			}
+			Expect(k8sClient.Create(context.Background(), owner)).To(Succeed())
+
+			sa := &corev1.ServiceAccount{}
+			objName := types.NamespacedName{Name: "test", Namespace: namespace.Name}
+			Expect(k8sClient.Get(context.Background(), objName, sa)).To(Succeed())
+
+			blockOwnerDeletion := false
+			owned := &corev1.ConfigMap{
+				TypeMeta: metav1.TypeMeta{},
+				ObjectMeta: metav1.ObjectMeta{
+					Name:        "test",
+					Namespace:   namespace.Name,
+					Labels:      configMap.GetLabels(),
+					Annotations: configMap.GetAnnotations(),
+					OwnerReferences: []metav1.OwnerReference{
+						{
+							APIVersion:         "v1",
+							Kind:               "ServiceAccount",
+							Name:               sa.Name,
+							UID:                sa.UID,
+							Controller:         &blockOwnerDeletion,
+							BlockOwnerDeletion: &blockOwnerDeletion,
+						},
+					},
+				},
+			}
+			Expect(k8sClient.Create(context.Background(), owned)).To(Succeed())
+
+			Expect(k8sClient.Delete(context.Background(), kustomization)).To(Succeed())
+			Eventually(func() bool {
+				err = k8sClient.Get(context.Background(), client.ObjectKey{Name: kustomization.Name, Namespace: namespace.Name}, kustomization)
+				return apierrors.IsNotFound(err)
+			}, timeout, time.Second).Should(BeTrue())
+
+			cf := &corev1.ConfigMap{}
+			err = k8sClient.Get(context.Background(), objName, cf)
+			Expect(apierrors.IsNotFound(err)).To(BeTrue())
+		})
+
 		It("skips deleted manifests labeled with prune disabled", func() {
 			configMapManifest := func(name string, skip string) string {
 				return fmt.Sprintf(`---