Add support for GitOps comments on Push commits

Add supports for GitOps comments on Push commits when using the Git
Provider.

Signed-off-by: Chmouel Boudjnah <[email protected]>

Author: chmouel

docs/content/docs/guide/matchingevents.md

@@ -178,9 +178,10 @@ files.
 ## Matching a PipelineRun on a Regexp in a comment
 
 {{< tech_preview "Matching PipelineRun on regexp in comments" >}}
+{{< support_matrix github_app="true" github_webhook="true" gitea="true" gitlab="true" bitbucket_cloud="false" bitbucket_server="false" >}}
 
-You can match a PipelineRun on a comment on a Pull Request with the annotation
-`pipelinesascode.tekton.dev/on-comment`.
+You can match a PipelineRun on a comment on a Pull Request or a [Pushed Commit]({{< relref "/docs/guide/running.md#gitops-commands-on-pushed-commits">}})
+with the annotation `pipelinesascode.tekton.dev/on-comment`.
 
 The comment is a regexp and if a newly created comment has this regexp it will
 automatically match the PipelineRun and start it.
@@ -208,7 +209,13 @@ Note that the `on-comment` annotation will respect the `pull_request` [Policy]({
 so only users in the `pull_request` policy will be able to trigger the
 PipelineRun.
 
-> *NOTE*: The `on-comment` annotation is only supported on GitHub, Gitea, and GitLab providers
+{{< hint info >}}
+
+- The `on-comment` annotation is supported on `pull_request`. On  `push` events,
+it is only supported [when targeting the main branch without arguments]({{< relref
+"/docs/guide/gitops_commands.md#gitops-commands-on-pushed-commits" >}}).
+
+{{< /hint >}}
 
 ## Matching PipelineRun to a Pull Request labels
 

pkg/pipelineascode/match.go

@@ -217,7 +217,6 @@ func (p *PacRun) getPipelineRunsFromRepo(ctx context.Context, repo *v1alpha1.Rep
 		p.eventEmitter.EmitMessage(nil, zap.InfoLevel, "RepositoryCannotLocatePipelineRun", msg)
 		return nil, nil
 	}
-
 	pipelineRuns, err = resolve.MetadataResolve(pipelineRuns)
 	if err != nil && len(pipelineRuns) == 0 {
 		p.eventEmitter.EmitMessage(repo, zap.ErrorLevel, "FailedToResolvePipelineRunMetadata", err.Error())

pkg/provider/github/detect.go

@@ -109,7 +109,7 @@ func (v *Provider) detectTriggerTypeFromPayload(ghEventType string, eventInt any
 				return triggertype.Cancel, ""
 			}
 		}
-		return "", fmt.Sprintf("commit_comment: unsupported action \"%s\"", event.GetAction())
+		return triggertype.Comment, ""
 	}
 	return "", fmt.Sprintf("github: event \"%v\" is not supported", ghEventType)
 }

pkg/provider/github/detect_test.go

