From 449866ced2faaadb6ef9c39fd65194b101a8a46b Mon Sep 17 00:00:00 2001 From: Chen Lei Date: Mon, 12 Jun 2023 11:33:10 +0800 Subject: [PATCH] add customized gin validator (#119) * add customized gin validator * add more test case * update go version --- http/wegin/engine.go | 23 ++++++ http/wegin/engine_test.go | 154 ++++++++++++++++++++++++++++++++++++++ http/wegin/go.mod | 37 +++++++++ http/wegin/go.sum | 85 +++++++++++++++++++++ http/wegin/validator.go | 25 +++++++ 5 files changed, 324 insertions(+) create mode 100644 http/wegin/engine.go create mode 100644 http/wegin/engine_test.go create mode 100644 http/wegin/go.mod create mode 100644 http/wegin/go.sum create mode 100644 http/wegin/validator.go diff --git a/http/wegin/engine.go b/http/wegin/engine.go new file mode 100644 index 0000000..119ab87 --- /dev/null +++ b/http/wegin/engine.go @@ -0,0 +1,23 @@ +package wegin + +import ( + "github.com/gin-gonic/gin" + "github.com/gin-gonic/gin/binding" + "github.com/go-playground/validator/v10" +) + +// New returns a new gin engine with custom validators +func New() *gin.Engine { + e := gin.New() + for key, value := range fieldValidators { + if v, ok := binding.Validator.Engine().(*validator.Validate); ok { + _ = v.RegisterValidation(key, value) + } + } + for key, value := range structValidators { + if v, ok := binding.Validator.Engine().(*validator.Validate); ok { + v.RegisterStructValidation(value, key) + } + } + return e +} diff --git a/http/wegin/engine_test.go b/http/wegin/engine_test.go new file mode 100644 index 0000000..413ff4d --- /dev/null +++ b/http/wegin/engine_test.go @@ -0,0 +1,154 @@ +package wegin_test + +import ( + "fmt" + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/suite" + "github.com/wego/pkg/http/wegin" + "net/http" + "net/http/httptest" + "strings" + "testing" +) + +type testStruct struct { + Reference string `json:"reference" binding:"required,alphanum_with_underscore_or_dash"` + ReferencePointer *string `json:"reference_pointer" binding:"required,alphanum_with_underscore_or_dash"` +} + +func testHandler(c *gin.Context) { + var b testStruct + if err := c.ShouldBindJSON(&b); err == nil { + c.JSON(http.StatusOK, b) + } else { + c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + } +} + +var ( + testEndpoint = "/test" +) + +type EngineSuite struct { + suite.Suite + router *gin.Engine +} + +func TestHandlers(t *testing.T) { + suite.Run(t, new(EngineSuite)) +} + +// SetupTest runs before each Test +func (s *EngineSuite) SetupTest() { + gin.SetMode(gin.TestMode) + s.router = wegin.New() + s.router.POST(testEndpoint, testHandler) +} + +func (s *EngineSuite) Test_AlphaNumWithUnderscoreOrDash() { + for _, testCase := range []struct { + name string + refKey string + refValue string + refPointerKey string + refPointerValue string + expectedStatus int + expectedBodies []string + }{ + { + name: "empty", + refKey: "reference", + refValue: "", + expectedStatus: http.StatusBadRequest, + expectedBodies: []string{ + "Key: 'testStruct.Reference' Error:Field validation for 'Reference' failed on the 'required' tag", + "Key: 'testStruct.ReferencePointer' Error:Field validation for 'ReferencePointer' failed on the 'required' tag", + }, + }, + { + name: "empty value", + refPointerKey: "reference_pointer", + refPointerValue: "", + expectedStatus: http.StatusBadRequest, + expectedBodies: []string{ + "Key: 'testStruct.Reference' Error:Field validation for 'Reference' failed on the 'required' tag", + "Key: 'testStruct.ReferencePointer' Error:Field validation for 'ReferencePointer' failed on the 'alphanum_with_underscore_or_dash' tag", + }, + }, + { + name: "all space", + refKey: "reference", + refValue: " ", + refPointerKey: "reference_pointer", + refPointerValue: " ", + expectedStatus: http.StatusBadRequest, + expectedBodies: []string{ + "Key: 'testStruct.Reference' Error:Field validation for 'Reference' failed on the 'alphanum_with_underscore_or_dash' tag", + "Key: 'testStruct.ReferencePointer' Error:Field validation for 'ReferencePointer' failed on the 'alphanum_with_underscore_or_dash' tag", + }, + }, + { + name: "alphanum with space", + refKey: "reference", + refValue: "abc def", + refPointerKey: "reference_pointer", + refPointerValue: "abc def", + expectedStatus: http.StatusBadRequest, + expectedBodies: []string{ + "Key: 'testStruct.Reference' Error:Field validation for 'Reference' failed on the 'alphanum_with_underscore_or_dash' tag", + "Key: 'testStruct.ReferencePointer' Error:Field validation for 'ReferencePointer' failed on the 'alphanum_with_underscore_or_dash' tag", + }, + }, + { + name: "alphanum with underscore", + refKey: "reference", + refValue: "abc123_def", + refPointerKey: "reference_pointer", + refPointerValue: "abc123_def", + expectedStatus: http.StatusOK, + expectedBodies: []string{ + `"reference":"abc123_def"`, + `"reference_pointer":"abc123_def"`, + }, + }, + { + name: "alphanum with dash", + refKey: "reference", + refValue: "abc123-def", + refPointerKey: "reference_pointer", + refPointerValue: "abc123-def", + expectedStatus: http.StatusOK, + expectedBodies: []string{ + `"reference":"abc123-def"`, + `"reference_pointer":"abc123-def"`, + }, + }, + { + name: "alphanum with underscore and dash", + refKey: "reference", + refValue: "abc123_def-ghi", + refPointerKey: "reference_pointer", + refPointerValue: "abc123_def-ghi", + expectedStatus: http.StatusOK, + expectedBodies: []string{ + `"reference":"abc123_def-ghi"`, + `"reference_pointer":"abc123_def-ghi"`, + }, + }, + } { + s.Run(testCase.name, func() { + req, err := http.NewRequest(http.MethodPost, testEndpoint, + strings.NewReader(fmt.Sprintf(`{"%s":"%s", "%s": "%s"}`, + testCase.refKey, testCase.refValue, testCase.refPointerKey, testCase.refPointerValue))) + s.NoError(err) + + r := httptest.NewRecorder() + s.router.ServeHTTP(r, req) + + s.Equal(testCase.expectedStatus, r.Code) + for _, body := range testCase.expectedBodies { + s.Contains(r.Body.String(), body) + } + }) + } +} diff --git a/http/wegin/go.mod b/http/wegin/go.mod new file mode 100644 index 0000000..90d4c2b --- /dev/null +++ b/http/wegin/go.mod @@ -0,0 +1,37 @@ +module github.com/wego/pkg/http/wegin + +go 1.19 + +require ( + github.com/gin-gonic/gin v1.9.1 + github.com/go-playground/validator/v10 v10.14.1 + github.com/stretchr/testify v1.8.3 +) + +require ( + github.com/bytedance/sonic v1.9.1 // indirect + github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/gabriel-vasile/mimetype v1.4.2 // indirect + github.com/gin-contrib/sse v0.1.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/goccy/go-json v0.10.2 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/klauspost/cpuid/v2 v2.2.4 // indirect + github.com/leodido/go-urn v1.2.4 // indirect + github.com/mattn/go-isatty v0.0.19 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.0.8 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.2.11 // indirect + golang.org/x/arch v0.3.0 // indirect + golang.org/x/crypto v0.9.0 // indirect + golang.org/x/net v0.10.0 // indirect + golang.org/x/sys v0.8.0 // indirect + golang.org/x/text v0.9.0 // indirect + google.golang.org/protobuf v1.30.0 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/http/wegin/go.sum b/http/wegin/go.sum new file mode 100644 index 0000000..3f78974 --- /dev/null +++ b/http/wegin/go.sum @@ -0,0 +1,85 @@ +github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM= +github.com/bytedance/sonic v1.9.1 h1:6iJ6NqdoxCDr6mbY8h18oSO+cShGSMRGCEo7F2h0x8s= +github.com/bytedance/sonic v1.9.1/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U= +github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY= +github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 h1:qSGYFH7+jGhDF8vLC+iwCD4WpbV1EBDSzWkJODFLams= +github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gabriel-vasile/mimetype v1.4.2 h1:w5qFW6JKBz9Y393Y4q372O9A7cUSequkh1Q7OhCmWKU= +github.com/gabriel-vasile/mimetype v1.4.2/go.mod h1:zApsH/mKG4w07erKIaJPFiX0Tsq9BFQgN3qGY5GnNgA= +github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= +github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.9.1 h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqJ+Jmg= +github.com/gin-gonic/gin v1.9.1/go.mod h1:hPrL7YrpYKXt5YId3A/Tnip5kqbEAP+KLuI3SUcPTeU= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.14.1 h1:9c50NUPC30zyuKprjL3vNZ0m5oG+jU0zvx4AqHGnv4k= +github.com/go-playground/validator/v10 v10.14.1/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU= +github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= +github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= +github.com/klauspost/cpuid/v2 v2.2.4 h1:acbojRNwl3o09bUq+yDCtZFc1aiwaAAxtcn8YkZXnvk= +github.com/klauspost/cpuid/v2 v2.2.4/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY= +github.com/leodido/go-urn v1.2.4 h1:XlAE/cm/ms7TE/VMVoduSpNBoyc2dOxHs5MZSwAN63Q= +github.com/leodido/go-urn v1.2.4/go.mod h1:7ZrI8mTSeBSHl/UaRyKQW1qZeMgak41ANeCNaVckg+4= +github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/pelletier/go-toml/v2 v2.0.8 h1:0ctb6s9mE31h0/lhu+J6OPmVeDxJn+kYnJc2jZR9tGQ= +github.com/pelletier/go-toml/v2 v2.0.8/go.mod h1:vuYfssBdrU2XDZ9bYydBu6t+6a6PYNcZljzZR9VXg+4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= +github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU= +github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= +golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= +golang.org/x/arch v0.3.0 h1:02VY4/ZcO/gBOH6PUaoiptASxtXU10jazRCP865E97k= +golang.org/x/arch v0.3.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= +golang.org/x/crypto v0.9.0 h1:LF6fAI+IutBocDJ2OT0Q1g8plpYljMZ4+lty+dsqw3g= +golang.org/x/crypto v0.9.0/go.mod h1:yrmDGqONDYtNj3tH8X9dzUun2m2lzPa9ngI6/RUPGR0= +golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/sys v0.0.0-20220704084225-05e143d24a9e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng= +google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= diff --git a/http/wegin/validator.go b/http/wegin/validator.go new file mode 100644 index 0000000..5363fa3 --- /dev/null +++ b/http/wegin/validator.go @@ -0,0 +1,25 @@ +package wegin + +import ( + "github.com/go-playground/validator/v10" + "regexp" +) + +var ( + alphaNumWithUnderscoreOrDashRegexString = `^[a-zA-Z0-9_\-]+$` +) + +var ( + alphaNumWithUnderscoreOrDashRegex = regexp.MustCompile(alphaNumWithUnderscoreOrDashRegexString) +) + +var ( + fieldValidators = map[string]validator.Func{ + "alphanum_with_underscore_or_dash": alphaNumWithUnderscoreOrDash, + } + structValidators = map[any]validator.StructLevelFunc{} +) + +var alphaNumWithUnderscoreOrDash validator.Func = func(fl validator.FieldLevel) bool { + return alphaNumWithUnderscoreOrDashRegex.MatchString(fl.Field().String()) +}