Fix review suggestions 1

banzaicloud · Nov 22, 2022 · ff029b3 · ff029b3
1 parent a400740
commit ff029b3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/controllers/cruisecontroltask_controller.go b/controllers/cruisecontroltask_controller.go
@@ -195,16 +195,16 @@ func (r *CruiseControlTaskReconciler) Reconcile(ctx context.Context, request ctr
 			allBrokerIDs = append(allBrokerIDs, fmt.Sprint(instance.Spec.Brokers[i].Id))
 		}
 		// we can do rebalance between the broker's disks when JBOD capacity config is used
-		// this selector distinguish the JBOD brokers from the not JBOD brokers
-		// we need to search in all brokers to find out is there any not JBOD broker because
-		// CC cannot do disk rebalance when one of the brokers has not JBOD capacity configuration
+		// this selector distinguishes the JBOD brokers from the not JBOD brokers
+		// we need to search in all brokers to find out if there are any not JBOD brokers because
+		// CC cannot do disk rebalance when at least one of the brokers has not JBOD capacity configuration
 		_, brokersNotJBOD, err := brokersJBODSelector(allBrokerIDs, instance.Spec.CruiseControlConfig.CapacityConfig)
 		if err != nil {
 			return requeueWithError(log, "failed to determine which broker using JBOD or not JBOD capacity configuration at rebalance operation", err)
 		}
 
 		var cruiseControlOpRef corev1.LocalObjectReference
-		// when there is one not JBOD broker in the kafka cluster CC cannot do the disk rebalance :(
+		// when there is at least one not JBOD broker in the kafka cluster CC cannot do the disk rebalance :(
 		if len(brokersNotJBOD) > 0 {
 			cruiseControlOpRef, err = r.rebalanceDisks(ctx, instance, operationTTLSecondsAfterFinished, brokerIDs, false)
 			if err != nil {
@@ -395,7 +395,7 @@ func brokersJBODSelector(brokerIDs []string, capacityConfigJSON string) (brokers
 			continue
 		}
 
-		// this cover that case when there was a -1 default capacity config but there is an override for a specific broker
+		// this covers the case when there was a -1 default capacity config but there is an override for a specific broker
 		if _, has := brokerIsJBOD[brokerId]; has && ok {
 			brokerIsJBOD[brokerId] = true
 		}

diff --git a/controllers/cruisecontroltask_controller_test.go b/controllers/cruisecontroltask_controller_test.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2022 [Cisco Systems, Inc.](https://www.cisco.com) and/or its affiliates
+// Copyright (c) 2022 Cisco Systems, Inc. and/or its affiliates
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/controllers/tests/cruisecontroltask_controller_test.go b/controllers/tests/cruisecontroltask_controller_test.go
@@ -109,7 +109,7 @@ var _ = Describe("CruiseControlTaskReconciler", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 		})
-		It("should creates one JBOD rebalance CruiseControlOperation", func() {
+		It("should create one JBOD rebalance CruiseControlOperation", func() {
 			Eventually(func() bool {
 				err := k8sClient.Get(context.Background(), types.NamespacedName{
 					Name:      kafkaCluster.Name,
@@ -189,7 +189,7 @@ var _ = Describe("CruiseControlTaskReconciler", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 		})
-		It("should creates one not JBOD rebalance CruiseControlOperation", func() {
+		It("should create one not JBOD rebalance CruiseControlOperation", func() {
 			Eventually(func() bool {
 				err := k8sClient.Get(context.Background(), types.NamespacedName{
 					Name:      kafkaCluster.Name,
@@ -273,7 +273,7 @@ var _ = Describe("CruiseControlTaskReconciler", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 		})
-		It("should creates not JBOD rebalance CruiseControlOperation", func() {
+		It("should create one not JBOD rebalance CruiseControlOperation", func() {
 			Eventually(func() bool {
 				err := k8sClient.Get(context.Background(), types.NamespacedName{
 					Name:      kafkaCluster.Name,