Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Parse Gitlab Status fields to align w/Github Status and Conclusion #3706

Merged
merged 5 commits into from
Dec 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions clients/gitlabrepo/checkruns.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,42 @@ func checkRunsFrom(data []*gitlab.PipelineInfo) []clients.CheckRun {
for _, pipelineInfo := range data {
// TODO: Can get more info from GitLab API here (e.g. pipeline name, URL)
// https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report
checkRuns = append(checkRuns, clients.CheckRun{
Status: pipelineInfo.Status,
URL: pipelineInfo.WebURL,
})
checkRuns = append(checkRuns, parseGitlabStatus(pipelineInfo))
}
return checkRuns
}

// Conclusion does not exist in the pipelines for gitlab,
// so we parse the status to determine the conclusion if it exists.
func parseGitlabStatus(info *gitlab.PipelineInfo) clients.CheckRun {
checkrun := clients.CheckRun{
URL: info.WebURL,
}
const completed = "completed"

switch info.Status {
case "created", "waiting_for_resource", "preparing", "pending", "scheduled":
checkrun.Status = "queued"
case "running":
checkrun.Status = "in_progress"
case "failed":
checkrun.Status = completed
checkrun.Conclusion = "failure"
case "success":
checkrun.Status = completed
checkrun.Conclusion = "success"
case "canceled":
checkrun.Status = completed
checkrun.Conclusion = "cancelled"
case "skipped":
checkrun.Status = completed
checkrun.Conclusion = "skipped"
case "manual":
checkrun.Status = completed
checkrun.Conclusion = "action_required"
spencerschrock marked this conversation as resolved.
Show resolved Hide resolved
default:
checkrun.Status = info.Status
}

return checkrun
}
124 changes: 123 additions & 1 deletion clients/gitlabrepo/checkruns_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func Test_CheckRuns(t *testing.T) {
responsePath: "./testdata/valid-checkruns",
want: []clients.CheckRun{
{
Status: "pending",
Status: "queued",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
Expand Down Expand Up @@ -88,3 +88,125 @@ func Test_CheckRuns(t *testing.T) {
})
}
}

func TestParseGitlabStatus(t *testing.T) {
t.Parallel()
tests := []struct {
status string
want clients.CheckRun
}{
{
status: "created",
want: clients.CheckRun{
Status: "queued",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
{
status: "waiting_for_resource",
want: clients.CheckRun{
Status: "queued",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
{
status: "preparing",
want: clients.CheckRun{
Status: "queued",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
{
status: "pending",
want: clients.CheckRun{
Status: "queued",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
{
status: "scheduled",
want: clients.CheckRun{
Status: "queued",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
{
status: "running",
want: clients.CheckRun{
Status: "in_progress",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
{
status: "failed",
want: clients.CheckRun{
Status: "completed",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "failure",
},
},
{
status: "success",
want: clients.CheckRun{
Status: "completed",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "success",
},
},
{
status: "canceled",
want: clients.CheckRun{
Status: "completed",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "cancelled",
},
},
{
status: "skipped",
want: clients.CheckRun{
Status: "completed",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "skipped",
},
},
{
status: "manual",
want: clients.CheckRun{
Status: "completed",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "action_required",
},
},
{
status: "invalid_status",
want: clients.CheckRun{
Status: "invalid_status",
URL: "https://example.com/foo/bar/pipelines/48",
Conclusion: "",
},
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.status, func(t *testing.T) {
t.Parallel()

info := gitlab.PipelineInfo{
WebURL: "https://example.com/foo/bar/pipelines/48",
Status: tt.status,
}

got := parseGitlabStatus(&info)

if !cmp.Equal(got, tt.want) {
t.Errorf("parseGitlabStatus() = %v, want %v", got, cmp.Diff(got, tt.want))
}
})
}
}
Loading