Merge pull request #1232 from fluxcd/zulip-comment

Improve zulip Alert Provider comment

Author: matheuscscp

internal/notifier/git_change_request_comment.go

@@ -18,8 +18,6 @@ package notifier
 
 import (
 	"fmt"
-	"slices"
-	"strings"
 
 	eventv1 "github.com/fluxcd/pkg/apis/event/v1beta1"
 )
@@ -52,35 +50,6 @@ func (c *changeRequestComment) formatCommentKeyMarker(event *eventv1.Event) stri
 // formatCommentBody formats the body of the change request comment based on the event data.
 func (c *changeRequestComment) formatCommentBody(event *eventv1.Event) string {
 	marker := c.formatCommentKeyMarker(event)
-
-	// Get emoji based on severity
-	var severityEmoji string
-	if event.Severity == eventv1.EventSeverityError {
-		severityEmoji = "⚠️"
-	} else {
-		severityEmoji = "ℹ️"
-	}
-
-	// Format object identifier
-	objectID := fmt.Sprintf("%s/%s/%s",
-		event.InvolvedObject.Kind,
-		event.InvolvedObject.Namespace,
-		event.InvolvedObject.Name)
-
-	// Build metadata section
-	keys := make([]string, 0, len(event.Metadata))
-	for k := range event.Metadata {
-		if k != eventv1.MetaChangeRequestKey {
-			keys = append(keys, k)
-		}
-	}
-	slices.Sort(keys)
-	var metadataLines strings.Builder
-	for _, key := range keys {
-		fmt.Fprintf(&metadataLines, "* `%s`: %s\n", key, event.Metadata[key])
-	}
-
-	// Format the comment body
-	return fmt.Sprintf("%s\n\n## Flux Status\n\n%s %s\n\n%s\n\nMetadata:\n%s",
-		marker, severityEmoji, objectID, event.Message, metadataLines.String())
+	body := formatMarkdownPost(event)
+	return fmt.Sprintf("%s\n\n%s", marker, body)
 }

internal/notifier/markdown.go

@@ -0,0 +1,59 @@
+/*
+Copyright 2026 The Flux authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package notifier
+
+import (
+	"fmt"
+	"slices"
+	"strings"
+
+	eventv1 "github.com/fluxcd/pkg/apis/event/v1beta1"
+)
+
+// formatMarkdownPost formats the event for Markdown rendering engines.
+func formatMarkdownPost(event *eventv1.Event) string {
+	// Get emoji based on severity
+	var severityEmoji string
+	if event.Severity == eventv1.EventSeverityError {
+		severityEmoji = "⚠️"
+	} else {
+		severityEmoji = "ℹ️"
+	}
+
+	// Format object identifier
+	objectID := fmt.Sprintf("%s/%s/%s",
+		event.InvolvedObject.Kind,
+		event.InvolvedObject.Namespace,
+		event.InvolvedObject.Name)
+
+	// Build metadata section
+	keys := make([]string, 0, len(event.Metadata))
+	for k := range event.Metadata {
+		if k != eventv1.MetaChangeRequestKey {
+			keys = append(keys, k)
+		}
+	}
+	slices.Sort(keys)
+	var metadataLines strings.Builder
+	for _, key := range keys {
+		fmt.Fprintf(&metadataLines, "* `%s`: %s\n", key, event.Metadata[key])
+	}
+
+	// Format the comment body
+	return fmt.Sprintf("## Flux Status\n\n%s %s\n\n%s\n\nMetadata:\n%s",
+		severityEmoji, objectID, event.Message, metadataLines.String())
+}

internal/notifier/zulip.go

@@ -21,7 +21,6 @@ import (
 	"crypto/tls"
 	"fmt"
 	"net/url"
-	"slices"
 	"strings"
 
 	eventv1 "github.com/fluxcd/pkg/apis/event/v1beta1"
@@ -66,34 +65,7 @@ func NewZulip(endpoint, channel, proxyURL string, tlsConfig *tls.Config, usernam
 func (z *Zulip) Post(ctx context.Context, event eventv1.Event) error {
 	const contentType = "application/x-www-form-urlencoded"
 
-	obj := fmt.Sprintf("%s/%s.%s",
-		strings.ToLower(event.InvolvedObject.Kind),
-		event.InvolvedObject.Name,
-		event.InvolvedObject.Namespace)
-
-	header := fmt.Sprintf("ℹ️ Info: `%s`", obj)
-	if event.Severity == eventv1.EventSeverityError {
-		header = fmt.Sprintf("⚠️ Error: `%s`", obj)
-	}
-
-	msg := fmt.Sprintf("`%s`", event.Message)
-
-	mdKeys := make([]string, 0, len(event.Metadata))
-	for k := range event.Metadata {
-		mdKeys = append(mdKeys, k)
-	}
-	slices.Sort(mdKeys)
-	md := make([]string, 0, len(event.Metadata))
-	for _, k := range mdKeys {
-		md = append(md, fmt.Sprintf("- **%s**: `%s`", k, event.Metadata[k]))
-	}
-
-	content := fmt.Sprintf(`%[1]s
-
-%[2]s
-
-Metadata:
-%[3]s`, header, msg, strings.Join(md, "\n"))
+	content := formatMarkdownPost(&event)
 
 	payload := []byte(url.Values{
 		"type":    {"stream"},

internal/notifier/zulip_test.go

@@ -70,12 +70,12 @@ func TestZulip_Post(t *testing.T) {
 		{
 			name:            "info severity event",
 			eventSeverity:   eventv1.EventSeverityInfo,
-			expectedContent: "ℹ️ Info: `kustomization/test-ks.default`\n\n`Test event message`\n\nMetadata:\n- **key1**: `value1`\n- **key2**: `value2`",
+			expectedContent: "## Flux Status\n\nℹ️ Kustomization/default/test-ks\n\nTest event message\n\nMetadata:\n* `key1`: value1\n* `key2`: value2\n",
 		},
 		{
 			name:            "error severity event",
 			eventSeverity:   eventv1.EventSeverityError,
-			expectedContent: "⚠️ Error: `kustomization/test-ks.default`\n\n`Test event message`\n\nMetadata:\n- **key1**: `value1`\n- **key2**: `value2`",
+			expectedContent: "## Flux Status\n\n⚠️ Kustomization/default/test-ks\n\nTest event message\n\nMetadata:\n* `key1`: value1\n* `key2`: value2\n",
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {