Update for the newest version.

Author: bigkevmcd

controllers/gitopsset_controller.go

@@ -52,7 +52,7 @@ const (
 )
 
 type eventRecorder interface {
-	Event(object runtime.Object, eventType, reason, message string)
+	Eventf(object runtime.Object, related runtime.Object, eventtype, reason string, action string, messageFmt string, args ...any)
 }
 
 // GitOpsSetReconciler reconciles a GitOpsSet object
@@ -70,7 +70,7 @@ type GitOpsSetReconciler struct {
 }
 
 // event emits a Kubernetes event using EventRecorder
-func (r *GitOpsSetReconciler) event(obj *templatesv1.GitOpsSet, severity, msg string) {
+func (r *GitOpsSetReconciler) event(obj *templatesv1.GitOpsSet, severity, msg string, args ...any) {
 	reason := conditions.GetReason(obj, fluxMeta.ReadyCondition)
 	if reason == "" {
 		reason = severity
@@ -81,7 +81,7 @@ func (r *GitOpsSetReconciler) event(obj *templatesv1.GitOpsSet, severity, msg st
 		eventType = corev1.EventTypeWarning
 	}
 
-	r.EventRecorder.Event(obj, eventType, reason, msg)
+	r.EventRecorder.Eventf(obj, nil, eventType, reason, "", msg, args...)
 }
 
 //+kubebuilder:rbac:groups=sets.gitops.pro,resources=gitopssets,verbs=get;list;watch;create;update;patch;delete
@@ -160,9 +160,9 @@ func (r *GitOpsSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 
 		// Log and emit success event.
 		if r.EventRecorder != nil && templatesv1.GetGitOpsSetReadiness(&gitOpsSet) == metav1.ConditionTrue {
-			msg := fmt.Sprintf("Reconciliation finished in %s",
+			r.event(&gitOpsSet, eventv1.EventSeverityInfo, "Reconciliation finished in %s",
 				time.Since(reconcileStart).String())
-			r.event(&gitOpsSet, eventv1.EventSeverityInfo, msg)
+
 		}
 	}()
 
@@ -184,8 +184,7 @@ func (r *GitOpsSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 		if err := r.patchStatus(ctx, req, gitOpsSet.Status); err != nil {
 			logger.Error(err, "failed to reconcile")
 		}
-		msg := fmt.Sprintf("Reconciliation failed after %s", time.Since(reconcileStart).String())
-		r.event(&gitOpsSet, eventv1.EventSeverityError, msg)
+		r.event(&gitOpsSet, eventv1.EventSeverityError, "Reconciliation failed after %s", time.Since(reconcileStart).String())
 
 		return ctrl.Result{}, err
 	}
@@ -197,8 +196,7 @@ func (r *GitOpsSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 		if err := r.patchStatus(ctx, req, gitOpsSet.Status); err != nil {
 			logger.Error(err, "failed to reconcile")
 			templatesv1.SetGitOpsSetReadiness(&gitOpsSet, inventory, metav1.ConditionFalse, templatesv1.ReconciliationFailedReason, err.Error())
-			msg := "Status and inventory update failed after reconciliation"
-			r.event(&gitOpsSet, eventv1.EventSeverityError, msg)
+			r.event(&gitOpsSet, eventv1.EventSeverityError, "Status and inventory update failed after reconciliation")
 
 			return ctrl.Result{}, fmt.Errorf("failed to update status and inventory: %w", err)
 		}

main.go

@@ -155,8 +155,8 @@ func main() {
 		os.Exit(1)
 	}
 	metricsH := runtimeCtrl.NewMetrics(mgr, metrics.MustMakeRecorder(), templatesv1.GitOpsSetFinalizer)
-	var eventRecorder *events.Recorder
-	if eventRecorder, err = events.NewRecorder(mgr, ctrl.Log, eventsAddr, controllerName); err != nil {
+	var eventRecorder events.Recorder
+	if eventRecorder, err = events.NewRecorder(ctrl.Log, eventsAddr, controllerName, events.WithManager(mgr)); err != nil {
 		setupLog.Error(err, "unable to create event recorder")
 		os.Exit(1)
 	}

test/events.go

@@ -1,6 +1,8 @@
 package test
 
 import (
+	"fmt"
+
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
@@ -14,15 +16,21 @@ type EventData struct {
 	EventType string
 	Reason    string
 	Message   string
+	Action    string
+	Object    runtime.Object
+	Related   runtime.Object
 }
 
 // Event records a new event in the slice of the fake event recorder used in a test
 // The interface using Event is the EventRecorder interface
-func (f *FakeEventRecorder) Event(object runtime.Object, eventtype, reason, message string) {
+func (f *FakeEventRecorder) Eventf(object, related runtime.Object, eventtype, reason string, action string, messageFmt string, args ...any) {
 	event := &EventData{
+		Object:    object,
+		Related:   related,
 		EventType: eventtype,
 		Reason:    reason,
-		Message:   message,
+		Action:    action,
+		Message:   fmt.Sprintf(messageFmt, args...),
 	}
 	f.Events = append(f.Events, event)
 }

tests/e2e/gitopsset_controller_test.go

@@ -967,7 +967,7 @@ func TestEventsWithReconciling(t *testing.T) {
 		EventType: "Normal",
 		Reason:    "ReconciliationSucceeded",
 	}
-	compareWant := gomega.BeComparableTo(want, cmpopts.IgnoreFields(test.EventData{}, "Message"))
+	compareWant := gomega.BeComparableTo(want, cmpopts.IgnoreFields(test.EventData{}, "Message", "Object", "Related"))
 
 	g := gomega.NewWithT(t)
 
@@ -1024,7 +1024,7 @@ func TestEventsWithFailingReconciling(t *testing.T) {
 	defer deleteGitOpsSetAndWaitForNotFound(t, testEnv, gs)
 
 	g := gomega.NewWithT(t)
-	g.Eventually(func() bool {
+	g.Eventually(func() string {
 		// reconciliation should fail because there is an existing resource.
 		want := []*test.EventData{
 			{
@@ -1033,8 +1033,8 @@ func TestEventsWithFailingReconciling(t *testing.T) {
 			},
 		}
 
-		return cmp.Diff(want, eventRecorder.Events, cmpopts.IgnoreFields(test.EventData{}, "Message")) == ""
-	}, timeout).Should(gomega.BeTrue())
+		return cmp.Diff(want, eventRecorder.Events, cmpopts.IgnoreFields(test.EventData{}, "Message", "Object", "Related"))
+	}, timeout).Should(gomega.Equal(""))
 }
 
 func deleteGitOpsSetAndWaitForNotFound(t *testing.T, cl client.Client, gs *templatesv1.GitOpsSet) {