Remove TODO, fix typo, and use %w for errors

maqiuyujoyce · maqiuyujoyce · commit c2dd9591cfcc · 2024-02-06T22:31:19.000Z
diff --git a/pkg/controller/dcl/controller.go b/pkg/controller/dcl/controller.go
@@ -198,7 +198,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (res
 		return reconcile.Result{}, fmt.Errorf("could not parse resource %s: %w", req.NamespacedName.String(), err)
 	}
 	if err := r.handleDefaultStateIntoSpecValue(resource); err != nil {
-		return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %v", k8s.GetNamespacedName(resource), err)
+		return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %w", k8s.GetNamespacedName(resource), err)
 	}
 	if err := r.applyChangesForBackwardsCompatibility(ctx, resource); err != nil {
 		return reconcile.Result{}, fmt.Errorf("error applying changes to resource '%v' for backwards compatibility: %v", k8s.GetNamespacedName(resource), err)
@@ -421,7 +421,7 @@ func (r *Reconciler) handleDefaultStateIntoSpecValue(resource *dcl.Resource) err
 	// Validate or set the default value (cluster-level or namespace-level) for
 	// the 'state-into-spec' annotation.
 	if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(&resource.Resource, k8s.StateMergeIntoSpec); err != nil {
-		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)
+		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)
 	}
 	return nil
 }
diff --git a/pkg/controller/iam/auditconfig/iamauditconfig_controller.go b/pkg/controller/iam/auditconfig/iamauditconfig_controller.go
@@ -140,7 +140,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
 		return reconcile.Result{}, err
 	}
 	if err := r.handleDefaultStateIntoSpecValue(&auditConfig); err != nil {
-		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %v", k8s.GetNamespacedName(&auditConfig), err)
+		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %w", k8s.GetNamespacedName(&auditConfig), err)
 	}
 	reconcileContext := &reconcileContext{
 		Reconciler:     r,
@@ -166,7 +166,7 @@ func (r *Reconciler) handleDefaultStateIntoSpecValue(auditConfig *iamv1beta1.IAM
 	// Validate or set the default value (cluster-level or namespace-level) for
 	// the 'state-into-spec' annotation.
 	if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(auditConfig, k8s.StateMergeIntoSpec); err != nil {
-		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(auditConfig), err)
+		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(auditConfig), err)
 	}
 	return nil
 }
diff --git a/pkg/controller/iam/partialpolicy/iampartialpolicy_controller.go b/pkg/controller/iam/partialpolicy/iampartialpolicy_controller.go
@@ -152,7 +152,7 @@ func (r *ReconcileIAMPartialPolicy) Reconcile(ctx context.Context, request recon
 		return reconcile.Result{}, err
 	}
 	if err := r.handleDefaultStateIntoSpecValue(policy); err != nil {
-		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM parital policy '%v': %v", k8s.GetNamespacedName(policy), err)
+		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM partial policy '%v': %w", k8s.GetNamespacedName(policy), err)
 	}
 	runCtx := &reconcileContext{
 		Reconciler:     r,
@@ -178,7 +178,7 @@ func (r *ReconcileIAMPartialPolicy) handleDefaultStateIntoSpecValue(pp *iamv1bet
 	// Validate or set the default value (cluster-level or namespace-level) for
 	// the 'state-into-spec' annotation.
 	if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(pp, k8s.StateMergeIntoSpec); err != nil {
-		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(pp), err)
+		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(pp), err)
 	}
 	return nil
 }
diff --git a/pkg/controller/iam/policy/iampolicy_controller.go b/pkg/controller/iam/policy/iampolicy_controller.go
@@ -151,7 +151,7 @@ func (r *ReconcileIAMPolicy) Reconcile(ctx context.Context, request reconcile.Re
 		return reconcile.Result{}, err
 	}
 	if err := r.handleDefaultStateIntoSpecValue(policy); err != nil {
-		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %v", k8s.GetNamespacedName(policy), err)
+		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %w", k8s.GetNamespacedName(policy), err)
 	}
 	runCtx := &reconcileContext{
 		Reconciler:     r,
@@ -177,7 +177,7 @@ func (r *ReconcileIAMPolicy) handleDefaultStateIntoSpecValue(policy *iamv1beta1.
 	// Validate or set the default value (cluster-level or namespace-level) for
 	// the 'state-into-spec' annotation.
 	if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(policy, k8s.StateMergeIntoSpec); err != nil {
-		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policy), err)
+		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policy), err)
 	}
 	return nil
 }
