aboutsummaryrefslogtreecommitdiffstats
path: root/modules/middleware/binding
diff options
context:
space:
mode:
authorUnknown <joe2010xtmf@163.com>2014-05-05 02:42:52 -0400
committerUnknown <joe2010xtmf@163.com>2014-05-05 02:42:52 -0400
commit816c0ed5e7bba89a87689e56c19a29617f5f0ea9 (patch)
treea75a6baf4a476d0962ddf9eb76e946d568584544 /modules/middleware/binding
parenta641854cad6dddda551a2995c765e970f7cea8ba (diff)
downloadgitea-816c0ed5e7bba89a87689e56c19a29617f5f0ea9.tar.gz
gitea-816c0ed5e7bba89a87689e56c19a29617f5f0ea9.zip
Fix import path
Diffstat (limited to 'modules/middleware/binding')
-rw-r--r--modules/middleware/binding/binding.go470
-rw-r--r--modules/middleware/binding/binding_test.go701
2 files changed, 1171 insertions, 0 deletions
diff --git a/modules/middleware/binding/binding.go b/modules/middleware/binding/binding.go
new file mode 100644
index 0000000000..6de5955154
--- /dev/null
+++ b/modules/middleware/binding/binding.go
@@ -0,0 +1,470 @@
+// Copyright 2013 The Martini Contrib Authors. All rights reserved.
+// Copyright 2014 The Gogs Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package binding
+
+import (
+ "encoding/json"
+ "fmt"
+ "io"
+ "net/http"
+ "reflect"
+ "regexp"
+ "strconv"
+ "strings"
+ "unicode/utf8"
+
+ "github.com/go-martini/martini"
+)
+
+/*
+ To the land of Middle-ware Earth:
+
+ One func to rule them all,
+ One func to find them,
+ One func to bring them all,
+ And in this package BIND them.
+*/
+
+// Bind accepts a copy of an empty struct and populates it with
+// values from the request (if deserialization is successful). It
+// wraps up the functionality of the Form and Json middleware
+// according to the Content-Type of the request, and it guesses
+// if no Content-Type is specified. Bind invokes the ErrorHandler
+// middleware to bail out if errors occurred. If you want to perform
+// your own error handling, use Form or Json middleware directly.
+// An interface pointer can be added as a second argument in order
+// to map the struct to a specific interface.
+func Bind(obj interface{}, ifacePtr ...interface{}) martini.Handler {
+ return func(context martini.Context, req *http.Request) {
+ contentType := req.Header.Get("Content-Type")
+
+ if strings.Contains(contentType, "form-urlencoded") {
+ context.Invoke(Form(obj, ifacePtr...))
+ } else if strings.Contains(contentType, "multipart/form-data") {
+ context.Invoke(MultipartForm(obj, ifacePtr...))
+ } else if strings.Contains(contentType, "json") {
+ context.Invoke(Json(obj, ifacePtr...))
+ } else {
+ context.Invoke(Json(obj, ifacePtr...))
+ if getErrors(context).Count() > 0 {
+ context.Invoke(Form(obj, ifacePtr...))
+ }
+ }
+
+ context.Invoke(ErrorHandler)
+ }
+}
+
+// BindIgnErr will do the exactly same thing as Bind but without any
+// error handling, which user has freedom to deal with them.
+// This allows user take advantages of validation.
+func BindIgnErr(obj interface{}, ifacePtr ...interface{}) martini.Handler {
+ return func(context martini.Context, req *http.Request) {
+ contentType := req.Header.Get("Content-Type")
+
+ if strings.Contains(contentType, "form-urlencoded") {
+ context.Invoke(Form(obj, ifacePtr...))
+ } else if strings.Contains(contentType, "multipart/form-data") {
+ context.Invoke(MultipartForm(obj, ifacePtr...))
+ } else if strings.Contains(contentType, "json") {
+ context.Invoke(Json(obj, ifacePtr...))
+ } else {
+ context.Invoke(Json(obj, ifacePtr...))
+ if getErrors(context).Count() > 0 {
+ context.Invoke(Form(obj, ifacePtr...))
+ }
+ }
+ }
+}
+
+// Form is middleware to deserialize form-urlencoded data from the request.
+// It gets data from the form-urlencoded body, if present, or from the
+// query string. It uses the http.Request.ParseForm() method
+// to perform deserialization, then reflection is used to map each field
+// into the struct with the proper type. Structs with primitive slice types
+// (bool, float, int, string) can support deserialization of repeated form
+// keys, for example: key=val1&key=val2&key=val3
+// An interface pointer can be added as a second argument in order
+// to map the struct to a specific interface.
+func Form(formStruct interface{}, ifacePtr ...interface{}) martini.Handler {
+ return func(context martini.Context, req *http.Request) {
+ ensureNotPointer(formStruct)
+ formStruct := reflect.New(reflect.TypeOf(formStruct))
+ errors := newErrors()
+ parseErr := req.ParseForm()
+
+ // Format validation of the request body or the URL would add considerable overhead,
+ // and ParseForm does not complain when URL encoding is off.
+ // Because an empty request body or url can also mean absence of all needed values,
+ // it is not in all cases a bad request, so let's return 422.
+ if parseErr != nil {
+ errors.Overall[BindingDeserializationError] = parseErr.Error()
+ }
+
+ mapForm(formStruct, req.Form, errors)
+
+ validateAndMap(formStruct, context, errors, ifacePtr...)
+ }
+}
+
+func MultipartForm(formStruct interface{}, ifacePtr ...interface{}) martini.Handler {
+ return func(context martini.Context, req *http.Request) {
+ ensureNotPointer(formStruct)
+ formStruct := reflect.New(reflect.TypeOf(formStruct))
+ errors := newErrors()
+
+ // Workaround for multipart forms returning nil instead of an error
+ // when content is not multipart
+ // https://code.google.com/p/go/issues/detail?id=6334
+ multipartReader, err := req.MultipartReader()
+ if err != nil {
+ errors.Overall[BindingDeserializationError] = err.Error()
+ } else {
+ form, parseErr := multipartReader.ReadForm(MaxMemory)
+
+ if parseErr != nil {
+ errors.Overall[BindingDeserializationError] = parseErr.Error()
+ }
+
+ req.MultipartForm = form
+ }
+
+ mapForm(formStruct, req.MultipartForm.Value, errors)
+
+ validateAndMap(formStruct, context, errors, ifacePtr...)
+ }
+}
+
+// Json is middleware to deserialize a JSON payload from the request
+// into the struct that is passed in. The resulting struct is then
+// validated, but no error handling is actually performed here.
+// An interface pointer can be added as a second argument in order
+// to map the struct to a specific interface.
+func Json(jsonStruct interface{}, ifacePtr ...interface{}) martini.Handler {
+ return func(context martini.Context, req *http.Request) {
+ ensureNotPointer(jsonStruct)
+ jsonStruct := reflect.New(reflect.TypeOf(jsonStruct))
+ errors := newErrors()
+
+ if req.Body != nil {
+ defer req.Body.Close()
+ }
+
+ if err := json.NewDecoder(req.Body).Decode(jsonStruct.Interface()); err != nil && err != io.EOF {
+ errors.Overall[BindingDeserializationError] = err.Error()
+ }
+
+ validateAndMap(jsonStruct, context, errors, ifacePtr...)
+ }
+}
+
+// Validate is middleware to enforce required fields. If the struct
+// passed in is a Validator, then the user-defined Validate method
+// is executed, and its errors are mapped to the context. This middleware
+// performs no error handling: it merely detects them and maps them.
+func Validate(obj interface{}) martini.Handler {
+ return func(context martini.Context, req *http.Request) {
+ errors := newErrors()
+ validateStruct(errors, obj)
+
+ if validator, ok := obj.(Validator); ok {
+ validator.Validate(errors, req, context)
+ }
+ context.Map(*errors)
+ }
+}
+
+var (
+ alphaDashPattern = regexp.MustCompile("[^\\d\\w-_]")
+ alphaDashDotPattern = regexp.MustCompile("[^\\d\\w-_\\.]")
+ emailPattern = regexp.MustCompile("[\\w!#$%&'*+/=?^_`{|}~-]+(?:\\.[\\w!#$%&'*+/=?^_`{|}~-]+)*@(?:[\\w](?:[\\w-]*[\\w])?\\.)+[a-zA-Z0-9](?:[\\w-]*[\\w])?")
+ urlPattern = regexp.MustCompile(`(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&amp;:/~\+#]*[\w\-\@?^=%&amp;/~\+#])?`)
+)
+
+func validateStruct(errors *BindingErrors, obj interface{}) {
+ typ := reflect.TypeOf(obj)
+ val := reflect.ValueOf(obj)
+
+ if typ.Kind() == reflect.Ptr {
+ typ = typ.Elem()
+ val = val.Elem()
+ }
+
+ for i := 0; i < typ.NumField(); i++ {
+ field := typ.Field(i)
+
+ // Allow ignored fields in the struct
+ if field.Tag.Get("form") == "-" {
+ continue
+ }
+
+ fieldValue := val.Field(i).Interface()
+ if field.Type.Kind() == reflect.Struct {
+ validateStruct(errors, fieldValue)
+ continue
+ }
+
+ zero := reflect.Zero(field.Type).Interface()
+
+ // Match rules.
+ for _, rule := range strings.Split(field.Tag.Get("binding"), ";") {
+ if len(rule) == 0 {
+ continue
+ }
+
+ switch {
+ case rule == "Required":
+ if reflect.DeepEqual(zero, fieldValue) {
+ errors.Fields[field.Name] = BindingRequireError
+ break
+ }
+ case rule == "AlphaDash":
+ if alphaDashPattern.MatchString(fmt.Sprintf("%v", fieldValue)) {
+ errors.Fields[field.Name] = BindingAlphaDashError
+ break
+ }
+ case rule == "AlphaDashDot":
+ if alphaDashDotPattern.MatchString(fmt.Sprintf("%v", fieldValue)) {
+ errors.Fields[field.Name] = BindingAlphaDashDotError
+ break
+ }
+ case strings.HasPrefix(rule, "MinSize("):
+ min, err := strconv.Atoi(rule[8 : len(rule)-1])
+ if err != nil {
+ errors.Overall["MinSize"] = err.Error()
+ break
+ }
+ if str, ok := fieldValue.(string); ok && utf8.RuneCountInString(str) < min {
+ errors.Fields[field.Name] = BindingMinSizeError
+ break
+ }
+ v := reflect.ValueOf(fieldValue)
+ if v.Kind() == reflect.Slice && v.Len() < min {
+ errors.Fields[field.Name] = BindingMinSizeError
+ break
+ }
+ case strings.HasPrefix(rule, "MaxSize("):
+ max, err := strconv.Atoi(rule[8 : len(rule)-1])
+ if err != nil {
+ errors.Overall["MaxSize"] = err.Error()
+ break
+ }
+ if str, ok := fieldValue.(string); ok && utf8.RuneCountInString(str) > max {
+ errors.Fields[field.Name] = BindingMaxSizeError
+ break
+ }
+ v := reflect.ValueOf(fieldValue)
+ if v.Kind() == reflect.Slice && v.Len() > max {
+ errors.Fields[field.Name] = BindingMinSizeError
+ break
+ }
+ case rule == "Email":
+ if !emailPattern.MatchString(fmt.Sprintf("%v", fieldValue)) {
+ errors.Fields[field.Name] = BindingEmailError
+ break
+ }
+ case rule == "Url":
+ if !urlPattern.MatchString(fmt.Sprintf("%v", fieldValue)) {
+ errors.Fields[field.Name] = BindingUrlError
+ break
+ }
+ }
+ }
+ }
+}
+
+func mapForm(formStruct reflect.Value, form map[string][]string, errors *BindingErrors) {
+ typ := formStruct.Elem().Type()
+
+ for i := 0; i < typ.NumField(); i++ {
+ typeField := typ.Field(i)
+ if inputFieldName := typeField.Tag.Get("form"); inputFieldName != "" {
+ structField := formStruct.Elem().Field(i)
+ if !structField.CanSet() {
+ continue
+ }
+
+ inputValue, exists := form[inputFieldName]
+
+ if !exists {
+ continue
+ }
+
+ numElems := len(inputValue)
+ if structField.Kind() == reflect.Slice && numElems > 0 {
+ sliceOf := structField.Type().Elem().Kind()
+ slice := reflect.MakeSlice(structField.Type(), numElems, numElems)
+ for i := 0; i < numElems; i++ {
+ setWithProperType(sliceOf, inputValue[i], slice.Index(i), inputFieldName, errors)
+ }
+ formStruct.Elem().Field(i).Set(slice)
+ } else {
+ setWithProperType(typeField.Type.Kind(), inputValue[0], structField, inputFieldName, errors)
+ }
+ }
+ }
+}
+
+// ErrorHandler simply counts the number of errors in the
+// context and, if more than 0, writes a 400 Bad Request
+// response and a JSON payload describing the errors with
+// the "Content-Type" set to "application/json".
+// Middleware remaining on the stack will not even see the request
+// if, by this point, there are any errors.
+// This is a "default" handler, of sorts, and you are
+// welcome to use your own instead. The Bind middleware
+// invokes this automatically for convenience.
+func ErrorHandler(errs BindingErrors, resp http.ResponseWriter) {
+ if errs.Count() > 0 {
+ resp.Header().Set("Content-Type", "application/json; charset=utf-8")
+ if _, ok := errs.Overall[BindingDeserializationError]; ok {
+ resp.WriteHeader(http.StatusBadRequest)
+ } else {
+ resp.WriteHeader(422)
+ }
+ errOutput, _ := json.Marshal(errs)
+ resp.Write(errOutput)
+ return
+ }
+}
+
+// This sets the value in a struct of an indeterminate type to the
+// matching value from the request (via Form middleware) in the
+// same type, so that not all deserialized values have to be strings.
+// Supported types are string, int, float, and bool.
+func setWithProperType(valueKind reflect.Kind, val string, structField reflect.Value, nameInTag string, errors *BindingErrors) {
+ switch valueKind {
+ case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
+ if val == "" {
+ val = "0"
+ }
+ intVal, err := strconv.ParseInt(val, 10, 64)
+ if err != nil {
+ errors.Fields[nameInTag] = BindingIntegerTypeError
+ } else {
+ structField.SetInt(intVal)
+ }
+ case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
+ if val == "" {
+ val = "0"
+ }
+ uintVal, err := strconv.ParseUint(val, 10, 64)
+ if err != nil {
+ errors.Fields[nameInTag] = BindingIntegerTypeError
+ } else {
+ structField.SetUint(uintVal)
+ }
+ case reflect.Bool:
+ structField.SetBool(val == "on")
+ case reflect.Float32:
+ if val == "" {
+ val = "0.0"
+ }
+ floatVal, err := strconv.ParseFloat(val, 32)
+ if err != nil {
+ errors.Fields[nameInTag] = BindingFloatTypeError
+ } else {
+ structField.SetFloat(floatVal)
+ }
+ case reflect.Float64:
+ if val == "" {
+ val = "0.0"
+ }
+ floatVal, err := strconv.ParseFloat(val, 64)
+ if err != nil {
+ errors.Fields[nameInTag] = BindingFloatTypeError
+ } else {
+ structField.SetFloat(floatVal)
+ }
+ case reflect.String:
+ structField.SetString(val)
+ }
+}
+
+// Don't pass in pointers to bind to. Can lead to bugs. See:
+// https://github.com/codegangsta/martini-contrib/issues/40
+// https://github.com/codegangsta/martini-contrib/pull/34#issuecomment-29683659
+func ensureNotPointer(obj interface{}) {
+ if reflect.TypeOf(obj).Kind() == reflect.Ptr {
+ panic("Pointers are not accepted as binding models")
+ }
+}
+
+// Performs validation and combines errors from validation
+// with errors from deserialization, then maps both the
+// resulting struct and the errors to the context.
+func validateAndMap(obj reflect.Value, context martini.Context, errors *BindingErrors, ifacePtr ...interface{}) {
+ context.Invoke(Validate(obj.Interface()))
+ errors.Combine(getErrors(context))
+ context.Map(*errors)
+ context.Map(obj.Elem().Interface())
+ if len(ifacePtr) > 0 {
+ context.MapTo(obj.Elem().Interface(), ifacePtr[0])
+ }
+}
+
+func newErrors() *BindingErrors {
+ return &BindingErrors{make(map[string]string), make(map[string]string)}
+}
+
+func getErrors(context martini.Context) BindingErrors {
+ return context.Get(reflect.TypeOf(BindingErrors{})).Interface().(BindingErrors)
+}
+
+type (
+ // Implement the Validator interface to define your own input
+ // validation before the request even gets to your application.
+ // The Validate method will be executed during the validation phase.
+ Validator interface {
+ Validate(*BindingErrors, *http.Request, martini.Context)
+ }
+)
+
+var (
+ // Maximum amount of memory to use when parsing a multipart form.
+ // Set this to whatever value you prefer; default is 10 MB.
+ MaxMemory = int64(1024 * 1024 * 10)
+)
+
+// Errors represents the contract of the response body when the
+// binding step fails before getting to the application.
+type BindingErrors struct {
+ Overall map[string]string `json:"overall"`
+ Fields map[string]string `json:"fields"`
+}
+
+// Total errors is the sum of errors with the request overall
+// and errors on individual fields.
+func (err BindingErrors) Count() int {
+ return len(err.Overall) + len(err.Fields)
+}
+
+func (this *BindingErrors) Combine(other BindingErrors) {
+ for key, val := range other.Fields {
+ if _, exists := this.Fields[key]; !exists {
+ this.Fields[key] = val
+ }
+ }
+ for key, val := range other.Overall {
+ if _, exists := this.Overall[key]; !exists {
+ this.Overall[key] = val
+ }
+ }
+}
+
+const (
+ BindingRequireError string = "Required"
+ BindingAlphaDashError string = "AlphaDash"
+ BindingAlphaDashDotError string = "AlphaDashDot"
+ BindingMinSizeError string = "MinSize"
+ BindingMaxSizeError string = "MaxSize"
+ BindingEmailError string = "Email"
+ BindingUrlError string = "Url"
+ BindingDeserializationError string = "DeserializationError"
+ BindingIntegerTypeError string = "IntegerTypeError"
+ BindingBooleanTypeError string = "BooleanTypeError"
+ BindingFloatTypeError string = "FloatTypeError"
+)
diff --git a/modules/middleware/binding/binding_test.go b/modules/middleware/binding/binding_test.go
new file mode 100644
index 0000000000..c39fbd2a5b
--- /dev/null
+++ b/modules/middleware/binding/binding_test.go
@@ -0,0 +1,701 @@
+// Copyright 2013 The Martini Contrib Authors. All rights reserved.
+// Copyright 2014 The Gogs Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package binding
+
+import (
+ "bytes"
+ "mime/multipart"
+ "net/http"
+ "net/http/httptest"
+ "strconv"
+ "strings"
+ "testing"
+
+ "github.com/codegangsta/martini"
+)
+
+func TestBind(t *testing.T) {
+ testBind(t, false)
+}
+
+func TestBindWithInterface(t *testing.T) {
+ testBind(t, true)
+}
+
+func TestMultipartBind(t *testing.T) {
+ index := 0
+ for test, expectStatus := range bindMultipartTests {
+ handler := func(post BlogPost, errors Errors) {
+ handle(test, t, index, post, errors)
+ }
+ recorder := testMultipart(t, test, Bind(BlogPost{}), handler, index)
+
+ if recorder.Code != expectStatus {
+ t.Errorf("On test case %v, got status code %d but expected %d", test, recorder.Code, expectStatus)
+ }
+
+ index++
+ }
+}
+
+func TestForm(t *testing.T) {
+ testForm(t, false)
+}
+
+func TestFormWithInterface(t *testing.T) {
+ testForm(t, true)
+}
+
+func TestEmptyForm(t *testing.T) {
+ testEmptyForm(t)
+}
+
+func TestMultipartForm(t *testing.T) {
+ for index, test := range multipartformTests {
+ handler := func(post BlogPost, errors Errors) {
+ handle(test, t, index, post, errors)
+ }
+ testMultipart(t, test, MultipartForm(BlogPost{}), handler, index)
+ }
+}
+
+func TestMultipartFormWithInterface(t *testing.T) {
+ for index, test := range multipartformTests {
+ handler := func(post Modeler, errors Errors) {
+ post.Create(test, t, index)
+ }
+ testMultipart(t, test, MultipartForm(BlogPost{}, (*Modeler)(nil)), handler, index)
+ }
+}
+
+func TestJson(t *testing.T) {
+ testJson(t, false)
+}
+
+func TestJsonWithInterface(t *testing.T) {
+ testJson(t, true)
+}
+
+func TestEmptyJson(t *testing.T) {
+ testEmptyJson(t)
+}
+
+func TestValidate(t *testing.T) {
+ handlerMustErr := func(errors Errors) {
+ if errors.Count() == 0 {
+ t.Error("Expected at least one error, got 0")
+ }
+ }
+ handlerNoErr := func(errors Errors) {
+ if errors.Count() > 0 {
+ t.Error("Expected no errors, got", errors.Count())
+ }
+ }
+
+ performValidationTest(&BlogPost{"", "...", 0, 0, []int{}}, handlerMustErr, t)
+ performValidationTest(&BlogPost{"Good Title", "Good content", 0, 0, []int{}}, handlerNoErr, t)
+
+ performValidationTest(&User{Name: "Jim", Home: Address{"", ""}}, handlerMustErr, t)
+ performValidationTest(&User{Name: "Jim", Home: Address{"required", ""}}, handlerNoErr, t)
+}
+
+func handle(test testCase, t *testing.T, index int, post BlogPost, errors Errors) {
+ assertEqualField(t, "Title", index, test.ref.Title, post.Title)
+ assertEqualField(t, "Content", index, test.ref.Content, post.Content)
+ assertEqualField(t, "Views", index, test.ref.Views, post.Views)
+
+ for i := range test.ref.Multiple {
+ if i >= len(post.Multiple) {
+ t.Errorf("Expected: %v (size %d) to have same size as: %v (size %d)", post.Multiple, len(post.Multiple), test.ref.Multiple, len(test.ref.Multiple))
+ break
+ }
+ if test.ref.Multiple[i] != post.Multiple[i] {
+ t.Errorf("Expected: %v to deep equal: %v", post.Multiple, test.ref.Multiple)
+ break
+ }
+ }
+
+ if test.ok && errors.Count() > 0 {
+ t.Errorf("%+v should be OK (0 errors), but had errors: %+v", test, errors)
+ } else if !test.ok && errors.Count() == 0 {
+ t.Errorf("%+v should have errors, but was OK (0 errors)", test)
+ }
+}
+
+func handleEmpty(test emptyPayloadTestCase, t *testing.T, index int, section BlogSection, errors Errors) {
+ assertEqualField(t, "Title", index, test.ref.Title, section.Title)
+ assertEqualField(t, "Content", index, test.ref.Content, section.Content)
+
+ if test.ok && errors.Count() > 0 {
+ t.Errorf("%+v should be OK (0 errors), but had errors: %+v", test, errors)
+ } else if !test.ok && errors.Count() == 0 {
+ t.Errorf("%+v should have errors, but was OK (0 errors)", test)
+ }
+}
+
+func testBind(t *testing.T, withInterface bool) {
+ index := 0
+ for test, expectStatus := range bindTests {
+ m := martini.Classic()
+ recorder := httptest.NewRecorder()
+ handler := func(post BlogPost, errors Errors) { handle(test, t, index, post, errors) }
+ binding := Bind(BlogPost{})
+
+ if withInterface {
+ handler = func(post BlogPost, errors Errors) {
+ post.Create(test, t, index)
+ }
+ binding = Bind(BlogPost{}, (*Modeler)(nil))
+ }
+
+ switch test.method {
+ case "GET":
+ m.Get(route, binding, handler)
+ case "POST":
+ m.Post(route, binding, handler)
+ }
+
+ req, err := http.NewRequest(test.method, test.path, strings.NewReader(test.payload))
+ req.Header.Add("Content-Type", test.contentType)
+
+ if err != nil {
+ t.Error(err)
+ }
+ m.ServeHTTP(recorder, req)
+
+ if recorder.Code != expectStatus {
+ t.Errorf("On test case %v, got status code %d but expected %d", test, recorder.Code, expectStatus)
+ }
+
+ index++
+ }
+}
+
+func testJson(t *testing.T, withInterface bool) {
+ for index, test := range jsonTests {
+ recorder := httptest.NewRecorder()
+ handler := func(post BlogPost, errors Errors) { handle(test, t, index, post, errors) }
+ binding := Json(BlogPost{})
+
+ if withInterface {
+ handler = func(post BlogPost, errors Errors) {
+ post.Create(test, t, index)
+ }
+ binding = Bind(BlogPost{}, (*Modeler)(nil))
+ }
+
+ m := martini.Classic()
+ switch test.method {
+ case "GET":
+ m.Get(route, binding, handler)
+ case "POST":
+ m.Post(route, binding, handler)
+ case "PUT":
+ m.Put(route, binding, handler)
+ case "DELETE":
+ m.Delete(route, binding, handler)
+ }
+
+ req, err := http.NewRequest(test.method, route, strings.NewReader(test.payload))
+ if err != nil {
+ t.Error(err)
+ }
+ m.ServeHTTP(recorder, req)
+ }
+}
+
+func testEmptyJson(t *testing.T) {
+ for index, test := range emptyPayloadTests {
+ recorder := httptest.NewRecorder()
+ handler := func(section BlogSection, errors Errors) { handleEmpty(test, t, index, section, errors) }
+ binding := Json(BlogSection{})
+
+ m := martini.Classic()
+ switch test.method {
+ case "GET":
+ m.Get(route, binding, handler)
+ case "POST":
+ m.Post(route, binding, handler)
+ case "PUT":
+ m.Put(route, binding, handler)
+ case "DELETE":
+ m.Delete(route, binding, handler)
+ }
+
+ req, err := http.NewRequest(test.method, route, strings.NewReader(test.payload))
+ if err != nil {
+ t.Error(err)
+ }
+ m.ServeHTTP(recorder, req)
+ }
+}
+
+func testForm(t *testing.T, withInterface bool) {
+ for index, test := range formTests {
+ recorder := httptest.NewRecorder()
+ handler := func(post BlogPost, errors Errors) { handle(test, t, index, post, errors) }
+ binding := Form(BlogPost{})
+
+ if withInterface {
+ handler = func(post BlogPost, errors Errors) {
+ post.Create(test, t, index)
+ }
+ binding = Form(BlogPost{}, (*Modeler)(nil))
+ }
+
+ m := martini.Classic()
+ switch test.method {
+ case "GET":
+ m.Get(route, binding, handler)
+ case "POST":
+ m.Post(route, binding, handler)
+ }
+
+ req, err := http.NewRequest(test.method, test.path, nil)
+ if err != nil {
+ t.Error(err)
+ }
+ m.ServeHTTP(recorder, req)
+ }
+}
+
+func testEmptyForm(t *testing.T) {
+ for index, test := range emptyPayloadTests {
+ recorder := httptest.NewRecorder()
+ handler := func(section BlogSection, errors Errors) { handleEmpty(test, t, index, section, errors) }
+ binding := Form(BlogSection{})
+
+ m := martini.Classic()
+ switch test.method {
+ case "GET":
+ m.Get(route, binding, handler)
+ case "POST":
+ m.Post(route, binding, handler)
+ }
+
+ req, err := http.NewRequest(test.method, test.path, nil)
+ if err != nil {
+ t.Error(err)
+ }
+ m.ServeHTTP(recorder, req)
+ }
+}
+
+func testMultipart(t *testing.T, test testCase, middleware martini.Handler, handler martini.Handler, index int) *httptest.ResponseRecorder {
+ recorder := httptest.NewRecorder()
+
+ m := martini.Classic()
+ m.Post(route, middleware, handler)
+
+ body := &bytes.Buffer{}
+ writer := multipart.NewWriter(body)
+ writer.WriteField("title", test.ref.Title)
+ writer.WriteField("content", test.ref.Content)
+ writer.WriteField("views", strconv.Itoa(test.ref.Views))
+ if len(test.ref.Multiple) != 0 {
+ for _, value := range test.ref.Multiple {
+ writer.WriteField("multiple", strconv.Itoa(value))
+ }
+ }
+
+ req, err := http.NewRequest(test.method, test.path, body)
+ req.Header.Add("Content-Type", writer.FormDataContentType())
+
+ if err != nil {
+ t.Error(err)
+ }
+
+ err = writer.Close()
+ if err != nil {
+ t.Error(err)
+ }
+
+ m.ServeHTTP(recorder, req)
+
+ return recorder
+}
+
+func assertEqualField(t *testing.T, fieldname string, testcasenumber int, expected interface{}, got interface{}) {
+ if expected != got {
+ t.Errorf("%s: expected=%s, got=%s in test case %d\n", fieldname, expected, got, testcasenumber)
+ }
+}
+
+func performValidationTest(data interface{}, handler func(Errors), t *testing.T) {
+ recorder := httptest.NewRecorder()
+ m := martini.Classic()
+ m.Get(route, Validate(data), handler)
+
+ req, err := http.NewRequest("GET", route, nil)
+ if err != nil {
+ t.Error("HTTP error:", err)
+ }
+
+ m.ServeHTTP(recorder, req)
+}
+
+func (self BlogPost) Validate(errors *Errors, req *http.Request) {
+ if len(self.Title) < 4 {
+ errors.Fields["Title"] = "Too short; minimum 4 characters"
+ }
+ if len(self.Content) > 1024 {
+ errors.Fields["Content"] = "Too long; maximum 1024 characters"
+ }
+ if len(self.Content) < 5 {
+ errors.Fields["Content"] = "Too short; minimum 5 characters"
+ }
+}
+
+func (self BlogPost) Create(test testCase, t *testing.T, index int) {
+ assertEqualField(t, "Title", index, test.ref.Title, self.Title)
+ assertEqualField(t, "Content", index, test.ref.Content, self.Content)
+ assertEqualField(t, "Views", index, test.ref.Views, self.Views)
+
+ for i := range test.ref.Multiple {
+ if i >= len(self.Multiple) {
+ t.Errorf("Expected: %v (size %d) to have same size as: %v (size %d)", self.Multiple, len(self.Multiple), test.ref.Multiple, len(test.ref.Multiple))
+ break
+ }
+ if test.ref.Multiple[i] != self.Multiple[i] {
+ t.Errorf("Expected: %v to deep equal: %v", self.Multiple, test.ref.Multiple)
+ break
+ }
+ }
+}
+
+func (self BlogSection) Create(test emptyPayloadTestCase, t *testing.T, index int) {
+ // intentionally left empty
+}
+
+type (
+ testCase struct {
+ method string
+ path string
+ payload string
+ contentType string
+ ok bool
+ ref *BlogPost
+ }
+
+ emptyPayloadTestCase struct {
+ method string
+ path string
+ payload string
+ contentType string
+ ok bool
+ ref *BlogSection
+ }
+
+ Modeler interface {
+ Create(test testCase, t *testing.T, index int)
+ }
+
+ BlogPost struct {
+ Title string `form:"title" json:"title" binding:"required"`
+ Content string `form:"content" json:"content"`
+ Views int `form:"views" json:"views"`
+ internal int `form:"-"`
+ Multiple []int `form:"multiple"`
+ }
+
+ BlogSection struct {
+ Title string `form:"title" json:"title"`
+ Content string `form:"content" json:"content"`
+ }
+
+ User struct {
+ Name string `json:"name" binding:"required"`
+ Home Address `json:"address" binding:"required"`
+ }
+
+ Address struct {
+ Street1 string `json:"street1" binding:"required"`
+ Street2 string `json:"street2"`
+ }
+)
+
+var (
+ bindTests = map[testCase]int{
+ // These should bail at the deserialization/binding phase
+ testCase{
+ "POST",
+ path,
+ `{ bad JSON `,
+ "application/json",
+ false,
+ new(BlogPost),
+ }: http.StatusBadRequest,
+ testCase{
+ "POST",
+ path,
+ `not multipart but has content-type`,
+ "multipart/form-data",
+ false,
+ new(BlogPost),
+ }: http.StatusBadRequest,
+ testCase{
+ "POST",
+ path,
+ `no content-type and not URL-encoded or JSON"`,
+ "",
+ false,
+ new(BlogPost),
+ }: http.StatusBadRequest,
+
+ // These should deserialize, then bail at the validation phase
+ testCase{
+ "POST",
+ path + "?title= This is wrong ",
+ `not URL-encoded but has content-type`,
+ "x-www-form-urlencoded",
+ false,
+ new(BlogPost),
+ }: 422, // according to comments in Form() -> although the request is not url encoded, ParseForm does not complain
+ testCase{
+ "GET",
+ path + "?content=This+is+the+content",
+ ``,
+ "x-www-form-urlencoded",
+ false,
+ &BlogPost{Title: "", Content: "This is the content"},
+ }: 422,
+ testCase{
+ "GET",
+ path + "",
+ `{"content":"", "title":"Blog Post Title"}`,
+ "application/json",
+ false,
+ &BlogPost{Title: "Blog Post Title", Content: ""},
+ }: 422,
+
+ // These should succeed
+ testCase{
+ "GET",
+ path + "",
+ `{"content":"This is the content", "title":"Blog Post Title"}`,
+ "application/json",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ }: http.StatusOK,
+ testCase{
+ "GET",
+ path + "?content=This+is+the+content&title=Blog+Post+Title",
+ ``,
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ }: http.StatusOK,
+ testCase{
+ "GET",
+ path + "?content=This is the content&title=Blog+Post+Title",
+ `{"content":"This is the content", "title":"Blog Post Title"}`,
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ }: http.StatusOK,
+ testCase{
+ "GET",
+ path + "",
+ `{"content":"This is the content", "title":"Blog Post Title"}`,
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ }: http.StatusOK,
+ }
+
+ bindMultipartTests = map[testCase]int{
+ // This should deserialize, then bail at the validation phase
+ testCase{
+ "POST",
+ path,
+ "",
+ "multipart/form-data",
+ false,
+ &BlogPost{Title: "", Content: "This is the content"},
+ }: 422,
+ // This should succeed
+ testCase{
+ "POST",
+ path,
+ "",
+ "multipart/form-data",
+ true,
+ &BlogPost{Title: "This is the Title", Content: "This is the content"},
+ }: http.StatusOK,
+ }
+
+ formTests = []testCase{
+ {
+ "GET",
+ path + "?content=This is the content",
+ "",
+ "",
+ false,
+ &BlogPost{Title: "", Content: "This is the content"},
+ },
+ {
+ "POST",
+ path + "?content=This+is+the+content&title=Blog+Post+Title&views=3",
+ "",
+ "",
+ false, // false because POST requests should have a body, not just a query string
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content", Views: 3},
+ },
+ {
+ "GET",
+ path + "?content=This+is+the+content&title=Blog+Post+Title&views=3&multiple=5&multiple=10&multiple=15&multiple=20",
+ "",
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content", Views: 3, Multiple: []int{5, 10, 15, 20}},
+ },
+ }
+
+ multipartformTests = []testCase{
+ {
+ "POST",
+ path,
+ "",
+ "multipart/form-data",
+ false,
+ &BlogPost{Title: "", Content: "This is the content"},
+ },
+ {
+ "POST",
+ path,
+ "",
+ "multipart/form-data",
+ false,
+ &BlogPost{Title: "Blog Post Title", Views: 3},
+ },
+ {
+ "POST",
+ path,
+ "",
+ "multipart/form-data",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content", Views: 3, Multiple: []int{5, 10, 15, 20}},
+ },
+ }
+
+ emptyPayloadTests = []emptyPayloadTestCase{
+ {
+ "GET",
+ "",
+ "",
+ "",
+ true,
+ &BlogSection{},
+ },
+ {
+ "POST",
+ "",
+ "",
+ "",
+ true,
+ &BlogSection{},
+ },
+ {
+ "PUT",
+ "",
+ "",
+ "",
+ true,
+ &BlogSection{},
+ },
+ {
+ "DELETE",
+ "",
+ "",
+ "",
+ true,
+ &BlogSection{},
+ },
+ }
+
+ jsonTests = []testCase{
+ // bad requests
+ {
+ "GET",
+ "",
+ `{blah blah blah}`,
+ "",
+ false,
+ &BlogPost{},
+ },
+ {
+ "POST",
+ "",
+ `{asdf}`,
+ "",
+ false,
+ &BlogPost{},
+ },
+ {
+ "PUT",
+ "",
+ `{blah blah blah}`,
+ "",
+ false,
+ &BlogPost{},
+ },
+ {
+ "DELETE",
+ "",
+ `{;sdf _SDf- }`,
+ "",
+ false,
+ &BlogPost{},
+ },
+
+ // Valid-JSON requests
+ {
+ "GET",
+ "",
+ `{"content":"This is the content"}`,
+ "",
+ false,
+ &BlogPost{Title: "", Content: "This is the content"},
+ },
+ {
+ "POST",
+ "",
+ `{}`,
+ "application/json",
+ false,
+ &BlogPost{Title: "", Content: ""},
+ },
+ {
+ "POST",
+ "",
+ `{"content":"This is the content", "title":"Blog Post Title"}`,
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ },
+ {
+ "PUT",
+ "",
+ `{"content":"This is the content", "title":"Blog Post Title"}`,
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ },
+ {
+ "DELETE",
+ "",
+ `{"content":"This is the content", "title":"Blog Post Title"}`,
+ "",
+ true,
+ &BlogPost{Title: "Blog Post Title", Content: "This is the content"},
+ },
+ }
+)
+
+const (
+ route = "/blogposts/create"
+ path = "http://localhost:3000" + route
+)