Add kstatus conformance tests

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>

Author: stefanprodan

controllers/kustomization_wait_test.go

@@ -23,9 +23,11 @@ import (
 	"time"
 
 	. "github.com/onsi/gomega"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/runtime/conditions"
@@ -39,6 +41,8 @@ func TestKustomizationReconciler_WaitConditions(t *testing.T) {
 	g := NewWithT(t)
 	id := "wait-" + randStringRunes(5)
 	revision := "v1.0.0"
+	resultK := &kustomizev1.Kustomization{}
+	reconcileRequestAt := metav1.Now().String()
 
 	err := createNamespace(id)
 	g.Expect(err).NotTo(HaveOccurred(), "failed to create test namespace")
@@ -115,25 +119,19 @@ parameters:
 
 	g.Expect(k8sClient.Create(context.Background(), kustomization)).To(Succeed())
 
-	resultK := &kustomizev1.Kustomization{}
-
-	g.Eventually(func() bool {
-		_ = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(kustomization), resultK)
-		return resultK.Status.LastAppliedRevision == revision
-	}, timeout, time.Second).Should(BeTrue())
-
 	t.Run("reports healthy status", func(t *testing.T) {
 		g.Eventually(func() bool {
 			_ = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(kustomization), resultK)
 			return isReconcileSuccess(resultK)
-		}, time.Second, time.Second).Should(BeTrue())
+		}, timeout, time.Second).Should(BeTrue())
 		logStatus(t, resultK)
 
 		g.Expect(resultK.Status.ObservedGeneration).To(BeIdenticalTo(resultK.Generation))
+
+		kstatusCheck.CheckErr(ctx, resultK)
 	})
 
-	t.Run("reports unhealthy status", func(t *testing.T) {
-		reconcileRequestAt := metav1.Now().String()
+	t.Run("reports progressing status", func(t *testing.T) {
 		g.Eventually(func() error {
 			_ = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(kustomization), resultK)
 			resultK.SetAnnotations(map[string]string{
@@ -166,7 +164,9 @@ parameters:
 			g.Expect(conditions.GetMessage(resultK, c)).To(ContainSubstring(expectedMessage))
 			g.Expect(conditions.GetObservedGeneration(resultK, c)).To(BeIdenticalTo(resultK.Generation))
 		}
+	})
 
+	t.Run("reports unhealthy status", func(t *testing.T) {
 		g.Eventually(func() bool {
 			_ = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(kustomization), resultK)
 			return isReconcileFailure(resultK)
@@ -179,11 +179,14 @@ parameters:
 			g.Expect(conditions.GetObservedGeneration(resultK, c)).To(BeIdenticalTo(resultK.Generation))
 		}
 
+		expectedMessage := "Running health checks"
 		g.Expect(conditions.GetReason(resultK, meta.ReconcilingCondition)).To(BeIdenticalTo(meta.ProgressingReason))
 		g.Expect(conditions.GetMessage(resultK, meta.ReconcilingCondition)).To(ContainSubstring(expectedMessage))
 
 		g.Expect(resultK.Status.LastHandledReconcileAt).To(BeIdenticalTo(reconcileRequestAt))
 		g.Expect(resultK.Status.ObservedGeneration).To(BeIdenticalTo(resultK.Generation - 1))
+
+		kstatusCheck.CheckErr(ctx, resultK)
 	})
 
 	t.Run("emits unhealthy event", func(t *testing.T) {
@@ -218,6 +221,8 @@ parameters:
 		g.Expect(conditions.GetMessage(resultK, meta.ReadyCondition)).To(BeIdenticalTo(fmt.Sprintf("Applied revision: %s", revision)))
 
 		g.Expect(resultK.Status.ObservedGeneration).To(BeIdenticalTo(resultK.Generation))
+
+		kstatusCheck.CheckErr(ctx, resultK)
 	})
 
 	t.Run("emits recovery event", func(t *testing.T) {
@@ -227,4 +232,44 @@ parameters:
 		g.Expect(events[len(events)-2].Type).To(BeIdenticalTo("Normal"))
 		g.Expect(events[len(events)-2].Message).To(ContainSubstring(expectedMessage))
 	})
+
+	t.Run("reports new revision healthy status", func(t *testing.T) {
+		revision = "v2.0.0"
+		artifact, err = testServer.ArtifactFromFiles(manifests(id, revision))
+		g.Expect(err).NotTo(HaveOccurred())
+		err = applyGitRepository(repositoryName, artifact, revision)
+		g.Expect(err).NotTo(HaveOccurred())
+
+		g.Eventually(func() bool {
+			_ = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(kustomization), resultK)
+			return resultK.Status.LastAppliedRevision == revision
+		}, timeout, time.Second).Should(BeTrue())
+		logStatus(t, resultK)
+
+		g.Expect(conditions.IsTrue(resultK, kustomizev1.HealthyCondition)).To(BeTrue())
+		g.Expect(conditions.IsTrue(resultK, meta.ReadyCondition)).To(BeTrue())
+		g.Expect(conditions.GetMessage(resultK, meta.ReadyCondition)).To(BeIdenticalTo(fmt.Sprintf("Applied revision: %s", revision)))
+
+		g.Expect(resultK.Status.LastAttemptedRevision).To(BeIdenticalTo(resultK.Status.LastAppliedRevision))
+
+		kstatusCheck.CheckErr(ctx, resultK)
+	})
+
+	t.Run("emits event for the new revision", func(t *testing.T) {
+		expectedMessage := "Health check passed"
+		events := getEvents(resultK.GetName(), map[string]string{"kustomize.toolkit.fluxcd.io/revision": revision})
+		g.Expect(len(events) > 1).To(BeTrue())
+		g.Expect(events[len(events)-2].Type).To(BeIdenticalTo("Normal"))
+		g.Expect(events[len(events)-2].Message).To(ContainSubstring(expectedMessage))
+	})
+
+	t.Run("finalizes object", func(t *testing.T) {
+		g.Expect(controllerutil.ContainsFinalizer(resultK, kustomizev1.KustomizationFinalizer)).To(BeTrue())
+		g.Expect(k8sClient.Delete(context.Background(), resultK)).To(Succeed())
+
+		g.Eventually(func() bool {
+			err = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(kustomization), resultK)
+			return apierrors.IsNotFound(err)
+		}, timeout, time.Second).Should(BeTrue())
+	})
 }

controllers/suite_test.go

@@ -41,6 +41,7 @@ import (
 
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/runtime/conditions"
+	kcheck "github.com/fluxcd/pkg/runtime/conditions/check"
 	"github.com/fluxcd/pkg/runtime/controller"
 	"github.com/fluxcd/pkg/runtime/testenv"
 	"github.com/fluxcd/pkg/testserver"
@@ -69,6 +70,7 @@ var (
 	testMetricsH controller.Metrics
 	ctx          = ctrl.SetupSignalHandler()
 	kubeConfig   []byte
+	kstatusCheck *kcheck.Checker
 	debugMode    = os.Getenv("DEBUG_TEST") != ""
 )
 
@@ -160,6 +162,10 @@ func TestMain(m *testing.M) {
 	runInContext(func(testEnv *testenv.Environment) {
 		controllerName := "kustomize-controller"
 		testMetricsH = controller.MustMakeMetrics(testEnv)
+		kstatusCheck = kcheck.NewChecker(testEnv.Client,
+			&kcheck.Conditions{
+				NegativePolarity: []string{meta.StalledCondition, meta.ReconcilingCondition},
+			})
 		reconciler = &KustomizationReconciler{
 			ControllerName: controllerName,
 			Client:         testEnv,