fix(github): handle check run status for validation errors

Fix check run creation to properly use status and conclusion from
statusOpts instead of hardcoding "in_progress". Also include output
fields (Title, Summary, Text) in check runs.

Prevent patching PipelineRun when validation fails by checking if
PipelineRun has a valid name before patching with checkRunID and
logURL. Validation errors provide PipelineRun struct but it's not
a valid cluster resource.

Also fix infinite loop in test by incrementing counter.

https://issues.redhat.com/browse/SRVKP-9206

Signed-off-by: Zaki Shaikh <zashaikh@redhat.com>

Author: zakisk

pkg/provider/github/status.go

@@ -112,14 +112,23 @@ func (v *Provider) canIUseCheckrunID(checkrunid *int64) bool {
 func (v *Provider) createCheckRunStatus(ctx context.Context, runevent *info.Event, status provider.StatusOpts) (*int64, error) {
 	now := github.Timestamp{Time: time.Now()}
 	checkrunoption := github.CreateCheckRunOptions{
-		Name:       provider.GetCheckName(status, v.pacInfo),
-		HeadSHA:    runevent.SHA,
-		Status:     github.Ptr("in_progress"),
+		Name:    provider.GetCheckName(status, v.pacInfo),
+		HeadSHA: runevent.SHA,
+		Status:  github.Ptr(status.Status), // take status from statusOpts because it can be in_progress, queued, or failure // same for conclusion as well
+		Output: &github.CheckRunOutput{
+			Title:   github.Ptr(status.Title),
+			Summary: github.Ptr(status.Summary),
+			Text:    github.Ptr(status.Text),
+		},
 		DetailsURL: github.Ptr(status.DetailsURL),
 		ExternalID: github.Ptr(status.PipelineRunName),
 		StartedAt:  &now,
 	}
 
+	if status.Status != "in_progress" && status.Status != "queued" {
+		checkrunoption.Conclusion = github.Ptr(status.Conclusion)
+	}
+
 	checkRun, _, err := wrapAPI(v, "create_check_run", func() (*github.CheckRun, *github.Response, error) {
 		return v.Client().Checks.CreateCheckRun(ctx, runevent.Organization, runevent.Repository, checkrunoption)
 	})
@@ -232,7 +241,11 @@ func (v *Provider) getOrUpdateCheckRunStatus(ctx context.Context, runevent *info
 				return err
 			}
 		}
-		if statusOpts.PipelineRun != nil {
+
+		// Patch the pipelineRun with the checkRunID and logURL only when the pipelineRun is not nil and has a name
+		// because on validation failed PipelineRun will provide PipelineRun struct but it is not a valid resource
+		// created in cluster so if its only validation error report then ignore patching the pipelineRun.
+		if statusOpts.PipelineRun != nil && (statusOpts.PipelineRun.GetName() != "" || statusOpts.PipelineRun.GetGenerateName() != "") {
 			if _, err := action.PatchPipelineRun(ctx, v.Logger, "checkRunID and logURL", v.Run.Clients.Tekton, statusOpts.PipelineRun, metadataPatch(checkRunID, statusOpts.DetailsURL)); err != nil {
 				return err
 			}

pkg/provider/github/status_test.go

@@ -336,6 +336,20 @@ func TestGithubProviderCreateStatus(t *testing.T) {
 			want:    &github.CheckRun{ID: &resultid},
 			wantErr: false,
 		},
+		{
+			name: "validation failure",
+			args: args{
+				runevent:    runEvent,
+				status:      "completed",
+				conclusion:  "failure",
+				text:        "There was an error creating the PipelineRun: ```admission webhook \"validation.webhook.pipeline.tekton.dev\" denied the request: validation failed: invalid value: 0s```",
+				detailsURL:  "https://cireport.com",
+				titleSubstr: "Failed",
+				githubApps:  true,
+			},
+			want:    &github.CheckRun{ID: &resultid},
+			wantErr: false,
+		},
 		{
 			name: "failure from bot",
 			args: args{

test/github_config_maxkeepruns_test.go

@@ -1,5 +1,3 @@
-//go:build e2e
-
 package test
 
 import (

test/github_pullrequest_test.go

@@ -264,6 +264,7 @@ func TestGithubPullRequestInvalidSpecValues(t *testing.T) {
 			break
 		}
 		time.Sleep(5 * time.Second)
+		counter++
 	}
 
 	assert.Equal(t, len(res.CheckRuns), 1)