From af9f31a83d64768fb3e1a927a722a99dab182b1a Mon Sep 17 00:00:00 2001
From: Aly Nathoo <aly.nathoo@dell.com>
Date: Thu, 19 Dec 2024 09:56:23 -0500
Subject: [PATCH] Addressing review comments.

---
 controllers/csm_controller.go      | 3 ++-
 controllers/csm_controller_test.go | 2 --
 pkg/drivers/powerflex.go           | 2 ++
 tests/shared/common.go             | 4 +++-
 4 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/controllers/csm_controller.go b/controllers/csm_controller.go
index 7b812732..02e68cca 100644
--- a/controllers/csm_controller.go
+++ b/controllers/csm_controller.go
@@ -1529,10 +1529,11 @@ func (r *ContainerStorageModuleReconciler) GetK8sClient() kubernetes.Interface {
 	return r.K8sClient
 }
 
+// ZoneValidation - If zones are configured performs validation and returns an error if the zone validation fails
 func (r *ContainerStorageModuleReconciler) ZoneValidation(ctx context.Context, cr *csmv1.ContainerStorageModule) error {
 	err := drivers.ValidateZones(ctx, cr, r.Client)
 	if err != nil {
-		return fmt.Errorf("ZoneValidation failed with error: %v", err)
+		return fmt.Errorf("zone validation failed with error: %v", err)
 	}
 
 	return err
diff --git a/controllers/csm_controller_test.go b/controllers/csm_controller_test.go
index ff144b0d..ca1ceda0 100644
--- a/controllers/csm_controller_test.go
+++ b/controllers/csm_controller_test.go
@@ -585,7 +585,6 @@ func (suite *CSMControllerTestSuite) TestCsmDowngrade() {
 	if err != nil {
 		panic(err)
 	}
-	// sec := shared.MakeSecret(csmName+"-config", suite.namespace, pFlexConfigVersion)
 	sec := shared.MakeSecretPowerFlex(csmName+"-config", suite.namespace, pFlexConfigVersion)
 	err = suite.fakeClient.Create(ctx, sec)
 	if err != nil {
@@ -654,7 +653,6 @@ func (suite *CSMControllerTestSuite) TestCsmDowngradeSkipVersion() {
 	if err != nil {
 		panic(err)
 	}
-	// sec := shared.MakeSecret(csmName+"-config", suite.namespace, pFlexConfigVersion)
 	sec := shared.MakeSecretPowerFlex(csmName+"-config", suite.namespace, pFlexConfigVersion)
 	err = suite.fakeClient.Create(ctx, sec)
 	if err != nil {
diff --git a/pkg/drivers/powerflex.go b/pkg/drivers/powerflex.go
index 88de486d..cb28d7b5 100644
--- a/pkg/drivers/powerflex.go
+++ b/pkg/drivers/powerflex.go
@@ -347,12 +347,14 @@ func ModifyPowerflexCR(yamlString string, cr csmv1.ContainerStorageModule, fileT
 	return yamlString
 }
 
+// ValidateZones - zone validation for topology aware clusters
 func ValidateZones(ctx context.Context, cr *csmv1.ContainerStorageModule, ct client.Client) error {
 	secretName := cr.Name + "-config"
 	err := ValidateZonesInSecret(ctx, ct, cr.Namespace, secretName)
 	return err
 }
 
+// ValidateZonesInSecret - inspects incoming secret for zone validity
 func ValidateZonesInSecret(ctx context.Context, kube client.Client, namespace string, secret string) error {
 	log := logger.GetLogger(ctx)
 
diff --git a/tests/shared/common.go b/tests/shared/common.go
index 6db741c7..f73b34d0 100644
--- a/tests/shared/common.go
+++ b/tests/shared/common.go
@@ -144,6 +144,7 @@ func MakeModule(configVersion string) csmv1.Module {
 	return moduleObj
 }
 
+// MakeSecretPowerFlexWithZone  returns a driver pre-req secret with zoning specified
 func MakeSecretPowerFlexWithZone(name, ns, _ string) *corev1.Secret {
 	dataWithZone := `
 - username: "admin"
@@ -168,7 +169,7 @@ func MakeSecretPowerFlexWithZone(name, ns, _ string) *corev1.Secret {
 	return secret
 }
 
-// MakeSecret  returns a driver pre-req secret array-config
+// MakeSecretPowerFlex  returns a pflex driver pre-req secret
 func MakeSecretPowerFlex(name, ns, _ string) *corev1.Secret {
 	dataWithoutZone := `
 - username: "admin"
@@ -191,6 +192,7 @@ func MakeSecretPowerFlex(name, ns, _ string) *corev1.Secret {
 	return secret
 }
 
+// MakeSecretPowerFlexMultiZoneInvalid  returns a pflex driver pre-req secret with invalid zone config
 func MakeSecretPowerFlexMultiZoneInvalid(name, ns, _ string) *corev1.Secret {
 	dataWithInvalidZone := `
 - username: "admin"