Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Always call decoders #68

Merged
merged 1 commit into from Jul 27, 2022
Merged

Always call decoders #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 7 additions & 9 deletions envconfig.go
View file
Open in desktop
Expand Up @@ -330,20 +330,18 @@ func processWith(ctx context.Context, i interface{}, l Lookuper, parentNoInit bo
// Lookup the value, ignoring an error if the key isn't defined. This is
// required for nested structs that don't declare their own `env` keys,
// but have internal fields with an `env` defined.
val, found, usedDefault, err := lookup(key, opts, l)
val, _, _, err := lookup(key, opts, l)
if err != nil && !errors.Is(err, ErrMissingKey) {
return fmt.Errorf("%s: %w", tf.Name, err)
}

if found || usedDefault {
if ok, err := processAsDecoder(val, ef); ok {
if err != nil {
return err
}

setNilStruct(ef)
continue
if ok, err := processAsDecoder(val, ef); ok {
if err != nil {
return err
}

setNilStruct(ef)
continue
}

plu := l
Expand Down
143 changes: 129 additions & 14 deletions envconfig_test.go
View file
Open in desktop
Expand Up @@ -42,6 +42,31 @@ func (c *CustomDecoderType) EnvDecode(val string) error {
return nil
}

// Level mirrors Zap's level marshalling to reproduce an issue for tests.
type Level int8

const (
DebugLevel Level = 0
InfoLevel Level = 5
ErrorLevel Level = 100
)

func (l *Level) UnmarshalText(text []byte) error {
switch string(text) {
case "debug":
*l = DebugLevel
return nil
case "info", "": // default
*l = InfoLevel
return nil
case "error":
*l = ErrorLevel
return nil
default:
return fmt.Errorf("unknown level %s", string(text))
}
}

var (
_ encoding.BinaryUnmarshaler = (*CustomStdLibDecodingType)(nil)
_ encoding.TextUnmarshaler = (*CustomStdLibDecodingType)(nil)
Expand Down Expand Up @@ -1401,20 +1426,6 @@ func TestProcessWith(t *testing.T) {
}),
errMsg: "broken",
},
{
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main behavior change that is reverted from #62.

name: "custom_decoder/not_called_on_unset_envvar",
input: &struct {
Field CustomTypeError `env:"FIELD"`
}{},
exp: &struct {
Field CustomTypeError `env:"FIELD"`
}{
Field: CustomTypeError{},
},
lookuper: MapLookuper(nil),
// Note: We explicitly want no error here. The custom marshaller should
// not have been called, since the environment variables was not defined.
},

// Expand
{
Expand Down Expand Up @@ -2112,6 +2123,110 @@ func TestProcessWith(t *testing.T) {
"VCR_REMOTE_BUTTON_NAME": "button",
}),
},
{
// https://github.com/sethvargo/go-envconfig/issues/61
name: "custom_decoder_overwrite_uses_default",
input: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{},
exp: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{
Level: ErrorLevel,
},
lookuper: MapLookuper(nil),
},
{
// https://github.com/sethvargo/go-envconfig/issues/61
name: "custom_decoder_overwrite_unset",
input: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{},
exp: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{
Level: DebugLevel,
},
lookuper: MapLookuper(map[string]string{
"LEVEL": "debug",
}),
},
{
// https://github.com/sethvargo/go-envconfig/issues/61
name: "custom_decoder_overwrite_existing_value",
input: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{
Level: InfoLevel,
},
exp: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{
Level: InfoLevel,
},
lookuper: MapLookuper(nil),
},
{
// https://github.com/sethvargo/go-envconfig/issues/61
name: "custom_decoder_overwrite_existing_value_envvar",
input: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{
Level: InfoLevel,
},
exp: &struct {
Level Level `env:"LEVEL,overwrite,default=error"`
}{
Level: DebugLevel,
},
lookuper: MapLookuper(map[string]string{
"LEVEL": "debug",
}),
},
{
// https://github.com/sethvargo/go-envconfig/issues/64
name: "custom_decoder_uses_decoder_no_env",
input: &struct {
URL *url.URL
}{},
exp: &struct {
URL *url.URL
}{
URL: &url.URL{},
},
lookuper: MapLookuper(nil),
},
{
// https://github.com/sethvargo/go-envconfig/issues/64
name: "custom_decoder_uses_decoder_env_no_value",
input: &struct {
URL *url.URL `env:"URL"`
}{},
exp: &struct {
URL *url.URL `env:"URL"`
}{
URL: &url.URL{},
},
lookuper: MapLookuper(nil),
},
{
// https://github.com/sethvargo/go-envconfig/issues/64
name: "custom_decoder_uses_decoder_env_with_value",
input: &struct {
URL *url.URL `env:"URL"`
}{},
exp: &struct {
URL *url.URL `env:"URL"`
}{
URL: &url.URL{
Scheme: "https",
Host: "foo.bar",
},
},
lookuper: MapLookuper(map[string]string{
"URL": "https://foo.bar",
}),
},
}

for _, tc := range cases {
Expand Down