feat: Add comment strategy support for Foregejo

Added `comment_strategy` configuration to the Foregejo/Gitea provider settings
to control how pipeline result comments were handled on pull requests.
Supported options included `disable_all` to prevent status comments
and `update` to modify a single existing comment per PipelineRun
instead of creating new ones on every trigger. Passed the execution
context to the status creation methods to support the updated comment
functionality and fixed the update marker regex by escaping meta
characters.

Jira: https://issues.redhat.com/browse/SRVKP-10900
Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>

Author: chmouel

config/300-repositories.yaml

@@ -451,6 +451,17 @@ spec:
                     forgejo:
                       description: Forgejo contains Forgejo/Gitea-specific settings.
                       properties:
+                        comment_strategy:
+                          description: |-
+                            CommentStrategy defines how Forgejo/Gitea comments are handled for pipeline results.
+                            Options:
+                            - 'disable_all': Disables all comments on pull requests
+                            - 'update': Updates a single comment per PipelineRun on every trigger.
+                          enum:
+                            - ""
+                            - disable_all
+                            - update
+                          type: string
                         user_agent:
                           description: |-
                             UserAgent sets the User-Agent header on API requests to the Gitea/Forgejo instance.

docs/content/docs/guide/repositorycrd.md

@@ -128,7 +128,7 @@ access to the infrastructure.
 
 ## Controlling Pull/Merge Request comment volume
 
-For GitHub (Webhook) and GitLab integrations, you can control the types
+For GitHub (Webhook), GitLab, and Gitea/Forgejo integrations, you can control the types
 of Pull/Merge request comments that Pipelines as Code emits using
 the `spec.<provider>.comment_strategy` setting. This can
 help reduce notification volume for repositories that use long-lasting

pkg/apis/pipelinesascode/v1alpha1/types.go

