cloudstackaffinitygroup_controller_test.go

/*
Copyright 2022 The Kubernetes 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_test

import (
	"github.com/golang/mock/gomock"
	ginkgo "github.com/onsi/ginkgo/v2"
	gomega "github.com/onsi/gomega"
	"k8s.io/apimachinery/pkg/api/errors"
	"k8s.io/utils/ptr"
	infrav1 "sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta3"
	"sigs.k8s.io/cluster-api-provider-cloudstack/pkg/cloud"
	dummies "sigs.k8s.io/cluster-api-provider-cloudstack/test/dummies/v1beta3"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/controller"
)

var _ = ginkgo.Describe("CloudStackAffinityGroupReconciler", func() {
	ginkgo.BeforeEach(func() {
		SetupTestEnvironment() // Must happen before setting up managers/reconcilers.
		dummies.SetDummyVars()
		gomega.Ω(AffinityGReconciler.SetupWithManager(k8sManager, controller.Options{SkipNameValidation: ptr.To(true)})).Should(gomega.Succeed()) // Register CloudStack AffinityGReconciler.
	})

	ginkgo.It("Should patch back the affinity group as ready after calling GetOrCreateAffinityGroup.", func() {
		// Modify failure domain name the same way the cluster controller would.
		dummies.CSAffinityGroup.Spec.FailureDomainName = dummies.CSFailureDomain1.Spec.Name

		mockCloudClient.EXPECT().GetOrCreateAffinityGroup(gomock.Any()).AnyTimes()

		gomega.Ω(k8sClient.Create(ctx, dummies.CSFailureDomain1))
		gomega.Ω(k8sClient.Create(ctx, dummies.CSAffinityGroup)).Should(gomega.Succeed())

		// Test that the AffinityGroup controller sets Status.Ready to true.
		gomega.Eventually(func() bool {
			nameSpaceFilter := &client.ListOptions{Namespace: dummies.ClusterNameSpace}
			affinityGroups := &infrav1.CloudStackAffinityGroupList{}
			if err := k8sClient.List(ctx, affinityGroups, nameSpaceFilter); err == nil {
				if len(affinityGroups.Items) == 1 {
					return affinityGroups.Items[0].Status.Ready
				}
			}
			return false
		}, timeout).WithPolling(pollInterval).Should(gomega.BeTrue())
	})

	ginkgo.It("Should remove affinity group finalizer if corresponding affinity group is not present on Cloudstack.", func() {
		// Modify failure domain name the same way the cluster controller would.
		dummies.CSAffinityGroup.Spec.FailureDomainName = dummies.CSFailureDomain1.Spec.Name

		mockCloudClient.EXPECT().GetOrCreateAffinityGroup(gomock.Any()).AnyTimes()

		gomega.Ω(k8sClient.Create(ctx, dummies.CSFailureDomain1))
		gomega.Ω(k8sClient.Create(ctx, dummies.CSAffinityGroup)).Should(gomega.Succeed())

		// Test that the AffinityGroup controller sets Status.Ready to true.
		gomega.Eventually(func() bool {
			nameSpaceFilter := &client.ListOptions{Namespace: dummies.ClusterNameSpace}
			affinityGroups := &infrav1.CloudStackAffinityGroupList{}
			if err := k8sClient.List(ctx, affinityGroups, nameSpaceFilter); err == nil {
				if len(affinityGroups.Items) == 1 {
					return affinityGroups.Items[0].Status.Ready
				}
			}
			return false
		}, timeout).WithPolling(pollInterval).Should(gomega.BeTrue())

		mockCloudClient.EXPECT().FetchAffinityGroup(gomock.Any()).Do(func(arg1 interface{}) {
			arg1.(*cloud.AffinityGroup).ID = ""
		}).AnyTimes().Return(nil)
		gomega.Ω(k8sClient.Delete(ctx, dummies.CSAffinityGroup))

		gomega.Ω(k8sClient.Delete(ctx, dummies.CSAffinityGroup))

		// Once the affinity group id was set to "" the controller should remove the finalizer and unblock deleting affinity group resource
		gomega.Eventually(func() bool {
			retrievedAffinityGroup := &infrav1.CloudStackAffinityGroup{}
			affinityGroupKey := client.ObjectKey{Namespace: dummies.ClusterNameSpace, Name: dummies.AffinityGroup.Name}
			if err := k8sClient.Get(ctx, affinityGroupKey, retrievedAffinityGroup); err != nil {
				return errors.IsNotFound(err)
			}
			return false
		}, timeout).WithPolling(pollInterval).Should(gomega.BeTrue())
	})
})