Skip to content

feat: support enum field validation #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ type config struct {
Port int `env:"PORT" required:"true"`
Peers []string `env:"PEERS"` // you can use `delimiter` tag to specify separator, for example `delimiter:" "`
ConnectionTimeout time.Duration `env:"TIMEOUT" default:"10s"`
LogLevel string `env:"LOG_LEVEL" enum:"debug info error" delimiter:" "` // the delimiter tag applies to enum as well
}

func main() {
Expand Down
4 changes: 4 additions & 0 deletions env.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ func setField(t reflect.StructField, v reflect.Value, value string) (err error)
return setSlice(t, v, value)
}

if err = checkEnum(t, value); err != nil {
return fmt.Errorf("error setting %q: %v", t.Name, err)
}

if err = setBuiltInField(v, value); err != nil {
return fmt.Errorf("error setting %q: %v", t.Name, err)
}
Expand Down
84 changes: 84 additions & 0 deletions env_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,90 @@ func TestEnvWithDefaultWhenProvided(t *testing.T) {
Equals(t, "goodbye", config.Prop)
}

func TestEnvEnumUnmatched(t *testing.T) {
os.Setenv("PROP", "foo")

config := struct {
Prop string `env:"PROP" enum:"1,2,3"`
}{}

err := Set(&config)
ErrorNotNil(t, err)
Assert(t, strings.HasPrefix(err.Error(), `error setting "Prop": "foo" is not a member of [1,2,3]`))
}

func TestEnvEnumMatchedString(t *testing.T) {
os.Setenv("PROP", "foo")

config := struct {
Prop string `env:"PROP" enum:"foo,bar,baz"`
}{}

err := Set(&config)
ErrorNil(t, err)
Assert(t, config.Prop == "foo")
}

func TestEnvEnumMatchedInteger(t *testing.T) {
os.Setenv("PROP", "1")

config := struct {
Prop int `env:"PROP" enum:"1,2,3"`
}{}

err := Set(&config)
ErrorNil(t, err)
Assert(t, config.Prop == 1)
}

func TestEnvEnumMatchedStringSlice(t *testing.T) {
os.Setenv("PROP", "foo,bar,baz")

config := struct {
Prop []string `env:"PROP" enum:"foo,bar,baz"`
}{}

err := Set(&config)
ErrorNil(t, err)
Equals(t, []string{"foo", "bar", "baz"}, config.Prop)
}

func TestEnvEnumUnmatchedStringSlice(t *testing.T) {
os.Setenv("PROP", "foo,bar,baz")

config := struct {
Prop []string `env:"PROP" enum:"foo,baz"`
}{}

err := Set(&config)
ErrorNotNil(t, err)
Equals(t, `error setting "Prop": "bar" is not a member of [foo,baz]`, err.Error())
}

func TestEnvEnumMatchedIntSlice(t *testing.T) {
os.Setenv("PROP", "1,3")

config := struct {
Prop []int `env:"PROP" enum:"1,3,5"`
}{}

err := Set(&config)
ErrorNil(t, err)
Equals(t, []int{1, 3}, config.Prop)
}

func TestEnvEnumUnmatchedIntSlice(t *testing.T) {
os.Setenv("PROP", "1,2,3")

config := struct {
Prop []int `env:"PROP" enum:"1,3,5"`
}{}

err := Set(&config)
ErrorNotNil(t, err)
Equals(t, `error setting "Prop": "2" is not a member of [1,3,5]`, err.Error())
}

func TestEnvWithDefaultWhenMissing(t *testing.T) {
unsetEnvironment()

Expand Down
22 changes: 22 additions & 0 deletions set.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package env
import (
"fmt"
"reflect"
"slices"
"strconv"
"strings"
"time"
Expand Down Expand Up @@ -106,6 +107,12 @@ func setSlice(t reflect.StructField, v reflect.Value, value string) (err error)
return
}

for _, rawValue := range rawValues {
if err = checkEnum(t, rawValue); err != nil {
return fmt.Errorf("error setting %q: %v", t.Name, err)
}
}

sliceValue, err := makeSlice(v, len(rawValues))
if err != nil {
return
Expand Down Expand Up @@ -179,3 +186,18 @@ func getDelimiter(t reflect.StructField) string {
}
return ","
}

func checkEnum(t reflect.StructField, value string) (err error) {
rawChoices, ok := t.Tag.Lookup("enum")
if !ok {
return
}

delimiter := getDelimiter(t)
choices := split(rawChoices, delimiter)
if !slices.Contains(choices, value) {
return fmt.Errorf(`"%s" is not a member of [%s]`, value, strings.Join(choices, ","))
}

return
}