diff --git a/pkg/controller/iam/policymember/iampolicymember_controller.go b/pkg/controller/iam/policymember/iampolicymember_controller.go
@@ -150,7 +150,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
 		return reconcile.Result{}, err
 	}
 	if err := r.handleDefaultStateIntoSpecValue(&memberPolicy); err != nil {
-		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy member '%v': %v", k8s.GetNamespacedName(&memberPolicy), err)
+		return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy member '%v': %w", k8s.GetNamespacedName(&memberPolicy), err)
 	}
 	reconcileContext := &reconcileContext{
 		Reconciler:     r,
@@ -179,7 +179,7 @@ func (r *Reconciler) handleDefaultStateIntoSpecValue(policyMember *iamv1beta1.IA
 	// Validate or set the default value (cluster-level or namespace-level) for
 	// the 'state-into-spec' annotation.
 	if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(policyMember, k8s.StateMergeIntoSpec); err != nil {
-		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policyMember), err)
+		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policyMember), err)
 	}
 	return nil
 }
diff --git a/pkg/controller/tf/controller.go b/pkg/controller/tf/controller.go
@@ -175,7 +175,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (res
 		return reconcile.Result{}, fmt.Errorf("could not parse resource %s: %v", req.NamespacedName.String(), err)
 	}
 	if err := r.handleDefaultStateIntoSpecValue(resource); err != nil {
-		return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %v", k8s.GetNamespacedName(resource), err)
+		return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %w", k8s.GetNamespacedName(resource), err)
 	}
 	if err := r.applyChangesForBackwardsCompatibility(ctx, resource); err != nil {
 		return reconcile.Result{}, fmt.Errorf("error applying changes to resource '%v' for backwards compatibility: %v", k8s.GetNamespacedName(resource), err)
@@ -405,7 +405,7 @@ func (r *Reconciler) handleDefaultStateIntoSpecValue(resource *krmtotf.Resource)
 	// Validate or set the default value (cluster-level or namespace-level) for
 	// the 'state-into-spec' annotation.
 	if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(&resource.Resource, k8s.StateMergeIntoSpec); err != nil {
-		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)
+		return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)
 	}
 	return nil
 }

Original file line number	Diff line number	Diff line change
`@@ -198,7 +198,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (res`
`198`	`198`	`return reconcile.Result{}, fmt.Errorf("could not parse resource %s: %w", req.NamespacedName.String(), err)`
`199`	`199`	`}`
`200`	`200`	`if err := r.handleDefaultStateIntoSpecValue(resource); err != nil {`
`201`		`- return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %v", k8s.GetNamespacedName(resource), err)`
	`201`	`+ return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %w", k8s.GetNamespacedName(resource), err)`
`202`	`202`	`}`
`203`	`203`	`if err := r.applyChangesForBackwardsCompatibility(ctx, resource); err != nil {`
`204`	`204`	`return reconcile.Result{}, fmt.Errorf("error applying changes to resource '%v' for backwards compatibility: %v", k8s.GetNamespacedName(resource), err)`
`@@ -421,7 +421,7 @@ func (r Reconciler) handleDefaultStateIntoSpecValue(resource dcl.Resource) err`
`421`	`421`	`// Validate or set the default value (cluster-level or namespace-level) for`
`422`	`422`	`// the 'state-into-spec' annotation.`
`423`	`423`	`if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(&resource.Resource, k8s.StateMergeIntoSpec); err != nil {`
`424`		`- return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)`
	`424`	`+ return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)`
