fix comments cont.

Author: jwtty

pkg/controllers/updaterun/controller_integration_test.go

@@ -435,16 +435,16 @@ func generateTestApprovalRequest(name string) *placementv1alpha1.ClusterApproval
 }
 
 func validateUpdateRunHasFinalizer(ctx context.Context, updateRun *placementv1alpha1.ClusterStagedUpdateRun) {
-	namepsacedName := types.NamespacedName{Name: updateRun.Name}
+	namespacedName := types.NamespacedName{Name: updateRun.Name}
 	Eventually(func() error {
-		if err := k8sClient.Get(ctx, namepsacedName, updateRun); err != nil {
-			return fmt.Errorf("failed to get clusterStagedUpdateRun %s: %w", namepsacedName, err)
+		if err := k8sClient.Get(ctx, namespacedName, updateRun); err != nil {
+			return fmt.Errorf("failed to get clusterStagedUpdateRun %s: %w", namespacedName, err)
 		}
 		if !controllerutil.ContainsFinalizer(updateRun, placementv1alpha1.ClusterStagedUpdateRunFinalizer) {
-			return fmt.Errorf("finalizer not added to clusterStagedUpdateRun %s", namepsacedName)
+			return fmt.Errorf("finalizer not added to clusterStagedUpdateRun %s", namespacedName)
 		}
 		return nil
-	}, timeout, interval).Should(Succeed(), "failed to add finalizer to clusterStagedUpdateRun %s", namepsacedName)
+	}, timeout, interval).Should(Succeed(), "failed to add finalizer to clusterStagedUpdateRun %s", namespacedName)
 }
 
 func validateUpdateRunIsDeleted(ctx context.Context, name types.NamespacedName) {

pkg/controllers/updaterun/initialization.go

@@ -105,8 +105,8 @@ func (r *Reconciler) determinePolicySnapshot(
 	}
 	if len(policySnapshotList.Items) != 1 {
 		if len(policySnapshotList.Items) > 1 {
-			err := fmt.Errorf("more than one (%d in actual) latest policy snapshots associated with the clusterResourcePlacement: %s", len(policySnapshotList.Items), placementName)
-			klog.ErrorS(controller.NewUnexpectedBehaviorError(err), "Failed to find the latest policy snapshot", "clusterResourcePlacement", placementName, "clusterStagedUpdateRun", updateRunRef)
+			err := controller.NewUnexpectedBehaviorError(fmt.Errorf("more than one (%d in actual) latest policy snapshots associated with the clusterResourcePlacement: %s", len(policySnapshotList.Items), placementName))
+			klog.ErrorS(err, "Failed to find the latest policy snapshot", "clusterResourcePlacement", placementName, "clusterStagedUpdateRun", updateRunRef)
 			// no more retries for this error.
 			return nil, -1, fmt.Errorf("%w: %s", errInitializedFailed, err.Error())
 		}
@@ -122,8 +122,8 @@ func (r *Reconciler) determinePolicySnapshot(
 
 	// Get the cluster count from the policy snapshot.
 	if latestPolicySnapshot.Spec.Policy == nil {
-		nopolicyErr := fmt.Errorf("policy snapshot `%s` does not have a policy", latestPolicySnapshot.Name)
-		klog.ErrorS(controller.NewUnexpectedBehaviorError(nopolicyErr), "Failed to get the policy from the latestPolicySnapshot", "clusterResourcePlacement", placementName, "latestPolicySnapshot", latestPolicySnapshot.Name, "clusterStagedUpdateRun", updateRunRef)
+		nopolicyErr := controller.NewUnexpectedBehaviorError(fmt.Errorf("policy snapshot `%s` does not have a policy", latestPolicySnapshot.Name))
+		klog.ErrorS(nopolicyErr, "Failed to get the policy from the latestPolicySnapshot", "clusterResourcePlacement", placementName, "latestPolicySnapshot", latestPolicySnapshot.Name, "clusterStagedUpdateRun", updateRunRef)
 		// no more retries here.
 		return nil, -1, fmt.Errorf("%w: %s", errInitializedFailed, nopolicyErr.Error())
 	}
@@ -132,8 +132,8 @@ func (r *Reconciler) determinePolicySnapshot(
 	if latestPolicySnapshot.Spec.Policy.PlacementType == placementv1beta1.PickNPlacementType {
 		count, err := annotations.ExtractNumOfClustersFromPolicySnapshot(&latestPolicySnapshot)
 		if err != nil {
-			annErr := fmt.Errorf("%w: the policy snapshot `%s` doesn't have valid cluster count annotation", err, latestPolicySnapshot.Name)
-			klog.ErrorS(controller.NewUnexpectedBehaviorError(annErr), "Failed to get the cluster count from the latestPolicySnapshot", "clusterResourcePlacement", placementName, "latestPolicySnapshot", latestPolicySnapshot.Name, "clusterStagedUpdateRun", updateRunRef)
+			annErr := controller.NewUnexpectedBehaviorError(fmt.Errorf("%w: the policy snapshot `%s` doesn't have valid cluster count annotation", err, latestPolicySnapshot.Name))
+			klog.ErrorS(annErr, "Failed to get the cluster count from the latestPolicySnapshot", "clusterResourcePlacement", placementName, "latestPolicySnapshot", latestPolicySnapshot.Name, "clusterStagedUpdateRun", updateRunRef)
 			// no more retries here.
 			return nil, -1, fmt.Errorf("%w, %s", errInitializedFailed, annErr.Error())
 		}

pkg/controllers/updaterun/initialization_integration_test.go

@@ -261,7 +261,7 @@ var _ = Describe("Updaterun initialization tests", func() {
 			By("Creating a new clusterStagedUpdateRun")
 			Expect(k8sClient.Create(ctx, updateRun)).To(Succeed())
 
-			By("Validating the initialization failed")
+			By("Validating policy snapshot details are copied to the updateRun status")
 			Eventually(func() error {
 				if err := k8sClient.Get(ctx, updateRunNamespacedName, updateRun); err != nil {
 					return err
@@ -294,7 +294,7 @@ var _ = Describe("Updaterun initialization tests", func() {
 			By("Creating a new clusterStagedUpdateRun")
 			Expect(k8sClient.Create(ctx, updateRun)).To(Succeed())
 
-			By("Validating the initialization failed")
+			By("Validating policy snapshot details are copied to the updateRun status")
 			Eventually(func() error {
 				if err := k8sClient.Get(ctx, updateRunNamespacedName, updateRun); err != nil {
 					return err
@@ -326,7 +326,7 @@ var _ = Describe("Updaterun initialization tests", func() {
 			By("Creating a new clusterStagedUpdateRun")
 			Expect(k8sClient.Create(ctx, updateRun)).To(Succeed())
 
-			By("Validating the initialization failed")
+			By("Validating policy snapshot details are copied to the updateRun status")
 			Eventually(func() error {
 				if err := k8sClient.Get(ctx, updateRunNamespacedName, updateRun); err != nil {
 					return err
@@ -384,14 +384,14 @@ var _ = Describe("Updaterun initialization tests", func() {
 		It("Should fail to initialize if the bindings are not in Scheduled or Bound state", func() {
 			By("Creating a not scheduled clusterResourceBinding")
 			binding := generateTestClusterResourceBinding(policySnapshot.Name, "cluster-1")
-			binding.Spec.State = ""
+			binding.Spec.State = placementv1beta1.BindingStateUnscheduled
 			Expect(k8sClient.Create(ctx, binding)).To(Succeed())
 
 			By("Creating a new clusterStagedUpdateRun")
 			Expect(k8sClient.Create(ctx, updateRun)).To(Succeed())
 
 			By("Validating the initialization failed")
-			validateFailedInitCondition(ctx, updateRun, "state  is not scheduled or bound")
+			validateFailedInitCondition(ctx, updateRun, "state Unscheduled is not scheduled or bound")
 
 			By("Deleting the clusterResourceBinding")
 			Expect(k8sClient.Delete(ctx, binding)).Should(Succeed())