github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/controller/configuration/envfrom_utils_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 configuration

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

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

	appsv1alpha1 "github.com/1aal/kubeblocks/apis/apps/v1alpha1"
	"github.com/1aal/kubeblocks/pkg/configuration/core"
	"github.com/1aal/kubeblocks/pkg/controller/component"
	intctrlutil "github.com/1aal/kubeblocks/pkg/controllerutil"
	testapps "github.com/1aal/kubeblocks/pkg/testutil/apps"
	testutil "github.com/1aal/kubeblocks/pkg/testutil/k8s"
)

var _ = Describe("ConfigEnvFrom test", func() {

	const (
		clusterDefName     = "test-clusterdef"
		clusterVersionName = "test-clusterversion"
		clusterName        = "test-cluster"

		mysqlCompDefName = "replicasets"
		mysqlCompName    = "mysql"
	)
	var (
		clusterDef     *appsv1alpha1.ClusterDefinition
		clusterVersion *appsv1alpha1.ClusterVersion
		cluster        *appsv1alpha1.Cluster

		k8sMockClient    *testutil.K8sClientMockHelper
		origCMObject     *corev1.ConfigMap
		configConstraint *appsv1alpha1.ConfigConstraint
	)

	BeforeEach(func() {
		k8sMockClient = testutil.NewK8sMockClient()

		cm := testapps.NewCustomizedObj("config/envfrom-config.yaml", &corev1.ConfigMap{},
			testCtx.UseDefaultNamespace())

		configConstraint = testapps.NewCustomizedObj("config/envfrom-constraint.yaml",
			&appsv1alpha1.ConfigConstraint{})

		clusterDef = testapps.NewClusterDefFactory(clusterDefName).
			AddComponentDef(testapps.StatefulMySQLComponent, mysqlCompDefName).
			AddConfigTemplate(cm.Name, cm.Name, configConstraint.Name, testCtx.DefaultNamespace, "mysql-config", testapps.DefaultMySQLContainerName).
			GetObject()
		clusterVersion = testapps.NewClusterVersionFactory(clusterVersionName, clusterDefName).
			AddComponentVersion(mysqlCompDefName).
			AddContainerShort("mysql", testapps.ApeCloudMySQLImage).
			GetObject()
		pvcSpec := testapps.NewPVCSpec("1Gi")
		cluster = testapps.NewClusterFactory(testCtx.DefaultNamespace, clusterName,
			clusterDef.Name, clusterVersion.Name).
			AddComponent(mysqlCompName, mysqlCompDefName).
			AddVolumeClaimTemplate(testapps.DataVolumeName, pvcSpec).
			GetObject()

		origCMObject = cm.DeepCopy()
		origCMObject.Name = core.GetComponentCfgName(clusterName, mysqlCompName, cm.Name)
	})

	AfterEach(func() {
		k8sMockClient.Finish()
	})

	Context("test config template inject envfrom", func() {
		It("should inject success", func() {
			reqCtx := intctrlutil.RequestCtx{
				Ctx: ctx,
				Log: logger,
			}
			component, err := component.BuildComponent(
				reqCtx,
				nil,
				cluster,
				clusterDef,
				&clusterDef.Spec.ComponentDefs[0],
				&cluster.Spec.ComponentSpecs[0],
				nil,
				&clusterVersion.Spec.ComponentVersions[0])
			Expect(err).Should(Succeed())

			podSpec := &corev1.PodSpec{
				Containers: []corev1.Container{
					{
						Name: testapps.DefaultMySQLContainerName,
					},
				},
			}
			k8sMockClient.MockGetMethod(testutil.WithGetReturned(testutil.WithConstructSimpleGetResult([]client.Object{
				origCMObject,
				configConstraint,
			}), testutil.WithAnyTimes()))
			k8sMockClient.MockCreateMethod(testutil.WithCreateReturned(testutil.WithCreatedFailedResult(), testutil.WithTimes(1)),
				testutil.WithCreateReturned(testutil.WithCreatedSucceedResult(), testutil.WithAnyTimes()))

			Expect(injectTemplateEnvFrom(cluster, component, podSpec, k8sMockClient.Client(), reqCtx.Ctx, nil)).ShouldNot(Succeed())
			Expect(injectTemplateEnvFrom(cluster, component, podSpec, k8sMockClient.Client(), reqCtx.Ctx, nil)).Should(Succeed())
		})

		It("should SyncEnvConfigmap success", func() {
			configSpec := clusterDef.Spec.ComponentDefs[0].ConfigSpecs[0]
			configSpec.Keys = []string{"env-config"}

			cmObj := origCMObject.DeepCopy()
			cmObj.SetName(core.GenerateEnvFromName(origCMObject.Name))
			k8sMockClient.MockGetMethod(testutil.WithGetReturned(testutil.WithConstructSimpleGetResult([]client.Object{
				cmObj,
				configConstraint,
			}), testutil.WithAnyTimes()))
			k8sMockClient.MockPatchMethod(testutil.WithFailed(core.MakeError("failed to patch"), testutil.WithTimes(1)),
				testutil.WithSucceed(), testutil.WithAnyTimes())

			Expect(SyncEnvConfigmap(configSpec, origCMObject, &configConstraint.Spec, k8sMockClient.Client(), ctx)).ShouldNot(Succeed())
			Expect(SyncEnvConfigmap(configSpec, origCMObject, &configConstraint.Spec, k8sMockClient.Client(), ctx)).Should(Succeed())
		})

		It("SyncEnvConfigmap abnormal test", func() {
			configSpec := clusterDef.Spec.ComponentDefs[0].ConfigSpecs[0]
			configSpec.AsEnvFrom = nil
			Expect(SyncEnvConfigmap(configSpec, origCMObject, &configConstraint.Spec, k8sMockClient.Client(), ctx)).Should(Succeed())

			configSpec.AsEnvFrom = nil
			cmObj := origCMObject.DeepCopy()
			cmObj.SetName(core.GenerateEnvFromName(origCMObject.Name))
			k8sMockClient.MockGetMethod(testutil.WithGetReturned(testutil.WithConstructSimpleGetResult([]client.Object{
				cmObj,
				configConstraint,
			}), testutil.WithAnyTimes()))
			k8sMockClient.MockPatchMethod(testutil.WithSucceed(testutil.WithAnyTimes()))

			configSpec = clusterDef.Spec.ComponentDefs[0].ConfigSpecs[0]
			configSpec.Keys = []string{"env-config", "not-exist"}
			Expect(SyncEnvConfigmap(configSpec, origCMObject, &configConstraint.Spec, k8sMockClient.Client(), ctx)).Should(Succeed())
		})

	})

})