mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-27 13:37:30 +00:00
Naming of Reason constants is inconsistent
Changed ReasonType to StatusReason (to match the field) and changed CauseReason to CauseType and renamed StatusCause.Reason to Type.
This commit is contained in:
parent
52923a1348
commit
0a841a49fd
@ -25,7 +25,7 @@ import (
|
|||||||
|
|
||||||
// ValidationErrorType is a machine readable value providing more detail about why
|
// ValidationErrorType is a machine readable value providing more detail about why
|
||||||
// a field is invalid. These values are expected to match 1-1 with
|
// a field is invalid. These values are expected to match 1-1 with
|
||||||
// CauseReasonType in api/types.go.
|
// CauseType in api/types.go.
|
||||||
type ValidationErrorType string
|
type ValidationErrorType string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
@ -368,7 +368,7 @@ type Status struct {
|
|||||||
// "failure" or "working" status. If this value is empty there
|
// "failure" or "working" status. If this value is empty there
|
||||||
// is no information available. A Reason clarifies an HTTP status
|
// is no information available. A Reason clarifies an HTTP status
|
||||||
// code but does not override it.
|
// code but does not override it.
|
||||||
Reason ReasonType `json:"reason,omitempty" yaml:"reason,omitempty"`
|
Reason StatusReason `json:"reason,omitempty" yaml:"reason,omitempty"`
|
||||||
// Extended data associated with the reason. Each reason may define its
|
// Extended data associated with the reason. Each reason may define its
|
||||||
// own extended details. This field is optional and the data returned
|
// own extended details. This field is optional and the data returned
|
||||||
// is not guaranteed to conform to any schema except that defined by
|
// is not guaranteed to conform to any schema except that defined by
|
||||||
@ -385,14 +385,14 @@ type Status struct {
|
|||||||
// and should assume that any attribute may be empty, invalid, or under
|
// and should assume that any attribute may be empty, invalid, or under
|
||||||
// defined.
|
// defined.
|
||||||
type StatusDetails struct {
|
type StatusDetails struct {
|
||||||
// The ID attribute of the resource associated with the status ReasonType
|
// The ID attribute of the resource associated with the status StatusReason
|
||||||
// (when there is a single ID which can be described).
|
// (when there is a single ID which can be described).
|
||||||
ID string `json:"id,omitempty" yaml:"id,omitempty"`
|
ID string `json:"id,omitempty" yaml:"id,omitempty"`
|
||||||
// The kind attribute of the resource associated with the status ReasonType.
|
// The kind attribute of the resource associated with the status StatusReason.
|
||||||
// On some operations may differ from the requested resource Kind.
|
// On some operations may differ from the requested resource Kind.
|
||||||
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
|
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
|
||||||
// The Causes array includes more details associated with the ReasonType
|
// The Causes array includes more details associated with the StatusReason
|
||||||
// failure. Not all ReasonTypes may provide detailed causes.
|
// failure. Not all StatusReasons may provide detailed causes.
|
||||||
Causes []StatusCause `json:"causes,omitempty" yaml:"causes,omitempty"`
|
Causes []StatusCause `json:"causes,omitempty" yaml:"causes,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -403,19 +403,19 @@ const (
|
|||||||
StatusWorking = "working"
|
StatusWorking = "working"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ReasonType is an enumeration of possible failure causes. Each ReasonType
|
// StatusReason is an enumeration of possible failure causes. Each StatusReason
|
||||||
// must map to a single HTTP status code, but multiple reasons may map
|
// must map to a single HTTP status code, but multiple reasons may map
|
||||||
// to the same HTTP status code.
|
// to the same HTTP status code.
|
||||||
// TODO: move to apiserver
|
// TODO: move to apiserver
|
||||||
type ReasonType string
|
type StatusReason string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// ReasonTypeUnknown means the server has declined to indicate a specific reason.
|
// StatusReasonUnknown means the server has declined to indicate a specific reason.
|
||||||
// The details field may contain other information about this error.
|
// The details field may contain other information about this error.
|
||||||
// Status code 500.
|
// Status code 500.
|
||||||
ReasonTypeUnknown ReasonType = ""
|
StatusReasonUnknown StatusReason = ""
|
||||||
|
|
||||||
// ReasonTypeWorking means the server is processing this request and will complete
|
// StatusReasonWorking means the server is processing this request and will complete
|
||||||
// at a future time.
|
// at a future time.
|
||||||
// Details (optional):
|
// Details (optional):
|
||||||
// "kind" string - the name of the resource being referenced ("operation" today)
|
// "kind" string - the name of the resource being referenced ("operation" today)
|
||||||
@ -425,7 +425,7 @@ const (
|
|||||||
// "Location" - HTTP header populated with a URL that can retrieved the final
|
// "Location" - HTTP header populated with a URL that can retrieved the final
|
||||||
// status of this operation.
|
// status of this operation.
|
||||||
// Status code 202
|
// Status code 202
|
||||||
ReasonTypeWorking ReasonType = "working"
|
StatusReasonWorking StatusReason = "working"
|
||||||
|
|
||||||
// ResourceTypeNotFound means one or more resources required for this operation
|
// ResourceTypeNotFound means one or more resources required for this operation
|
||||||
// could not be found.
|
// could not be found.
|
||||||
@ -435,21 +435,21 @@ const (
|
|||||||
// resource.
|
// resource.
|
||||||
// "id" string - the identifier of the missing resource
|
// "id" string - the identifier of the missing resource
|
||||||
// Status code 404
|
// Status code 404
|
||||||
ReasonTypeNotFound ReasonType = "not_found"
|
StatusReasonNotFound StatusReason = "not_found"
|
||||||
|
|
||||||
// ReasonTypeAlreadyExists means the resource you are creating already exists.
|
// StatusReasonAlreadyExists means the resource you are creating already exists.
|
||||||
// Details (optional):
|
// Details (optional):
|
||||||
// "kind" string - the kind attribute of the conflicting resource
|
// "kind" string - the kind attribute of the conflicting resource
|
||||||
// "id" string - the identifier of the conflicting resource
|
// "id" string - the identifier of the conflicting resource
|
||||||
// Status code 409
|
// Status code 409
|
||||||
ReasonTypeAlreadyExists ReasonType = "already_exists"
|
StatusReasonAlreadyExists StatusReason = "already_exists"
|
||||||
|
|
||||||
// ResourceTypeConflict means the requested update operation cannot be completed
|
// ResourceTypeConflict means the requested update operation cannot be completed
|
||||||
// due to a conflict in the operation. The client may need to alter the request.
|
// due to a conflict in the operation. The client may need to alter the request.
|
||||||
// Each resource may define custom details that indicate the nature of the
|
// Each resource may define custom details that indicate the nature of the
|
||||||
// conflict.
|
// conflict.
|
||||||
// Status code 409
|
// Status code 409
|
||||||
ReasonTypeConflict ReasonType = "conflict"
|
StatusReasonConflict StatusReason = "conflict"
|
||||||
|
|
||||||
// ResourceTypeInvalid means the requested create or update operation cannot be
|
// ResourceTypeInvalid means the requested create or update operation cannot be
|
||||||
// completed due to invalid data provided as part of the request. The client may
|
// completed due to invalid data provided as part of the request. The client may
|
||||||
@ -462,7 +462,7 @@ const (
|
|||||||
// provided resource that was invalid. The code, message, and
|
// provided resource that was invalid. The code, message, and
|
||||||
// field attributes will be set.
|
// field attributes will be set.
|
||||||
// Status code 422
|
// Status code 422
|
||||||
ReasonTypeInvalid ReasonType = "invalid"
|
StatusReasonInvalid StatusReason = "invalid"
|
||||||
)
|
)
|
||||||
|
|
||||||
// StatusCause provides more information about an api.Status failure, including
|
// StatusCause provides more information about an api.Status failure, including
|
||||||
@ -470,7 +470,7 @@ const (
|
|||||||
type StatusCause struct {
|
type StatusCause struct {
|
||||||
// A machine-readable description of the cause of the error. If this value is
|
// A machine-readable description of the cause of the error. If this value is
|
||||||
// empty there is no information available.
|
// empty there is no information available.
|
||||||
Reason CauseReasonType `json:"reason,omitempty" yaml:"reason,omitempty"`
|
Type CauseType `json:"reason,omitempty" yaml:"reason,omitempty"`
|
||||||
// A human-readable description of the cause of the error. This field may be
|
// A human-readable description of the cause of the error. This field may be
|
||||||
// presented as-is to a reader.
|
// presented as-is to a reader.
|
||||||
Message string `json:"message,omitempty" yaml:"message,omitempty"`
|
Message string `json:"message,omitempty" yaml:"message,omitempty"`
|
||||||
@ -486,26 +486,27 @@ type StatusCause struct {
|
|||||||
Field string `json:"field,omitempty" yaml:"field,omitempty"`
|
Field string `json:"field,omitempty" yaml:"field,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// CauseReasonType is a machine readable value providing more detail about why
|
// CauseType is a machine readable value providing more detail about what
|
||||||
// an operation failed. An operation may have multiple causes for a failure.
|
// occured in a status response. An operation may have multiple causes for a
|
||||||
type CauseReasonType string
|
// status (whether failure, success, or working).
|
||||||
|
type CauseType string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// CauseReasonTypeFieldValueNotFound is used to report failure to find a requested value
|
// CauseTypeFieldValueNotFound is used to report failure to find a requested value
|
||||||
// (e.g. looking up an ID).
|
// (e.g. looking up an ID).
|
||||||
CauseReasonTypeFieldValueNotFound CauseReasonType = "fieldValueNotFound"
|
CauseTypeFieldValueNotFound CauseType = "fieldValueNotFound"
|
||||||
// CauseReasonTypeFieldValueInvalid is used to report required values that are not
|
// CauseTypeFieldValueInvalid is used to report required values that are not
|
||||||
// provided (e.g. empty strings, null values, or empty arrays).
|
// provided (e.g. empty strings, null values, or empty arrays).
|
||||||
CauseReasonTypeFieldValueRequired CauseReasonType = "fieldValueRequired"
|
CauseTypeFieldValueRequired CauseType = "fieldValueRequired"
|
||||||
// CauseReasonTypeFieldValueDuplicate is used to report collisions of values that must be
|
// CauseTypeFieldValueDuplicate is used to report collisions of values that must be
|
||||||
// unique (e.g. unique IDs).
|
// unique (e.g. unique IDs).
|
||||||
CauseReasonTypeFieldValueDuplicate CauseReasonType = "fieldValueDuplicate"
|
CauseTypeFieldValueDuplicate CauseType = "fieldValueDuplicate"
|
||||||
// CauseReasonTypeFieldValueInvalid is used to report malformed values (e.g. failed regex
|
// CauseTypeFieldValueInvalid is used to report malformed values (e.g. failed regex
|
||||||
// match).
|
// match).
|
||||||
CauseReasonTypeFieldValueInvalid CauseReasonType = "fieldValueInvalid"
|
CauseTypeFieldValueInvalid CauseType = "fieldValueInvalid"
|
||||||
// CauseReasonTypeFieldValueNotSupported is used to report valid (as per formatting rules)
|
// CauseTypeFieldValueNotSupported is used to report valid (as per formatting rules)
|
||||||
// values that can not be handled (e.g. an enumerated string).
|
// values that can not be handled (e.g. an enumerated string).
|
||||||
CauseReasonTypeFieldValueNotSupported CauseReasonType = "fieldValueNotSupported"
|
CauseTypeFieldValueNotSupported CauseType = "fieldValueNotSupported"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ServerOp is an operation delivered to API clients.
|
// ServerOp is an operation delivered to API clients.
|
||||||
|
@ -372,7 +372,7 @@ type Status struct {
|
|||||||
// "failure" or "working" status. If this value is empty there
|
// "failure" or "working" status. If this value is empty there
|
||||||
// is no information available. A Reason clarifies an HTTP status
|
// is no information available. A Reason clarifies an HTTP status
|
||||||
// code but does not override it.
|
// code but does not override it.
|
||||||
Reason ReasonType `json:"reason,omitempty" yaml:"reason,omitempty"`
|
Reason StatusReason `json:"reason,omitempty" yaml:"reason,omitempty"`
|
||||||
// Extended data associated with the reason. Each reason may define its
|
// Extended data associated with the reason. Each reason may define its
|
||||||
// own extended details. This field is optional and the data returned
|
// own extended details. This field is optional and the data returned
|
||||||
// is not guaranteed to conform to any schema except that defined by
|
// is not guaranteed to conform to any schema except that defined by
|
||||||
@ -389,14 +389,14 @@ type Status struct {
|
|||||||
// and should assume that any attribute may be empty, invalid, or under
|
// and should assume that any attribute may be empty, invalid, or under
|
||||||
// defined.
|
// defined.
|
||||||
type StatusDetails struct {
|
type StatusDetails struct {
|
||||||
// The ID attribute of the resource associated with the status ReasonType
|
// The ID attribute of the resource associated with the status StatusReason
|
||||||
// (when there is a single ID which can be described).
|
// (when there is a single ID which can be described).
|
||||||
ID string `json:"id,omitempty" yaml:"id,omitempty"`
|
ID string `json:"id,omitempty" yaml:"id,omitempty"`
|
||||||
// The kind attribute of the resource associated with the status ReasonType.
|
// The kind attribute of the resource associated with the status StatusReason.
|
||||||
// On some operations may differ from the requested resource Kind.
|
// On some operations may differ from the requested resource Kind.
|
||||||
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
|
Kind string `json:"kind,omitempty" yaml:"kind,omitempty"`
|
||||||
// The Causes array includes more details associated with the ReasonType
|
// The Causes array includes more details associated with the StatusReason
|
||||||
// failure. Not all ReasonTypes may provide detailed causes.
|
// failure. Not all StatusReasons may provide detailed causes.
|
||||||
Causes []StatusCause `json:"causes,omitempty" yaml:"causes,omitempty"`
|
Causes []StatusCause `json:"causes,omitempty" yaml:"causes,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -407,19 +407,19 @@ const (
|
|||||||
StatusWorking = "working"
|
StatusWorking = "working"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ReasonType is an enumeration of possible failure causes. Each ReasonType
|
// StatusReason is an enumeration of possible failure causes. Each StatusReason
|
||||||
// must map to a single HTTP status code, but multiple reasons may map
|
// must map to a single HTTP status code, but multiple reasons may map
|
||||||
// to the same HTTP status code.
|
// to the same HTTP status code.
|
||||||
// TODO: move to apiserver
|
// TODO: move to apiserver
|
||||||
type ReasonType string
|
type StatusReason string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// ReasonTypeUnknown means the server has declined to indicate a specific reason.
|
// StatusReasonUnknown means the server has declined to indicate a specific reason.
|
||||||
// The details field may contain other information about this error.
|
// The details field may contain other information about this error.
|
||||||
// Status code 500.
|
// Status code 500.
|
||||||
ReasonTypeUnknown ReasonType = ""
|
StatusReasonUnknown StatusReason = ""
|
||||||
|
|
||||||
// ReasonTypeWorking means the server is processing this request and will complete
|
// StatusReasonWorking means the server is processing this request and will complete
|
||||||
// at a future time.
|
// at a future time.
|
||||||
// Details (optional):
|
// Details (optional):
|
||||||
// "kind" string - the name of the resource being referenced ("operation" today)
|
// "kind" string - the name of the resource being referenced ("operation" today)
|
||||||
@ -429,7 +429,7 @@ const (
|
|||||||
// "Location" - HTTP header populated with a URL that can retrieved the final
|
// "Location" - HTTP header populated with a URL that can retrieved the final
|
||||||
// status of this operation.
|
// status of this operation.
|
||||||
// Status code 202
|
// Status code 202
|
||||||
ReasonTypeWorking ReasonType = "working"
|
StatusReasonWorking StatusReason = "working"
|
||||||
|
|
||||||
// ResourceTypeNotFound means one or more resources required for this operation
|
// ResourceTypeNotFound means one or more resources required for this operation
|
||||||
// could not be found.
|
// could not be found.
|
||||||
@ -439,21 +439,21 @@ const (
|
|||||||
// resource.
|
// resource.
|
||||||
// "id" string - the identifier of the missing resource
|
// "id" string - the identifier of the missing resource
|
||||||
// Status code 404
|
// Status code 404
|
||||||
ReasonTypeNotFound ReasonType = "notFound"
|
StatusReasonNotFound StatusReason = "notFound"
|
||||||
|
|
||||||
// ReasonTypeAlreadyExists means the resource you are creating already exists.
|
// StatusReasonAlreadyExists means the resource you are creating already exists.
|
||||||
// Details (optional):
|
// Details (optional):
|
||||||
// "kind" string - the kind attribute of the conflicting resource
|
// "kind" string - the kind attribute of the conflicting resource
|
||||||
// "id" string - the identifier of the conflicting resource
|
// "id" string - the identifier of the conflicting resource
|
||||||
// Status code 409
|
// Status code 409
|
||||||
ReasonTypeAlreadyExists ReasonType = "alreadyExists"
|
StatusReasonAlreadyExists StatusReason = "alreadyExists"
|
||||||
|
|
||||||
// ResourceTypeConflict means the requested update operation cannot be completed
|
// ResourceTypeConflict means the requested update operation cannot be completed
|
||||||
// due to a conflict in the operation. The client may need to alter the request.
|
// due to a conflict in the operation. The client may need to alter the request.
|
||||||
// Each resource may define custom details that indicate the nature of the
|
// Each resource may define custom details that indicate the nature of the
|
||||||
// conflict.
|
// conflict.
|
||||||
// Status code 409
|
// Status code 409
|
||||||
ReasonTypeConflict ReasonType = "conflict"
|
StatusReasonConflict StatusReason = "conflict"
|
||||||
)
|
)
|
||||||
|
|
||||||
// StatusCause provides more information about an api.Status failure, including
|
// StatusCause provides more information about an api.Status failure, including
|
||||||
@ -461,7 +461,7 @@ const (
|
|||||||
type StatusCause struct {
|
type StatusCause struct {
|
||||||
// A machine-readable description of the cause of the error. If this value is
|
// A machine-readable description of the cause of the error. If this value is
|
||||||
// empty there is no information available.
|
// empty there is no information available.
|
||||||
Reason CauseReasonType `json:"reason,omitempty" yaml:"reason,omitempty"`
|
Type CauseType `json:"reason,omitempty" yaml:"reason,omitempty"`
|
||||||
// A human-readable description of the cause of the error. This field may be
|
// A human-readable description of the cause of the error. This field may be
|
||||||
// presented as-is to a reader.
|
// presented as-is to a reader.
|
||||||
Message string `json:"message,omitempty" yaml:"message,omitempty"`
|
Message string `json:"message,omitempty" yaml:"message,omitempty"`
|
||||||
@ -477,26 +477,27 @@ type StatusCause struct {
|
|||||||
Field string `json:"field,omitempty" yaml:"field,omitempty"`
|
Field string `json:"field,omitempty" yaml:"field,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// CauseReasonType is a machine readable value providing more detail about why
|
// CauseType is a machine readable value providing more detail about what
|
||||||
// an operation failed. An operation may have multiple causes for a failure.
|
// occured in a status response. An operation may have multiple causes for a
|
||||||
type CauseReasonType string
|
// status (whether failure, success, or working).
|
||||||
|
type CauseType string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// CauseReasonTypeFieldValueNotFound is used to report failure to find a requested value
|
// CauseTypeFieldValueNotFound is used to report failure to find a requested value
|
||||||
// (e.g. looking up an ID).
|
// (e.g. looking up an ID).
|
||||||
CauseReasonTypeFieldValueNotFound CauseReasonType = "fieldValueNotFound"
|
CauseTypeFieldValueNotFound CauseType = "fieldValueNotFound"
|
||||||
// CauseReasonTypeFieldValueInvalid is used to report required values that are not
|
// CauseTypeFieldValueInvalid is used to report required values that are not
|
||||||
// provided (e.g. empty strings, null values, or empty arrays).
|
// provided (e.g. empty strings, null values, or empty arrays).
|
||||||
CauseReasonTypeFieldValueRequired CauseReasonType = "fieldValueRequired"
|
CauseTypeFieldValueRequired CauseType = "fieldValueRequired"
|
||||||
// CauseReasonTypeFieldValueDuplicate is used to report collisions of values that must be
|
// CauseTypeFieldValueDuplicate is used to report collisions of values that must be
|
||||||
// unique (e.g. unique IDs).
|
// unique (e.g. unique IDs).
|
||||||
CauseReasonTypeFieldValueDuplicate CauseReasonType = "fieldValueDuplicate"
|
CauseTypeFieldValueDuplicate CauseType = "fieldValueDuplicate"
|
||||||
// CauseReasonTypeFieldValueInvalid is used to report malformed values (e.g. failed regex
|
// CauseTypeFieldValueInvalid is used to report malformed values (e.g. failed regex
|
||||||
// match).
|
// match).
|
||||||
CauseReasonTypeFieldValueInvalid CauseReasonType = "fieldValueInvalid"
|
CauseTypeFieldValueInvalid CauseType = "fieldValueInvalid"
|
||||||
// CauseReasonTypeFieldValueNotSupported is used to report valid (as per formatting rules)
|
// CauseTypeFieldValueNotSupported is used to report valid (as per formatting rules)
|
||||||
// values that can not be handled (e.g. an enumerated string).
|
// values that can not be handled (e.g. an enumerated string).
|
||||||
CauseReasonTypeFieldValueNotSupported CauseReasonType = "fieldValueNotSupported"
|
CauseTypeFieldValueNotSupported CauseType = "fieldValueNotSupported"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ServerOp is an operation delivered to API clients.
|
// ServerOp is an operation delivered to API clients.
|
||||||
|
@ -626,7 +626,7 @@ func TestAsyncDelayReturnsError(t *testing.T) {
|
|||||||
server := httptest.NewServer(handler)
|
server := httptest.NewServer(handler)
|
||||||
|
|
||||||
status := expectApiStatus(t, "DELETE", fmt.Sprintf("%s/prefix/version/foo/bar", server.URL), nil, http.StatusConflict)
|
status := expectApiStatus(t, "DELETE", fmt.Sprintf("%s/prefix/version/foo/bar", server.URL), nil, http.StatusConflict)
|
||||||
if status.Status != api.StatusFailure || status.Message == "" || status.Details == nil || status.Reason != api.ReasonTypeAlreadyExists {
|
if status.Status != api.StatusFailure || status.Message == "" || status.Details == nil || status.Reason != api.StatusReasonAlreadyExists {
|
||||||
t.Errorf("Unexpected status %#v", status)
|
t.Errorf("Unexpected status %#v", status)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -687,7 +687,7 @@ func TestWriteJSONDecodeError(t *testing.T) {
|
|||||||
writeJSON(http.StatusOK, api.Codec, &T{"Undecodable"}, w)
|
writeJSON(http.StatusOK, api.Codec, &T{"Undecodable"}, w)
|
||||||
}))
|
}))
|
||||||
status := expectApiStatus(t, "GET", server.URL, nil, http.StatusInternalServerError)
|
status := expectApiStatus(t, "GET", server.URL, nil, http.StatusInternalServerError)
|
||||||
if status.Reason != api.ReasonTypeUnknown {
|
if status.Reason != api.StatusReasonUnknown {
|
||||||
t.Errorf("unexpected reason %#v", status)
|
t.Errorf("unexpected reason %#v", status)
|
||||||
}
|
}
|
||||||
if !strings.Contains(status.Message, "type apiserver.T is not registered") {
|
if !strings.Contains(status.Message, "type apiserver.T is not registered") {
|
||||||
|
@ -40,7 +40,7 @@ func NewNotFoundErr(kind, name string) error {
|
|||||||
return &apiServerError{api.Status{
|
return &apiServerError{api.Status{
|
||||||
Status: api.StatusFailure,
|
Status: api.StatusFailure,
|
||||||
Code: http.StatusNotFound,
|
Code: http.StatusNotFound,
|
||||||
Reason: api.ReasonTypeNotFound,
|
Reason: api.StatusReasonNotFound,
|
||||||
Details: &api.StatusDetails{
|
Details: &api.StatusDetails{
|
||||||
Kind: kind,
|
Kind: kind,
|
||||||
ID: name,
|
ID: name,
|
||||||
@ -54,7 +54,7 @@ func NewAlreadyExistsErr(kind, name string) error {
|
|||||||
return &apiServerError{api.Status{
|
return &apiServerError{api.Status{
|
||||||
Status: api.StatusFailure,
|
Status: api.StatusFailure,
|
||||||
Code: http.StatusConflict,
|
Code: http.StatusConflict,
|
||||||
Reason: api.ReasonTypeAlreadyExists,
|
Reason: api.StatusReasonAlreadyExists,
|
||||||
Details: &api.StatusDetails{
|
Details: &api.StatusDetails{
|
||||||
Kind: kind,
|
Kind: kind,
|
||||||
ID: name,
|
ID: name,
|
||||||
@ -68,7 +68,7 @@ func NewConflictErr(kind, name string, err error) error {
|
|||||||
return &apiServerError{api.Status{
|
return &apiServerError{api.Status{
|
||||||
Status: api.StatusFailure,
|
Status: api.StatusFailure,
|
||||||
Code: http.StatusConflict,
|
Code: http.StatusConflict,
|
||||||
Reason: api.ReasonTypeConflict,
|
Reason: api.StatusReasonConflict,
|
||||||
Details: &api.StatusDetails{
|
Details: &api.StatusDetails{
|
||||||
Kind: kind,
|
Kind: kind,
|
||||||
ID: name,
|
ID: name,
|
||||||
@ -83,7 +83,7 @@ func NewInvalidErr(kind, name string, errs errors.ErrorList) error {
|
|||||||
for i := range errs {
|
for i := range errs {
|
||||||
if err, ok := errs[i].(errors.ValidationError); ok {
|
if err, ok := errs[i].(errors.ValidationError); ok {
|
||||||
causes = append(causes, api.StatusCause{
|
causes = append(causes, api.StatusCause{
|
||||||
Reason: api.CauseReasonType(err.Type),
|
Type: api.CauseType(err.Type),
|
||||||
Message: err.Error(),
|
Message: err.Error(),
|
||||||
Field: err.Field,
|
Field: err.Field,
|
||||||
})
|
})
|
||||||
@ -92,7 +92,7 @@ func NewInvalidErr(kind, name string, errs errors.ErrorList) error {
|
|||||||
return &apiServerError{api.Status{
|
return &apiServerError{api.Status{
|
||||||
Status: api.StatusFailure,
|
Status: api.StatusFailure,
|
||||||
Code: 422, // RFC 4918
|
Code: 422, // RFC 4918
|
||||||
Reason: api.ReasonTypeInvalid,
|
Reason: api.StatusReasonInvalid,
|
||||||
Details: &api.StatusDetails{
|
Details: &api.StatusDetails{
|
||||||
Kind: kind,
|
Kind: kind,
|
||||||
ID: name,
|
ID: name,
|
||||||
@ -104,30 +104,30 @@ func NewInvalidErr(kind, name string, errs errors.ErrorList) error {
|
|||||||
|
|
||||||
// IsNotFound returns true if the specified error was created by NewNotFoundErr
|
// IsNotFound returns true if the specified error was created by NewNotFoundErr
|
||||||
func IsNotFound(err error) bool {
|
func IsNotFound(err error) bool {
|
||||||
return reasonForError(err) == api.ReasonTypeNotFound
|
return reasonForError(err) == api.StatusReasonNotFound
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsAlreadyExists determines if the err is an error which indicates that a specified resource already exists.
|
// IsAlreadyExists determines if the err is an error which indicates that a specified resource already exists.
|
||||||
func IsAlreadyExists(err error) bool {
|
func IsAlreadyExists(err error) bool {
|
||||||
return reasonForError(err) == api.ReasonTypeAlreadyExists
|
return reasonForError(err) == api.StatusReasonAlreadyExists
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsConflict determines if the err is an error which indicates the provided update conflicts
|
// IsConflict determines if the err is an error which indicates the provided update conflicts
|
||||||
func IsConflict(err error) bool {
|
func IsConflict(err error) bool {
|
||||||
return reasonForError(err) == api.ReasonTypeConflict
|
return reasonForError(err) == api.StatusReasonConflict
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsInvalid determines if the err is an error which indicates the provided resource is not valid
|
// IsInvalid determines if the err is an error which indicates the provided resource is not valid
|
||||||
func IsInvalid(err error) bool {
|
func IsInvalid(err error) bool {
|
||||||
return reasonForError(err) == api.ReasonTypeInvalid
|
return reasonForError(err) == api.StatusReasonInvalid
|
||||||
}
|
}
|
||||||
|
|
||||||
func reasonForError(err error) api.ReasonType {
|
func reasonForError(err error) api.StatusReason {
|
||||||
switch t := err.(type) {
|
switch t := err.(type) {
|
||||||
case *apiServerError:
|
case *apiServerError:
|
||||||
return t.Status.Reason
|
return t.Status.Reason
|
||||||
}
|
}
|
||||||
return api.ReasonTypeUnknown
|
return api.StatusReasonUnknown
|
||||||
}
|
}
|
||||||
|
|
||||||
// errToAPIStatus converts an error to an api.Status object.
|
// errToAPIStatus converts an error to an api.Status object.
|
||||||
@ -148,7 +148,7 @@ func errToAPIStatus(err error) *api.Status {
|
|||||||
return &api.Status{
|
return &api.Status{
|
||||||
Status: api.StatusFailure,
|
Status: api.StatusFailure,
|
||||||
Code: status,
|
Code: status,
|
||||||
Reason: api.ReasonTypeUnknown,
|
Reason: api.StatusReasonUnknown,
|
||||||
Message: err.Error(),
|
Message: err.Error(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -35,7 +35,7 @@ func TestErrorNew(t *testing.T) {
|
|||||||
t.Errorf("expected to not be confict")
|
t.Errorf("expected to not be confict")
|
||||||
}
|
}
|
||||||
if IsNotFound(err) {
|
if IsNotFound(err) {
|
||||||
t.Errorf(fmt.Sprintf("expected to not be %s", api.ReasonTypeNotFound))
|
t.Errorf(fmt.Sprintf("expected to not be %s", api.StatusReasonNotFound))
|
||||||
}
|
}
|
||||||
if IsInvalid(err) {
|
if IsInvalid(err) {
|
||||||
t.Errorf("expected to not be invalid")
|
t.Errorf("expected to not be invalid")
|
||||||
@ -63,7 +63,7 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
Kind: "kind",
|
Kind: "kind",
|
||||||
ID: "name",
|
ID: "name",
|
||||||
Causes: []api.StatusCause{{
|
Causes: []api.StatusCause{{
|
||||||
Reason: api.CauseReasonTypeFieldValueDuplicate,
|
Type: api.CauseTypeFieldValueDuplicate,
|
||||||
Field: "field[0].name",
|
Field: "field[0].name",
|
||||||
}},
|
}},
|
||||||
},
|
},
|
||||||
@ -74,7 +74,7 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
Kind: "kind",
|
Kind: "kind",
|
||||||
ID: "name",
|
ID: "name",
|
||||||
Causes: []api.StatusCause{{
|
Causes: []api.StatusCause{{
|
||||||
Reason: api.CauseReasonTypeFieldValueInvalid,
|
Type: api.CauseTypeFieldValueInvalid,
|
||||||
Field: "field[0].name",
|
Field: "field[0].name",
|
||||||
}},
|
}},
|
||||||
},
|
},
|
||||||
@ -85,7 +85,7 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
Kind: "kind",
|
Kind: "kind",
|
||||||
ID: "name",
|
ID: "name",
|
||||||
Causes: []api.StatusCause{{
|
Causes: []api.StatusCause{{
|
||||||
Reason: api.CauseReasonTypeFieldValueNotFound,
|
Type: api.CauseTypeFieldValueNotFound,
|
||||||
Field: "field[0].name",
|
Field: "field[0].name",
|
||||||
}},
|
}},
|
||||||
},
|
},
|
||||||
@ -96,7 +96,7 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
Kind: "kind",
|
Kind: "kind",
|
||||||
ID: "name",
|
ID: "name",
|
||||||
Causes: []api.StatusCause{{
|
Causes: []api.StatusCause{{
|
||||||
Reason: api.CauseReasonTypeFieldValueNotSupported,
|
Type: api.CauseTypeFieldValueNotSupported,
|
||||||
Field: "field[0].name",
|
Field: "field[0].name",
|
||||||
}},
|
}},
|
||||||
},
|
},
|
||||||
@ -107,7 +107,7 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
Kind: "kind",
|
Kind: "kind",
|
||||||
ID: "name",
|
ID: "name",
|
||||||
Causes: []api.StatusCause{{
|
Causes: []api.StatusCause{{
|
||||||
Reason: api.CauseReasonTypeFieldValueRequired,
|
Type: api.CauseTypeFieldValueRequired,
|
||||||
Field: "field[0].name",
|
Field: "field[0].name",
|
||||||
}},
|
}},
|
||||||
},
|
},
|
||||||
@ -118,7 +118,7 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
expected.Causes[0].Message = vErr.Error()
|
expected.Causes[0].Message = vErr.Error()
|
||||||
err := NewInvalidErr("kind", "name", apierrors.ErrorList{vErr})
|
err := NewInvalidErr("kind", "name", apierrors.ErrorList{vErr})
|
||||||
status := errToAPIStatus(err)
|
status := errToAPIStatus(err)
|
||||||
if status.Code != 422 || status.Reason != api.ReasonTypeInvalid {
|
if status.Code != 422 || status.Reason != api.StatusReasonInvalid {
|
||||||
t.Errorf("unexpected status: %#v", status)
|
t.Errorf("unexpected status: %#v", status)
|
||||||
}
|
}
|
||||||
if !reflect.DeepEqual(expected, status.Details) {
|
if !reflect.DeepEqual(expected, status.Details) {
|
||||||
@ -130,13 +130,13 @@ func TestNewInvalidErr(t *testing.T) {
|
|||||||
func Test_errToAPIStatus(t *testing.T) {
|
func Test_errToAPIStatus(t *testing.T) {
|
||||||
err := &apiServerError{}
|
err := &apiServerError{}
|
||||||
status := errToAPIStatus(err)
|
status := errToAPIStatus(err)
|
||||||
if status.Reason != api.ReasonTypeUnknown || status.Status != api.StatusFailure {
|
if status.Reason != api.StatusReasonUnknown || status.Status != api.StatusFailure {
|
||||||
t.Errorf("unexpected status object: %#v", status)
|
t.Errorf("unexpected status object: %#v", status)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func Test_reasonForError(t *testing.T) {
|
func Test_reasonForError(t *testing.T) {
|
||||||
if e, a := api.ReasonTypeUnknown, reasonForError(nil); e != a {
|
if e, a := api.StatusReasonUnknown, reasonForError(nil); e != a {
|
||||||
t.Errorf("unexpected reason type: %#v", a)
|
t.Errorf("unexpected reason type: %#v", a)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -192,7 +192,7 @@ func (op *Operation) StatusOrResult() (description interface{}, finished bool) {
|
|||||||
if op.finished == nil {
|
if op.finished == nil {
|
||||||
return &api.Status{
|
return &api.Status{
|
||||||
Status: api.StatusWorking,
|
Status: api.StatusWorking,
|
||||||
Reason: api.ReasonTypeWorking,
|
Reason: api.StatusReasonWorking,
|
||||||
Details: &api.StatusDetails{ID: op.ID, Kind: "operation"},
|
Details: &api.StatusDetails{ID: op.ID, Kind: "operation"},
|
||||||
}, false
|
}, false
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user