feat: show error message when pipeline syntax is wrong

Signed-off-by: ankitm123 <[email protected]>

pkg/jobutil/jobutil.go

@@ -95,7 +95,7 @@ func createRefs(pr *scm.PullRequest, baseSHA string, prRefFmt string) v1alpha1.R
 // NewPresubmit converts a config.Presubmit into a builder.PipelineOptions.
 // The builder.Refs are configured correctly per the pr, baseSHA.
 // The eventGUID becomes a gitprovider.EventGUID label.
-func NewPresubmit(logger *logrus.Entry, pr *scm.PullRequest, baseSHA string, job job.Presubmit, eventGUID string, prRefFmt string) v1alpha1.LighthouseJob {
+func NewPresubmit(logger *logrus.Entry, pr *scm.PullRequest, baseSHA string, job job.Presubmit, eventGUID string, prRefFmt string) (v1alpha1.LighthouseJob, error) {
 	refs := createRefs(pr, baseSHA, prRefFmt)
 	labels := make(map[string]string)
 	for k, v := range job.Labels {
@@ -106,12 +106,19 @@ func NewPresubmit(logger *logrus.Entry, pr *scm.PullRequest, baseSHA string, job
 		annotations[k] = v
 	}
 	labels[scmprovider.EventGUID] = eventGUID
-	return NewLighthouseJob(PresubmitSpec(logger, job, refs), labels, annotations)
+	preSubmitSpec, err := PresubmitSpec(logger, job, refs)
+	if err != nil {
+		return v1alpha1.LighthouseJob{}, err
+	}
+	return NewLighthouseJob(preSubmitSpec, labels, annotations), nil
 }
 
 // PresubmitSpec initializes a PipelineOptionsSpec for a given presubmit job.
-func PresubmitSpec(logger *logrus.Entry, p job.Presubmit, refs v1alpha1.Refs) v1alpha1.LighthouseJobSpec {
-	pjs := specFromJobBase(logger, p.Base)
+func PresubmitSpec(logger *logrus.Entry, p job.Presubmit, refs v1alpha1.Refs) (v1alpha1.LighthouseJobSpec, error) {
+	pjs, err := specFromJobBase(logger, p.Base)
+	if err != nil {
+		return pjs, err
+	}
 	pjs.Type = job.PresubmitJob
 	pjs.Context = p.Context
 	pjs.RerunCommand = p.RerunCommand
@@ -123,12 +130,12 @@ func PresubmitSpec(logger *logrus.Entry, p job.Presubmit, refs v1alpha1.Refs) v1
 		}
 	}
 
-	return pjs
+	return pjs, nil
 }
 
 // PostsubmitSpec initializes a PipelineOptionsSpec for a given postsubmit job.
 func PostsubmitSpec(logger *logrus.Entry, p job.Postsubmit, refs v1alpha1.Refs) v1alpha1.LighthouseJobSpec {
-	pjs := specFromJobBase(logger, p.Base)
+	pjs, _ := specFromJobBase(logger, p.Base)
 	pjs.Type = job.PostsubmitJob
 	pjs.Context = p.Context
 	pjs.Refs = completePrimaryRefs(refs, p.Base)
@@ -144,29 +151,38 @@ func PostsubmitSpec(logger *logrus.Entry, p job.Postsubmit, refs v1alpha1.Refs)
 
 // PeriodicSpec initializes a PipelineOptionsSpec for a given periodic job.
 func PeriodicSpec(logger *logrus.Entry, p job.Periodic) v1alpha1.LighthouseJobSpec {
-	pjs := specFromJobBase(logger, p.Base)
+	pjs, _ := specFromJobBase(logger, p.Base)
 	pjs.Type = job.PeriodicJob
 
 	return pjs
 }
 
 // BatchSpec initializes a PipelineOptionsSpec for a given batch job and ref spec.
 func BatchSpec(logger *logrus.Entry, p job.Presubmit, refs v1alpha1.Refs) v1alpha1.LighthouseJobSpec {
-	pjs := specFromJobBase(logger, p.Base)
+	pjs, _ := specFromJobBase(logger, p.Base)
 	pjs.Type = job.BatchJob
 	pjs.Context = p.Context
 	pjs.Refs = completePrimaryRefs(refs, p.Base)
 
 	return pjs
 }
 
-func specFromJobBase(logger *logrus.Entry, jb job.Base) v1alpha1.LighthouseJobSpec {
+func specFromJobBase(logger *logrus.Entry, jb job.Base) (v1alpha1.LighthouseJobSpec, error) {
 	// if we have not yet loaded the PipelineRunSpec then lets do it now
 	if jb.PipelineRunSpec == nil {
 		logger = logger.WithField("JobName", jb.Name)
 		err := jb.LoadPipeline(logger)
 		if err != nil {
 			logger.WithError(err).Warn("failed to lazy load the PipelineRunSpec")
+			return v1alpha1.LighthouseJobSpec{
+				Agent:             jb.Agent,
+				Job:               jb.Name,
+				Namespace:         *jb.Namespace,
+				MaxConcurrency:    jb.MaxConcurrency,
+				PodSpec:           jb.Spec,
+				PipelineRunSpec:   jb.PipelineRunSpec,
+				PipelineRunParams: jb.PipelineRunParams,
+			}, err
 		}
 	}
 	var namespace string
@@ -181,7 +197,7 @@ func specFromJobBase(logger *logrus.Entry, jb job.Base) v1alpha1.LighthouseJobSp
 		PodSpec:           jb.Spec,
 		PipelineRunSpec:   jb.PipelineRunSpec,
 		PipelineRunParams: jb.PipelineRunParams,
-	}
+	}, nil
 }
 
 func completePrimaryRefs(refs v1alpha1.Refs, jb job.Base) *v1alpha1.Refs {

pkg/jobutil/jobutil_test.go

@@ -204,7 +204,7 @@ func TestPresubmitSpec(t *testing.T) {
 	}
 
 	for _, tc := range tests {
-		actual := PresubmitSpec(logger, tc.p, tc.refs)
+		actual, _ := PresubmitSpec(logger, tc.p, tc.refs)
 		if expected := tc.expected; !reflect.DeepEqual(actual, expected) {
 			t.Errorf("%s: actual %#v != expected %#v", tc.name, actual, expected)
 		}
@@ -592,7 +592,7 @@ func TestSpecFromJobBase(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			pj := specFromJobBase(logger, tc.jobBase)
+			pj, _ := specFromJobBase(logger, tc.jobBase)
 			if err := tc.verify(pj); err != nil {
 				t.Fatalf("Verification failed: %v", err)
 			}

pkg/keeper/keeper.go

@@ -1201,7 +1201,7 @@ func (c *DefaultController) trigger(sp subpool, presubmits map[int][]job.Presubm
 			triggeredContexts.Insert(ps.Context)
 			var spec v1alpha1.LighthouseJobSpec
 			if len(prs) == 1 {
-				spec = jobutil.PresubmitSpec(c.logger, ps, refs)
+				spec, _ = jobutil.PresubmitSpec(c.logger, ps, refs)
 			} else {
 				spec = jobutil.BatchSpec(c.logger, ps, refs)
 			}

pkg/plugins/override/override.go

@@ -206,7 +206,7 @@ Only the following contexts were expected:
 				return spc.CreateComment(org, repo, number, e.IsPR, plugins.FormatResponseRaw(e.Body, e.Link, spc.QuoteAuthorForComment(user), resp))
 			}
 
-			pj := jobutil.NewPresubmit(log, pr, baseSHA, *pre, e.GUID, spc.PRRefFmt())
+			pj, _ := jobutil.NewPresubmit(log, pr, baseSHA, *pre, e.GUID, spc.PRRefFmt())
 			now := metav1.Now()
 			pj.Status = v1alpha1.LighthouseJobStatus{
 				State:          v1alpha1.SuccessState,

pkg/plugins/trigger/trigger.go

@@ -41,41 +41,39 @@ const (
 	customerTriggerCommandEnvVar = "LH_CUSTOM_TRIGGER_COMMAND"
 )
 
-var (
-	plugin = plugins.Plugin{
-		Description: `The trigger plugin starts tests in reaction to commands and pull request events. It is responsible for ensuring that test jobs are only run on trusted PRs. A PR is considered trusted if the author is a member of the 'trusted organization' for the repository or if such a member has left an '/ok-to-test' command on the PR.
+var plugin = plugins.Plugin{
+	Description: `The trigger plugin starts tests in reaction to commands and pull request events. It is responsible for ensuring that test jobs are only run on trusted PRs. A PR is considered trusted if the author is a member of the 'trusted organization' for the repository or if such a member has left an '/ok-to-test' command on the PR.
 <br>Trigger starts jobs automatically when a new trusted PR is created or when an untrusted PR becomes trusted, but it can also be used to start jobs manually via the '/test' command.
 <br>The '/retest' command can be used to rerun jobs that have reported failure.`,
-		ConfigHelpProvider: configHelp,
-		PullRequestHandler: handlePullRequest,
-		PushEventHandler:   handlePush,
-		Commands: []plugins.Command{{
-			Name:        "ok-to-test",
-			Description: "Marks a PR as 'trusted' and starts tests.",
-			WhoCanUse:   "Members of the trusted organization for the repo.",
-			Action: plugins.
-				Invoke(handleGenericCommentEvent).
-				When(plugins.Action(scm.ActionCreate), plugins.IsPR(), plugins.IssueState("open")),
-		}, {
-			Name: "test",
-			Arg: &plugins.CommandArg{
-				Pattern: `[-\w]+(?:,[-\w]+)*`,
-			},
-			Description: "Manually starts a/all test job(s).",
-			Featured:    true,
-			Action: plugins.
-				Invoke(handleGenericCommentEvent).
-				When(plugins.Action(scm.ActionCreate), plugins.IsPR(), plugins.IssueState("open")),
-		}, {
-			Name:        "retest",
-			Description: "Rerun test jobs that have failed.",
-			Featured:    true,
-			Action: plugins.
-				Invoke(handleGenericCommentEvent).
-				When(plugins.Action(scm.ActionCreate), plugins.IsPR(), plugins.IssueState("open")),
-		}},
-	}
-)
+	ConfigHelpProvider: configHelp,
+	PullRequestHandler: handlePullRequest,
+	PushEventHandler:   handlePush,
+	Commands: []plugins.Command{{
+		Name:        "ok-to-test",
+		Description: "Marks a PR as 'trusted' and starts tests.",
+		WhoCanUse:   "Members of the trusted organization for the repo.",
+		Action: plugins.
+			Invoke(handleGenericCommentEvent).
+			When(plugins.Action(scm.ActionCreate), plugins.IsPR(), plugins.IssueState("open")),
+	}, {
+		Name: "test",
+		Arg: &plugins.CommandArg{
+			Pattern: `[-\w]+(?:,[-\w]+)*`,
+		},
+		Description: "Manually starts a/all test job(s).",
+		Featured:    true,
+		Action: plugins.
+			Invoke(handleGenericCommentEvent).
+			When(plugins.Action(scm.ActionCreate), plugins.IsPR(), plugins.IssueState("open")),
+	}, {
+		Name:        "retest",
+		Description: "Rerun test jobs that have failed.",
+		Featured:    true,
+		Action: plugins.
+			Invoke(handleGenericCommentEvent).
+			When(plugins.Action(scm.ActionCreate), plugins.IsPR(), plugins.IssueState("open")),
+	}},
+}
 
 func init() {
 	customTriggerCommand := os.Getenv(customerTriggerCommandEnvVar)
@@ -283,7 +281,10 @@ func runRequested(c Client, pr *scm.PullRequest, requestedJobs []job.Presubmit,
 	var errors []error
 	for _, job := range requestedJobs {
 		c.Logger.Infof("Starting %s build.", job.Name)
-		pj := jobutil.NewPresubmit(c.Logger, pr, baseSHA, job, eventGUID, c.SCMProviderClient.PRRefFmt())
+		pj, err := jobutil.NewPresubmit(c.Logger, pr, baseSHA, job, eventGUID, c.SCMProviderClient.PRRefFmt())
+		if err != nil {
+			errors = append(errors, err)
+		}
 		c.Logger.WithFields(jobutil.LighthouseJobFields(&pj)).Info("Creating a new LighthouseJob.")
 		if _, err := c.LauncherClient.Launch(&pj); err != nil {
 			c.Logger.WithError(err).Error("Failed to create LighthouseJob.")
@@ -293,6 +294,17 @@ func runRequested(c Client, pr *scm.PullRequest, requestedJobs []job.Presubmit,
 			}
 		}
 	}
+
+	if len(errors) > 0 {
+		org, repo, _ := orgRepoAuthor(*pr)
+		errorString := ""
+		for k := range errors {
+			errorString += "*" + errors[k].Error() + "\n"
+		}
+		message := "failed to trigger Pull Request pipeline\n" + errorString
+		c.SCMProviderClient.CreateComment(org, repo, pr.Number, true, message)
+	}
+
 	return errorutil.NewAggregate(errors...)
 }
 

pkg/webhook/webhook.go

@@ -520,7 +520,7 @@ func (o *WebhooksController) createHookServer() (*Server, error) {
 		Metrics:     promMetrics,
 		ServerURL:   serverURL,
 		InRepoCache: cache,
-		//TokenGenerator: secretAgent.GetTokenGenerator(o.webhookSecretFile),
+		// TokenGenerator: secretAgent.GetTokenGenerator(o.webhookSecretFile),
 	}
 	return server, nil
 }