Make the validation types match the pending ReasonCauses

This commit is contained in:
Clayton Coleman
2014-08-19 22:57:48 -04:00
parent 7332241c0d
commit 60126bfe64
3 changed files with 84 additions and 42 deletions

View File

@@ -19,53 +19,85 @@ package errors
import ( import (
"fmt" "fmt"
"strings" "strings"
"github.com/golang/glog"
) )
// ValidationErrorEnum is a type of validation error. // ValidationErrorType is a machine readable value providing more detail about why
type ValidationErrorEnum string // a field is invalid. These values are expected to match 1-1 with
// CauseReasonType in api/types.go.
type ValidationErrorType string
// These are known errors of validation.
const ( const (
Invalid ValidationErrorEnum = "invalid value" // ValidationErrorTypeNotFound is used to report failure to find a requested value
NotSupported ValidationErrorEnum = "unsupported value" // (e.g. looking up an ID).
Duplicate ValidationErrorEnum = "duplicate value" ValidationErrorTypeNotFound ValidationErrorType = "fieldValueNotFound"
NotFound ValidationErrorEnum = "not found" // ValidationErrorTypeRequired is used to report required values that are not
// provided (e.g. empty strings, null values, or empty arrays).
ValidationErrorTypeRequired ValidationErrorType = "fieldValueRequired"
// ValidationErrorTypeDuplicate is used to report collisions of values that must be
// unique (e.g. unique IDs).
ValidationErrorTypeDuplicate ValidationErrorType = "fieldValueDuplicate"
// ValidationErrorTypeInvalid is used to report malformed values (e.g. failed regex
// match).
ValidationErrorTypeInvalid ValidationErrorType = "fieldValueInvalid"
// ValidationErrorTypeNotSupported is used to report valid (as per formatting rules)
// values that can not be handled (e.g. an enumerated string).
ValidationErrorTypeNotSupported ValidationErrorType = "fieldValueNotSupported"
) )
func ValueOf(t ValidationErrorType) string {
switch t {
case ValidationErrorTypeNotFound:
return "not found"
case ValidationErrorTypeRequired:
return "required value"
case ValidationErrorTypeDuplicate:
return "duplicate value"
case ValidationErrorTypeInvalid:
return "invalid value"
case ValidationErrorTypeNotSupported:
return "unsupported value"
default:
glog.Errorf("unrecognized validation type: %#v", t)
return ""
}
}
// ValidationError is an implementation of the 'error' interface, which represents an error of validation. // ValidationError is an implementation of the 'error' interface, which represents an error of validation.
type ValidationError struct { type ValidationError struct {
Type ValidationErrorEnum Type ValidationErrorType
Field string Field string
BadValue interface{} BadValue interface{}
} }
func (v ValidationError) Error() string { func (v ValidationError) Error() string {
return fmt.Sprintf("%s: %v '%v'", v.Field, v.Type, v.BadValue) return fmt.Sprintf("%s: %v '%v'", v.Field, ValueOf(v.Type), v.BadValue)
} }
// NewInvalid returns a ValidationError indicating "invalid value". Use this to // NewInvalid returns a ValidationError indicating "value required"
// report malformed values (e.g. failed regex match) or missing "required" fields. func NewRequired(field string, value interface{}) ValidationError {
return ValidationError{ValidationErrorTypeRequired, field, value}
}
// NewInvalid returns a ValidationError indicating "invalid value"
func NewInvalid(field string, value interface{}) ValidationError { func NewInvalid(field string, value interface{}) ValidationError {
return ValidationError{Invalid, field, value} return ValidationError{ValidationErrorTypeInvalid, field, value}
} }
// NewNotSupported returns a ValidationError indicating "unsuported value". Use // NewNotSupported returns a ValidationError indicating "unsupported value"
// this to report valid (as per formatting rules) values that can not be handled
// (e.g. an enumerated string).
func NewNotSupported(field string, value interface{}) ValidationError { func NewNotSupported(field string, value interface{}) ValidationError {
return ValidationError{NotSupported, field, value} return ValidationError{ValidationErrorTypeNotSupported, field, value}
} }
// NewDuplicate returns a ValidationError indicating "duplicate value". Use this // NewDuplicate returns a ValidationError indicating "duplicate value"
// to report collisions of values that must be unique (e.g. unique IDs).
func NewDuplicate(field string, value interface{}) ValidationError { func NewDuplicate(field string, value interface{}) ValidationError {
return ValidationError{Duplicate, field, value} return ValidationError{ValidationErrorTypeDuplicate, field, value}
} }
// NewNotFound returns a ValidationError indicating "value not found". Use this // NewNotFound returns a ValidationError indicating "value not found"
// to report failure to find a requested value (e.g. looking up an ID).
func NewNotFound(field string, value interface{}) ValidationError { func NewNotFound(field string, value interface{}) ValidationError {
return ValidationError{NotFound, field, value} return ValidationError{ValidationErrorTypeNotFound, field, value}
} }
// ErrorList is a collection of errors. This does not implement the error // ErrorList is a collection of errors. This does not implement the error

