// +build codegen package api import ( "bytes" "fmt" "text/template" ) // A ShapeValidationType is the type of validation that a shape needs type ShapeValidationType int const ( // ShapeValidationRequired states the shape must be set ShapeValidationRequired = iota // ShapeValidationMinVal states the shape must have at least a number of // elements, or for numbers a minimum value ShapeValidationMinVal // ShapeValidationNested states the shape has nested values that need // to be validated ShapeValidationNested ) // A ShapeValidation contains information about a shape and the type of validation // that is needed type ShapeValidation struct { // Name of the shape to be validated Name string // Reference to the shape within the context the shape is referenced Ref *ShapeRef // Type of validation needed Type ShapeValidationType } var validationGoCodeTmpls = template.Must( template.New("validationGoCodeTmpls"). Funcs(template.FuncMap{ "getMin": func(ref *ShapeRef) float64 { if !ref.CanBeEmpty() && ref.Shape.Min <= 0 { return 1 } return ref.Shape.Min }, }). Parse(` {{ define "requiredValue" -}} {{ if .Ref.Shape.IsEnum -}} if len(s.{{ .Name }}) == 0 { invalidParams.Add(aws.NewErrParamRequired("{{ .Name }}")) } {{- else }} if s.{{ .Name }} == nil { invalidParams.Add(aws.NewErrParamRequired("{{ .Name }}")) } {{- end }} {{- end }} {{ define "minLen" -}} {{- $min := getMin .Ref -}} if s.{{ .Name }} != nil && len(s.{{ .Name }}) < {{ $min }} { invalidParams.Add(aws.NewErrParamMinLen("{{ .Name }}", {{ $min }})) } {{- end }} {{ define "minLenString" -}} {{ if (not .Ref.Shape.IsEnum) -}} {{- $min := getMin .Ref -}} if s.{{ .Name }} != nil && len(*s.{{ .Name }}) < {{ $min }} { invalidParams.Add(aws.NewErrParamMinLen("{{ .Name }}", {{ $min }})) } {{- end }} {{- end }} {{ define "minVal" -}} {{ if (not .Ref.Shape.IsEnum) -}} {{- $min := getMin .Ref -}} if s.{{ .Name }} != nil && *s.{{ .Name }} < {{ $min }} { invalidParams.Add(aws.NewErrParamMinValue("{{ .Name }}", {{ $min }})) } {{- end }} {{- end }} {{ define "nestedMapList" -}} if s.{{ .Name }} != nil { for i, v := range s.{{ .Name }} { if err := v.Validate(); err != nil { invalidParams.AddNested(fmt.Sprintf("%s[%v]", "{{ .Name }}", i), err.(aws.ErrInvalidParams)) } } } {{- end }} {{ define "nestedStruct" -}} if s.{{ .Name }} != nil { if err := s.{{ .Name }}.Validate(); err != nil { invalidParams.AddNested("{{ .Name }}", err.(aws.ErrInvalidParams)) } } {{- end }} `)) // GoCode returns the generated Go code for the Shape with its validation type. func (sv ShapeValidation) GoCode() string { var err error w := &bytes.Buffer{} switch sv.Type { case ShapeValidationRequired: err = validationGoCodeTmpls.ExecuteTemplate(w, "requiredValue", sv) case ShapeValidationMinVal: switch sv.Ref.Shape.Type { case "list", "map", "blob": err = validationGoCodeTmpls.ExecuteTemplate(w, "minLen", sv) case "string": err = validationGoCodeTmpls.ExecuteTemplate(w, "minLenString", sv) case "integer", "long", "float", "double": err = validationGoCodeTmpls.ExecuteTemplate(w, "minVal", sv) default: panic(fmt.Sprintf("ShapeValidation.GoCode, %s's type %s, no min value handling", sv.Name, sv.Ref.Shape.Type)) } case ShapeValidationNested: switch sv.Ref.Shape.Type { case "map", "list": sv.Ref.API.AddImport("fmt") err = validationGoCodeTmpls.ExecuteTemplate(w, "nestedMapList", sv) default: err = validationGoCodeTmpls.ExecuteTemplate(w, "nestedStruct", sv) } default: panic(fmt.Sprintf("ShapeValidation.GoCode, %s's type %d, unknown validation type", sv.Name, sv.Type)) } if err != nil { panic(fmt.Sprintf("ShapeValidation.GoCode failed, err: %v", err)) } return w.String() } // A ShapeValidations is a collection of shape validations needed nested within // a parent shape type ShapeValidations []ShapeValidation var validateShapeTmpl = template.Must(template.New("ValidateShape").Parse(` // Validate inspects the fields of the type to determine if they are valid. func (s *{{ .Shape.ShapeName }}) Validate() error { invalidParams := aws.ErrInvalidParams{Context: "{{ .Shape.ShapeName }}"} {{ range $_, $v := .Validations -}} {{ $v.GoCode }} {{ end }} if invalidParams.Len() > 0 { return invalidParams } return nil } `)) // GoCode generates the Go code needed to perform validations for the // shape and its nested fields. func (vs ShapeValidations) GoCode(shape *Shape) string { buf := &bytes.Buffer{} validateShapeTmpl.Execute(buf, map[string]interface{}{ "Shape": shape, "Validations": vs, }) return buf.String() } // Has returns true or false if the ShapeValidations already contains the // the reference and validation type. func (vs ShapeValidations) Has(ref *ShapeRef, typ ShapeValidationType) bool { for _, v := range vs { if v.Ref == ref && v.Type == typ { return true } } return false }