gf/util/gvalid/gvalid_z_unit_feature_custom_rule_test.go
2023-03-13 22:16:57 +08:00

313 lines
7.9 KiB
Go

// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gvalid_test
import (
"context"
"errors"
"testing"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/test/gtest"
"github.com/gogf/gf/v2/util/guid"
"github.com/gogf/gf/v2/util/gvalid"
)
func Test_CustomRule1(t *testing.T) {
rule := "custom"
gvalid.RegisterRule(
rule,
func(ctx context.Context, in gvalid.RuleFuncInput) error {
pass := in.Value.String()
if len(pass) != 6 {
return errors.New(in.Message)
}
m := in.Data.Map()
if m["data"] != pass {
return errors.New(in.Message)
}
return nil
},
)
gtest.C(t, func(t *gtest.T) {
err := g.Validator().Data("123456").Rules(rule).Messages("custom message").Run(ctx)
t.Assert(err.String(), "custom message")
err = g.Validator().Data("123456").Assoc(g.Map{"data": "123456"}).Rules(rule).Messages("custom message").Run(ctx)
t.AssertNil(err)
})
// Error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@custom#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "123",
Data: "123456",
}
err := g.Validator().Data(st).Run(ctx)
t.Assert(err.String(), "自定义错误")
})
// No error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@custom#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "123456",
Data: "123456",
}
err := g.Validator().Data(st).Run(ctx)
t.AssertNil(err)
})
}
func Test_CustomRule2(t *testing.T) {
rule := "required-map"
gvalid.RegisterRule(rule, func(ctx context.Context, in gvalid.RuleFuncInput) error {
m := in.Value.Map()
if len(m) == 0 {
return errors.New(in.Message)
}
return nil
})
// Check.
gtest.C(t, func(t *gtest.T) {
errStr := "data map should not be empty"
t.Assert(g.Validator().Data(g.Map{}).Messages(errStr).Rules(rule).Run(ctx), errStr)
t.Assert(g.Validator().Data(g.Map{"k": "v"}).Rules(rule).Messages(errStr).Run(ctx), nil)
})
// Error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value map[string]string `v:"uid@required-map#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: map[string]string{},
Data: "123456",
}
err := g.Validator().Data(st).Run(ctx)
t.Assert(err.String(), "自定义错误")
})
// No error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value map[string]string `v:"uid@required-map#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: map[string]string{"k": "v"},
Data: "123456",
}
err := g.Validator().Data(st).Run(ctx)
t.AssertNil(err)
})
}
func Test_CustomRule_AllowEmpty(t *testing.T) {
rule := "allow-empty-str"
gvalid.RegisterRule(rule, func(ctx context.Context, in gvalid.RuleFuncInput) error {
s := in.Value.String()
if len(s) == 0 || s == "gf" {
return nil
}
return errors.New(in.Message)
})
// Check.
gtest.C(t, func(t *gtest.T) {
errStr := "error"
t.Assert(g.Validator().Data("").Rules(rule).Messages(errStr).Run(ctx), "")
t.Assert(g.Validator().Data("gf").Rules(rule).Messages(errStr).Run(ctx), "")
t.Assert(g.Validator().Data("gf2").Rules(rule).Messages(errStr).Run(ctx), errStr)
})
// Error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@allow-empty-str#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "",
Data: "123456",
}
err := g.Validator().Data(st).Run(ctx)
t.AssertNil(err)
})
// No error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@allow-empty-str#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "john",
Data: "123456",
}
err := g.Validator().Data(st).Run(ctx)
t.Assert(err.String(), "自定义错误")
})
}
func TestValidator_RuleFunc(t *testing.T) {
ruleName := "custom_1"
ruleFunc := func(ctx context.Context, in gvalid.RuleFuncInput) error {
pass := in.Value.String()
if len(pass) != 6 {
return errors.New(in.Message)
}
if m := in.Data.Map(); m["data"] != pass {
return errors.New(in.Message)
}
return nil
}
gtest.C(t, func(t *gtest.T) {
err := g.Validator().Rules(ruleName).
Messages("custom message").
RuleFunc(ruleName, ruleFunc).
Data("123456").
Run(ctx)
t.Assert(err.String(), "custom message")
err = g.Validator().
Rules(ruleName).
Messages("custom message").
Data("123456").Assoc(g.Map{"data": "123456"}).
RuleFunc(ruleName, ruleFunc).
Run(ctx)
t.AssertNil(err)
})
// Error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@custom_1#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "123",
Data: "123456",
}
err := g.Validator().RuleFunc(ruleName, ruleFunc).Data(st).Run(ctx)
t.Assert(err.String(), "自定义错误")
})
// No error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@custom_1#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "123456",
Data: "123456",
}
err := g.Validator().RuleFunc(ruleName, ruleFunc).Data(st).Run(ctx)
t.AssertNil(err)
})
}
func TestValidator_RuleFuncMap(t *testing.T) {
ruleName := "custom_1"
ruleFunc := func(ctx context.Context, in gvalid.RuleFuncInput) error {
pass := in.Value.String()
if len(pass) != 6 {
return errors.New(in.Message)
}
if m := in.Data.Map(); m["data"] != pass {
return errors.New(in.Message)
}
return nil
}
gtest.C(t, func(t *gtest.T) {
err := g.Validator().
Rules(ruleName).
Messages("custom message").
RuleFuncMap(map[string]gvalid.RuleFunc{
ruleName: ruleFunc,
}).Data("123456").Run(ctx)
t.Assert(err.String(), "custom message")
err = g.Validator().
Rules(ruleName).
Messages("custom message").
Data("123456").Assoc(g.Map{"data": "123456"}).
RuleFuncMap(map[string]gvalid.RuleFunc{
ruleName: ruleFunc,
}).Run(ctx)
t.AssertNil(err)
})
// Error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@custom_1#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "123",
Data: "123456",
}
err := g.Validator().
RuleFuncMap(map[string]gvalid.RuleFunc{
ruleName: ruleFunc,
}).Data(st).Run(ctx)
t.Assert(err.String(), "自定义错误")
})
// No error with struct validation.
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@custom_1#自定义错误"`
Data string `p:"data"`
}
st := &T{
Value: "123456",
Data: "123456",
}
err := g.Validator().
RuleFuncMap(map[string]gvalid.RuleFunc{
ruleName: ruleFunc,
}).Data(st).Run(ctx)
t.AssertNil(err)
})
}
func Test_CustomRule_Overwrite(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var rule = "custom-" + guid.S()
gvalid.RegisterRule(rule, func(ctx context.Context, in gvalid.RuleFuncInput) error {
return gerror.New("1")
})
t.Assert(g.Validator().Rules(rule).Data(1).Run(ctx), "1")
gvalid.RegisterRule(rule, func(ctx context.Context, in gvalid.RuleFuncInput) error {
return gerror.New("2")
})
t.Assert(g.Validator().Rules(rule).Data(1).Run(ctx), "2")
})
g.Dump(gvalid.GetRegisteredRuleMap())
}
func Test_Issue2499(t *testing.T) {
ruleName := "required"
ruleFunc := func(ctx context.Context, in gvalid.RuleFuncInput) error {
return errors.New(in.Message)
}
gtest.C(t, func(t *gtest.T) {
type T struct {
Value string `v:"uid@required"`
Data string `p:"data"`
}
st := &T{
Value: "",
Data: "123456",
}
err := g.Validator().
RuleFuncMap(map[string]gvalid.RuleFunc{
ruleName: ruleFunc,
}).Data(st).Run(ctx)
t.Assert(err.String(), `The uid field is required`)
})
}