github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-03 09:22:44 +00:00
Code Issues Projects Releases Wiki Activity

Clarify invalid vs not-supported

Browse Source
This commit is contained in:
Tim Hockin 2015-11-03 14:47:43 -08:00
parent 2c60a97e72
commit f8ad75df44
5 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/api/errors/errors_test.go
View File

@ -125,7 +125,7 @@ func TestNewInvalid(t *testing.T) {
}, },
}, },
{ {
validation.NewFieldValueNotSupported("field[0].name", "bar", nil), validation.NewFieldNotSupported("field[0].name", "bar", nil),
&unversioned.StatusDetails{ &unversioned.StatusDetails{
Kind: "kind", Kind: "kind",
Name: "name", Name: "name",

20
pkg/api/validation/validation.go
View File

@ -789,7 +789,7 @@ func validatePorts(ports []api.ContainerPort) validation.ErrorList {
if len(port.Protocol) == 0 { if len(port.Protocol) == 0 {
pErrs = append(pErrs, validation.NewFieldRequired("protocol")) pErrs = append(pErrs, validation.NewFieldRequired("protocol"))
} else if !supportedPortProtocols.Has(string(port.Protocol)) { } else if !supportedPortProtocols.Has(string(port.Protocol)) {
pErrs = append(pErrs, validation.NewFieldValueNotSupported("protocol", port.Protocol, supportedPortProtocols.List())) pErrs = append(pErrs, validation.NewFieldNotSupported("protocol", port.Protocol, supportedPortProtocols.List()))
} }
allErrs = append(allErrs, pErrs.PrefixIndex(i)...) allErrs = append(allErrs, pErrs.PrefixIndex(i)...)
} }
@ -848,7 +848,7 @@ func validateObjectFieldSelector(fs *api.ObjectFieldSelector, expressions *sets.
if err != nil { if err != nil {
allErrs = append(allErrs, validation.NewFieldInvalid("fieldPath", fs.FieldPath, "error converting fieldPath")) allErrs = append(allErrs, validation.NewFieldInvalid("fieldPath", fs.FieldPath, "error converting fieldPath"))
} else if !expressions.Has(internalFieldPath) { } else if !expressions.Has(internalFieldPath) {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("fieldPath", internalFieldPath, expressions.List())) allErrs = append(allErrs, validation.NewFieldNotSupported("fieldPath", internalFieldPath, expressions.List()))
} }
} }
@ -996,7 +996,7 @@ func validatePullPolicy(ctr *api.Container) validation.ErrorList {
allErrors = append(allErrors, validation.NewFieldRequired("")) allErrors = append(allErrors, validation.NewFieldRequired(""))
default: default:
validValues := []string{string(api.PullAlways), string(api.PullIfNotPresent), string(api.PullNever)} validValues := []string{string(api.PullAlways), string(api.PullIfNotPresent), string(api.PullNever)}
allErrors = append(allErrors, validation.NewFieldValueNotSupported("", ctr.ImagePullPolicy, validValues)) allErrors = append(allErrors, validation.NewFieldNotSupported("", ctr.ImagePullPolicy, validValues))
} }
return allErrors return allErrors
@ -1057,7 +1057,7 @@ func validateRestartPolicy(restartPolicy *api.RestartPolicy) validation.ErrorLis
allErrors = append(allErrors, validation.NewFieldRequired("")) allErrors = append(allErrors, validation.NewFieldRequired(""))
default: default:
validValues := []string{string(api.RestartPolicyAlways), string(api.RestartPolicyOnFailure), string(api.RestartPolicyNever)} validValues := []string{string(api.RestartPolicyAlways), string(api.RestartPolicyOnFailure), string(api.RestartPolicyNever)}
allErrors = append(allErrors, validation.NewFieldValueNotSupported("", *restartPolicy, validValues)) allErrors = append(allErrors, validation.NewFieldNotSupported("", *restartPolicy, validValues))
} }
return allErrors return allErrors
@ -1072,7 +1072,7 @@ func validateDNSPolicy(dnsPolicy *api.DNSPolicy) validation.ErrorList {
allErrors = append(allErrors, validation.NewFieldRequired("")) allErrors = append(allErrors, validation.NewFieldRequired(""))
default: default:
validValues := []string{string(api.DNSClusterFirst), string(api.DNSDefault)} validValues := []string{string(api.DNSClusterFirst), string(api.DNSDefault)}
allErrors = append(allErrors, validation.NewFieldValueNotSupported("", dnsPolicy, validValues)) allErrors = append(allErrors, validation.NewFieldNotSupported("", dnsPolicy, validValues))
} }
return allErrors return allErrors
} }
@ -1250,7 +1250,7 @@ func ValidateService(service *api.Service) validation.ErrorList {
if service.Spec.SessionAffinity == "" { if service.Spec.SessionAffinity == "" {
allErrs = append(allErrs, validation.NewFieldRequired("spec.sessionAffinity")) allErrs = append(allErrs, validation.NewFieldRequired("spec.sessionAffinity"))
} else if !supportedSessionAffinityType.Has(string(service.Spec.SessionAffinity)) { } else if !supportedSessionAffinityType.Has(string(service.Spec.SessionAffinity)) {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("spec.sessionAffinity", service.Spec.SessionAffinity, supportedSessionAffinityType.List())) allErrs = append(allErrs, validation.NewFieldNotSupported("spec.sessionAffinity", service.Spec.SessionAffinity, supportedSessionAffinityType.List()))
} }
if api.IsServiceIPSet(service) { if api.IsServiceIPSet(service) {
@ -1269,7 +1269,7 @@ func ValidateService(service *api.Service) validation.ErrorList {
if service.Spec.Type == "" { if service.Spec.Type == "" {
allErrs = append(allErrs, validation.NewFieldRequired("spec.type")) allErrs = append(allErrs, validation.NewFieldRequired("spec.type"))
} else if !supportedServiceType.Has(string(service.Spec.Type)) { } else if !supportedServiceType.Has(string(service.Spec.Type)) {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("spec.type", service.Spec.Type, supportedServiceType.List())) allErrs = append(allErrs, validation.NewFieldNotSupported("spec.type", service.Spec.Type, supportedServiceType.List()))
} }
if service.Spec.Type == api.ServiceTypeLoadBalancer { if service.Spec.Type == api.ServiceTypeLoadBalancer {
@ -1330,7 +1330,7 @@ func validateServicePort(sp *api.ServicePort, requireName bool, allNames *sets.S
if len(sp.Protocol) == 0 { if len(sp.Protocol) == 0 {
allErrs = append(allErrs, validation.NewFieldRequired("protocol")) allErrs = append(allErrs, validation.NewFieldRequired("protocol"))
} else if !supportedPortProtocols.Has(string(sp.Protocol)) { } else if !supportedPortProtocols.Has(string(sp.Protocol)) {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("protocol", sp.Protocol, supportedPortProtocols.List())) allErrs = append(allErrs, validation.NewFieldNotSupported("protocol", sp.Protocol, supportedPortProtocols.List()))
} }
if sp.TargetPort.Type == intstr.Int && !validation.IsValidPortNum(sp.TargetPort.IntVal) { if sp.TargetPort.Type == intstr.Int && !validation.IsValidPortNum(sp.TargetPort.IntVal) {
@ -1411,7 +1411,7 @@ func ValidatePodTemplateSpecForRC(template *api.PodTemplateSpec, selectorMap map
} }
// RestartPolicy has already been first-order validated as per ValidatePodTemplateSpec(). // RestartPolicy has already been first-order validated as per ValidatePodTemplateSpec().
if template.Spec.RestartPolicy != api.RestartPolicyAlways { if template.Spec.RestartPolicy != api.RestartPolicyAlways {
allErrs = append(allErrs, validation.NewFieldValueNotSupported(fieldName+".spec.restartPolicy", template.Spec.RestartPolicy, []string{string(api.RestartPolicyAlways)})) allErrs = append(allErrs, validation.NewFieldNotSupported(fieldName+".spec.restartPolicy", template.Spec.RestartPolicy, []string{string(api.RestartPolicyAlways)}))
} }
} }
return allErrs return allErrs
@ -1974,7 +1974,7 @@ func validateEndpointPort(port *api.EndpointPort, requireName bool) validation.E
if len(port.Protocol) == 0 { if len(port.Protocol) == 0 {
allErrs = append(allErrs, validation.NewFieldRequired("protocol")) allErrs = append(allErrs, validation.NewFieldRequired("protocol"))
} else if !supportedPortProtocols.Has(string(port.Protocol)) { } else if !supportedPortProtocols.Has(string(port.Protocol)) {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("protocol", port.Protocol, supportedPortProtocols.List())) allErrs = append(allErrs, validation.NewFieldNotSupported("protocol", port.Protocol, supportedPortProtocols.List()))
} }
return allErrs return allErrs
} }

