Basic fd controller test runs now.

Joshua Reed · Joshua Reed · commit 26692a034205 · 2022-07-06T13:36:21.000-07:00
diff --git a/controllers/cloudstackaffinitygroup_controller.go b/controllers/cloudstackaffinitygroup_controller.go
@@ -17,6 +17,7 @@ limitations under the License.
 package controllers
 
 import (
+	"github.com/onsi/ginkgo/v2"
 	"context"
 
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -54,6 +55,7 @@ func NewCSAGReconciliationRunner() *CloudStackAGReconciliationRunner {
 }
 
 func (reconciler *CloudStackAffinityGroupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	defer ginkgo.GinkgoRecover()
 	return NewCSAGReconciliationRunner().
 		UsingBaseReconciler(reconciler.ReconcilerBase).
 		ForRequest(req).
@@ -62,6 +64,7 @@ func (reconciler *CloudStackAffinityGroupReconciler) Reconcile(ctx context.Conte
 }
 
 func (r *CloudStackAGReconciliationRunner) Reconcile() (ctrl.Result, error) {
+	defer ginkgo.GinkgoRecover()
 	controllerutil.AddFinalizer(r.ReconciliationSubject, infrav1.AffinityGroupFinalizer)
 	affinityGroup := &cloud.AffinityGroup{Name: r.ReconciliationSubject.Spec.Name, Type: r.ReconciliationSubject.Spec.Type}
 	if err := r.CSUser.GetOrCreateAffinityGroup(affinityGroup); err != nil {
diff --git a/controllers/cloudstackcluster_controller.go b/controllers/cloudstackcluster_controller.go
@@ -17,6 +17,7 @@ limitations under the License.
 package controllers
 
 import (
+	"github.com/onsi/ginkgo/v2"
 	"context"
 	"fmt"
 	"reflect"
@@ -76,6 +77,7 @@ func NewCSClusterReconciliationRunner() *CloudStackClusterReconciliationRunner {
 
 // Reconcile is the method k8s will call upon a reconciliation request.
 func (reconciler *CloudStackClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (retRes ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
 	return NewCSClusterReconciliationRunner().
 		UsingBaseReconciler(reconciler.ReconcilerBase).
 		ForRequest(req).
@@ -85,6 +87,7 @@ func (reconciler *CloudStackClusterReconciler) Reconcile(ctx context.Context, re
 
 // Reconcile actually reconciles the CloudStackCluster.
 func (r *CloudStackClusterReconciliationRunner) Reconcile() (res ctrl.Result, reterr error) {
+	defer ginkgo.GinkgoRecover()
 	return r.RunReconciliationStages(
 		r.RequeueIfMissingBaseCRs,
 		r.CreateFailureDomains(r.ReconciliationSubject.Spec.FailureDomains),
diff --git a/controllers/cloudstackcluster_controller_test.go b/controllers/cloudstackcluster_controller_test.go
@@ -28,8 +28,9 @@ import (
 var _ = Describe("CloudStackClusterReconciler", func() {
 	Context("With k8s like test environment.", func() {
 		BeforeEach(func() {
-			SetupTestEnvironment()                                              // Must happen before setting up managers/reconcilers.
-			Ω(ClusterReconciler.SetupWithManager(k8sManager)).Should(Succeed()) // Register CloudStack ClusterReconciler.
+			SetupTestEnvironment()                                                    // Must happen before setting up managers/reconcilers.
+			Ω(ClusterReconciler.SetupWithManager(k8sManager)).Should(Succeed())       // Register CloudStack ClusterReconciler.
+			Ω(FailureDomainReconciler.SetupWithManager(k8sManager)).Should(Succeed()) // Register CloudStack ClusterReconciler.
 		})
 
 		It("Should create a CloudStackFailureDomain.", func() {
diff --git a/controllers/cloudstackfailuredomain_controller.go b/controllers/cloudstackfailuredomain_controller.go
@@ -19,35 +19,67 @@ package controllers
 import (
 	"context"
 
-	"k8s.io/apimachinery/pkg/runtime"
+	"github.com/onsi/ginkgo/v2"
+
 	ctrl "sigs.k8s.io/controller-runtime"
-	"sigs.k8s.io/controller-runtime/pkg/client"
-	"sigs.k8s.io/controller-runtime/pkg/log"
 
-	infrastructurev1beta2 "sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	infrav1 "sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	csCtrlrUtils "sigs.k8s.io/cluster-api-provider-cloudstack/controllers/utils"
 )
 
-// CloudStackFailureDomainReconciler reconciles a CloudStackFailureDomain object
+// CloudStackFailureDomainReconciler is the k8s controller manager's interface to reconcile a CloudStackFailureDomain.
+// This is primarily to adapt to k8s.
 type CloudStackFailureDomainReconciler struct {
-	client.Client
-	Scheme *runtime.Scheme
+	csCtrlrUtils.ReconcilerBase
 }
 
 //+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=cloudstackfailuredomains,verbs=get;list;watch;create;update;patch;delete
 //+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=cloudstackfailuredomains/status,verbs=get;update;patch
 //+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=cloudstackfailuredomains/finalizers,verbs=update
 
-func (r *CloudStackFailureDomainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	_ = log.FromContext(ctx)
+// CloudStackFailureDomainReconciliationRunner is a ReconciliationRunner with extensions specific to CloudStackFailureDomains.
+// The runner does the actual reconciliation.
+type CloudStackFailureDomainReconciliationRunner struct {
+	csCtrlrUtils.ReconciliationRunner
+	ReconciliationSubject *infrav1.CloudStackFailureDomain
+}
+
+// Initialize a new CloudStackFailureDomain reconciliation runner with concrete types and initialized member fields.
+func NewCSFailureDomainReconciliationRunner() *CloudStackFailureDomainReconciliationRunner {
+	// Set concrete type and init pointers.
+	r := &CloudStackFailureDomainReconciliationRunner{ReconciliationSubject: &infrav1.CloudStackFailureDomain{}}
+	// Setup the base runner. Initializes pointers and links reconciliation methods.
+	r.ReconciliationRunner = csCtrlrUtils.NewRunner(r, r.ReconciliationSubject)
+
+	return r
+}
 
-	// TODO(user): your logic here
+// Reconcile is the method k8s will call upon a reconciliation request.
+func (reconciler *CloudStackFailureDomainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (retRes ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
+	return NewCSFailureDomainReconciliationRunner().
+		UsingBaseReconciler(reconciler.ReconcilerBase).
+		ForRequest(req).
+		WithRequestCtx(ctx).
+		RunBaseReconciliationStages()
+}
+
+// Reconcile on the ReconciliationRunner actually attempts to modify or create the reconciliation subject.
+func (r *CloudStackFailureDomainReconciliationRunner) Reconcile() (retRes ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
+	r.Log.Info("blah2")
+	r.ReconciliationSubject.Status.Ready = true
+	return ctrl.Result{}, nil
+}
 
+// ReconcileDelete on the ReconciliationRunner actually attempts to delete the reconciliation subject.
+func (r *CloudStackFailureDomainReconciliationRunner) ReconcileDelete() (retRes ctrl.Result, retErr error) {
+	r.Log.Info("blah3")
 	return ctrl.Result{}, nil
 }
 
 // SetupWithManager sets up the controller with the Manager.
-func (r *CloudStackFailureDomainReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewControllerManagedBy(mgr).
-		For(&infrastructurev1beta2.CloudStackFailureDomain{}).
-		Complete(r)
+func (reconciler *CloudStackFailureDomainReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	_, err := ctrl.NewControllerManagedBy(mgr).For(&infrav1.CloudStackFailureDomain{}).Build(reconciler)
+	return err
 }
diff --git a/controllers/cloudstackfailuredomain_controller_test.go b/controllers/cloudstackfailuredomain_controller_test.go
@@ -0,0 +1,48 @@
+/*
+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/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	infrav1 "sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	dummies "sigs.k8s.io/cluster-api-provider-cloudstack/test/dummies/v1beta2"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ = Describe("CloudStackFailureDomainReconciler", func() {
+	Context("With k8s like test environment.", func() {
+		BeforeEach(func() {
+			dummies.SetDummyVars()
+			SetupTestEnvironment()                                                    // Must happen before setting up managers/reconcilers.
+			Ω(FailureDomainReconciler.SetupWithManager(k8sManager)).Should(Succeed()) // Register CloudStack FailureDomainReconciler.
+		})
+
+		It("Should set failure domain Status.Ready to true.", func() {
+			Ω(k8sClient.Create(ctx, dummies.CSFailureDomain1))
+
+			tempfd := &infrav1.CloudStackFailureDomain{}
+			Eventually(func() bool {
+				key := client.ObjectKeyFromObject(dummies.CSFailureDomain1)
+				if err := k8sClient.Get(ctx, key, tempfd); err == nil {
+					return tempfd.Status.Ready
+				}
+				return false
+			}, timeout).Should(BeTrue())
+		})
+	})
+})
diff --git a/controllers/cloudstackisolatednetwork_controller.go b/controllers/cloudstackisolatednetwork_controller.go
@@ -17,6 +17,7 @@ limitations under the License.
 package controllers
 
 import (
+	"github.com/onsi/ginkgo/v2"
 	"context"
 	"strings"
 
@@ -57,6 +58,7 @@ func NewCSIsoNetReconciliationRunner() *CloudStackIsoNetReconciliationRunner {
 }
 
 func (reconciler *CloudStackIsoNetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
 	return NewCSIsoNetReconciliationRunner().
 		UsingBaseReconciler(reconciler.ReconcilerBase).
 		ForRequest(req).
@@ -65,6 +67,7 @@ func (reconciler *CloudStackIsoNetReconciler) Reconcile(ctx context.Context, req
 }
 
 func (r *CloudStackIsoNetReconciliationRunner) Reconcile() (retRes ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
 	if res, err := r.RequeueIfMissingBaseCRs(); r.ShouldReturn(res, err) {
 		return res, err
 	}
diff --git a/controllers/cloudstackmachine_controller.go b/controllers/cloudstackmachine_controller.go
@@ -17,6 +17,7 @@ limitations under the License.
 package controllers
 
 import (
+	"github.com/onsi/ginkgo/v2"
 	"context"
 	"fmt"
 	"math/rand"
@@ -81,6 +82,7 @@ func NewCSMachineReconciliationRunner() *CloudStackMachineReconciliationRunner {
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.
 func (reconciler *CloudStackMachineReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
 	return NewCSMachineReconciliationRunner().
 		UsingBaseReconciler(reconciler.ReconcilerBase).
 		ForRequest(req).
@@ -89,6 +91,7 @@ func (reconciler *CloudStackMachineReconciler) Reconcile(ctx context.Context, re
 }
 
 func (r *CloudStackMachineReconciliationRunner) Reconcile() (retRes ctrl.Result, reterr error) {
+	defer ginkgo.GinkgoRecover()
 	return r.RunReconciliationStages(
 		r.GetZonesAndRequeueIfMissing(r.Zones),
 		r.GetParent(r.ReconciliationSubject, r.CAPIMachine),
diff --git a/controllers/cloudstackmachinestatechecker_controller.go b/controllers/cloudstackmachinestatechecker_controller.go
@@ -17,6 +17,7 @@ limitations under the License.
 package controllers
 
 import (
+	"github.com/onsi/ginkgo/v2"
 	"context"
 	"strings"
 	"time"
@@ -59,6 +60,7 @@ func NewCSMachineStateCheckerReconciliationRunner() *CloudStackMachineStateCheck
 }
 
 func (r *CloudStackMachineStateCheckerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	defer ginkgo.GinkgoRecover()
 	return NewCSMachineStateCheckerReconciliationRunner().
 		UsingBaseReconciler(r.ReconcilerBase).
 		ForRequest(req).
@@ -67,6 +69,7 @@ func (r *CloudStackMachineStateCheckerReconciler) Reconcile(ctx context.Context,
 }
 
 func (r *CloudStackMachineStateCheckerReconciliationRunner) Reconcile() (ctrl.Result, error) {
+	defer ginkgo.GinkgoRecover()
 	if res, err := r.GetParent(r.ReconciliationSubject, r.CSMachine)(); r.ShouldReturn(res, err) {
 		return res, err
 	}
diff --git a/controllers/cloudstackzone_controller.go b/controllers/cloudstackzone_controller.go
@@ -17,6 +17,7 @@ limitations under the License.
 package controllers
 
 import (
+	"github.com/onsi/ginkgo/v2"
 	"context"
 
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -57,6 +58,7 @@ func NewCSZoneReconciliationRunner() *CloudStackZoneReconciliationRunner {
 
 // Reconciler Reconcile adapts the runner to the runner to what k8s expects.
 func (reconciler *CloudStackZoneReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res ctrl.Result, retErr error) {
+	defer ginkgo.GinkgoRecover()
 	return NewCSZoneReconciliationRunner().
 		UsingBaseReconciler(reconciler.ReconcilerBase).
 		ForRequest(req).
@@ -73,6 +75,7 @@ func (reconciler *CloudStackZoneReconciler) SetupWithManager(mgr ctrl.Manager) e
 
 // Reconcile attempts to move the state of CRs to the requested state.
 func (r *CloudStackZoneReconciliationRunner) Reconcile() (retRes ctrl.Result, reterr error) {
+	defer ginkgo.GinkgoRecover()
 	// Prevent premature deletion.
 	controllerutil.AddFinalizer(r.ReconciliationSubject, infrav1.ZoneFinalizer)
 
diff --git a/controllers/controllers_suite_test.go b/controllers/controllers_suite_test.go
@@ -119,11 +119,12 @@ var (
 	mockCSAPIClient *cloudstack.CloudStackClient
 
 	// Reconcilers
-	MachineReconciler   *csReconcilers.CloudStackMachineReconciler
-	ClusterReconciler   *csReconcilers.CloudStackClusterReconciler
-	ZoneReconciler      *csReconcilers.CloudStackZoneReconciler
-	IsoNetReconciler    *csReconcilers.CloudStackIsoNetReconciler
-	AffinityGReconciler *csReconcilers.CloudStackAffinityGroupReconciler
+	MachineReconciler       *csReconcilers.CloudStackMachineReconciler
+	ClusterReconciler       *csReconcilers.CloudStackClusterReconciler
+	FailureDomainReconciler *csReconcilers.CloudStackFailureDomainReconciler
+	ZoneReconciler          *csReconcilers.CloudStackZoneReconciler
+	IsoNetReconciler        *csReconcilers.CloudStackIsoNetReconciler
+	AffinityGReconciler     *csReconcilers.CloudStackAffinityGroupReconciler
 )
 
 var projectDir = os.Getenv("PROJECT_DIR")
@@ -192,8 +193,10 @@ func SetupTestEnvironment() {
 	ClusterReconciler = &csReconcilers.CloudStackClusterReconciler{ReconcilerBase: base}
 	MachineReconciler = &csReconcilers.CloudStackMachineReconciler{ReconcilerBase: base}
 	ZoneReconciler = &csReconcilers.CloudStackZoneReconciler{ReconcilerBase: base}
+	FailureDomainReconciler = &csReconcilers.CloudStackFailureDomainReconciler{ReconcilerBase: base}
 	IsoNetReconciler = &csReconcilers.CloudStackIsoNetReconciler{ReconcilerBase: base}
 	AffinityGReconciler = &csReconcilers.CloudStackAffinityGroupReconciler{ReconcilerBase: base}
+
 	ctx, cancel = context.WithCancel(context.TODO())
 
 	// Setup mock clients.
@@ -206,6 +209,7 @@ func SetupTestEnvironment() {
 	IsoNetReconciler.CSClient = mockCloudClient
 	MachineReconciler.CSClient = mockCloudClient
 	AffinityGReconciler.CSClient = mockCloudClient
+	FailureDomainReconciler.CSClient = mockCloudClient
 
 	setupClusterCRDs()
 
@@ -245,6 +249,7 @@ func setupFakeTestClient() {
 	ClusterReconciler = &csReconcilers.CloudStackClusterReconciler{ReconcilerBase: base}
 	MachineReconciler = &csReconcilers.CloudStackMachineReconciler{ReconcilerBase: base}
 	ZoneReconciler = &csReconcilers.CloudStackZoneReconciler{ReconcilerBase: base}
+	FailureDomainReconciler = &csReconcilers.CloudStackFailureDomainReconciler{ReconcilerBase: base}
 	IsoNetReconciler = &csReconcilers.CloudStackIsoNetReconciler{ReconcilerBase: base}
 	AffinityGReconciler = &csReconcilers.CloudStackAffinityGroupReconciler{ReconcilerBase: base}
 
@@ -253,6 +258,7 @@ func setupFakeTestClient() {
 	ZoneReconciler.CSClient = mockCloudClient
 	IsoNetReconciler.CSClient = mockCloudClient
 	MachineReconciler.CSClient = mockCloudClient
+	FailureDomainReconciler.CSClient = mockCloudClient
 	AffinityGReconciler.CSClient = mockCloudClient
 
 	DeferCleanup(func() {
diff --git a/test/dummies/v1beta2/vars.go b/test/dummies/v1beta2/vars.go
@@ -279,8 +279,30 @@ func SetDummyCAPCClusterVars() {
 	Net1 = infrav1.Network{Name: GetYamlVal("CLOUDSTACK_NETWORK_NAME"), Type: cloud.NetworkTypeShared}
 	Net2 = infrav1.Network{Name: "SharedGuestNet2", Type: cloud.NetworkTypeShared, ID: "FakeSharedNetID2"}
 	ISONet1 = infrav1.Network{Name: "isoguestnet1", Type: cloud.NetworkTypeIsolated, ID: "FakeIsolatedNetID1"}
-	CSFailureDomain1 = &infrav1.CloudStackFailureDomain{Spec: infrav1.CloudStackFailureDomainSpec{Zone: Zone1}}
-	CSFailureDomain2 = &infrav1.CloudStackFailureDomain{Spec: infrav1.CloudStackFailureDomainSpec{Zone: Zone1}}
+	CSFailureDomain1 = &infrav1.CloudStackFailureDomain{
+		TypeMeta: metav1.TypeMeta{
+			APIVersion: CSApiVersion,
+			Kind:       "CloudStackFailureDomain",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "fd1",
+			Namespace: "default",
+			UID:       "0",
+			Labels:    ClusterLabel,
+		},
+		Spec: infrav1.CloudStackFailureDomainSpec{Name: "fd1", Zone: Zone1}}
+	CSFailureDomain2 = &infrav1.CloudStackFailureDomain{
+		TypeMeta: metav1.TypeMeta{
+			APIVersion: CSApiVersion,
+			Kind:       "CloudStackFailureDomain",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "fd2",
+			Namespace: "default",
+			UID:       "0",
+			Labels:    ClusterLabel,
+		},
+		Spec: infrav1.CloudStackFailureDomainSpec{Zone: Zone1}}
 	CSCluster = &infrav1.CloudStackCluster{
 		TypeMeta: metav1.TypeMeta{
 			APIVersion: CSApiVersion,

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ limitations under the License.`
`17`	`17`	`package controllers`
`18`	`18`
`19`	`19`	`import (`
	`20`	`+ "github.com/onsi/ginkgo/v2"`
`20`	`21`	`"context"`
`21`	`22`	`"strings"`
`22`	`23`
`@@ -57,6 +58,7 @@ func NewCSIsoNetReconciliationRunner() *CloudStackIsoNetReconciliationRunner {`
`57`	`58`	`}`
`58`	`59`
`59`	`60`	`func (reconciler *CloudStackIsoNetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res ctrl.Result, retErr error) {`
	`61`	`+ defer ginkgo.GinkgoRecover()`
`60`	`62`	`return NewCSIsoNetReconciliationRunner().`
`61`	`63`	`UsingBaseReconciler(reconciler.ReconcilerBase).`
`62`	`64`	`ForRequest(req).`
`@@ -65,6 +67,7 @@ func (reconciler *CloudStackIsoNetReconciler) Reconcile(ctx context.Context, req`
`65`	`67`	`}`
`66`	`68`
`67`	`69`	`func (r *CloudStackIsoNetReconciliationRunner) Reconcile() (retRes ctrl.Result, retErr error) {`
	`70`	`+ defer ginkgo.GinkgoRecover()`
`68`	`71`	`if res, err := r.RequeueIfMissingBaseCRs(); r.ShouldReturn(res, err) {`
`69`	`72`	`return res, err`
`70`	`73`	`}`