drone/internal/api/usererror/usererror.go

89 lines
3.5 KiB
Go

// Copyright 2022 Harness Inc. All rights reserved.
// Use of this source code is governed by the Polyform Free Trial License
// that can be found in the LICENSE.md file for this repository.
package usererror
import "net/http"
var (
// ErrInternal is returned when an internal error occurred.
ErrInternal = New(http.StatusInternalServerError, "Internal error occured")
// ErrInvalidToken is returned when the api request token is invalid.
ErrInvalidToken = New(http.StatusUnauthorized, "Invalid or missing token")
// ErrBadRequest is returned when there was an issue with the input.
ErrBadRequest = New(http.StatusBadRequest, "Bad Request")
// ErrUnauthorized is returned when the acting principal is not authenticated.
ErrUnauthorized = New(http.StatusUnauthorized, "Unauthorized")
// ErrForbidden is returned when the acting principal is not authorized.
ErrForbidden = New(http.StatusForbidden, "Forbidden")
// ErrNotFound is returned when a resource is not found.
ErrNotFound = New(http.StatusNotFound, "Not Found")
// ErrNoChange is returned when no change was found based on the request.
ErrNoChange = New(http.StatusBadRequest, "No Change")
// ErrDuplicate is returned when a resource already exits.
ErrDuplicate = New(http.StatusConflict, "Resource already exists")
// ErrPrimaryPathCantBeDeleted is returned when trying to delete a primary path.
ErrPrimaryPathCantBeDeleted = New(http.StatusBadRequest, "The primary path of an object can't be deleted")
// ErrPathTooLong is returned when an action would lead to a path that is too long.
ErrPathTooLong = New(http.StatusBadRequest, "The resource path is too long")
// ErrCyclicHierarchy is returned if the action would create a cyclic dependency between spaces.
ErrCyclicHierarchy = New(http.StatusBadRequest, "Unable to perform the action as it would lead to a cyclic dependency")
// ErrSpaceWithChildsCantBeDeleted is returned if the principal is trying to delete a space that
// still has child resources.
ErrSpaceWithChildsCantBeDeleted = New(http.StatusBadRequest,
"Space can't be deleted as it still contains child resources")
// ErrDefaultBranchCantBeDeleted is returned if the user tries to delete the default branch of a repository.
ErrDefaultBranchCantBeDeleted = New(http.StatusBadRequest, "The default branch of a repository can't be deleted")
// ErrRequestTooLarge is returned if the request it too large.
ErrRequestTooLarge = New(http.StatusRequestEntityTooLarge, "The request is too large")
// ErrWebhookNotRetriggerable is returned if the webhook can't be retriggered.
ErrWebhookNotRetriggerable = New(http.StatusMethodNotAllowed,
"The webhook execution is incomplete and can't be retriggered")
)
// Error represents a json-encoded API error.
type Error struct {
Status int `json:"-"`
Message string `json:"message"`
Values map[string]any `json:"values,omitempty"`
}
func (e *Error) Error() string {
return e.Message
}
// New returns a new error message.
func New(status int, message string, valueMaps ...map[string]any) *Error {
var values map[string]any
for _, valueMap := range valueMaps {
if values == nil {
values = valueMap
continue
}
for k, v := range valueMap {
values[k] = v
}
}
return &Error{Status: status, Message: message, Values: values}
}
// BadRequest gives an error that will be returned as HTTP status=400 with the provided message.
func BadRequest(message string, values ...map[string]any) *Error {
return New(http.StatusBadRequest, message, values...)
}