github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-28 22:17:14 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #343 from thockin/valid2

Browse Source 
Use structured errors during validation
This commit is contained in:
Daniel Smith 2014-07-02 16:25:18 -07:00
commit 126b185053
1 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
pkg/api/validation.go
View File

@ -27,16 +27,37 @@ var (
supportedManifestVersions util.StringSet = util.NewStringSet("v1beta1", "v1beta2") supportedManifestVersions util.StringSet = util.NewStringSet("v1beta1", "v1beta2")
) )
func errInvalid(field string, value interface{}) error { // Validation errors.
return fmt.Errorf("%s is invalid: '%v'", field, value) type ValidationErrorEnum string
const (
ErrTypeInvalid ValidationErrorEnum = "invalid value"
ErrTypeNotSupported ValidationErrorEnum = "unsupported value"
ErrTypeDuplicate ValidationErrorEnum = "duplicate value"
)
// Implements the 'error' interface.
type ValidationError struct {
ErrorType ValidationErrorEnum
ErrorField string
BadValue interface{}
} }
func errNotSupported(field string, value interface{}) error { func (v ValidationError) Error() string {
return fmt.Errorf("%s is not supported: '%v'", field, value) return fmt.Sprintf("%s: %v '%v'", v.ErrorField, v.ErrorType, v.BadValue)
} }
func errNotUnique(field string, value interface{}) error { // Factory functions for errors.
return fmt.Errorf("%s is not unique: '%v'", field, value) func makeInvalidError(field string, value interface{}) ValidationError {
return ValidationError{ErrTypeInvalid, field, value}
}
func makeNotSupportedError(field string, value interface{}) ValidationError {
return ValidationError{ErrTypeNotSupported, field, value}
}
func makeDuplicateError(field string, value interface{}) ValidationError {
return ValidationError{ErrTypeDuplicate, field, value}
} }
func validateVolumes(volumes []Volume) (util.StringSet, error) { func validateVolumes(volumes []Volume) (util.StringSet, error) {
@ -44,10 +65,10 @@ func validateVolumes(volumes []Volume) (util.StringSet, error) {
for i := range volumes { for i := range volumes {
vol := &volumes[i] // so we can set default values vol := &volumes[i] // so we can set default values
if len(vol.Name) > 63 || !util.IsDNSLabel(vol.Name) { if len(vol.Name) > 63 || !util.IsDNSLabel(vol.Name) {
return util.StringSet{}, errInvalid("Volume.Name", vol.Name) return util.StringSet{}, makeInvalidError("Volume.Name", vol.Name)
} }
if allNames.Has(vol.Name) { if allNames.Has(vol.Name) {
return util.StringSet{}, errNotUnique("Volume.Name", vol.Name) return util.StringSet{}, makeDuplicateError("Volume.Name", vol.Name)
} }
allNames.Insert(vol.Name) allNames.Insert(vol.Name)
} }
@ -60,14 +81,14 @@ func validateEnv(vars []EnvVar) error {
if len(ev.Name) == 0 { if len(ev.Name) == 0 {
// Backwards compat. // Backwards compat.
if len(ev.Key) == 0 { if len(ev.Key) == 0 {
return errInvalid("EnvVar.Name", ev.Name) return makeInvalidError("EnvVar.Name", ev.Name)
} }
glog.Warning("DEPRECATED: EnvVar.Key has been replaced by EnvVar.Name") glog.Warning("DEPRECATED: EnvVar.Key has been replaced by EnvVar.Name")
ev.Name = ev.Key ev.Name = ev.Key
ev.Key = "" ev.Key = ""
} }
if !util.IsCIdentifier(ev.Name) { if !util.IsCIdentifier(ev.Name) {
return errInvalid("EnvVar.Name", ev.Name) return makeInvalidError("EnvVar.Name", ev.Name)
} }
} }
return nil return nil
@ -78,14 +99,14 @@ func validateContainers(containers []Container, volumes util.StringSet) error {
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 len(ctr.Name) > 63 || !util.IsDNSLabel(ctr.Name) { if len(ctr.Name) > 63 || !util.IsDNSLabel(ctr.Name) {
return errInvalid("Container.Name", ctr.Name) return makeInvalidError("Container.Name", ctr.Name)
} }
if allNames.Has(ctr.Name) { if allNames.Has(ctr.Name) {
return errNotUnique("Container.Name", ctr.Name) return makeDuplicateError("Container.Name", ctr.Name)
} }
allNames.Insert(ctr.Name) allNames.Insert(ctr.Name)
if len(ctr.Image) == 0 { if len(ctr.Image) == 0 {
return errInvalid("Container.Image", ctr.Name) return makeInvalidError("Container.Image", ctr.Name)
} }
if err := validateEnv(ctr.Env); err != nil { if err := validateEnv(ctr.Env); err != nil {
return err return err
@ -103,13 +124,13 @@ func validateContainers(containers []Container, volumes util.StringSet) error {
// TODO(thockin): We should probably collect all errors rather than aborting the validation. // TODO(thockin): We should probably collect all errors rather than aborting the validation.
func ValidateManifest(manifest *ContainerManifest) error { func ValidateManifest(manifest *ContainerManifest) error {
if len(manifest.Version) == 0 { if len(manifest.Version) == 0 {
return errInvalid("ContainerManifest.Version", manifest.Version) return makeInvalidError("ContainerManifest.Version", manifest.Version)
} }
if !supportedManifestVersions.Has(manifest.Version) { if !supportedManifestVersions.Has(manifest.Version) {
return errNotSupported("ContainerManifest.Version", manifest.Version) return makeNotSupportedError("ContainerManifest.Version", manifest.Version)
} }
if len(manifest.ID) > 255 || !util.IsDNSSubdomain(manifest.ID) { if len(manifest.ID) > 255 || !util.IsDNSSubdomain(manifest.ID) {
return errInvalid("ContainerManifest.ID", manifest.ID) return makeInvalidError("ContainerManifest.ID", manifest.ID)
} }
allVolumes, err := validateVolumes(manifest.Volumes) allVolumes, err := validateVolumes(manifest.Volumes)
if err != nil { if err != nil {