Add the revision to FluxInstance events metadata

Signed-off-by: Stefan Prodan <[email protected]>
controlplaneio-fluxcd · Dec 23, 2024 · 9e3e6da · 9e3e6da
1 parent b0cee38
commit 9e3e6da
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 19 deletions.
diff --git a/internal/controller/fluxinstance_artifact_controller_test.go b/internal/controller/fluxinstance_artifact_controller_test.go
@@ -125,7 +125,7 @@ func TestFluxInstanceArtifactReconciler(t *testing.T) {
 					Namespace:   ns.Name,
 					Annotations: tt.annotations,
 				},
-				Spec: getDefaultFluxSpec(),
+				Spec: getDefaultFluxSpec(t),
 			}
 			obj.Spec.Distribution.Artifact = tt.manifestsURL
 

diff --git a/internal/controller/fluxinstance_controller.go b/internal/controller/fluxinstance_controller.go
@@ -154,7 +154,7 @@ func (r *FluxInstanceReconciler) reconcile(ctx context.Context,
 			meta.ReadyCondition,
 			meta.ArtifactFailedReason,
 			"%s", msg)
-		r.EventRecorder.Event(obj, corev1.EventTypeWarning, meta.ArtifactFailedReason, msg)
+		r.notify(ctx, obj, meta.ArtifactFailedReason, corev1.EventTypeWarning, msg)
 		return ctrl.Result{}, err
 	}
 
@@ -528,7 +528,9 @@ func (r *FluxInstanceReconciler) apply(ctx context.Context,
 			action = "installed"
 		}
 
-		msg := fmt.Sprintf("Flux %s revision %s\n%s", action, buildResult.Revision, applyLog)
+		ver := strings.Split(buildResult.Revision, "@")[0]
+
+		msg := fmt.Sprintf("Flux %s %s\n%s", ver, action, applyLog)
 		r.notify(ctx, obj, meta.ReconciliationSucceededReason, corev1.EventTypeNormal, msg)
 	}
 
@@ -641,7 +643,7 @@ func (r *FluxInstanceReconciler) recordMetrics(obj *fluxcdv1.FluxInstance) error
 
 func (r *FluxInstanceReconciler) notify(ctx context.Context, obj *fluxcdv1.FluxInstance, reason, eventType, msg string) {
 	notificationAddress := ""
-	if builder.ContainElementString(obj.GetComponents(), builder.MakeDefaultOptions().NotificationController) {
+	if os.Getenv("NOTIFICATIONS_DISABLED") == "" && builder.ContainElementString(obj.GetComponents(), builder.MakeDefaultOptions().NotificationController) {
 		notificationAddress = fmt.Sprintf("http://%s.%s.svc.%s/",
 			builder.MakeDefaultOptions().NotificationController,
 			obj.GetNamespace(),
@@ -662,5 +664,10 @@ func (r *FluxInstanceReconciler) notify(ctx context.Context, obj *fluxcdv1.FluxI
 		return
 	}
 
-	go eventRecorder.Eventf(obj, eventType, reason, "%s", msg)
+	annotations := map[string]string{}
+	if obj.Status.LastAttemptedRevision != "" {
+		annotations[fluxcdv1.RevisionAnnotation] = obj.Status.LastAttemptedRevision
+	}
+
+	eventRecorder.AnnotatedEventf(obj, annotations, eventType, reason, "%s", msg)
 }
diff --git a/internal/controller/fluxinstance_controller_test.go b/internal/controller/fluxinstance_controller_test.go
@@ -42,7 +42,7 @@ func TestFluxInstanceReconciler_LifeCycle(t *testing.T) {
 			Name:      ns.Name,
 			Namespace: ns.Name,
 		},
-		Spec: getDefaultFluxSpec(),
+		Spec: getDefaultFluxSpec(t),
 	}
 	obj.Spec.Distribution.Artifact = manifestsURL
 
@@ -196,16 +196,19 @@ func TestFluxInstanceReconciler_LifeCycle(t *testing.T) {
 	}
 	messages := []string{
 		"is outdated",
-		"Installing revision",
-		"Flux installed revision",
-		"Upgrading to revision",
-		"Flux updated revision",
+		"Installing",
+		"installed",
+		"Upgrading",
+		"updated",
 		"Reconciliation finished",
 	}
 	for _, message := range messages {
 		g.Expect(events).Should(ContainElement(WithTransform(func(e corev1.Event) string { return e.Message }, ContainSubstring(message))))
 	}
 
+	// Check if events contain the revision metadata.
+	g.Expect(events[len(events)-1].Annotations).To(HaveKeyWithValue(fluxcdv1.RevisionAnnotation, resultFinal.Status.LastAppliedRevision))
+
 	// Uninstall the instance.
 	err = testClient.Delete(ctx, obj)
 	g.Expect(err).ToNot(HaveOccurred())
@@ -238,7 +241,7 @@ func TestFluxInstanceReconciler_FetchFail(t *testing.T) {
 			Name:      ns.Name,
 			Namespace: ns.Name,
 		},
-		Spec: getDefaultFluxSpec(),
+		Spec: getDefaultFluxSpec(t),
 	}
 	obj.Spec.Distribution.Artifact = manifestsURL
 
@@ -300,7 +303,7 @@ func TestFluxInstanceReconciler_BuildFail(t *testing.T) {
 			Name:      ns.Name,
 			Namespace: ns.Name,
 		},
-		Spec: getDefaultFluxSpec(),
+		Spec: getDefaultFluxSpec(t),
 	}
 
 	err = testClient.Create(ctx, obj)