`425`	`425`	`}`
`426`	`426`	`return nil`
`427`	`427`	`}`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (`
`140`	`140`	`return reconcile.Result{}, err`
`141`	`141`	`}`
`142`	`142`	`if err := r.handleDefaultStateIntoSpecValue(&auditConfig); err != nil {`
`143`		`- return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %v", k8s.GetNamespacedName(&auditConfig), err)`
	`143`	`+ return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %w", k8s.GetNamespacedName(&auditConfig), err)`
`144`	`144`	`}`
`145`	`145`	`reconcileContext := &reconcileContext{`
`146`	`146`	`Reconciler: r,`
`@@ -166,7 +166,7 @@ func (r Reconciler) handleDefaultStateIntoSpecValue(auditConfig iamv1beta1.IAM`
`166`	`166`	`// Validate or set the default value (cluster-level or namespace-level) for`
`167`	`167`	`// the 'state-into-spec' annotation.`
`168`	`168`	`if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(auditConfig, k8s.StateMergeIntoSpec); err != nil {`
`169`		`- return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(auditConfig), err)`
	`169`	`+ return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(auditConfig), err)`
`170`	`170`	`}`
`171`	`171`	`return nil`
`172`	`172`	`}`
Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ func (r *ReconcileIAMPartialPolicy) Reconcile(ctx context.Context, request recon`
`152`	`152`	`return reconcile.Result{}, err`
`153`	`153`	`}`
`154`	`154`	`if err := r.handleDefaultStateIntoSpecValue(policy); err != nil {`
`155`		`- return reconcile.Result{}, fmt.Errorf("error handling default values for IAM parital policy '%v': %v", k8s.GetNamespacedName(policy), err)`
	`155`	`+ return reconcile.Result{}, fmt.Errorf("error handling default values for IAM partial policy '%v': %w", k8s.GetNamespacedName(policy), err)`
`156`	`156`	`}`
`157`	`157`	`runCtx := &reconcileContext{`
`158`	`158`	`Reconciler: r,`
`@@ -178,7 +178,7 @@ func (r ReconcileIAMPartialPolicy) handleDefaultStateIntoSpecValue(pp iamv1bet`
`178`	`178`	`// Validate or set the default value (cluster-level or namespace-level) for`
`179`	`179`	`// the 'state-into-spec' annotation.`
`180`	`180`	`if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(pp, k8s.StateMergeIntoSpec); err != nil {`
`181`		`- return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(pp), err)`
	`181`	`+ return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(pp), err)`
`182`	`182`	`}`
`183`	`183`	`return nil`
`184`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ func (r *ReconcileIAMPolicy) Reconcile(ctx context.Context, request reconcile.Re`
`151`	`151`	`return reconcile.Result{}, err`
`152`	`152`	`}`
`153`	`153`	`if err := r.handleDefaultStateIntoSpecValue(policy); err != nil {`
`154`		`- return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %v", k8s.GetNamespacedName(policy), err)`
	`154`	`+ return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy '%v': %w", k8s.GetNamespacedName(policy), err)`
`155`	`155`	`}`
`156`	`156`	`runCtx := &reconcileContext{`
`157`	`157`	`Reconciler: r,`
`@@ -177,7 +177,7 @@ func (r ReconcileIAMPolicy) handleDefaultStateIntoSpecValue(policy iamv1beta1.`
`177`	`177`	`// Validate or set the default value (cluster-level or namespace-level) for`
`178`	`178`	`// the 'state-into-spec' annotation.`
`179`	`179`	`if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(policy, k8s.StateMergeIntoSpec); err != nil {`
`180`		`- return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policy), err)`
	`180`	`+ return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policy), err)`
`181`	`181`	`}`
`182`	`182`	`return nil`
`183`	`183`	`}`
Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (`
`150`	`150`	`return reconcile.Result{}, err`
`151`	`151`	`}`
`152`	`152`	`if err := r.handleDefaultStateIntoSpecValue(&memberPolicy); err != nil {`
`153`		`- return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy member '%v': %v", k8s.GetNamespacedName(&memberPolicy), err)`
	`153`	`+ return reconcile.Result{}, fmt.Errorf("error handling default values for IAM policy member '%v': %w", k8s.GetNamespacedName(&memberPolicy), err)`
`154`	`154`	`}`
`155`	`155`	`reconcileContext := &reconcileContext{`
`156`	`156`	`Reconciler: r,`
`@@ -179,7 +179,7 @@ func (r Reconciler) handleDefaultStateIntoSpecValue(policyMember iamv1beta1.IA`
`179`	`179`	`// Validate or set the default value (cluster-level or namespace-level) for`
`180`	`180`	`// the 'state-into-spec' annotation.`
`181`	`181`	`if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(policyMember, k8s.StateMergeIntoSpec); err != nil {`
`182`		`- return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policyMember), err)`
	`182`	`+ return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(policyMember), err)`
`183`	`183`	`}`
`184`	`184`	`return nil`
`185`	`185`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (res`
`175`	`175`	`return reconcile.Result{}, fmt.Errorf("could not parse resource %s: %v", req.NamespacedName.String(), err)`
`176`	`176`	`}`
`177`	`177`	`if err := r.handleDefaultStateIntoSpecValue(resource); err != nil {`
`178`		`- return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %v", k8s.GetNamespacedName(resource), err)`
	`178`	`+ return reconcile.Result{}, fmt.Errorf("error handling default values for resource '%v': %w", k8s.GetNamespacedName(resource), err)`
`179`	`179`	`}`
`180`	`180`	`if err := r.applyChangesForBackwardsCompatibility(ctx, resource); err != nil {`
`181`	`181`	`return reconcile.Result{}, fmt.Errorf("error applying changes to resource '%v' for backwards compatibility: %v", k8s.GetNamespacedName(resource), err)`
`@@ -405,7 +405,7 @@ func (r Reconciler) handleDefaultStateIntoSpecValue(resource krmtotf.Resource)`
`405`	`405`	`// Validate or set the default value (cluster-level or namespace-level) for`
`406`	`406`	`// the 'state-into-spec' annotation.`
`407`	`407`	`if err := k8s.ValidateOrDefaultStateIntoSpecAnnotation(&resource.Resource, k8s.StateMergeIntoSpec); err != nil {`
`408`		`- return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %v", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)`
	`408`	`+ return fmt.Errorf("error validating or defaulting the '%v' annotation for resource '%v': %w", k8s.StateIntoSpecAnnotation, k8s.GetNamespacedName(resource), err)`
`409`	`409`	`}`
`410`	`410`	`return nil`
`411`	`411`	`}`