Resolve GitOps comment problem with push requests

When a user adds a GitOps comment
to a push request targeting a branch other than
the main branch, the pipelinerun should not
execute for those instances where the target
branch is set to 'main.'

Signed-off-by: Savita Ashture <[email protected]>

Author: savitaashture

pkg/provider/github/parse_payload.go

@@ -390,48 +390,49 @@ func (v *Provider) handleCommitCommentEvent(ctx context.Context, event *github.C
 	runevent.EventType = "push"
 	runevent.TriggerTarget = "push"
 
-	// by default head and base branch is main
-	runevent.HeadBranch = "main"
-	runevent.BaseBranch = "main"
-
+	// Set main as default branch to runevent.HeadBranch, runevent.BaseBranch
+	runevent.HeadBranch, runevent.BaseBranch = "main", "main"
 	var (
 		branchName string
 		prName     string
 		err        error
 	)
 
-	// if it is a /test or /retest comment with pipelinerun name figure out the pipelinerun name
+	// If it is a /test or /retest comment with pipelinerun name figure out the pipelinerun name
 	if provider.IsTestRetestComment(event.GetComment().GetBody()) {
 		prName, branchName, err = provider.GetPipelineRunAndBranchNameFromTestComment(event.GetComment().GetBody())
 		if err != nil {
 			return runevent, err
 		}
 		runevent.TargetTestPipelineRun = prName
 	}
+	// Check for /cancel comment
 	if provider.IsCancelComment(event.GetComment().GetBody()) {
 		action = "cancellation"
 		prName, branchName, err = provider.GetPipelineRunAndBranchNameFromCancelComment(event.GetComment().GetBody())
 		if err != nil {
 			return runevent, err
 		}
+		runevent.CancelPipelineRuns = true
 		runevent.TargetCancelPipelineRun = prName
 	}
 
-	if branchName != "" {
-		if err = v.isBranchContainsCommit(ctx, runevent, branchName); err != nil {
-			return runevent, err
-		}
-		runevent.HeadBranch = branchName
-		runevent.BaseBranch = branchName
+	// If no branch is specified in GitOps comments, use runevent.HeadBranch
+	if branchName == "" {
+		branchName = runevent.HeadBranch
 	}
 
-	if provider.IsCancelComment(event.GetComment().GetBody()) {
-		if err = v.isBranchContainsCommit(ctx, runevent, runevent.HeadBranch); err != nil {
+	// Check if the specified branch contains the commit
+	if err = v.isBranchContainsCommit(ctx, runevent, branchName); err != nil {
+		if provider.IsCancelComment(event.GetComment().GetBody()) {
 			runevent.CancelPipelineRuns = false
-			return runevent, err
 		}
-		runevent.CancelPipelineRuns = true
+		return runevent, err
 	}
+	// Finally update branch information to runevent.HeadBranch and runevent.BaseBranch
+	runevent.HeadBranch = branchName
+	runevent.BaseBranch = branchName
+
 	v.Logger.Infof("commit_comment: pipelinerun %s on %s/%s#%s has been requested", action, runevent.Organization, runevent.Repository, runevent.SHA)
 	return runevent, nil
 }

pkg/provider/github/parse_payload_test.go

@@ -77,6 +77,14 @@ var samplePR = github.PullRequest{
 	},
 }
 
+var samplePRAnother = github.PullRequest{
+	Number: github.Int(54321),
+	Head: &github.PullRequestBranch{
+		SHA:  github.String("samplePRshanew"),
+		Repo: sampleRepo,
+	},
+}
+
 func TestParsePayLoad(t *testing.T) {
 	tests := []struct {
 		name                       string
@@ -474,6 +482,25 @@ func TestParsePayLoad(t *testing.T) {
 			isCancelPipelineRunEnabled: false,
 			wantErrString:              "404 Not Found",
 		},
+		{
+			name:          "commit comment to retest a pr with a SHA that does not exist in the main branch",
+			eventType:     "commit_comment",
+			triggerTarget: "push",
+			githubClient:  true,
+			payloadEventStruct: github.CommitCommentEvent{
+				Repo: sampleRepo,
+				Comment: &github.RepositoryComment{
+					CommitID: github.String("samplePRshanew"),
+					HTMLURL:  github.String("/777"),
+					Body:     github.String("/retest dummy"),
+				},
+			},
+			muxReplies:        map[string]interface{}{"/repos/owner/reponame/pulls/777": samplePRAnother},
+			shaRet:            "samplePRshanew",
+			targetPipelinerun: "dummy",
+			wantedBranchName:  "main",
+			wantErrString:     "provided branch main does not contains sha samplePRshanew",
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -498,6 +525,16 @@ func TestParsePayLoad(t *testing.T) {
 			"commit": {
 				"sha": "samplePRsha"
 			}
+		}`)
+					assert.NilError(t, err)
+				})
+				mux.HandleFunc(fmt.Sprintf("/repos/%s/%s/branches/testnew",
+					"owner", "reponame"), func(rw http.ResponseWriter, r *http.Request) {
+					_, err := fmt.Fprintf(rw, `{
+			"name": "testnew",
+			"commit": {
+				"sha": "samplePRshanew"
+			}
 		}`)
 					assert.NilError(t, err)
 				})