6
pkg/apis/extensions/validation/validation.go
View File

@ -56,7 +56,7 @@ func validateHorizontalPodAutoscalerSpec(autoscaler extensions.HorizontalPodAuto
if refErrs := ValidateSubresourceReference(autoscaler.ScaleRef); len(refErrs) > 0 { if refErrs := ValidateSubresourceReference(autoscaler.ScaleRef); len(refErrs) > 0 {
allErrs = append(allErrs, refErrs.Prefix("scaleRef")...) allErrs = append(allErrs, refErrs.Prefix("scaleRef")...)
} else if autoscaler.ScaleRef.Subresource != "scale" { } else if autoscaler.ScaleRef.Subresource != "scale" {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("scaleRef.subresource", autoscaler.ScaleRef.Subresource, []string{"scale"})) allErrs = append(allErrs, validation.NewFieldNotSupported("scaleRef.subresource", autoscaler.ScaleRef.Subresource, []string{"scale"}))
} }
return allErrs return allErrs
} }
@ -206,7 +206,7 @@ func ValidateDaemonSetSpec(spec *extensions.DaemonSetSpec) validation.ErrorList
allErrs = append(allErrs, apivalidation.ValidateReadOnlyPersistentDisks(spec.Template.Spec.Volumes).Prefix("template.spec.volumes")...) allErrs = append(allErrs, apivalidation.ValidateReadOnlyPersistentDisks(spec.Template.Spec.Volumes).Prefix("template.spec.volumes")...)
// RestartPolicy has already been first-order validated as per ValidatePodTemplateSpec(). // RestartPolicy has already been first-order validated as per ValidatePodTemplateSpec().
if spec.Template.Spec.RestartPolicy != api.RestartPolicyAlways { if spec.Template.Spec.RestartPolicy != api.RestartPolicyAlways {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("template.spec.restartPolicy", spec.Template.Spec.RestartPolicy, []string{string(api.RestartPolicyAlways)})) allErrs = append(allErrs, validation.NewFieldNotSupported("template.spec.restartPolicy", spec.Template.Spec.RestartPolicy, []string{string(api.RestartPolicyAlways)}))
} }
return allErrs return allErrs
@ -360,7 +360,7 @@ func ValidateJobSpec(spec *extensions.JobSpec) validation.ErrorList {
allErrs = append(allErrs, apivalidation.ValidatePodTemplateSpec(&spec.Template).Prefix("template")...) allErrs = append(allErrs, apivalidation.ValidatePodTemplateSpec(&spec.Template).Prefix("template")...)
if spec.Template.Spec.RestartPolicy != api.RestartPolicyOnFailure && if spec.Template.Spec.RestartPolicy != api.RestartPolicyOnFailure &&
spec.Template.Spec.RestartPolicy != api.RestartPolicyNever { spec.Template.Spec.RestartPolicy != api.RestartPolicyNever {
allErrs = append(allErrs, validation.NewFieldValueNotSupported("template.spec.restartPolicy", allErrs = append(allErrs, validation.NewFieldNotSupported("template.spec.restartPolicy",
spec.Template.Spec.RestartPolicy, []string{string(api.RestartPolicyOnFailure), string(api.RestartPolicyNever)})) spec.Template.Spec.RestartPolicy, []string{string(api.RestartPolicyOnFailure), string(api.RestartPolicyNever)}))
} }
return allErrs return allErrs

13
pkg/util/validation/errors.go
View File

@ -77,9 +77,8 @@ const (
// ErrorTypeInvalid is used to report malformed values (e.g. failed regex // ErrorTypeInvalid is used to report malformed values (e.g. failed regex
// match, too long, out of bounds). See NewFieldInvalid. // match, too long, out of bounds). See NewFieldInvalid.
ErrorTypeInvalid ErrorType = "FieldValueInvalid" ErrorTypeInvalid ErrorType = "FieldValueInvalid"
// ErrorTypeNotSupported is used to report valid (as per formatting rules) // ErrorTypeNotSupported is used to report unknown values for enumerated
// values that can not be handled (e.g. an enumerated string). See // fields (e.g. a list of valid values). See NewFieldNotSupported.
// NewFieldValueNotSupported.
ErrorTypeNotSupported ErrorType = "FieldValueNotSupported" ErrorTypeNotSupported ErrorType = "FieldValueNotSupported"
// ErrorTypeForbidden is used to report valid (as per formatting rules) // ErrorTypeForbidden is used to report valid (as per formatting rules)
// values which would be accepted under some conditions, but which are not // values which would be accepted under some conditions, but which are not
@ -140,10 +139,10 @@ func NewFieldInvalid(field string, value interface{}, detail string) *Error {
return &Error{ErrorTypeInvalid, field, value, detail} return &Error{ErrorTypeInvalid, field, value, detail}
} }
// NewFieldValueNotSupported returns a *Error indicating "unsupported value". // NewFieldNotSupported returns a *Error indicating "unsupported value".
// This is used to report valid (as per formatting rules) values that can not // This is used to report unknown values for enumerated fields (e.g. a list of
// be handled (e.g. an enumerated string). // valid values).
func NewFieldValueNotSupported(field string, value interface{}, validValues []string) *Error { func NewFieldNotSupported(field string, value interface{}, validValues []string) *Error {
detail := "" detail := ""
if validValues != nil && len(validValues) > 0 { if validValues != nil && len(validValues) > 0 {
detail = "supported values: " + strings.Join(validValues, ", ") detail = "supported values: " + strings.Join(validValues, ", ")

2
pkg/util/validation/errors_test.go
View File

@ -31,7 +31,7 @@ func TestMakeFuncs(t *testing.T) {
ErrorTypeInvalid, ErrorTypeInvalid,
}, },
{ {
func() *Error { return NewFieldValueNotSupported("f", "v", nil) }, func() *Error { return NewFieldNotSupported("f", "v", nil) },
ErrorTypeNotSupported, ErrorTypeNotSupported,
}, },
{ {