@@ -69,13 +69,13 @@ func TestProvider_Detect(t *testing.T) {
 			processReq: false,
 		},
 		{
-			name: "invalid commit_comment Event",
+			name: "non standard commit_comment Event",
 			event: github.CommitCommentEvent{
 				Action: github.String("something"),
 			},
 			eventType:  "commit_comment",
 			isGH:       true,
-			processReq: false,
+			processReq: true,
 		},
 		{
 			name: "invalid check run Event",

pkg/provider/github/parse_payload.go

@@ -427,9 +427,8 @@ func (v *Provider) handleCommitCommentEvent(ctx context.Context, event *github.C
 	runevent.SHA = event.GetComment().GetCommitID()
 	runevent.HeadURL = runevent.URL
 	runevent.BaseURL = runevent.HeadURL
-	runevent.EventType = "push"
-	runevent.TriggerTarget = "push"
-	runevent.TriggerComment = event.GetComment().GetBody()
+	runevent.TriggerTarget = triggertype.Push
+	opscomments.SetEventTypeAndTargetPR(runevent, event.GetComment().GetBody())
 
 	// Set main as default branch to runevent.HeadBranch, runevent.BaseBranch
 	runevent.HeadBranch, runevent.BaseBranch = "main", "main"

test/github_push_retest_test.go

@@ -5,25 +5,86 @@ package test
 
 import (
 	"context"
+	"fmt"
 	"regexp"
 	"testing"
 
 	"github.com/google/go-github/v66/github"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/keys"
 	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/cctx"
 	tgithub "github.com/openshift-pipelines/pipelines-as-code/test/pkg/github"
+	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/options"
 	twait "github.com/openshift-pipelines/pipelines-as-code/test/pkg/wait"
 	tektonv1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
 	"gotest.tools/v3/assert"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+func TestGithubPushRequestGitOpsCommentOnComment(t *testing.T) {
+	opsComment := "/hello-world"
+	ctx := context.Background()
+	g := &tgithub.PRTest{
+		Label:         "Github GitOps push/retest request",
+		YamlFiles:     []string{"testdata/pipelinerun-on-comment-annotation.yaml"},
+		NoStatusCheck: true,
+		TargetRefName: options.MainBranch,
+	}
+	g.RunPushRequest(ctx, t)
+	defer g.TearDown(ctx, t)
+
+	// let's make sure we didn't create any PipelineRuns since we only match on-comment here
+	pruns, err := g.Cnx.Clients.Tekton.TektonV1().PipelineRuns(g.TargetNamespace).List(ctx, metav1.ListOptions{})
+	assert.NilError(t, err)
+	assert.Equal(t, len(pruns.Items), 0)
+
+	g.Cnx.Clients.Log.Infof("Running ops comment %s as Push comment", opsComment)
+	_, _, err = g.Provider.Client.Repositories.CreateComment(ctx,
+		g.Options.Organization,
+		g.Options.Repo, g.SHA,
+		&github.RepositoryComment{Body: github.String(opsComment)})
+	assert.NilError(t, err)
+
+	waitOpts := twait.Opts{
+		RepoName:        g.TargetNamespace,
+		Namespace:       g.TargetNamespace,
+		MinNumberStatus: len(g.YamlFiles),
+		PollTimeout:     twait.DefaultTimeout,
+		TargetSHA:       g.SHA,
+	}
+	g.Cnx.Clients.Log.Info("Waiting for Repository to be updated")
+	_, err = twait.UntilRepositoryUpdated(ctx, g.Cnx.Clients, waitOpts)
+	assert.NilError(t, err)
+
+	g.Cnx.Clients.Log.Infof("Check if we have the repository set as succeeded")
+	repo, err := g.Cnx.Clients.PipelineAsCode.PipelinesascodeV1alpha1().Repositories(g.TargetNamespace).Get(ctx, g.TargetNamespace, metav1.GetOptions{})
+	assert.NilError(t, err)
+	assert.Equal(t, repo.Status[len(repo.Status)-1].Conditions[0].Status, corev1.ConditionTrue)
+
+	pruns, err = g.Cnx.Clients.Tekton.TektonV1().PipelineRuns(g.TargetNamespace).List(ctx, metav1.ListOptions{})
+	assert.NilError(t, err)
+	assert.Equal(t, len(pruns.Items), len(g.YamlFiles))
+	lastPrName := pruns.Items[0].GetName()
+	err = twait.RegexpMatchingInPodLog(
+		context.Background(),
+		g.Cnx,
+		g.TargetNamespace,
+		fmt.Sprintf("tekton.dev/pipelineRun=%s", lastPrName),
+		"step-task",
+		*regexp.MustCompile(opsComment),
+		"",
+		2)
+
+	assert.NilError(t, err)
+}
+
 func TestGithubPushRequestGitOpsCommentRetest(t *testing.T) {
 	ctx := context.Background()
 	g := &tgithub.PRTest{
-		Label:     "Github GitOps push/retest request",
-		YamlFiles: []string{"testdata/pipelinerun-on-push.yaml", "testdata/pipelinerun.yaml"},
+		Label: "Github GitOps push/retest request",
+		YamlFiles: []string{
+			"testdata/pipelinerun-on-push.yaml", "testdata/pipelinerun.yaml",
+		},
 	}
 	g.RunPushRequest(ctx, t)
 	defer g.TearDown(ctx, t)

test/pkg/github/pr.go

@@ -16,6 +16,7 @@ import (
 	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/options"
 	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/payload"
 	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/repository"
+	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/scm"
 	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/wait"
 	"github.com/tektoncd/pipeline/pkg/names"
 	"go.uber.org/zap"
@@ -72,7 +73,7 @@ func PushFilesToRef(ctx context.Context, client *ghlib.Client, commitMessage, ba
 		},
 	}, &ghlib.CreateCommitOptions{})
 	if err != nil {
-		return "", nil, err
+		return "", nil, fmt.Errorf("error creating commit: %w", err)
 	}
 
 	ref := &ghlib.Reference{
@@ -83,9 +84,8 @@ func PushFilesToRef(ctx context.Context, client *ghlib.Client, commitMessage, ba
 	}
 	vref, _, err := client.Git.CreateRef(ctx, owner, repo, ref)
 	if err != nil {
-		return "", nil, err
+		return "", nil, fmt.Errorf("error creating ref: %w", err)
 	}
-
 	return commit.GetSHA(), vref, nil
 }
 
@@ -155,6 +155,7 @@ func (g *PRTest) RunPullRequest(ctx context.Context, t *testing.T) {
 	sha, vref, err := PushFilesToRef(ctx, ghcnx.Client, g.CommitTitle, repoinfo.GetDefaultBranch(), targetRefName,
 		opts.Organization, opts.Repo, entries)
 	assert.NilError(t, err)
+
 	g.Logger.Infof("Commit %s has been created and pushed to %s", sha, vref.GetURL())
 	number, err := PRCreate(ctx, runcnx, ghcnx, opts.Organization,
 		opts.Repo, targetRefName, repoinfo.GetDefaultBranch(), g.CommitTitle)
@@ -197,14 +198,21 @@ func (g *PRTest) TearDown(ctx context.Context, t *testing.T) {
 	if g.TargetNamespace != "" {
 		repository.NSTearDown(ctx, t, g.Cnx, g.TargetNamespace)
 	}
-	g.Logger.Infof("Deleting Ref %s", g.TargetRefName)
-	_, err := g.Provider.Client.Git.DeleteRef(ctx, g.Options.Organization, g.Options.Repo, g.TargetRefName)
-	assert.NilError(t, err)
+	if g.TargetRefName != options.MainBranch {
+		branch := fmt.Sprintf("heads/%s", filepath.Base(g.TargetRefName))
+		g.Logger.Infof("Deleting Ref %s", branch)
+		_, err := g.Provider.Client.Git.DeleteRef(ctx, g.Options.Organization, g.Options.Repo, branch)
+		assert.NilError(t, err)
+	}
 }
 
 func (g *PRTest) RunPushRequest(ctx context.Context, t *testing.T) {
 	targetNS := names.SimpleNameGenerator.RestrictLengthWithRandomSuffix("pac-e2e-push")
-	targetBranch := targetNS
+
+	targetBranch := g.TargetRefName
+	if targetBranch == "" {
+		targetBranch = targetNS
+	}
 	targetEvent := "push"
 	ctx, runcnx, opts, ghcnx, err := Setup(ctx, g.SecondController, g.Webhook)
 	assert.NilError(t, err)
@@ -235,19 +243,34 @@ func (g *PRTest) RunPushRequest(ctx context.Context, t *testing.T) {
 		targetNS, targetBranch, targetEvent, map[string]string{})
 	assert.NilError(t, err)
 
-	targetRefName := fmt.Sprintf("refs/heads/%s", targetBranch)
-	sha, vref, err := PushFilesToRef(ctx, ghcnx.Client, logmsg, repoinfo.GetDefaultBranch(), targetRefName, opts.Organization, opts.Repo, entries)
-	g.Logger.Infof("Commit %s has been created and pushed to %s", sha, vref.GetURL())
+	targetRefName := targetBranch
+	cloneURL, err := scm.MakeGitCloneURL(repoinfo.GetCloneURL(), "git", *ghcnx.Token)
+	assert.NilError(t, err)
+	scmOpts := scm.Opts{
+		GitURL:        cloneURL,
+		TargetRefName: targetRefName,
+		BaseRefName:   repoinfo.GetDefaultBranch(),
+		WebURL:        repoinfo.GetHTMLURL(),
+		Log:           runcnx.Clients.Log,
+		CommitTitle:   logmsg,
+	}
+	scm.PushFilesToRefGit(t, &scmOpts, entries)
+	branch, _, err := ghcnx.Client.Repositories.GetBranch(ctx, opts.Organization, opts.Repo, targetBranch, 1)
+	assert.NilError(t, err)
+	sha := branch.GetCommit().GetSHA()
+	g.Logger.Infof("Commit %s has been created and pushed to %s in branch %s", sha, branch.GetCommit().GetHTMLURL(), branch.GetName())
 	assert.NilError(t, err)
 
-	sopt := wait.SuccessOpt{
-		Title:           logmsg,
-		OnEvent:         triggertype.Push.String(),
-		TargetNS:        targetNS,
-		NumberofPRMatch: len(g.YamlFiles),
-		SHA:             sha,
+	if !g.NoStatusCheck {
+		sopt := wait.SuccessOpt{
+			Title:           logmsg,
+			OnEvent:         triggertype.Push.String(),
+			TargetNS:        targetNS,
+			NumberofPRMatch: len(g.YamlFiles),
+			SHA:             sha,
+		}
+		wait.Succeeded(ctx, t, runcnx, opts, sopt)
 	}
-	wait.Succeeded(ctx, t, runcnx, opts, sopt)
 
 	g.Cnx = runcnx
 	g.Options = opts

test/pkg/github/setup.go

@@ -109,6 +109,7 @@ func Setup(ctx context.Context, onSecondController, viaDirectWebhook bool) (cont
 		Token: githubToken,
 		URL:   githubURL,
 	}
+	gprovider.Token = &githubToken
 	// TODO: before PR
 	if err := gprovider.SetClient(ctx, nil, event, nil, nil); err != nil {
 		return ctx, nil, options.E2E{}, github.New(), err