Move WithClusterSuffix to utils package

Author: wongni

api/v1beta1/conversion.go

@@ -22,7 +22,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	conv "k8s.io/apimachinery/pkg/conversion"
 	"sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
-	"sigs.k8s.io/cluster-api-provider-cloudstack/controllers"
+	"sigs.k8s.io/cluster-api-provider-cloudstack/controllers/utils"
 	"sigs.k8s.io/cluster-api-provider-cloudstack/pkg/cloud"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
@@ -142,7 +142,7 @@ func GetDefaultFailureDomainName(namespace string, clusterName string, zoneID st
 }
 
 func WithZoneID(zoneID, clusterName string) string {
-	return controllers.WithClusterSuffix(zoneID[len(zoneID)-8:], clusterName)
+	return utils.WithClusterSuffix(zoneID[len(zoneID)-8:], clusterName)
 }
 
 func fetchZoneIDUsingK8s(namespace string, zoneName string) (string, error) {

controllers/cloudstackcluster_controller.go

@@ -20,7 +20,6 @@ import (
 	"context"
 	"fmt"
 	"reflect"
-	"strings"
 
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
@@ -31,6 +30,7 @@ import (
 
 	"github.com/pkg/errors"
 	infrav1 "sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
+	"sigs.k8s.io/cluster-api-provider-cloudstack/controllers/utils"
 	csCtrlrUtils "sigs.k8s.io/cluster-api-provider-cloudstack/controllers/utils"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/util"
@@ -109,7 +109,7 @@ func (r *CloudStackClusterReconciliationRunner) VerifyFailureDomainCRDs() (ctrl.
 	for _, requiredFd := range r.ReconciliationSubject.Spec.FailureDomains {
 		found := false
 		for _, fd := range r.FailureDomains.Items {
-			requiredFDName := WithClusterSuffix(requiredFd.Name, r.CAPICluster.Name)
+			requiredFDName := utils.WithClusterSuffix(requiredFd.Name, r.CAPICluster.Name)
 			if requiredFDName == fd.Name {
 				found = true
 				if !fd.Status.Ready {
@@ -125,20 +125,11 @@ func (r *CloudStackClusterReconciliationRunner) VerifyFailureDomainCRDs() (ctrl.
 	return ctrl.Result{}, nil
 }
 
-// WithClusterSuffix appends a hyphen and the cluster name to a name if not already present.
-func WithClusterSuffix(name string, clusterName string) string {
-	newName := name
-	if !strings.HasSuffix(name, "-"+clusterName) { // Add cluster name suffix if missing.
-		newName = name + "-" + clusterName
-	}
-	return newName
-}
-
 // SetFailureDomainsStatusMap sets failure domains in CloudStackCluster status to be used for CAPI machine placement.
 func (r *CloudStackClusterReconciliationRunner) SetFailureDomainsStatusMap() (ctrl.Result, error) {
 	r.ReconciliationSubject.Status.FailureDomains = clusterv1.FailureDomains{}
 	for _, fdSpec := range r.ReconciliationSubject.Spec.FailureDomains {
-		fdSpec.Name = WithClusterSuffix(fdSpec.Name, r.CAPICluster.Name)
+		fdSpec.Name = utils.WithClusterSuffix(fdSpec.Name, r.CAPICluster.Name)
 		r.ReconciliationSubject.Status.FailureDomains[fdSpec.Name] = clusterv1.FailureDomainSpec{ControlPlane: true}
 	}
 	return ctrl.Result{}, nil

controllers/utils/utils.go

@@ -166,3 +166,12 @@ func ContainsNoMatchSubstring(err error) bool {
 func ContainsAlreadyExistsSubstring(err error) bool {
 	return strings.Contains(strings.ToLower(err.Error()), "already exists")
 }
+
+// WithClusterSuffix appends a hyphen and the cluster name to a name if not already present.
+func WithClusterSuffix(name string, clusterName string) string {
+	newName := name
+	if !strings.HasSuffix(name, "-"+clusterName) { // Add cluster name suffix if missing.
+		newName = name + "-" + clusterName
+	}
+	return newName
+}