Use formatting placeholders for errors in events

This should prevent events from containing malformed messages, should
error messages ever contain `%` symbols.

Author: weyfonk

internal/cmd/controller/gitops/reconciler/gitjob_controller.go

@@ -207,7 +207,8 @@ func (r *GitJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
 			corev1.EventTypeWarning,
 			"FailedToApplyRestrictions",
 			"ApplyGitRepoRestrictions",
-			err.Error(),
+			"%v",
+			err,
 		)
 
 		return ctrl.Result{}, updateErrorStatus(ctx, r.Client, req.NamespacedName, *oldStatus, err)
@@ -319,7 +320,8 @@ func (r *GitJobReconciler) manageGitJob(ctx context.Context, logger logr.Logger,
 			corev1.EventTypeWarning,
 			"FailedToGetGitJob",
 			"GetGitJob",
-			err.Error(),
+			"%v",
+			err,
 		)
 
 		return ctrl.Result{}, err
@@ -334,7 +336,8 @@ func (r *GitJobReconciler) manageGitJob(ctx context.Context, logger logr.Logger,
 				corev1.EventTypeWarning,
 				"FailedValidatingSecret",
 				"ValidateSecret",
-				err.Error(),
+				"%v",
+				err,
 			)
 			return ctrl.Result{}, fmt.Errorf("error validating external secrets: %w", err)
 		}
@@ -360,7 +363,8 @@ func (r *GitJobReconciler) manageGitJob(ctx context.Context, logger logr.Logger,
 					corev1.EventTypeWarning,
 					"Failed",
 					"MonitorLatestCommit",
-					err.Error(),
+					"%v",
+					err,
 				)
 			} else if oldCommit != gitrepo.Status.Commit {
 				r.Recorder.Eventf(
@@ -383,7 +387,8 @@ func (r *GitJobReconciler) manageGitJob(ctx context.Context, logger logr.Logger,
 					corev1.EventTypeWarning,
 					"FailedValidatingSecret",
 					"ValidateSecret",
-					err.Error(),
+					"%v",
+					err,
 				)
 				return ctrl.Result{}, fmt.Errorf("error validating external secrets: %w", err)
 			}

internal/cmd/controller/gitops/reconciler/gitjob_test.go

@@ -85,6 +85,24 @@ func (m gitRepoPointerMatcher) String() string {
 	return ""
 }
 
+// errorMatcher implements a gomock matcher on error message strings.
+type errorMatcher struct {
+	errMsg string
+}
+
+func (m errorMatcher) Matches(x interface{}) bool {
+	err, ok := x.(error)
+	if !ok {
+		return false
+	}
+
+	return err.Error() == m.errMsg
+}
+
+func (m errorMatcher) String() string {
+	return fmt.Sprintf("matches error %q", m.errMsg)
+}
+
 func TestReconcile_Error_WhenGitrepoRestrictionsAreNotMet(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()
@@ -135,7 +153,8 @@ func TestReconcile_Error_WhenGitrepoRestrictionsAreNotMet(t *testing.T) {
 		corev1.EventTypeWarning,
 		"FailedToApplyRestrictions",
 		"ApplyGitRepoRestrictions",
-		"empty targetNamespace denied, because allowedTargetNamespaces restriction is present",
+		"%v",
+		errorMatcher{"empty targetNamespace denied, because allowedTargetNamespaces restriction is present"},
 	)
 
 	r := GitJobReconciler{
@@ -212,7 +231,8 @@ func TestReconcile_Error_WhenGetGitJobErrors(t *testing.T) {
 		corev1.EventTypeWarning,
 		"FailedToGetGitJob",
 		"GetGitJob",
-		"error retrieving git job: GITJOB ERROR",
+		"%v",
+		errorMatcher{"error retrieving git job: GITJOB ERROR"},
 	)
 
 	r := GitJobReconciler{
@@ -285,7 +305,8 @@ func TestReconcile_Error_WhenSecretDoesNotExist(t *testing.T) {
 		corev1.EventTypeWarning,
 		"FailedValidatingSecret",
 		"ValidateSecret",
-		"failed to look up HelmSecretNameForPaths, error: SECRET ERROR",
+		"%v",
+		errorMatcher{"failed to look up HelmSecretNameForPaths, error: SECRET ERROR"},
 	)
 
 	statusClient := mocks.NewMockStatusWriter(mockCtrl)

internal/cmd/controller/gitops/reconciler/polling_job.go

@@ -95,7 +95,8 @@ func (j *gitPollingJob) pollGitRepo(ctx context.Context) error {
 			corev1.EventTypeWarning,
 			"FailedToCheckCommit",
 			"CheckCommit",
-			origErr.Error(),
+			"%v",
+			origErr,
 		)
 
 		return j.updateErrorStatus(ctx, gitrepo, pollingTimestamp, origErr)

internal/cmd/controller/helmops/reconciler/polling_job.go

@@ -124,7 +124,8 @@ func (j *helmPollingJob) pollHelm(ctx context.Context) error {
 				corev1.EventTypeWarning,
 				eventReason,
 				eventAction,
-				origErr.Error(),
+				"%v",
+				origErr,
 			)
 		}
 
@@ -156,6 +157,7 @@ func (j *helmPollingJob) pollHelm(ctx context.Context) error {
 			corev1.EventTypeNormal,
 			"GotNewChartVersion",
 			"GetNewChartVersion",
+			"%s",
 			version,
 		)
 	}

internal/cmd/controller/reconciler/bundle_controller.go

@@ -913,7 +913,8 @@ func (r *BundleReconciler) maybeDeleteOCIArtifact(ctx context.Context, bundle *f
 			"DeleteOCIArtifact",
 			"deleting OCI artifact %q: %v",
 			bundle.Spec.ContentsID,
-			err.Error(),
+			"%v",
+			err,
 		)
 	}