-
Notifications
You must be signed in to change notification settings - Fork 0
/
validation.go
168 lines (140 loc) · 4.36 KB
/
validation.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
// Copyright 2023 Emory.Du <orangeduxiaocheng@gmail.com>. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
package validation
import (
"fmt"
"os"
"reflect"
english "github.com/go-playground/locales/en"
ut "github.com/go-playground/universal-translator"
"github.com/go-playground/validator/v10"
"github.com/go-playground/validator/v10/translations/en"
"github.com/emorydu/component-base/pkg/validation/field"
)
const (
maxDescriptionLength = 255
)
// Validator is a custom validator for configs.
type Validator struct {
val *validator.Validate
data interface{}
trans ut.Translator
}
// NewValidator creates a new Validator.
func NewValidator(data interface{}) *Validator {
result := validator.New()
// independent validators
result.RegisterValidation("dir", validateDir) // nolint: errcheck // no need
result.RegisterValidation("file", validateFile) // nolint: errcheck // no need
result.RegisterValidation("description", validateDescription) // nolint: errcheck // no need
result.RegisterValidation("name", validateName) // nolint: errcheck // no need
// default translations
eng := english.New()
uni := ut.New(eng, eng)
trans, _ := uni.GetTranslator("en")
err := en.RegisterDefaultTranslations(result, trans)
if err != nil {
panic(err)
}
// additional translations
translations := []struct {
tag string
translation string
}{
{
tag: "dir",
translation: "{0} must point to an existing directory, but found '{1}'",
},
{
tag: "file",
translation: "{0} must point to an existing file, but found '{1}'",
},
{
tag: "description",
translation: fmt.Sprintf("must be less than %d", maxDescriptionLength),
},
{
tag: "name",
translation: "is not a invalid name",
},
}
for _, t := range translations {
err = result.RegisterTranslation(t.tag, trans, registrationFunc(t.tag, t.translation), translateFunc)
if err != nil {
panic(err)
}
}
return &Validator{
val: result,
data: data,
trans: trans,
}
}
func registrationFunc(tag string, translation string) validator.RegisterTranslationsFunc {
return func(ut ut.Translator) (err error) {
if err = ut.Add(tag, translation, true); err != nil {
return
}
return
}
}
func translateFunc(ut ut.Translator, fe validator.FieldError) string {
t, err := ut.T(fe.Tag(), fe.Field(), reflect.ValueOf(fe.Value()).String())
if err != nil {
return fe.(error).Error()
}
return t
}
// Validate validates config for errors and returns an error (it can be casted to
// ValidationErrors, containing a list of errors inside). When error is printed as string, it will
// automatically contains the full list of validation errors.
func (v *Validator) Validate() field.ErrorList {
// validate policy
err := v.val.Struct(v.data)
if err == nil {
return nil
}
// this check is only needed when your code could produce
// an invalid value for validation such as interface with nil
// value most including myself do not usually have code like this.
if _, ok := err.(*validator.InvalidValidationError); ok {
return field.ErrorList{field.Invalid(field.NewPath(""), err.Error(), "")}
}
allErrs := field.ErrorList{}
// collect human-readable errors
vErrors, _ := err.(validator.ValidationErrors)
for _, vErr := range vErrors {
allErrs = append(allErrs, field.Invalid(field.NewPath(vErr.Namespace()), vErr.Translate(v.trans), ""))
}
return allErrs
}
// validateDir checks if a given string is an existing directory.
func validateDir(fl validator.FieldLevel) bool {
path := fl.Field().String()
if stat, err := os.Stat(path); err == nil && stat.IsDir() {
return true
}
return false
}
// validateFile checks if a given string is an existing file.
func validateFile(fl validator.FieldLevel) bool {
path := fl.Field().String()
if stat, err := os.Stat(path); err == nil && !stat.IsDir() {
return true
}
return false
}
// validateDescription checks if a given description is illegal.
func validateDescription(fl validator.FieldLevel) bool {
description := fl.Field().String()
return len(description) <= maxDescriptionLength
}
// validateName checks if a given name is illegal.
func validateName(fl validator.FieldLevel) bool {
name := fl.Field().String()
if errs := IsQualifiedName(name); len(errs) > 0 {
return false
}
return true
}