Single signal reason for verification failure

buildkite · Aug 4, 2023 · aaaeaaf · aaaeaaf
1 parent 773277f
commit aaaeaaf
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 12 deletions.
diff --git a/agent/integration/job_verification_integration_test.go b/agent/integration/job_verification_integration_test.go
@@ -102,7 +102,7 @@ func TestJobVerification(t *testing.T) {
 			job:                      jobWithInvalidSignature,
 			mockBootstrapExpectation: func(bt *bintest.Mock) { bt.Expect().NotCalled() },
 			expectedExitStatus:       "-1",
-			expectedSignalReason:     "job_verification_failed_invalid_signature",
+			expectedSignalReason:     agent.SignalReasonVerificationFailed,
 			expectLogsContain:        []string{"⚠️ ERROR"},
 		},
 		{
@@ -127,7 +127,7 @@ func TestJobVerification(t *testing.T) {
 			job:                      jobWithNoSignature,
 			mockBootstrapExpectation: func(bt *bintest.Mock) { bt.Expect().NotCalled() },
 			expectedExitStatus:       "-1",
-			expectedSignalReason:     "job_verification_failed_no_signature",
+			expectedSignalReason:     agent.SignalReasonVerificationFailed,
 			expectLogsContain:        []string{"⚠️ ERROR"},
 		},
 		{
@@ -144,7 +144,7 @@ func TestJobVerification(t *testing.T) {
 			job:                      jobWithMismatchedStepAndJob,
 			mockBootstrapExpectation: func(bt *bintest.Mock) { bt.Expect().NotCalled() },
 			expectedExitStatus:       "-1",
-			expectedSignalReason:     "job_verification_failed_invalid_signature",
+			expectedSignalReason:     agent.SignalReasonVerificationFailed,
 			expectLogsContain: []string{
 				"⚠️ ERROR",
 				fmt.Sprintf(`the value of field "command" on the job (%q) does not match the value of the field on the step (%q)`,
@@ -238,7 +238,7 @@ func TestWhenTheJobHasASignature_ButTheJobRunnerCantVerify_ItRefusesTheJob(t *te
 		}
 	}
 
-	if got, want := finish.SignalReason, "job_verification_failed_with_error"; got != want {
+	if got, want := finish.SignalReason, agent.SignalReasonVerificationFailed; got != want {
 		t.Errorf("job.SignalReason = %q, want %q", got, want)
 	}
 }
diff --git a/agent/run_job.go b/agent/run_job.go
@@ -18,6 +18,14 @@ import (
 	"github.com/buildkite/roko"
 )
 
+const (
+	SignalReasonAgentRefused       = "agent_refused"
+	SignalReasonAgentStop          = "agent_stop"
+	SignalReasonCancel             = "cancel"
+	SignalReasonVerificationFailed = "verification_failed"
+	SignalReasonProcessRunError    = "process_run_error"
+)
+
 // Runs the job
 func (r *JobRunner) Run(ctx context.Context) error {
 	r.logger.Info("Starting job %s", r.conf.Job.ID)
@@ -87,7 +95,7 @@ func (r *JobRunner) Run(ctx context.Context) error {
 			VerificationBehaviourBlock,
 		)
 		exit.Status = -1
-		exit.SignalReason = "job_verification_failed_with_error"
+		exit.SignalReason = SignalReasonVerificationFailed
 		return nil
 	}
 
@@ -98,22 +106,22 @@ func (r *JobRunner) Run(ctx context.Context) error {
 			r.verificationFailureLogs(err, r.NoSignatureBehavior)
 			if r.NoSignatureBehavior == VerificationBehaviourBlock {
 				exit.Status = -1
-				exit.SignalReason = "job_verification_failed_no_signature"
+				exit.SignalReason = SignalReasonVerificationFailed
 				return nil
 			}
 
 		case errors.As(err, &ise):
 			r.verificationFailureLogs(err, r.InvalidSignatureBehavior)
 			if r.InvalidSignatureBehavior == VerificationBehaviourBlock {
 				exit.Status = -1
-				exit.SignalReason = "job_verification_failed_invalid_signature"
+				exit.SignalReason = SignalReasonVerificationFailed
 				return nil
 			}
 
 		case err != nil: // some other error
 			r.verificationFailureLogs(err, VerificationBehaviourBlock) // errors in verification are always fatal
 			exit.Status = -1
-			exit.SignalReason = "job_verification_failed_with_error"
+			exit.SignalReason = SignalReasonVerificationFailed
 			return nil
 
 		default: // no error, all good, keep going
@@ -134,7 +142,7 @@ func (r *JobRunner) Run(ctx context.Context) error {
 			r.logger.Error("pre-bootstrap hook rejected this job: %s", err)
 
 			exit.Status = -1
-			exit.SignalReason = "agent_refused"
+			exit.SignalReason = SignalReasonAgentRefused
 
 			return nil
 		}
@@ -166,7 +174,7 @@ func (r *JobRunner) runJob(ctx context.Context) processExit {
 		// The process did not run at all, so make sure it fails
 		return processExit{
 			Status:       -1,
-			SignalReason: "process_run_error",
+			SignalReason: SignalReasonProcessRunError,
 		}
 	}
 	// Intended to capture situations where the job-exec (aka bootstrap) container did not
@@ -193,11 +201,11 @@ func (r *JobRunner) runJob(ctx context.Context) processExit {
 	case r.stopped:
 		// The agent is being gracefully stopped, and we signaled the job to end. Often due
 		// to pending host shutdown or EC2 spot instance termination
-		exit.SignalReason = "agent_stop"
+		exit.SignalReason = SignalReasonAgentStop
 
 	case r.cancelled:
 		// The job was signaled because it was cancelled via the buildkite web UI
-		exit.SignalReason = "cancel"
+		exit.SignalReason = SignalReasonCancel
 	}
 
 	return exit