@@ -355,7 +358,7 @@ func TestFluxInstanceReconciler_BuildFail(t *testing.T) {
 func TestFluxInstanceReconciler_Downgrade(t *testing.T) {
 	g := NewWithT(t)
 	reconciler := getFluxInstanceReconciler()
-	spec := getDefaultFluxSpec()
+	spec := getDefaultFluxSpec(t)
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
 	defer cancel()
 
@@ -433,7 +436,7 @@ func TestFluxInstanceReconciler_Downgrade(t *testing.T) {
 func TestFluxInstanceReconciler_Disabled(t *testing.T) {
 	g := NewWithT(t)
 	reconciler := getFluxInstanceReconciler()
-	spec := getDefaultFluxSpec()
+	spec := getDefaultFluxSpec(t)
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
 	defer cancel()
 
@@ -530,7 +533,7 @@ func TestFluxInstanceReconciler_Disabled(t *testing.T) {
 func TestFluxInstanceReconciler_Profiles(t *testing.T) {
 	g := NewWithT(t)
 	reconciler := getFluxInstanceReconciler()
-	spec := getDefaultFluxSpec()
+	spec := getDefaultFluxSpec(t)
 	spec.Distribution.Version = "v2.4.x"
 	spec.Cluster = &fluxcdv1.Cluster{
 		Type:        "openshift",
@@ -640,7 +643,7 @@ func TestFluxInstanceReconciler_Profiles(t *testing.T) {
 func TestFluxInstanceReconciler_NewVersion(t *testing.T) {
 	g := NewWithT(t)
 	reconciler := getFluxInstanceReconciler()
-	spec := getDefaultFluxSpec()
+	spec := getDefaultFluxSpec(t)
 	spec.Distribution.Version = "v2.2.x"
 
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)
@@ -689,7 +692,9 @@ func TestFluxInstanceReconciler_NewVersion(t *testing.T) {
 
 }
 
-func getDefaultFluxSpec() fluxcdv1.FluxInstanceSpec {
+func getDefaultFluxSpec(t *testing.T) fluxcdv1.FluxInstanceSpec {
+	t.Setenv("NOTIFICATIONS_DISABLED", "yes")
+
 	return fluxcdv1.FluxInstanceSpec{
 		Wait:             ptr.To(false),
 		MigrateResources: ptr.To(true),

diff --git a/internal/controller/fluxreport_controller_test.go b/internal/controller/fluxreport_controller_test.go
@@ -45,7 +45,7 @@ func TestFluxReportReconciler_Reconcile(t *testing.T) {
 			Name:      ns.Name,
 			Namespace: ns.Name,
 		},
-		Spec: getDefaultFluxSpec(),
+		Spec: getDefaultFluxSpec(t),
 	}
 	err = testEnv.Create(ctx, instance)
 	g.Expect(err).ToNot(HaveOccurred())
@@ -161,7 +161,7 @@ func TestFluxReportReconciler_CustomSyncName(t *testing.T) {
 			Name:      ns.Name,
 			Namespace: ns.Name,
 		},
-		Spec: getDefaultFluxSpec(),
+		Spec: getDefaultFluxSpec(t),
 	}
 
 	// Set custom sync name.