github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/controllers/apps/clusterdefinition_controller_test.go

/*
Copyright (C) 2022-2023 ApeCloud Co., Ltd

This file is part of KubeBlocks project

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package apps

import (
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"

	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/types"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"

	appsv1alpha1 "github.com/1aal/kubeblocks/apis/apps/v1alpha1"
	cfgcore "github.com/1aal/kubeblocks/pkg/configuration/core"
	"github.com/1aal/kubeblocks/pkg/constant"
	intctrlutil "github.com/1aal/kubeblocks/pkg/generics"
	testapps "github.com/1aal/kubeblocks/pkg/testutil/apps"
)

var _ = Describe("ClusterDefinition Controller", func() {
	const clusterDefName = "test-clusterdef"
	const clusterVersionName = "test-clusterversion"

	const statefulCompDefName = "replicasets"

	const configVolumeName = "mysql-config"

	const cmName = "mysql-tree-node-template-8.0"

	cleanEnv := func() {
		// must wait till resources deleted and no longer existed before the testcases start,
		// otherwise if later it needs to create some new resource objects with the same name,
		// in race conditions, it will find the existence of old objects, resulting failure to
		// create the new objects.
		By("clean resources")

		inNS := client.InNamespace(testCtx.DefaultNamespace)
		ml := client.HasLabels{testCtx.TestObjLabelKey}

		// resources should be released in following order
		// non-namespaced
		testapps.ClearResourcesWithRemoveFinalizerOption(&testCtx, intctrlutil.ClusterVersionSignature, true, ml)
		testapps.ClearResourcesWithRemoveFinalizerOption(&testCtx, intctrlutil.ClusterDefinitionSignature, true, ml)
		testapps.ClearResources(&testCtx, intctrlutil.ConfigConstraintSignature, ml)

		// namespaced
		testapps.ClearResourcesWithRemoveFinalizerOption(&testCtx, intctrlutil.ConfigMapSignature, true, inNS, ml)
	}

	BeforeEach(func() {
		cleanEnv()

	})

	AfterEach(func() {
		cleanEnv()
	})

	var (
		clusterDefObj     *appsv1alpha1.ClusterDefinition
		clusterVersionObj *appsv1alpha1.ClusterVersion
	)

	Context("with no ConfigSpec", func() {
		BeforeEach(func() {
			By("Create a clusterDefinition obj")
			clusterDefObj = testapps.NewClusterDefFactory(clusterDefName).
				AddComponentDef(testapps.StatefulMySQLComponent, statefulCompDefName).
				Create(&testCtx).GetObject()

			By("Create a clusterVersion obj")
			clusterVersionObj = testapps.NewClusterVersionFactory(clusterVersionName, clusterDefObj.GetName()).
				AddComponentVersion(statefulCompDefName).AddContainerShort("mysql", testapps.ApeCloudMySQLImage).
				Create(&testCtx).GetObject()
		})

		It("should update status of clusterVersion at the same time when updating clusterDefinition", func() {
			By("Check reconciled finalizer and status of ClusterDefinition")
			var cdGen int64
			Eventually(testapps.CheckObj(&testCtx, client.ObjectKeyFromObject(clusterDefObj),
				func(g Gomega, cd *appsv1alpha1.ClusterDefinition) {
					g.Expect(cd.Finalizers).NotTo(BeEmpty())
					g.Expect(cd.Status.ObservedGeneration).To(BeEquivalentTo(1))
					cdGen = cd.Status.ObservedGeneration
				})).Should(Succeed())

			By("Check reconciled finalizer and status of ClusterVersion")
			Eventually(testapps.CheckObj(&testCtx, client.ObjectKeyFromObject(clusterVersionObj),
				func(g Gomega, cv *appsv1alpha1.ClusterVersion) {
					g.Expect(cv.Finalizers).NotTo(BeEmpty())
					g.Expect(cv.Status.ObservedGeneration).To(BeEquivalentTo(1))
					g.Expect(cv.Status.ClusterDefGeneration).To(Equal(cdGen))
				})).Should(Succeed())

			By("updating clusterDefinition's spec which then update clusterVersion's status")
			Eventually(testapps.GetAndChangeObj(&testCtx, client.ObjectKeyFromObject(clusterDefObj),
				func(cd *appsv1alpha1.ClusterDefinition) {
					cd.Spec.ConnectionCredential["root"] = "password"
				})).Should(Succeed())

			By("Check ClusterVersion.Status as updated")
			Eventually(testapps.CheckObj(&testCtx, client.ObjectKeyFromObject(clusterVersionObj),
				func(g Gomega, cv *appsv1alpha1.ClusterVersion) {
					g.Expect(cv.Status.Phase).To(Equal(appsv1alpha1.AvailablePhase))
					g.Expect(cv.Status.Message).To(Equal(""))
					g.Expect(cv.Status.ClusterDefGeneration > cdGen).To(BeTrue())
				})).Should(Succeed())

			// TODO: update components to break @validateClusterVersion, and transit ClusterVersion.Status.Phase to UnavailablePhase
		})
	})

	assureCfgTplConfigMapObj := func() *corev1.ConfigMap {
		By("Create a configmap and config template obj")
		cm := testapps.CreateCustomizedObj(&testCtx, "config/config-template.yaml", &corev1.ConfigMap{},
			testCtx.UseDefaultNamespace())

		cfgTpl := testapps.CreateCustomizedObj(&testCtx, "config/config-constraint.yaml",
			&appsv1alpha1.ConfigConstraint{})
		Expect(testapps.ChangeObjStatus(&testCtx, cfgTpl, func() {
			cfgTpl.Status.Phase = appsv1alpha1.CCAvailablePhase
		})).Should(Succeed())
		return cm
	}

	Context("with ConfigSpec", func() {
		BeforeEach(func() {
			By("Create a clusterDefinition obj")
			clusterDefObj = testapps.NewClusterDefFactory(clusterDefName).
				AddComponentDef(testapps.StatefulMySQLComponent, statefulCompDefName).
				AddConfigTemplate(cmName, cmName, cmName, testCtx.DefaultNamespace, configVolumeName).
				Create(&testCtx).GetObject()

			By("Create a clusterVersion obj")
			clusterVersionObj = testapps.NewClusterVersionFactory(clusterVersionName, clusterDefObj.GetName()).
				AddComponentVersion(statefulCompDefName).AddContainerShort("mysql", testapps.ApeCloudMySQLImage).
				Create(&testCtx).GetObject()
		})

		It("should stop proceeding the status of clusterDefinition if configmap is invalid or doesn't exist", func() {
			By("check the reconciler won't update Status.ObservedGeneration if configmap doesn't exist.")
			// should use Consistently here, since cd.Status.ObservedGeneration is initialized to be zero,
			// we must watch the value for a while to tell it's not changed by the reconciler.
			Consistently(testapps.CheckObj(&testCtx, client.ObjectKeyFromObject(clusterDefObj),
				func(g Gomega, cd *appsv1alpha1.ClusterDefinition) {
					g.Expect(cd.Status.ObservedGeneration).To(BeEquivalentTo(0))
				})).Should(Succeed())

			assureCfgTplConfigMapObj()

			By("check the reconciler update Status.ObservedGeneration after configmap is created.")
			Eventually(testapps.CheckObj(&testCtx, client.ObjectKeyFromObject(clusterDefObj),
				func(g Gomega, cd *appsv1alpha1.ClusterDefinition) {
					g.Expect(cd.Status.ObservedGeneration).To(BeEquivalentTo(1))

					// check labels and finalizers
					g.Expect(cd.Finalizers).ShouldNot(BeEmpty())
					configCMLabel := cfgcore.GenerateTPLUniqLabelKeyWithConfig(cmName)
					configConstraintLabel := cfgcore.GenerateConstraintsUniqLabelKeyWithConfig(cmName)
					g.Expect(cd.Labels[configCMLabel]).Should(BeEquivalentTo(cmName))
					g.Expect(cd.Labels[configConstraintLabel]).Should(BeEquivalentTo(cmName))
				})).Should(Succeed())

			By("check the reconciler update configmap.Finalizer after configmap is created.")
			cmKey := types.NamespacedName{
				Namespace: testCtx.DefaultNamespace,
				Name:      cmName,
			}
			Eventually(testapps.CheckObj(&testCtx, cmKey, func(g Gomega, cmObj *corev1.ConfigMap) {
				g.Expect(controllerutil.ContainsFinalizer(cmObj, constant.ConfigurationTemplateFinalizerName)).To(BeTrue())
			})).Should(Succeed())
		})
	})
})