feat: detect pipeline & jobs allowed to fail (#990)

* fix: missing new status success_with_warnings

* feat: detect jobs allowed to fail

Author: seyguai

pkg/controller/collectors.go

@@ -10,7 +10,7 @@ var (
 	environmentInformationLabels = []string{"environment_id", "external_url", "kind", "ref", "latest_commit_short_id", "current_commit_short_id", "available", "username"}
 	testSuiteLabels              = []string{"test_suite_name"}
 	testCaseLabels               = []string{"test_case_name", "test_case_classname"}
-	statusesList                 = [...]string{"created", "waiting_for_resource", "preparing", "pending", "running", "success", "failed", "canceled", "skipped", "manual", "scheduled", "error"}
+	statusesList                 = [...]string{"created", "waiting_for_resource", "preparing", "pending", "running", "success", "failed", "canceled", "skipped", "manual", "scheduled", "error", "success_with_warnings"}
 )
 
 // NewInternalCollectorCurrentlyQueuedTasksCount returns a new collector for the gcpe_currently_queued_tasks_count metric.

pkg/controller/jobs.go

@@ -173,13 +173,18 @@ func (c *Controller) ProcessJobMetrics(ctx context.Context, ref schemas.Ref, job
 		Value:  job.ArtifactSize,
 	})
 
+	jobStatus := job.Status
+	if jobStatus == "failed" && job.AllowFailure {
+		jobStatus = "success_with_warnings"
+	}
+
 	emitStatusMetric(
 		ctx,
 		c.Store,
 		schemas.MetricKindJobStatus,
 		labels,
 		statusesList[:],
-		job.Status,
+		jobStatus,
 		ref.Project.OutputSparseStatusMetrics,
 	)
 }

pkg/controller/jobs_test.go

@@ -80,6 +80,7 @@ func TestProcessJobMetrics(t *testing.T) {
 		Stage:           "🚀",
 		TagList:         "",
 		ArtifactSize:    150,
+		AllowFailure:    true,
 		Runner: schemas.Runner{
 			Description: "foo-123-bar",
 		},
@@ -163,7 +164,7 @@ func TestProcessJobMetrics(t *testing.T) {
 	}
 	assert.Equal(t, artifactSize, metrics[artifactSize.Key()])
 
-	labels["status"] = newJob.Status
+	labels["status"] = "success_with_warnings"
 	status := schemas.Metric{
 		Kind:   schemas.MetricKindJobStatus,
 		Labels: labels,

pkg/schemas/jobs.go

@@ -17,6 +17,7 @@ type Job struct {
 	Status                string
 	TagList               string
 	ArtifactSize          float64
+	AllowFailure          bool
 	FailureReason         string
 	Runner                Runner
 }
@@ -54,6 +55,7 @@ func NewJob(gj goGitlab.Job) Job {
 		Status:                gj.Status,
 		TagList:               strings.Join(gj.TagList, ","),
 		ArtifactSize:          artifactSize,
+		AllowFailure:          gj.AllowFailure,
 		FailureReason:         gj.FailureReason,
 
 		Runner: Runner{

pkg/schemas/jobs_test.go

@@ -19,6 +19,7 @@ func TestNewJob(t *testing.T) {
 		StartedAt:      &startedAt,
 		Duration:       15,
 		QueuedDuration: 10,
+		AllowFailure:   true,
 		Status:         "failed",
 		Stage:          "🚀",
 		TagList:        []string{"test-tag"},
@@ -56,6 +57,7 @@ func TestNewJob(t *testing.T) {
 		Status:                "failed",
 		TagList:               "test-tag",
 		ArtifactSize:          150,
+		AllowFailure:          true,
 
 		Runner: Runner{
 			Description: "xxx",

pkg/schemas/pipelines.go

@@ -3,6 +3,7 @@ package schemas
 import (
 	"context"
 	"strconv"
+	"strings"
 
 	log "github.com/sirupsen/logrus"
 	goGitlab "gitlab.com/gitlab-org/api/client-go"
@@ -83,7 +84,7 @@ func NewPipeline(ctx context.Context, gp goGitlab.Pipeline) Pipeline {
 	}
 
 	if gp.DetailedStatus != nil {
-		pipeline.Status = gp.DetailedStatus.Group
+		pipeline.Status = strings.ReplaceAll(gp.DetailedStatus.Group, "-", "_")
 	} else {
 		pipeline.Status = gp.Status
 	}

pkg/schemas/pipelines_test.go

@@ -53,7 +53,7 @@ func TestNewPipeline(t *testing.T) {
 				Label: "passed with warnings",
 				Group: "success-with-warnings",
 			},
-			"success-with-warnings",
+			"success_with_warnings",
 		},
 	}