View File

@@ -24,23 +24,27 @@ import (
func TestMakeFuncs(t *testing.T) { func TestMakeFuncs(t *testing.T) {
testCases := []struct { testCases := []struct {
fn func() ValidationError fn func() ValidationError
expected ValidationErrorEnum expected ValidationErrorType
}{ }{
{ {
func() ValidationError { return NewInvalid("f", "v") }, func() ValidationError { return NewInvalid("f", "v") },
Invalid, ValidationErrorTypeInvalid,
}, },
{ {
func() ValidationError { return NewNotSupported("f", "v") }, func() ValidationError { return NewNotSupported("f", "v") },
NotSupported, ValidationErrorTypeNotSupported,
}, },
{ {
func() ValidationError { return NewDuplicate("f", "v") }, func() ValidationError { return NewDuplicate("f", "v") },
Duplicate, ValidationErrorTypeDuplicate,
}, },
{ {
func() ValidationError { return NewNotFound("f", "v") }, func() ValidationError { return NewNotFound("f", "v") },
NotFound, ValidationErrorTypeNotFound,
},
{
func() ValidationError { return NewRequired("f", "v") },
ValidationErrorTypeRequired,
}, },
} }

View File

@@ -36,7 +36,9 @@ func validateVolumes(volumes []Volume) (util.StringSet, errs.ErrorList) {
if vol.Source != nil { if vol.Source != nil {
el = validateSource(vol.Source) el = validateSource(vol.Source)
} }
if !util.IsDNSLabel(vol.Name) { if len(vol.Name) == 0 {
el = append(el, errs.NewRequired("Volume.Name", vol.Name))
} else if !util.IsDNSLabel(vol.Name) {
el = append(el, errs.NewInvalid("Volume.Name", vol.Name)) el = append(el, errs.NewInvalid("Volume.Name", vol.Name))
} else if allNames.Has(vol.Name) { } else if allNames.Has(vol.Name) {
el = append(el, errs.NewDuplicate("Volume.Name", vol.Name)) el = append(el, errs.NewDuplicate("Volume.Name", vol.Name))
@@ -92,7 +94,9 @@ func validatePorts(ports []Port) errs.ErrorList {
allNames.Insert(port.Name) allNames.Insert(port.Name)
} }
} }
if !util.IsValidPortNum(port.ContainerPort) { if port.ContainerPort == 0 {
allErrs = append(allErrs, errs.NewRequired("Port.ContainerPort", port.ContainerPort))
} else if !util.IsValidPortNum(port.ContainerPort) {
allErrs = append(allErrs, errs.NewInvalid("Port.ContainerPort", port.ContainerPort)) allErrs = append(allErrs, errs.NewInvalid("Port.ContainerPort", port.ContainerPort))
} }
if port.HostPort != 0 && !util.IsValidPortNum(port.HostPort) { if port.HostPort != 0 && !util.IsValidPortNum(port.HostPort) {
@@ -113,7 +117,7 @@ func validateEnv(vars []EnvVar) errs.ErrorList {
for i := range vars { for i := range vars {
ev := &vars[i] // so we can set default values ev := &vars[i] // so we can set default values
if len(ev.Name) == 0 { if len(ev.Name) == 0 {
allErrs = append(allErrs, errs.NewInvalid("EnvVar.Name", ev.Name)) allErrs = append(allErrs, errs.NewRequired("EnvVar.Name", ev.Name))
} }
if !util.IsCIdentifier(ev.Name) { if !util.IsCIdentifier(ev.Name) {
allErrs = append(allErrs, errs.NewInvalid("EnvVar.Name", ev.Name)) allErrs = append(allErrs, errs.NewInvalid("EnvVar.Name", ev.Name))
@@ -128,14 +132,14 @@ func validateVolumeMounts(mounts []VolumeMount, volumes util.StringSet) errs.Err
for i := range mounts { for i := range mounts {
mnt := &mounts[i] // so we can set default values mnt := &mounts[i] // so we can set default values
if len(mnt.Name) == 0 { if len(mnt.Name) == 0 {
allErrs = append(allErrs, errs.NewInvalid("VolumeMount.Name", mnt.Name)) allErrs = append(allErrs, errs.NewRequired("VolumeMount.Name", mnt.Name))
} else if !volumes.Has(mnt.Name) { } else if !volumes.Has(mnt.Name) {
allErrs = append(allErrs, errs.NewNotFound("VolumeMount.Name", mnt.Name)) allErrs = append(allErrs, errs.NewNotFound("VolumeMount.Name", mnt.Name))
} }
if len(mnt.MountPath) == 0 { if len(mnt.MountPath) == 0 {
// Backwards compat. // Backwards compat.
if len(mnt.Path) == 0 { if len(mnt.Path) == 0 {
allErrs = append(allErrs, errs.NewInvalid("VolumeMount.MountPath", mnt.MountPath)) allErrs = append(allErrs, errs.NewRequired("VolumeMount.MountPath", mnt.MountPath))
} else { } else {
glog.Warning("DEPRECATED: VolumeMount.Path has been replaced by VolumeMount.MountPath") glog.Warning("DEPRECATED: VolumeMount.Path has been replaced by VolumeMount.MountPath")
mnt.MountPath = mnt.Path mnt.MountPath = mnt.Path
@@ -183,7 +187,9 @@ func validateContainers(containers []Container, volumes util.StringSet) errs.Err
allNames := util.StringSet{} allNames := util.StringSet{}
for i := range containers { for i := range containers {
ctr := &containers[i] // so we can set default values ctr := &containers[i] // so we can set default values
if !util.IsDNSLabel(ctr.Name) { if len(ctr.Name) == 0 {
allErrs = append(allErrs, errs.NewRequired("Container.Name", ctr.Name))
} else if !util.IsDNSLabel(ctr.Name) {
allErrs = append(allErrs, errs.NewInvalid("Container.Name", ctr.Name)) allErrs = append(allErrs, errs.NewInvalid("Container.Name", ctr.Name))
} else if allNames.Has(ctr.Name) { } else if allNames.Has(ctr.Name) {
allErrs = append(allErrs, errs.NewDuplicate("Container.Name", ctr.Name)) allErrs = append(allErrs, errs.NewDuplicate("Container.Name", ctr.Name))
@@ -217,7 +223,7 @@ func ValidateManifest(manifest *ContainerManifest) errs.ErrorList {
allErrs := errs.ErrorList{} allErrs := errs.ErrorList{}
if len(manifest.Version) == 0 { if len(manifest.Version) == 0 {
allErrs = append(allErrs, errs.NewInvalid("ContainerManifest.Version", manifest.Version)) allErrs = append(allErrs, errs.NewRequired("ContainerManifest.Version", manifest.Version))
} else if !supportedManifestVersions.Has(strings.ToLower(manifest.Version)) { } else if !supportedManifestVersions.Has(strings.ToLower(manifest.Version)) {
allErrs = append(allErrs, errs.NewNotSupported("ContainerManifest.Version", manifest.Version)) allErrs = append(allErrs, errs.NewNotSupported("ContainerManifest.Version", manifest.Version))
} }
@@ -245,8 +251,8 @@ func ValidatePodState(podState *PodState) errs.ErrorList {
// Pod tests if required fields in the pod are set. // Pod tests if required fields in the pod are set.
func ValidatePod(pod *Pod) errs.ErrorList { func ValidatePod(pod *Pod) errs.ErrorList {
allErrs := errs.ErrorList{} allErrs := errs.ErrorList{}
if pod.ID == "" { if len(pod.ID) == 0 {
allErrs = append(allErrs, errs.NewInvalid("Pod.ID", pod.ID)) allErrs = append(allErrs, errs.NewRequired("Pod.ID", pod.ID))
} }
allErrs = append(allErrs, ValidatePodState(&pod.DesiredState)...) allErrs = append(allErrs, ValidatePodState(&pod.DesiredState)...)
return allErrs return allErrs
@@ -255,8 +261,8 @@ func ValidatePod(pod *Pod) errs.ErrorList {
// ValidateService tests if required fields in the service are set. // ValidateService tests if required fields in the service are set.
func ValidateService(service *Service) errs.ErrorList { func ValidateService(service *Service) errs.ErrorList {
allErrs := errs.ErrorList{} allErrs := errs.ErrorList{}
if service.ID == "" { if len(service.ID) == 0 {
allErrs = append(allErrs, errs.NewInvalid("Service.ID", service.ID)) allErrs = append(allErrs, errs.NewRequired("Service.ID", service.ID))
} else if !util.IsDNS952Label(service.ID) { } else if !util.IsDNS952Label(service.ID) {
allErrs = append(allErrs, errs.NewInvalid("Service.ID", service.ID)) allErrs = append(allErrs, errs.NewInvalid("Service.ID", service.ID))
} }
@@ -264,7 +270,7 @@ func ValidateService(service *Service) errs.ErrorList {
allErrs = append(allErrs, errs.NewInvalid("Service.Port", service.Port)) allErrs = append(allErrs, errs.NewInvalid("Service.Port", service.Port))
} }
if labels.Set(service.Selector).AsSelector().Empty() { if labels.Set(service.Selector).AsSelector().Empty() {
allErrs = append(allErrs, errs.NewInvalid("Service.Selector", service.Selector)) allErrs = append(allErrs, errs.NewRequired("Service.Selector", service.Selector))
} }
return allErrs return allErrs
} }
@@ -272,11 +278,11 @@ func ValidateService(service *Service) errs.ErrorList {
// ValidateReplicationController tests if required fields in the replication controller are set. // ValidateReplicationController tests if required fields in the replication controller are set.
func ValidateReplicationController(controller *ReplicationController) errs.ErrorList { func ValidateReplicationController(controller *ReplicationController) errs.ErrorList {
allErrs := errs.ErrorList{} allErrs := errs.ErrorList{}
if controller.ID == "" { if len(controller.ID) == 0 {
allErrs = append(allErrs, errs.NewInvalid("ReplicationController.ID", controller.ID)) allErrs = append(allErrs, errs.NewRequired("ReplicationController.ID", controller.ID))
} }
if labels.Set(controller.DesiredState.ReplicaSelector).AsSelector().Empty() { if labels.Set(controller.DesiredState.ReplicaSelector).AsSelector().Empty() {
allErrs = append(allErrs, errs.NewInvalid("ReplicationController.ReplicaSelector", controller.DesiredState.ReplicaSelector)) allErrs = append(allErrs, errs.NewRequired("ReplicationController.ReplicaSelector", controller.DesiredState.ReplicaSelector))
} }
selector := labels.Set(controller.DesiredState.ReplicaSelector).AsSelector() selector := labels.Set(controller.DesiredState.ReplicaSelector).AsSelector()
labels := labels.Set(controller.DesiredState.PodTemplate.Labels) labels := labels.Set(controller.DesiredState.PodTemplate.Labels)