Add support for time zone validation

pull/641/head
math-nao 5 years ago
parent ea924ce89a
commit 44f3347f13
  1. 27
      baked_in.go
  2. 8
      doc.go
  3. 41
      validator_test.go

@ -174,6 +174,7 @@ var (
"lowercase": isLowercase,
"uppercase": isUppercase,
"datetime": isDatetime,
"timeZone": isTimeZone,
}
)
@ -2096,3 +2097,29 @@ func isDatetime(fl FieldLevel) bool {
panic(fmt.Sprintf("Bad field type %T", field.Interface()))
}
// isTimeZone is the validation function for validating if the current field's value is a valid time zone string.
func isTimeZone(fl FieldLevel) bool {
field := fl.Field()
if field.Kind() == reflect.String {
// empty value is converted to UTC by time.LoadLocation but disallow it as it is not a valid time zone name
if field.String() == "" {
return false
}
// Local value is converted to the current system time zone by time.LoadLocation but disallow it as it is not a valid time zone name
if strings.ToLower(field.String()) == "local" {
return false
}
_, err := time.LoadLocation(field.String())
if err != nil {
return false
}
return true
}
panic(fmt.Sprintf("Bad field type %T", field.Interface()))
}

@ -1088,6 +1088,14 @@ Supplied format must match the official Go time format layout as documented in h
Usage: datetime=2006-01-02
TimeZone
This validates that a string value is a valid time zone based on the time zone database present on the system.
Although empty value and Local value are allowed by time.LoadLocation golang function, they are not allowed by this validator.
More information on https://golang.org/pkg/time/#LoadLocation
Usage: timeZone
Alias Validators and Tags
NOTE: When returning an error, the tag returned in "FieldError" will be

@ -9201,3 +9201,44 @@ func TestDatetimeValidation(t *testing.T) {
_ = validate.Var(2, "datetime")
}, "Bad field type int")
}
func TestTimeZoneValidation(t *testing.T) {
tests := []struct {
value string `validate:"timeZone"`
tag string
expected bool
}{
// systems may have different time zone database, some systems time zone are case insensitive
{"America/New_York", `timeZone`, true},
{"UTC", `timeZone`, true},
{"", `timeZone`, false},
{"Local", `timeZone`, false},
{"Unknown", `timeZone`, false},
}
validate := New()
for i, test := range tests {
errs := validate.Var(test.value, test.tag)
if test.expected {
if !IsEqual(errs, nil) {
t.Fatalf("Index: %d time zone failed Error: %s", i, errs)
}
} else {
if IsEqual(errs, nil) {
t.Fatalf("Index: %d time zone failed Error: %s", i, errs)
} else {
val := getError(errs, "", "")
if val.Tag() != "timeZone" {
t.Fatalf("Index: %d time zone failed Error: %s", i, errs)
}
}
}
}
PanicMatches(t, func() {
_ = validate.Var(2, "timeZone")
}, "Bad field type int")
}

Loading…
Cancel
Save