Introduce combined status

modules/commitstatus/combined_status.go

@@ -0,0 +1,35 @@
+// Copyright 2025 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package commitstatus
+
+// CombinedStatus represents the combined status of a commit.
+type CombinedStatus string
+
+const (
+	// CombinedStatusPending is for when the CombinedStatus is Pending
+	CombinedStatusPending CombinedStatus = "pending"
+	// CombinedStatusSuccess is for when the CombinedStatus is Success
+	CombinedStatusSuccess CombinedStatus = "success"
+	// CombinedStatusFailure is for when the CombinedStatus is Failure
+	CombinedStatusFailure CombinedStatus = "failure"
+)
+
+func (cs CombinedStatus) String() string {
+	return string(cs)
+}
+
+// IsPending represents if commit status state is pending
+func (cs CombinedStatus) IsPending() bool {
+	return cs == CombinedStatusPending
+}
+
+// IsSuccess represents if commit status state is success
+func (cs CombinedStatus) IsSuccess() bool {
+	return cs == CombinedStatusSuccess
+}
+
+// IsFailure represents if commit status state is failure
+func (cs CombinedStatus) IsFailure() bool {
+	return cs == CombinedStatusFailure
+}

modules/commitstatus/commit_status.go

@@ -0,0 +1,98 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package commitstatus
+
+// CommitStatusState holds the state of a CommitStatus
+// It can be "pending", "success", "error" and "failure"
+type CommitStatusState string //nolint
+
+const (
+	// CommitStatusPending is for when the CommitStatus is Pending
+	CommitStatusPending CommitStatusState = "pending"
+	// CommitStatusSuccess is for when the CommitStatus is Success
+	CommitStatusSuccess CommitStatusState = "success"
+	// CommitStatusError is for when the CommitStatus is Error
+	CommitStatusError CommitStatusState = "error"
+	// CommitStatusFailure is for when the CommitStatus is Failure
+	CommitStatusFailure CommitStatusState = "failure"
+	// CommitStatusWarning is for when the CommitStatus is Warning
+	CommitStatusWarning CommitStatusState = "warning"
+)
+
+var commitStatusPriorities = map[CommitStatusState]int{
+	CommitStatusError:   0,
+	CommitStatusFailure: 1,
+	CommitStatusWarning: 2,
+	CommitStatusPending: 3,
+	CommitStatusSuccess: 4,
+}
+
+func (css CommitStatusState) String() string {
+	return string(css)
+}
+
+// NoBetterThan returns true if this State is no better than the given State
+// This function only handles the states defined in CommitStatusPriorities
+func (css CommitStatusState) NoBetterThan(css2 CommitStatusState) bool {
+	// NoBetterThan only handles the 5 states above
+	if _, exist := commitStatusPriorities[css]; !exist {
+		return false
+	}
+
+	if _, exist := commitStatusPriorities[css2]; !exist {
+		return false
+	}
+
+	return commitStatusPriorities[css] <= commitStatusPriorities[css2]
+}
+
+// IsPending represents if commit status state is pending
+func (css CommitStatusState) IsPending() bool {
+	return css == CommitStatusPending
+}
+
+// IsSuccess represents if commit status state is success
+func (css CommitStatusState) IsSuccess() bool {
+	return css == CommitStatusSuccess
+}
+
+// IsError represents if commit status state is error
+func (css CommitStatusState) IsError() bool {
+	return css == CommitStatusError
+}
+
+// IsFailure represents if commit status state is failure
+func (css CommitStatusState) IsFailure() bool {
+	return css == CommitStatusFailure
+}
+
+// IsWarning represents if commit status state is warning
+func (css CommitStatusState) IsWarning() bool {
+	return css == CommitStatusWarning
+}
+
+type CommitStatusStates []CommitStatusState //nolint
+
+// According to https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#get-the-combined-status-for-a-specific-reference
+// > Additionally, a combined state is returned. The state is one of:
+// > failure if any of the contexts report as error or failure
+// > pending if there are no statuses or a context is pending
+// > success if the latest status for all contexts is success
+
+func (css CommitStatusStates) Merge() CombinedStatus {
+	successCnt := 0
+	for _, state := range css {
+		switch {
+		case state.IsError() || state.IsFailure():
+			return CombinedStatusFailure
+		case state.IsPending():
+		case state.IsSuccess() || state.IsWarning():
+			successCnt++
+		}
+	}
+	if successCnt > 0 && successCnt == len(css) {
+		return CombinedStatusSuccess
+	}
+	return CombinedStatusPending
+}

