gin/binding/validate_test.go

229 lines
5.3 KiB
Go
Raw Normal View History

// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
2015-04-09 10:15:02 +00:00
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
package binding
import (
2016-01-26 18:28:26 +00:00
"bytes"
2015-04-09 10:15:02 +00:00
"testing"
2016-01-26 18:28:26 +00:00
"time"
2015-04-09 10:15:02 +00:00
"github.com/go-playground/validator/v10"
2015-04-09 10:15:02 +00:00
"github.com/stretchr/testify/assert"
)
2016-01-26 18:28:26 +00:00
type testInterface interface {
String() string
2015-04-09 10:15:02 +00:00
}
2016-04-14 23:16:46 +00:00
type substructNoValidation struct {
IString string
IInt int
2015-04-09 10:15:02 +00:00
}
2016-04-14 23:16:46 +00:00
type mapNoValidationSub map[string]substructNoValidation
2016-01-26 18:28:26 +00:00
2016-04-14 23:16:46 +00:00
type structNoValidationValues struct {
substructNoValidation
2016-01-26 18:28:26 +00:00
Boolean bool
Uinteger uint
2015-04-09 10:15:02 +00:00
Integer int
2016-01-26 18:28:26 +00:00
Integer8 int8
Integer16 int16
Integer32 int32
Integer64 int64
Uinteger8 uint8
Uinteger16 uint16
Uinteger32 uint32
Uinteger64 uint64
Float32 float32
Float64 float64
String string
Date time.Time
2016-04-14 23:16:46 +00:00
Struct substructNoValidation
2016-01-26 18:28:26 +00:00
InlinedStruct struct {
String []string
Integer int
}
IntSlice []int
IntPointerSlice []*int
2016-04-14 23:16:46 +00:00
StructPointerSlice []*substructNoValidation
StructSlice []substructNoValidation
2016-01-26 18:28:26 +00:00
InterfaceSlice []testInterface
2022-03-21 01:43:17 +00:00
UniversalInterface any
2016-01-26 18:28:26 +00:00
CustomInterface testInterface
FloatMap map[string]float32
StructMap mapNoValidationSub
2015-04-09 10:15:02 +00:00
}
2016-04-14 23:16:46 +00:00
func createNoValidationValues() structNoValidationValues {
2016-01-26 18:28:26 +00:00
integer := 1
2016-04-14 23:16:46 +00:00
s := structNoValidationValues{
2016-01-26 18:28:26 +00:00
Boolean: true,
Uinteger: 1 << 29,
Integer: -10000,
Integer8: 120,
Integer16: -20000,
Integer32: 1 << 29,
Integer64: 1 << 61,
Uinteger8: 250,
Uinteger16: 50000,
Uinteger32: 1 << 31,
Uinteger64: 1 << 62,
Float32: 123.456,
Float64: 123.456789,
String: "text",
Date: time.Time{},
CustomInterface: &bytes.Buffer{},
2016-04-14 23:16:46 +00:00
Struct: substructNoValidation{},
2016-01-26 18:28:26 +00:00
IntSlice: []int{-3, -2, 1, 0, 1, 2, 3},
IntPointerSlice: []*int{&integer},
2016-04-14 23:16:46 +00:00
StructSlice: []substructNoValidation{},
2016-01-26 18:28:26 +00:00
UniversalInterface: 1.2,
FloatMap: map[string]float32{
"foo": 1.23,
"bar": 232.323,
},
StructMap: mapNoValidationSub{
2016-04-14 23:16:46 +00:00
"foo": substructNoValidation{},
"bar": substructNoValidation{},
2015-04-09 10:15:02 +00:00
},
2016-01-26 18:28:26 +00:00
// StructPointerSlice []noValidationSub
// InterfaceSlice []testInterface
2015-04-09 10:15:02 +00:00
}
2016-01-26 18:28:26 +00:00
s.InlinedStruct.Integer = 1000
s.InlinedStruct.String = []string{"first", "second"}
2016-04-14 23:16:46 +00:00
s.IString = "substring"
s.IInt = 987654
2016-01-26 18:28:26 +00:00
return s
2015-04-09 10:15:02 +00:00
}
2016-01-26 18:28:26 +00:00
func TestValidateNoValidationValues(t *testing.T) {
2016-04-14 23:16:46 +00:00
origin := createNoValidationValues()
test := createNoValidationValues()
empty := structNoValidationValues{}
2016-01-26 18:28:26 +00:00
assert.Nil(t, validate(test))
2015-05-31 14:30:00 +00:00
assert.Nil(t, validate(&test))
2016-01-26 18:28:26 +00:00
assert.Nil(t, validate(empty))
assert.Nil(t, validate(&empty))
assert.Equal(t, origin, test)
2015-04-09 10:15:02 +00:00
}
2015-05-29 18:34:41 +00:00
2016-04-14 23:16:46 +00:00
type structNoValidationPointer struct {
substructNoValidation
2016-01-26 18:28:26 +00:00
Boolean bool
2015-05-29 18:34:41 +00:00
2016-01-26 18:28:26 +00:00
Uinteger *uint
Integer *int
Integer8 *int8
Integer16 *int16
Integer32 *int32
Integer64 *int64
Uinteger8 *uint8
Uinteger16 *uint16
Uinteger32 *uint32
Uinteger64 *uint64
2015-05-29 18:34:41 +00:00
2016-01-26 18:28:26 +00:00
Float32 *float32
Float64 *float64
String *string
Date *time.Time
2016-04-14 23:16:46 +00:00
Struct *substructNoValidation
2016-01-26 18:28:26 +00:00
IntSlice *[]int
IntPointerSlice *[]*int
2016-04-14 23:16:46 +00:00
StructPointerSlice *[]*substructNoValidation
StructSlice *[]substructNoValidation
2016-01-26 18:28:26 +00:00
InterfaceSlice *[]testInterface
FloatMap *map[string]float32
StructMap *mapNoValidationSub
}
func TestValidateNoValidationPointers(t *testing.T) {
//origin := createNoValidation_values()
//test := createNoValidation_values()
2016-04-14 23:16:46 +00:00
empty := structNoValidationPointer{}
2016-01-26 18:28:26 +00:00
//assert.Nil(t, validate(test))
//assert.Nil(t, validate(&test))
assert.Nil(t, validate(empty))
assert.Nil(t, validate(&empty))
//assert.Equal(t, origin, test)
}
2022-03-21 01:43:17 +00:00
type Object map[string]any
2016-01-26 18:28:26 +00:00
func TestValidatePrimitives(t *testing.T) {
obj := Object{"foo": "bar", "bar": 1}
2015-05-31 14:30:00 +00:00
assert.NoError(t, validate(obj))
assert.NoError(t, validate(&obj))
assert.Equal(t, Object{"foo": "bar", "bar": 1}, obj)
2016-01-26 18:28:26 +00:00
obj2 := []Object{{"foo": "bar", "bar": 1}, {"foo": "bar", "bar": 1}}
2015-05-31 14:30:00 +00:00
assert.NoError(t, validate(obj2))
assert.NoError(t, validate(&obj2))
2016-01-26 18:28:26 +00:00
nu := 10
2015-05-31 14:30:00 +00:00
assert.NoError(t, validate(nu))
assert.NoError(t, validate(&nu))
assert.Equal(t, 10, nu)
2016-01-26 18:28:26 +00:00
str := "value"
assert.NoError(t, validate(str))
assert.NoError(t, validate(&str))
assert.Equal(t, "value", str)
2015-05-29 18:34:41 +00:00
}
// structCustomValidation is a helper struct we use to check that
// custom validation can be registered on it.
// The `notone` binding directive is for custom validation and registered later.
type structCustomValidation struct {
Integer int `binding:"notone"`
}
func notOne(f1 validator.FieldLevel) bool {
if val, ok := f1.Field().Interface().(int); ok {
return val != 1
}
return false
}
func TestValidatorEngine(t *testing.T) {
// This validates that the function `notOne` matches
// the expected function signature by `defaultValidator`
// and by extension the validator library.
engine, ok := Validator.Engine().(*validator.Validate)
assert.True(t, ok)
err := engine.RegisterValidation("notone", notOne)
// Check that we can register custom validation without error
assert.Nil(t, err)
// Create an instance which will fail validation
withOne := structCustomValidation{Integer: 1}
errs := validate(withOne)
// Check that we got back non-nil errs
assert.NotNil(t, errs)
// Check that the error matches expectation
assert.Error(t, errs, "", "", "notone")
}