Checks for feature flag during VM reconciliation

Adds the check for the state of the anti affinity feature flag when
reconciling VM. When reconciling the VM, the cluster module info should
be looked up only when the NodeAntiAffinity feature flag is turned on.
This also solves the issue when the control plane provider is something
other than the KubeadmControlPlane, in which case we do not want to
allow checks for cluster module info.

Signed-off-by: Sagar Muchhal <[email protected]>

Author: srm09

controllers/vspherevm_controller.go

@@ -48,6 +48,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-vsphere/apis/v1beta1"
+	"sigs.k8s.io/cluster-api-provider-vsphere/feature"
 	"sigs.k8s.io/cluster-api-provider-vsphere/pkg/clustermodule"
 	"sigs.k8s.io/cluster-api-provider-vsphere/pkg/context"
 	"sigs.k8s.io/cluster-api-provider-vsphere/pkg/identity"
@@ -285,14 +286,16 @@ func (r vmReconciler) Reconcile(ctx goctx.Context, req ctrl.Request) (_ ctrl.Res
 // This logic was moved to a smaller function outside of the main Reconcile() loop
 // for the ease of testing.
 func (r vmReconciler) reconcile(ctx *context.VMContext, input fetchClusterModuleInput) (reconcile.Result, error) {
-	clusterModuleInfo, err := r.fetchClusterModuleInfo(input)
-	// If cluster module information cannot be fetched for a VM being deleted,
-	// we should not block VM deletion since the cluster module is updated
-	// once the VM gets removed.
-	if err != nil && ctx.VSphereVM.ObjectMeta.DeletionTimestamp.IsZero() {
-		return reconcile.Result{}, err
+	if feature.Gates.Enabled(feature.NodeAntiAffinity) {
+		clusterModuleInfo, err := r.fetchClusterModuleInfo(input)
+		// If cluster module information cannot be fetched for a VM being deleted,
+		// we should not block VM deletion since the cluster module is updated
+		// once the VM gets removed.
+		if err != nil && ctx.VSphereVM.ObjectMeta.DeletionTimestamp.IsZero() {
+			return reconcile.Result{}, err
+		}
+		ctx.ClusterModuleInfo = clusterModuleInfo
 	}
-	ctx.ClusterModuleInfo = clusterModuleInfo
 
 	// Handle deleted machines
 	if !ctx.VSphereVM.ObjectMeta.DeletionTimestamp.IsZero() {

controllers/vspherevm_controller_test.go

@@ -38,6 +38,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-vsphere/apis/v1beta1"
+	"sigs.k8s.io/cluster-api-provider-vsphere/feature"
 	"sigs.k8s.io/cluster-api-provider-vsphere/pkg/context"
 	"sigs.k8s.io/cluster-api-provider-vsphere/pkg/context/fake"
 	"sigs.k8s.io/cluster-api-provider-vsphere/pkg/identity"
@@ -522,18 +523,42 @@ func Test_reconcile(t *testing.T) {
 	t.Run("during VM creation", func(t *testing.T) {
 		initObjs := []client.Object{vsphereCluster, machine, vsphereVM}
 		t.Run("when info cannot be fetched", func(t *testing.T) {
-			r := setupReconciler(new(fake_svc.VMService), initObjs...)
-			_, err := r.reconcile(&context.VMContext{
-				ControllerContext: r.ControllerContext,
-				VSphereVM:         vsphereVM,
-				Logger:            r.Logger,
-			}, fetchClusterModuleInput{
-				VSphereCluster: vsphereCluster,
-				Machine:        machine,
+			t.Run("when anti affinity feature gate is turned off", func(t *testing.T) {
+				fakeVMSvc := new(fake_svc.VMService)
+				fakeVMSvc.On("ReconcileVM", mock.Anything).Return(infrav1.VirtualMachine{
+					Name:     vsphereVM.Name,
+					BiosUUID: "265104de-1472-547c-b873-6dc7883fb6cb",
+					State:    infrav1.VirtualMachineStateReady,
+				}, nil)
+				r := setupReconciler(fakeVMSvc, initObjs...)
+				_, err := r.reconcile(&context.VMContext{
+					ControllerContext: r.ControllerContext,
+					VSphereVM:         vsphereVM,
+					Logger:            r.Logger,
+				}, fetchClusterModuleInput{
+					VSphereCluster: vsphereCluster,
+					Machine:        machine,
+				})
+
+				g := NewWithT(t)
+				g.Expect(err).NotTo(HaveOccurred())
 			})
 
-			g := NewWithT(t)
-			g.Expect(err).To(HaveOccurred())
+			t.Run("when anti affinity feature gate is turned on", func(t *testing.T) {
+				_ = feature.MutableGates.Set("NodeAntiAffinity=true")
+				r := setupReconciler(new(fake_svc.VMService), initObjs...)
+				_, err := r.reconcile(&context.VMContext{
+					ControllerContext: r.ControllerContext,
+					VSphereVM:         vsphereVM,
+					Logger:            r.Logger,
+				}, fetchClusterModuleInput{
+					VSphereCluster: vsphereCluster,
+					Machine:        machine,
+				})
+
+				g := NewWithT(t)
+				g.Expect(err).To(HaveOccurred())
+			})
 		})
 
 		t.Run("when info can be fetched", func(t *testing.T) {