refactor: renames func and error messages

Author: manoj-nutanix

pkg/webhook/cluster/nutanix_validator.go

@@ -5,6 +5,7 @@ package cluster
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net"
 	"net/http"
@@ -72,7 +73,7 @@ func (a *nutanixValidator) validate(
 	if clusterConfig.Nutanix != nil &&
 		clusterConfig.Addons != nil {
 		// Check if Prism Central IP is in MetalLB Load Balancer IP range.
-		if err := checkIfPrismCentralIPInLoadBalancerIPRange(
+		if err := validatePrismCentralIPNotInLoadBalancerIPRange(
 			clusterConfig.Nutanix.PrismCentralEndpoint,
 			clusterConfig.Addons.ServiceLoadBalancer,
 		); err != nil {
@@ -83,9 +84,9 @@ func (a *nutanixValidator) validate(
 	return admission.Allowed("")
 }
 
-// checkIfPrismCentralIPInLoadBalancerIPRange checks if the Prism Central IP is in the MetalLB Load Balancer IP range.
-// Errors out if Prism Central IP is in the Load Balancer IP range.
-func checkIfPrismCentralIPInLoadBalancerIPRange(
+// validatePrismCentralIPNotInLoadBalancerIPRange checks if the Prism Central IP is not
+// in the MetalLB Load Balancer IP range and error out if it is.
+func validatePrismCentralIPNotInLoadBalancerIPRange(
 	pcEndpoint v1alpha1.NutanixPrismCentralEndpointSpec,
 	serviceLoadBalancerConfiguration *v1alpha1.ServiceLoadBalancer,
 ) error {
@@ -110,16 +111,21 @@ func checkIfPrismCentralIPInLoadBalancerIPRange(
 		isIPInRange, err := helpers.IsIPInRange(pool.Start, pool.End, pcIP.String())
 		if err != nil {
 			return fmt.Errorf(
-				"error while checking if Prism Central IP %q is part of MetalLB address range %q-%q: %w",
+				"failed to check if Prism Central IP %q is part of MetalLB address range %q-%q: %w",
 				pcIP,
 				pool.Start,
 				pool.End,
 				err,
 			)
 		}
 		if isIPInRange {
-			return fmt.Errorf("prism central IP %q must not be part of MetalLB address range %q-%q",
-				pcIP, pool.Start, pool.End)
+			errMsg := fmt.Sprintf(
+				"Prism Central IP %q must not be part of MetalLB address range %q-%q",
+				pcIP,
+				pool.Start,
+				pool.End,
+			)
+			return errors.New(errMsg)
 		}
 	}
 

pkg/webhook/cluster/nutanix_validator_test.go

@@ -12,7 +12,7 @@ import (
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
 )
 
-func TestCheckIfPrismCentralIPInLoadBalancerIPRange(t *testing.T) {
+func TestValidatePrismCentralIPNotInLoadBalancerIPRange(t *testing.T) {
 	tests := []struct {
 		name                             string
 		pcEndpoint                       v1alpha1.NutanixPrismCentralEndpointSpec
@@ -48,7 +48,7 @@ func TestCheckIfPrismCentralIPInLoadBalancerIPRange(t *testing.T) {
 				},
 			},
 			expectedErr: fmt.Errorf(
-				"prism central IP %q must not be part of MetalLB address range %q-%q",
+				"Prism Central IP %q must not be part of MetalLB address range %q-%q",
 				"192.168.1.15",
 				"192.168.1.10",
 				"192.168.1.20",
@@ -99,7 +99,7 @@ func TestCheckIfPrismCentralIPInLoadBalancerIPRange(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			err := checkIfPrismCentralIPInLoadBalancerIPRange(
+			err := validatePrismCentralIPNotInLoadBalancerIPRange(
 				tt.pcEndpoint,
 				tt.serviceLoadBalancerConfiguration,
 			)