mirror of
https://github.com/go-gitea/gitea.git
synced 2025-12-26 06:55:20 +01:00
99 lines
3.1 KiB
Go
99 lines
3.1 KiB
Go
// 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
|
|
}
|