modules/commitstatus/commit_status_test.go

@@ -0,0 +1,174 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package commitstatus
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNoBetterThan(t *testing.T) {
+	type args struct {
+		css  CommitStatusState
+		css2 CommitStatusState
+	}
+	var unExpectedState CommitStatusState
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{
+			name: "success is no better than success",
+			args: args{
+				css:  CommitStatusSuccess,
+				css2: CommitStatusSuccess,
+			},
+			want: true,
+		},
+		{
+			name: "success is no better than pending",
+			args: args{
+				css:  CommitStatusSuccess,
+				css2: CommitStatusPending,
+			},
+			want: false,
+		},
+		{
+			name: "success is no better than failure",
+			args: args{
+				css:  CommitStatusSuccess,
+				css2: CommitStatusFailure,
+			},
+			want: false,
+		},
+		{
+			name: "success is no better than error",
+			args: args{
+				css:  CommitStatusSuccess,
+				css2: CommitStatusError,
+			},
+			want: false,
+		},
+		{
+			name: "pending is no better than success",
+			args: args{
+				css:  CommitStatusPending,
+				css2: CommitStatusSuccess,
+			},
+			want: true,
+		},
+		{
+			name: "pending is no better than pending",
+			args: args{
+				css:  CommitStatusPending,
+				css2: CommitStatusPending,
+			},
+			want: true,
+		},
+		{
+			name: "pending is no better than failure",
+			args: args{
+				css:  CommitStatusPending,
+				css2: CommitStatusFailure,
+			},
+			want: false,
+		},
+		{
+			name: "pending is no better than error",
+			args: args{
+				css:  CommitStatusPending,
+				css2: CommitStatusError,
+			},
+			want: false,
+		},
+		{
+			name: "failure is no better than success",
+			args: args{
+				css:  CommitStatusFailure,
+				css2: CommitStatusSuccess,
+			},
+			want: true,
+		},
+		{
+			name: "failure is no better than pending",
+			args: args{
+				css:  CommitStatusFailure,
+				css2: CommitStatusPending,
+			},
+			want: true,
+		},
+		{
+			name: "failure is no better than failure",
+			args: args{
+				css:  CommitStatusFailure,
+				css2: CommitStatusFailure,
+			},
+			want: true,
+		},
+		{
+			name: "failure is no better than error",
+			args: args{
+				css:  CommitStatusFailure,
+				css2: CommitStatusError,
+			},
+			want: false,
+		},
+		{
+			name: "error is no better than success",
+			args: args{
+				css:  CommitStatusError,
+				css2: CommitStatusSuccess,
+			},
+			want: true,
+		},
+		{
+			name: "error is no better than pending",
+			args: args{
+				css:  CommitStatusError,
+				css2: CommitStatusPending,
+			},
+			want: true,
+		},
+		{
+			name: "error is no better than failure",
+			args: args{
+				css:  CommitStatusError,
+				css2: CommitStatusFailure,
+			},
+			want: true,
+		},
+		{
+			name: "error is no better than error",
+			args: args{
+				css:  CommitStatusError,
+				css2: CommitStatusError,
+			},
+			want: true,
+		},
+		{
+			name: "unExpectedState is no better than success",
+			args: args{
+				css:  unExpectedState,
+				css2: CommitStatusSuccess,
+			},
+			want: false,
+		},
+		{
+			name: "unExpectedState is no better than unExpectedState",
+			args: args{
+				css:  unExpectedState,
+				css2: unExpectedState,
+			},
+			want: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := tt.args.css.NoBetterThan(tt.args.css2)
+			assert.Equal(t, tt.want, result)
+		})
+	}
+}