@@ -197,6 +197,14 @@ type ForgejoSettings struct {
 	// Defaults to "pipelines-as-code/<version>" when left empty.
 	// +optional
 	UserAgent string `json:"user_agent,omitempty"`
+
+	// CommentStrategy defines how Forgejo/Gitea comments are handled for pipeline results.
+	// Options:
+	// - 'disable_all': Disables all comments on pull requests
+	// - 'update': Updates a single comment per PipelineRun on every trigger.
+	// +optional
+	// +kubebuilder:validation:Enum="";disable_all;update
+	CommentStrategy string `json:"comment_strategy,omitempty"`
 }
 
 func (s *Settings) Merge(newSettings *Settings) {

pkg/provider/gitea/gitea.go

@@ -101,7 +101,7 @@ func (v *Provider) CreateComment(_ context.Context, event *info.Event, commit, u
 			return err
 		}
 
-		re := regexp.MustCompile(updateMarker)
+		re := regexp.MustCompile(regexp.QuoteMeta(updateMarker))
 		for _, comment := range comments {
 			if re.MatchString(comment.Body) {
 				// Get the UserID for the PAC user.
@@ -229,7 +229,7 @@ func (v *Provider) SetClient(_ context.Context, run *params.Run, runevent *info.
 	return nil
 }
 
-func (v *Provider) CreateStatus(_ context.Context, event *info.Event, statusOpts providerstatus.StatusOpts) error {
+func (v *Provider) CreateStatus(ctx context.Context, event *info.Event, statusOpts providerstatus.StatusOpts) error {
 	if v.giteaClient == nil {
 		return fmt.Errorf("cannot set status on gitea no token or url set")
 	}
@@ -265,10 +265,10 @@ func (v *Provider) CreateStatus(_ context.Context, event *info.Event, statusOpts
 	// gitea show weirdly the <br>
 	statusOpts.Summary = fmt.Sprintf("%s%s %s", v.pacInfo.ApplicationName, onPr, statusOpts.Summary)
 
-	return v.createStatusCommit(event, v.pacInfo, statusOpts)
+	return v.createStatusCommit(ctx, event, v.pacInfo, statusOpts)
 }
 
-func (v *Provider) createStatusCommit(event *info.Event, pacopts *info.PacOpts, status providerstatus.StatusOpts) error {
+func (v *Provider) createStatusCommit(ctx context.Context, event *info.Event, pacopts *info.PacOpts, status providerstatus.StatusOpts) error {
 	state := forgejo.StatusState(status.Conclusion)
 	switch status.Conclusion {
 	case providerstatus.ConclusionNeutral:
@@ -315,15 +315,45 @@ func (v *Provider) createStatusCommit(event *info.Event, pacopts *info.PacOpts,
 	if opscomments.IsAnyOpsEventType(eventType.String()) {
 		eventType = triggertype.PullRequest
 	}
-	if status.Text != "" && (eventType == triggertype.PullRequest || event.TriggerTarget == triggertype.PullRequest) {
-		status.Text = strings.ReplaceAll(strings.TrimSpace(status.Text), "<br>", "\n")
-		_, _, err := v.Client().CreateIssueComment(event.Organization, event.Repository,
-			int64(event.PullRequestNumber), forgejo.CreateIssueCommentOption{
-				Body: fmt.Sprintf("%s\n%s", status.Summary, status.Text),
-			},
-		)
-		if err != nil {
-			return err
+
+	var commentStrategy string
+	if v.repo != nil && v.repo.Spec.Settings != nil && v.repo.Spec.Settings.Forgejo != nil {
+		commentStrategy = v.repo.Spec.Settings.Forgejo.CommentStrategy
+	}
+	switch commentStrategy {
+	case provider.DisableAllCommentStrategy:
+		v.Logger.Warn("Comments related to PipelineRuns status have been disabled for Gitea/Forgejo pull requests")
+		return nil
+	case provider.UpdateCommentStrategy:
+		if eventType == triggertype.PullRequest || event.TriggerTarget == triggertype.PullRequest {
+			status.Text = strings.ReplaceAll(strings.TrimSpace(status.Text), "<br>", "\n")
+			statusComment := v.formatPipelineComment(event.SHA, status)
+			// Creating the prefix that is added to the status comment for a pipeline run.
+			plrStatusCommentPrefix := fmt.Sprintf(provider.PlrStatusCommentPrefixTemplate, status.OriginalPipelineRunName)
+			// The entire markdown comment, including the prefix that is added to the pull request for the pipelinerun.
+			markdownStatusComment := fmt.Sprintf("%s\n%s", plrStatusCommentPrefix, statusComment)
+
+			if err := v.CreateComment(ctx, event, markdownStatusComment, plrStatusCommentPrefix); err != nil {
+				v.eventEmitter.EmitMessage(
+					v.repo,
+					zap.ErrorLevel,
+					"PipelineRunCommentCreationError",
+					fmt.Sprintf("failed to create comment: %s", err.Error()),
+				)
+				return err
+			}
+		}
+	default:
+		if status.Text != "" && (eventType == triggertype.PullRequest || event.TriggerTarget == triggertype.PullRequest) {
+			status.Text = strings.ReplaceAll(strings.TrimSpace(status.Text), "<br>", "\n")
+			_, _, err := v.Client().CreateIssueComment(event.Organization, event.Repository,
+				int64(event.PullRequestNumber), forgejo.CreateIssueCommentOption{
+					Body: fmt.Sprintf("%s\n%s", status.Summary, status.Text),
+				},
+			)
+			if err != nil {
+				return err
+			}
 		}
 	}
 	return nil
@@ -570,3 +600,25 @@ func (v *Provider) CreateToken(_ context.Context, _ []string, _ *info.Event) (st
 func (v *Provider) GetTemplate(commentType provider.CommentType) string {
 	return provider.GetHTMLTemplate(commentType)
 }
+
+func (v *Provider) formatPipelineComment(sha string, status providerstatus.StatusOpts) string {
+	var emoji string
+
+	if status.Status == "in_progress" {
+		emoji = "🚀"
+	} else {
+		switch status.Conclusion {
+		case providerstatus.ConclusionCancelled:
+			emoji = "⚠️"
+		case providerstatus.ConclusionFailure:
+			emoji = "❌"
+		case providerstatus.ConclusionSuccess:
+			emoji = "✅"
+		default:
+			emoji = "ℹ️"
+		}
+	}
+
+	return fmt.Sprintf("%s **%s: %s/%s for %s**\n\n%s\n\n<small>Full log available [here](%s)</small>",
+		emoji, status.Title, v.pacInfo.ApplicationName, status.OriginalPipelineRunName, sha, status.Text, status.DetailsURL)
+}

pkg/provider/gitea/gitea_test.go

@@ -22,11 +22,13 @@ import (
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/info"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/settings"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/triggertype"
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/provider"
 	tgitea "github.com/openshift-pipelines/pipelines-as-code/pkg/provider/gitea/test"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/provider/status"
 	"go.uber.org/zap"
 	zapobserver "go.uber.org/zap/zaptest/observer"
 	"gotest.tools/v3/assert"
+	"gotest.tools/v3/golden"
 	rtesting "knative.dev/pkg/reconciler/testing"
 )
 
@@ -579,7 +581,7 @@ func TestProvider_CreateStatusCommit(t *testing.T) {
 				giteaClient: fakeclient,
 			}
 
-			if err := v.createStatusCommit(tt.args.event, tt.args.pacopts, tt.args.status); (err != nil) != tt.wantErr {
+			if err := v.createStatusCommit(context.Background(), tt.args.event, tt.args.pacopts, tt.args.status); (err != nil) != tt.wantErr {
 				t.Errorf("Provider.createStatusCommit() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})
@@ -653,7 +655,7 @@ func TestProviderCreateStatusCommitRetryOnTransientError(t *testing.T) {
 				Conclusion: "success",
 			}
 
-			err := v.createStatusCommit(event, pacopts, status)
+			err := v.createStatusCommit(context.Background(), event, pacopts, status)
 
 			if tt.wantErr {
 				assert.Assert(t, err != nil, "expected an error but got none")
@@ -872,6 +874,110 @@ func TestCreateComment(t *testing.T) {
 	}
 }
 
+func TestCreateStatusUpdateCommentNormalizesBreaks(t *testing.T) {
+	fakeclient, mux, teardown := tgitea.Setup(t)
+	defer teardown()
+
+	var createCommentBody string
+	mux.HandleFunc("/repos/org/repo/statuses/", func(rw http.ResponseWriter, _ *http.Request) {
+		fmt.Fprint(rw, `{"state":"pending"}`)
+	})
+	mux.HandleFunc("/repos/org/repo/issues/123/comments", func(rw http.ResponseWriter, r *http.Request) {
+		switch r.Method {
+		case http.MethodGet:
+			fmt.Fprint(rw, `[]`)
+		case http.MethodPost:
+			b, err := io.ReadAll(r.Body)
+			assert.NilError(t, err)
+			createCommentBody = string(b)
+			fmt.Fprint(rw, `{}`)
+		default:
+			t.Fatalf("unexpected method: %s", r.Method)
+		}
+	})
+
+	p := &Provider{
+		giteaClient: fakeclient,
+		pacInfo: &info.PacOpts{
+			Settings: settings.Settings{
+				ApplicationName: settings.PACApplicationNameDefaultValue,
+			},
+		},
+		repo: &v1alpha1.Repository{
+			Spec: v1alpha1.RepositorySpec{
+				Settings: &v1alpha1.Settings{
+					Forgejo: &v1alpha1.ForgejoSettings{CommentStrategy: provider.UpdateCommentStrategy},
+				},
+			},
+		},
+	}
+
+	err := p.CreateStatus(context.Background(), &info.Event{
+		Organization:      "org",
+		Repository:        "repo",
+		SHA:               "abc123",
+		PullRequestNumber: 123,
+		EventType:         triggertype.PullRequest.String(),
+		TriggerTarget:     triggertype.PullRequest,
+	}, status.StatusOpts{
+		Status:                  "in_progress",
+		Text:                    "line1<br>line2",
+		OriginalPipelineRunName: "demo",
+		DetailsURL:              "https://example.test/log",
+	})
+	assert.NilError(t, err)
+	assert.Assert(t, !strings.Contains(createCommentBody, "<br>"), "comment body should not contain raw <br>: %s", createCommentBody)
+	assert.Assert(t, strings.Contains(createCommentBody, "line1\\nline2"), "comment body should contain normalized newline: %s", createCommentBody)
+
+	golden.Assert(t, createCommentBody, strings.ReplaceAll(fmt.Sprintf("%s.golden", t.Name()), "/", "-"))
+}
+
+func TestFormatPipelineCommentEmoji(t *testing.T) {
+	p := &Provider{
+		pacInfo: &info.PacOpts{
+			Settings: settings.Settings{
+				ApplicationName: settings.PACApplicationNameDefaultValue,
+			},
+		},
+	}
+
+	tests := []struct {
+		name   string
+		status status.StatusOpts
+		emoji  string
+	}{
+		{
+			name: "failure conclusion uses failure emoji",
+			status: status.StatusOpts{
+				Conclusion:              status.ConclusionFailure,
+				Title:                   "Failed",
+				Text:                    "details",
+				OriginalPipelineRunName: "demo",
+				DetailsURL:              "https://example.test/log",
+			},
+			emoji: "❌",
+		},
+		{
+			name: "in progress status uses rocket emoji",
+			status: status.StatusOpts{
+				Status:                  "in_progress",
+				Title:                   "CI has Started",
+				Text:                    "details",
+				OriginalPipelineRunName: "demo",
+				DetailsURL:              "https://example.test/log",
+			},
+			emoji: "🚀",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := p.formatPipelineComment("abc123", tt.status)
+			assert.Assert(t, strings.HasPrefix(got, tt.emoji+" "), "expected prefix %q in comment %q", tt.emoji+" ", got)
+		})
+	}
+}
+
 func TestGetCommitInfo(t *testing.T) {
 	tests := []struct {
 		name                string

pkg/provider/gitea/testdata/TestCreateStatusUpdateCommentNormalizesBreaks.golden

@@ -0,0 +1 @@
+{"body":"\u003c!-- pac-status-demo --\u003e\n🚀 **CI has Started: Pipelines as Code CI/demo for abc123**\n\nline1\nline2\n\n\u003csmall\u003eFull log available [here](https://example.test/log)\u003c/small\u003e"}

pkg/provider/provider.go

@@ -242,10 +242,13 @@ const (
 func IsCommentStrategyUpdate(repo *v1alpha1.Repository) bool {
 	var commentStrategy string
 	if repo != nil && repo.Spec.Settings != nil {
-		if repo.Spec.Settings.Gitlab != nil {
+		switch {
+		case repo.Spec.Settings.Gitlab != nil:
 			commentStrategy = repo.Spec.Settings.Gitlab.CommentStrategy
-		} else if repo.Spec.Settings.Github != nil {
+		case repo.Spec.Settings.Github != nil:
 			commentStrategy = repo.Spec.Settings.Github.CommentStrategy
+		case repo.Spec.Settings.Forgejo != nil:
+			commentStrategy = repo.Spec.Settings.Forgejo.CommentStrategy
 		}
 	}
 

pkg/webhook/validation.go

@@ -18,7 +18,10 @@ import (
 
 var universalDeserializer = serializer.NewCodecFactory(runtime.NewScheme()).UniversalDeserializer()
 
-var allowedGitlabDisableCommentStrategyOnMr = sets.NewString("", provider.DisableAllCommentStrategy, provider.UpdateCommentStrategy)
+var (
+	allowedGitlabDisableCommentStrategyOnMr = sets.NewString("", provider.DisableAllCommentStrategy, provider.UpdateCommentStrategy)
+	allowedForgejoCommentStrategyOnPr       = sets.NewString("", provider.DisableAllCommentStrategy, provider.UpdateCommentStrategy)
+)
 
 // Path implements AdmissionController.
 func (ac *reconciler) Path() string {
@@ -68,6 +71,12 @@ func (ac *reconciler) Admit(_ context.Context, request *v1.AdmissionRequest) *v1
 		}
 	}
 
+	if repo.Spec.Settings != nil && repo.Spec.Settings.Forgejo != nil {
+		if !allowedForgejoCommentStrategyOnPr.Has(repo.Spec.Settings.Forgejo.CommentStrategy) {
+			return webhook.MakeErrorStatus("comment strategy '%s' is not supported for Forgejo/Gitea PRs", repo.Spec.Settings.Forgejo.CommentStrategy)
+		}
+	}
+
 	return &v1.AdmissionResponse{Allowed: true}
 }