Files
upstream-centrifugo/internal/config/envconfig/envconfig_test.go
upstream-mirror b352a9a30d
Some checks failed
test / Lint (push) Failing after 3s
test / Test with Go 1.26.8 (push) Failing after 2s
snapshot of https://github.com/centrifugal/centrifugo.git (master, 2026-09-16; blobs > 131072B omitted)
2026-09-16 01:17:21 +05:00

1101 lines
32 KiB
Go

// Copyright (c) 2013 Kelsey Hightower. All rights reserved.
// Use of this source code is governed by the MIT License that can be found in
// the LICENSE file.
package envconfig
import (
"flag"
"fmt"
"net/url"
"os"
"testing"
"time"
)
type HonorDecodeInStruct struct {
Value string
}
func (h *HonorDecodeInStruct) Decode(env string) error {
h.Value = "decoded"
return nil
}
type CustomURL struct {
Value *url.URL
}
func (cu *CustomURL) UnmarshalBinary(data []byte) error {
u, err := url.Parse(string(data))
cu.Value = u
return err
}
type Specification struct {
Embedded `desc:"can we document a struct"`
EmbeddedButIgnored `ignored:"true"`
Debug bool
Port int
Rate float32
User string
TTL uint32
Timeout time.Duration
AdminUsers []string
MagicNumbers []int
EmptyNumbers []int
ByteSlice []byte
ColorCodes map[string]int
MultiWordVar string
MultiWordVarWithAutoSplit uint32 `split_words:"true"`
MultiWordACRWithAutoSplit uint32 `split_words:"true"`
SomePointer *string
SomePointerWithDefault *string `default:"foo2baz" desc:"foorbar is the word"`
MultiWordVarWithAlt string `envconfig:"MULTI_WORD_VAR_WITH_ALT" desc:"what alt"`
MultiWordVarWithLowerCaseAlt string `envconfig:"multi_word_var_with_lower_case_alt"`
NoPrefixWithAlt string `envconfig:"SERVICE_HOST"`
DefaultVar string `default:"foobar"`
RequiredVar string `required:"True"`
NoPrefixDefault string `envconfig:"BROKER" default:"127.0.0.1"`
RequiredDefault string `required:"true" default:"foo2bar"`
Ignored string `ignored:"true"`
NestedSpecification struct {
Property string `envconfig:"inner"`
PropertyWithDefault string `default:"fuzzybydefault"`
} `envconfig:"outer"`
AfterNested string
DecodeStruct HonorDecodeInStruct `envconfig:"honor"`
Datetime time.Time
MapField map[string]string `default:"one:two,three:four"`
UrlValue CustomURL
UrlPointer *CustomURL
}
type Embedded struct {
Enabled bool `desc:"some embedded value"`
EmbeddedPort int
MultiWordVar string
MultiWordVarWithAlt string `envconfig:"MULTI_WITH_DIFFERENT_ALT"`
EmbeddedAlt string `envconfig:"EMBEDDED_WITH_ALT"`
EmbeddedIgnored string `ignored:"true"`
}
type EmbeddedButIgnored struct {
FirstEmbeddedButIgnored string
SecondEmbeddedButIgnored string
}
func TestProcess(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_RATE", "0.5")
_ = os.Setenv("ENV_CONFIG_USER", "Kelsey")
_ = os.Setenv("ENV_CONFIG_TIMEOUT", "2m")
_ = os.Setenv("ENV_CONFIG_ADMINUSERS", "John Adam Will")
_ = os.Setenv("ENV_CONFIG_MAGICNUMBERS", "5 10 20")
_ = os.Setenv("ENV_CONFIG_EMPTYNUMBERS", "")
_ = os.Setenv("ENV_CONFIG_BYTESLICE", "this is a test value")
_ = os.Setenv("ENV_CONFIG_COLORCODES", "red:1,green:2,blue:3")
_ = os.Setenv("SERVICE_HOST", "127.0.0.1")
_ = os.Setenv("ENV_CONFIG_TTL", "30")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_IGNORED", "was-not-ignored")
_ = os.Setenv("ENV_CONFIG_OUTER_INNER", "iamnested")
_ = os.Setenv("ENV_CONFIG_AFTERNESTED", "after")
_ = os.Setenv("ENV_CONFIG_HONOR", "honor")
_ = os.Setenv("ENV_CONFIG_DATETIME", "2016-08-16T18:57:05Z")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "24")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_ACR_WITH_AUTO_SPLIT", "25")
_ = os.Setenv("ENV_CONFIG_URLVALUE", "https://github.com/kelseyhightower/envconfig")
_ = os.Setenv("ENV_CONFIG_URLPOINTER", "https://github.com/kelseyhightower/envconfig")
_, err := Process("env_config", &s)
if err != nil {
t.Error(err.Error())
}
//if s.NoPrefixWithAlt != "127.0.0.1" {
// t.Errorf("expected %v, got %v", "127.0.0.1", s.NoPrefixWithAlt)
//}
if !s.Debug {
t.Errorf("expected %v, got %v", true, s.Debug)
}
if s.Port != 8080 {
t.Errorf("expected %d, got %v", 8080, s.Port)
}
if s.Rate != 0.5 {
t.Errorf("expected %f, got %v", 0.5, s.Rate)
}
if s.TTL != 30 {
t.Errorf("expected %d, got %v", 30, s.TTL)
}
if s.User != "Kelsey" {
t.Errorf("expected %s, got %s", "Kelsey", s.User)
}
if s.Timeout != 2*time.Minute {
t.Errorf("expected %s, got %s", 2*time.Minute, s.Timeout)
}
if s.RequiredVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.RequiredVar)
}
if len(s.AdminUsers) != 3 ||
s.AdminUsers[0] != "John" ||
s.AdminUsers[1] != "Adam" ||
s.AdminUsers[2] != "Will" {
t.Errorf("expected %#v, got %#v", []string{"John", "Adam", "Will"}, s.AdminUsers)
}
if len(s.MagicNumbers) != 3 ||
s.MagicNumbers[0] != 5 ||
s.MagicNumbers[1] != 10 ||
s.MagicNumbers[2] != 20 {
t.Errorf("expected %#v, got %#v", []int{5, 10, 20}, s.MagicNumbers)
}
if len(s.EmptyNumbers) != 0 {
t.Errorf("expected %#v, got %#v", []int{}, s.EmptyNumbers)
}
expected := "this is a test value"
if string(s.ByteSlice) != expected {
t.Errorf("expected %v, got %v", expected, string(s.ByteSlice))
}
if s.Ignored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
if len(s.ColorCodes) != 3 ||
s.ColorCodes["red"] != 1 ||
s.ColorCodes["green"] != 2 ||
s.ColorCodes["blue"] != 3 {
t.Errorf(
"expected %#v, got %#v",
map[string]int{
"red": 1,
"green": 2,
"blue": 3,
},
s.ColorCodes,
)
}
if s.NestedSpecification.Property != "iamnested" {
t.Errorf("expected '%s' string, got %#v", "iamnested", s.NestedSpecification.Property)
}
if s.NestedSpecification.PropertyWithDefault != "fuzzybydefault" {
t.Errorf("expected default '%s' string, got %#v", "fuzzybydefault", s.NestedSpecification.PropertyWithDefault)
}
if s.AfterNested != "after" {
t.Errorf("expected default '%s' string, got %#v", "after", s.AfterNested)
}
if s.DecodeStruct.Value != "decoded" {
t.Errorf("expected default '%s' string, got %#v", "decoded", s.DecodeStruct.Value)
}
if expected := time.Date(2016, 8, 16, 18, 57, 05, 0, time.UTC); !s.Datetime.Equal(expected) {
t.Errorf("expected %s, got %s", expected.Format(time.RFC3339), s.Datetime.Format(time.RFC3339))
}
if s.MultiWordVarWithAutoSplit != 24 {
t.Errorf("expected %d, got %d", 24, s.MultiWordVarWithAutoSplit)
}
if s.MultiWordACRWithAutoSplit != 25 {
t.Errorf("expected %d, got %d", 25, s.MultiWordACRWithAutoSplit)
}
u, err := url.Parse("https://github.com/kelseyhightower/envconfig")
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if *s.UrlValue.Value != *u {
t.Errorf("expected %q, got %q", u, s.UrlValue.Value.String())
}
if *s.UrlPointer.Value != *u {
t.Errorf("expected %q, got %q", u, s.UrlPointer.Value.String())
}
}
func TestParseErrorBool(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "string")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Debug" {
t.Errorf("expected %s, got %v", "Debug", v.FieldName)
}
if s.Debug != false {
t.Errorf("expected %v, got %v", false, s.Debug)
}
}
func TestParseErrorFloat32(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_RATE", "string")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Rate" {
t.Errorf("expected %s, got %v", "Rate", v.FieldName)
}
if s.Rate != 0 {
t.Errorf("expected %v, got %v", 0, s.Rate)
}
}
func TestParseErrorInt(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_PORT", "string")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Port" {
t.Errorf("expected %s, got %v", "Port", v.FieldName)
}
if s.Port != 0 {
t.Errorf("expected %v, got %v", 0, s.Port)
}
}
func TestParseErrorUint(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_TTL", "-30")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "TTL" {
t.Errorf("expected %s, got %v", "TTL", v.FieldName)
}
if s.TTL != 0 {
t.Errorf("expected %v, got %v", 0, s.TTL)
}
}
func TestParseErrorSplitWords(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "shakespeare")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "MultiWordVarWithAutoSplit" {
t.Errorf("expected %s, got %v", "", v.FieldName)
}
if s.MultiWordVarWithAutoSplit != 0 {
t.Errorf("expected %v, got %v", 0, s.MultiWordVarWithAutoSplit)
}
}
func TestErrInvalidSpecification(t *testing.T) {
m := make(map[string]string)
_, err := Process("env_config", &m)
if err != ErrInvalidSpecification {
t.Errorf("expected %v, got %v", ErrInvalidSpecification, err)
}
}
func TestUnsetVars(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("USER", "foo")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
// If the var is not defined the non-prefixed version should not be used
// unless the struct tag says so
if s.User != "" {
t.Errorf("expected %q, got %q", "", s.User)
}
}
func TestAlternateVarNames(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR", "foo")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_ALT", "bar")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_LOWER_CASE_ALT", "baz")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
// Setting the alt version of the var in the environment has no effect if
// the struct tag is not supplied
if s.MultiWordVar != "" {
t.Errorf("expected %q, got %q", "", s.MultiWordVar)
}
// Setting the alt version of the var in the environment correctly sets
// the value if the struct tag IS supplied
if s.MultiWordVarWithAlt != "bar" {
t.Errorf("expected %q, got %q", "bar", s.MultiWordVarWithAlt)
}
// Alt value is not case sensitive and is treated as all uppercase
if s.MultiWordVarWithLowerCaseAlt != "baz" {
t.Errorf("expected %q, got %q", "baz", s.MultiWordVarWithLowerCaseAlt)
}
}
func TestRequiredVar(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foobar")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.RequiredVar != "foobar" {
t.Errorf("expected %s, got %s", "foobar", s.RequiredVar)
}
}
func TestRequiredMissing(t *testing.T) {
var s Specification
os.Clearenv()
_, err := Process("env_config", &s)
if err == nil {
t.Error("no failure when missing required variable")
}
}
func TestBlankDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "requiredvalue")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.DefaultVar != "foobar" {
t.Errorf("expected %s, got %s", "foobar", s.DefaultVar)
}
if *s.SomePointerWithDefault != "foo2baz" {
t.Errorf("expected %s, got %s", "foo2baz", *s.SomePointerWithDefault)
}
}
func TestNonBlankDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEFAULTVAR", "nondefaultval")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "requiredvalue")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.DefaultVar != "nondefaultval" {
t.Errorf("expected %s, got %s", "nondefaultval", s.DefaultVar)
}
}
func TestExplicitBlankDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEFAULTVAR", "")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.DefaultVar != "foobar" { // Empty values are considered unset.
t.Errorf("expected %s, got %s", "\"\"", s.DefaultVar)
}
}
func TestAlternateNameDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("BROKER", "betterbroker")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
//if s.NoPrefixDefault != "betterbroker" {
// t.Errorf("expected %q, got %q", "betterbroker", s.NoPrefixDefault)
//}
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.NoPrefixDefault != "127.0.0.1" {
t.Errorf("expected %q, got %q", "127.0.0.1", s.NoPrefixDefault)
}
}
func TestRequiredDefault(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.RequiredDefault != "foo2bar" {
t.Errorf("expected %q, got %q", "foo2bar", s.RequiredDefault)
}
}
func TestPointerFieldBlank(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.SomePointer != nil {
t.Errorf("expected <nil>, got %q", *s.SomePointer)
}
}
func TestEmptyMapFieldOverride(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_MAPFIELD", "") // Empty values are considered unset.
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.MapField == nil {
t.Error("expected empty map, got <nil>")
}
if len(s.MapField) != 2 {
t.Errorf("expected map with default values, got map of size %d", len(s.MapField))
}
}
func TestMustProcess(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_RATE", "0.5")
_ = os.Setenv("ENV_CONFIG_USER", "Kelsey")
_ = os.Setenv("SERVICE_HOST", "127.0.0.1")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
MustProcess("env_config", &s)
defer func() {
if err := recover(); err != nil {
return
}
t.Error("expected panic")
}()
m := make(map[string]string)
MustProcess("env_config", &m)
}
func TestEmbeddedStruct(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "required")
_ = os.Setenv("ENV_CONFIG_ENABLED", "true")
_ = os.Setenv("ENV_CONFIG_EMBEDDEDPORT", "1234")
_ = os.Setenv("ENV_CONFIG_MULTIWORDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_ALT", "bar")
_ = os.Setenv("ENV_CONFIG_MULTI_WITH_DIFFERENT_ALT", "baz")
_ = os.Setenv("ENV_CONFIG_EMBEDDED_WITH_ALT", "foobar")
_ = os.Setenv("ENV_CONFIG_SOMEPOINTER", "foobaz")
_ = os.Setenv("ENV_CONFIG_EMBEDDED_IGNORED", "was-not-ignored")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if !s.Enabled {
t.Errorf("expected %v, got %v", true, s.Enabled)
}
if s.EmbeddedPort != 1234 {
t.Errorf("expected %d, got %v", 1234, s.EmbeddedPort)
}
if s.MultiWordVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.MultiWordVar)
}
if s.Embedded.MultiWordVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.Embedded.MultiWordVar)
}
if s.MultiWordVarWithAlt != "bar" {
t.Errorf("expected %s, got %s", "bar", s.MultiWordVarWithAlt)
}
if s.Embedded.MultiWordVarWithAlt != "baz" {
t.Errorf("expected %s, got %s", "baz", s.Embedded.MultiWordVarWithAlt)
}
if s.EmbeddedAlt != "foobar" {
t.Errorf("expected %s, got %s", "foobar", s.EmbeddedAlt)
}
if *s.SomePointer != "foobaz" {
t.Errorf("expected %s, got %s", "foobaz", *s.SomePointer)
}
if s.EmbeddedIgnored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
}
func TestEmbeddedButIgnoredStruct(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "required")
_ = os.Setenv("ENV_CONFIG_FIRSTEMBEDDEDBUTIGNORED", "was-not-ignored")
_ = os.Setenv("ENV_CONFIG_SECONDEMBEDDEDBUTIGNORED", "was-not-ignored")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if s.FirstEmbeddedButIgnored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
if s.SecondEmbeddedButIgnored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
}
func TestNonPointerFailsProperly(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "snap")
_, err := Process("env_config", s)
if err != ErrInvalidSpecification {
t.Errorf("non-pointer should fail with ErrInvalidSpecification, was instead %s", err)
}
}
func TestCustomValueFields(t *testing.T) {
var s struct {
Foo string
Bar bracketed
Baz quoted
Struct setterStruct
}
// Set would panic when the receiver is nil,
// so make sure it has an initial value to replace.
s.Baz = quoted{new(bracketed)}
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_FOO", "foo")
_ = os.Setenv("ENV_CONFIG_BAR", "bar")
_ = os.Setenv("ENV_CONFIG_BAZ", "baz")
_ = os.Setenv("ENV_CONFIG_STRUCT", "inner")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if want := "foo"; s.Foo != want {
t.Errorf("foo: got %#q, want %#q", s.Foo, want)
}
if want := "[bar]"; s.Bar.String() != want {
t.Errorf("bar: got %#q, want %#q", s.Bar, want)
}
if want := `["baz"]`; s.Baz.String() != want {
t.Errorf(`baz: got %#q, want %#q`, s.Baz, want)
}
if want := `setterstruct{"inner"}`; s.Struct.Inner != want {
t.Errorf(`Struct.Inner: got %#q, want %#q`, s.Struct.Inner, want)
}
}
func TestCustomPointerFields(t *testing.T) {
var s struct {
Foo string
Bar *bracketed
Baz *quoted
Struct *setterStruct
}
// Set would panic when the receiver is nil,
// so make sure they have initial values to replace.
s.Bar = new(bracketed)
s.Baz = &quoted{new(bracketed)}
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_FOO", "foo")
_ = os.Setenv("ENV_CONFIG_BAR", "bar")
_ = os.Setenv("ENV_CONFIG_BAZ", "baz")
_ = os.Setenv("ENV_CONFIG_STRUCT", "inner")
if _, err := Process("env_config", &s); err != nil {
t.Error(err.Error())
}
if want := "foo"; s.Foo != want {
t.Errorf("foo: got %#q, want %#q", s.Foo, want)
}
if want := "[bar]"; s.Bar.String() != want {
t.Errorf("bar: got %#q, want %#q", s.Bar, want)
}
if want := `["baz"]`; s.Baz.String() != want {
t.Errorf(`baz: got %#q, want %#q`, s.Baz, want)
}
if want := `setterstruct{"inner"}`; s.Struct.Inner != want {
t.Errorf(`Struct.Inner: got %#q, want %#q`, s.Struct.Inner, want)
}
}
func TestEmptyPrefixUsesFieldNames(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("REQUIREDVAR", "foo")
_, err := Process("", &s)
if err != nil {
t.Errorf("Process failed: %s", err)
}
if s.RequiredVar != "foo" {
t.Errorf(
`RequiredVar not populated correctly: expected "foo", got %q`,
s.RequiredVar,
)
}
}
type Nested struct {
NestedSpecification struct {
Property string `envconfig:"inner"`
PropertyWithDefault string `default:"fuzzybydefault" envconfig:"property_with_default"`
} `envconfig:"outer"`
}
func TestNestedStructVarName(t *testing.T) {
var s Nested
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_OUTER_INNER", "required")
_, err := Process("ENV_CONFIG", &s)
if err != nil {
t.Error(err.Error())
}
if s.NestedSpecification.Property != "required" {
t.Errorf("expected %s, got %s", "required", s.NestedSpecification.Property)
}
if s.NestedSpecification.PropertyWithDefault != "fuzzybydefault" {
t.Errorf("expected %s, got %s", "fuzzybydefault", s.NestedSpecification.PropertyWithDefault)
}
}
func TestTextUnmarshalerError(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_DATETIME", "I'M NOT A DATE")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Datetime" {
t.Errorf("expected %s, got %v", "Datetime", v.FieldName)
}
expectedLowLevelError := time.ParseError{
Layout: time.RFC3339,
Value: "I'M NOT A DATE",
LayoutElem: "2006",
ValueElem: "I'M NOT A DATE",
}
if v.Err.Error() != expectedLowLevelError.Error() {
t.Errorf("expected %s, got %s", expectedLowLevelError, v.Err)
}
}
func TestBinaryUnmarshalerError(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_URLPOINTER", "http://%41:8080/")
_, err := Process("env_config", &s)
v, ok := err.(*ParseError)
if !ok {
t.Fatalf("expected ParseError, got %T %v", err, err)
}
if v.FieldName != "UrlPointer" {
t.Errorf("expected %s, got %v", "UrlPointer", v.FieldName)
}
// To be compatible with go 1.5 and lower we should do a very basic check,
// because underlying error message varies in go 1.5 and go 1.6+.
e, ok := v.Err.(*url.Error)
if !ok {
t.Errorf("expected error type to be \"*url.Error\", got %T", v.Err)
}
if e.Op != "parse" {
t.Errorf("expected error op to be \"parse\", got %q", e.Op)
}
}
func TestCheckDisallowedOnlyAllowed(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("UNRELATED_ENV_VAR", "true")
err := CheckDisallowed("env_config", &s)
if err != nil {
t.Errorf("expected no error, got %s", err)
}
}
func TestCheckDisallowedMisspelled(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_ZEBUG", "false")
err := CheckDisallowed("env_config", &s)
if experr := "unknown environment variable ENV_CONFIG_ZEBUG"; err.Error() != experr {
t.Errorf("expected %s, got %s", experr, err)
}
}
func TestCheckDisallowedIgnored(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_IGNORED", "false")
err := CheckDisallowed("env_config", &s)
if experr := "unknown environment variable ENV_CONFIG_IGNORED"; err.Error() != experr {
t.Errorf("expected %s, got %s", experr, err)
}
}
//func TestErrorMessageForRequiredAltVar(t *testing.T) {
// var s struct {
// Foo string `envconfig:"BAR" required:"true"`
// }
//
// os.Clearenv()
// _, err := Process("env_config", &s)
//
// if err == nil {
// t.Error("no failure when missing required variable")
// }
//
// if !strings.Contains(err.Error(), " BAR ") {
// t.Errorf("expected error message to contain BAR, got \"%v\"", err)
// }
//}
type bracketed string
func (b *bracketed) Set(value string) error {
*b = bracketed("[" + value + "]")
return nil
}
func (b bracketed) String() string {
return string(b)
}
// quoted is used to test the precedence of Decode over Set.
// The sole field is a flag.Value rather than a setter to validate that
// all flag.Value implementations are also Setter implementations.
type quoted struct{ flag.Value }
func (d quoted) Decode(value string) error {
return d.Set(`"` + value + `"`)
}
type setterStruct struct {
Inner string
}
func (ss *setterStruct) Set(value string) error {
ss.Inner = fmt.Sprintf("setterstruct{%q}", value)
return nil
}
func TestProcessWithoutNestedKeys(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_RATE", "0.5")
_ = os.Setenv("ENV_CONFIG_USER", "Kelsey")
_ = os.Setenv("ENV_CONFIG_TIMEOUT", "2m")
_ = os.Setenv("ENV_CONFIG_ADMINUSERS", "John Adam Will")
_ = os.Setenv("ENV_CONFIG_MAGICNUMBERS", "5 10 20")
_ = os.Setenv("ENV_CONFIG_EMPTYNUMBERS", "")
_ = os.Setenv("ENV_CONFIG_BYTESLICE", "this is a test value")
_ = os.Setenv("ENV_CONFIG_COLORCODES", "red:1,green:2,blue:3")
_ = os.Setenv("SERVICE_HOST", "127.0.0.1")
_ = os.Setenv("ENV_CONFIG_TTL", "30")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_IGNORED", "was-not-ignored")
_ = os.Setenv("ENV_CONFIG_OUTER_INNER", "iamnested")
_ = os.Setenv("ENV_CONFIG_AFTERNESTED", "after")
_ = os.Setenv("ENV_CONFIG_HONOR", "honor")
_ = os.Setenv("ENV_CONFIG_DATETIME", "2016-08-16T18:57:05Z")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "24")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_ACR_WITH_AUTO_SPLIT", "25")
_ = os.Setenv("ENV_CONFIG_URLVALUE", "https://github.com/kelseyhightower/envconfig")
_ = os.Setenv("ENV_CONFIG_URLPOINTER", "https://github.com/kelseyhightower/envconfig")
// Exclude debug and port fields using their nested keys
excludeKeys := []string{"debug", "port"}
_, err := ProcessWithoutNestedKeys("env_config", &s, excludeKeys)
if err != nil {
t.Error(err.Error())
}
// Debug should remain false (default) because it was excluded
if s.Debug {
t.Errorf("expected %v, got %v (debug should be excluded)", false, s.Debug)
}
// Port should remain 0 (default) because it was excluded
if s.Port != 0 {
t.Errorf("expected %d, got %v (port should be excluded)", 0, s.Port)
}
// Other fields should be processed normally
if s.Rate != 0.5 {
t.Errorf("expected %f, got %v", 0.5, s.Rate)
}
if s.TTL != 30 {
t.Errorf("expected %d, got %v", 30, s.TTL)
}
if s.User != "Kelsey" {
t.Errorf("expected %s, got %s", "Kelsey", s.User)
}
if s.RequiredVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.RequiredVar)
}
}
func TestProcessWithoutNestedKeysNestedStruct(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_OUTER_INNER", "iamnested")
_ = os.Setenv("ENV_CONFIG_AFTERNESTED", "after")
// Exclude the nested struct property using its nested key
excludeKeys := []string{"outer.inner"}
_, err := ProcessWithoutNestedKeys("env_config", &s, excludeKeys)
if err != nil {
t.Error(err.Error())
}
// Regular fields should be processed
if !s.Debug {
t.Errorf("expected %v, got %v", true, s.Debug)
}
if s.Port != 8080 {
t.Errorf("expected %d, got %v", 8080, s.Port)
}
if s.AfterNested != "after" {
t.Errorf("expected %s, got %s", "after", s.AfterNested)
}
// Nested field should remain empty because it was excluded
if s.NestedSpecification.Property != "" {
t.Errorf("expected empty string, got %s (nested property should be excluded)", s.NestedSpecification.Property)
}
// But the default value should still be applied to non-excluded nested fields
if s.NestedSpecification.PropertyWithDefault != "fuzzybydefault" {
t.Errorf("expected %s, got %s", "fuzzybydefault", s.NestedSpecification.PropertyWithDefault)
}
}
func TestProcessWithoutNestedKeysEmbeddedStruct(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "required")
_ = os.Setenv("ENV_CONFIG_ENABLED", "true")
_ = os.Setenv("ENV_CONFIG_EMBEDDEDPORT", "1234")
_ = os.Setenv("ENV_CONFIG_MULTIWORDVAR", "foo")
// Exclude embedded fields using their nested keys
excludeKeys := []string{"enabled", "embeddedport"}
_, err := ProcessWithoutNestedKeys("env_config", &s, excludeKeys)
if err != nil {
t.Error(err.Error())
}
// Excluded embedded fields should remain at default values
if s.Enabled {
t.Errorf("expected %v, got %v (enabled should be excluded)", false, s.Enabled)
}
if s.EmbeddedPort != 0 {
t.Errorf("expected %d, got %v (embeddedport should be excluded)", 0, s.EmbeddedPort)
}
// Non-excluded embedded fields should be processed
if s.MultiWordVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.MultiWordVar)
}
}
func TestProcessWithoutNestedKeysEmptyExcludeList(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
// Empty exclude list should behave like normal Process
_, err := ProcessWithoutNestedKeys("env_config", &s, []string{})
if err != nil {
t.Error(err.Error())
}
if !s.Debug {
t.Errorf("expected %v, got %v", true, s.Debug)
}
if s.Port != 8080 {
t.Errorf("expected %d, got %v", 8080, s.Port)
}
}
func TestProcessWithoutNestedKeysNilExcludeList(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
// Nil exclude list should behave like normal Process
_, err := ProcessWithoutNestedKeys("env_config", &s, nil)
if err != nil {
t.Error(err.Error())
}
if !s.Debug {
t.Errorf("expected %v, got %v", true, s.Debug)
}
if s.Port != 8080 {
t.Errorf("expected %d, got %v", 8080, s.Port)
}
}
func TestProcessWithoutNestedKeysRequired(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
// Excluding a required field should not cause an error if it's set
excludeKeys := []string{"requiredvar"}
_, err := ProcessWithoutNestedKeys("env_config", &s, excludeKeys)
if err != nil {
t.Error(err.Error())
}
// RequiredVar should remain empty because it was excluded
if s.RequiredVar != "" {
t.Errorf("expected empty string, got %s (requiredvar should be excluded)", s.RequiredVar)
}
}
func TestProcessWithoutNestedKeysWithDefaults(t *testing.T) {
var s Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
// Exclude a field with a default value
excludeKeys := []string{"defaultvar"}
_, err := ProcessWithoutNestedKeys("env_config", &s, excludeKeys)
if err != nil {
t.Error(err.Error())
}
// DefaultVar should remain empty because it was excluded (no default applied)
if s.DefaultVar != "" {
t.Errorf("expected empty string, got %s (defaultvar should be excluded)", s.DefaultVar)
}
}
func TestProcessBackwardCompatibility(t *testing.T) {
var s1, s2 Specification
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
// Test that Process and ProcessWithoutNestedKeys with nil excludeKeys produce same results
_, err1 := Process("env_config", &s1)
_, err2 := ProcessWithoutNestedKeys("env_config", &s2, nil)
if err1 != nil {
t.Error("Process failed:", err1.Error())
}
if err2 != nil {
t.Error("ProcessWithoutNestedKeys failed:", err2.Error())
}
if s1.Debug != s2.Debug {
t.Errorf("Debug mismatch: Process=%v, ProcessWithoutNestedKeys=%v", s1.Debug, s2.Debug)
}
if s1.Port != s2.Port {
t.Errorf("Port mismatch: Process=%v, ProcessWithoutNestedKeys=%v", s1.Port, s2.Port)
}
if s1.RequiredVar != s2.RequiredVar {
t.Errorf("RequiredVar mismatch: Process=%s, ProcessWithoutNestedKeys=%s", s1.RequiredVar, s2.RequiredVar)
}
}
func BenchmarkGatherInfo(b *testing.B) {
os.Clearenv()
_ = os.Setenv("ENV_CONFIG_DEBUG", "true")
_ = os.Setenv("ENV_CONFIG_PORT", "8080")
_ = os.Setenv("ENV_CONFIG_RATE", "0.5")
_ = os.Setenv("ENV_CONFIG_USER", "Kelsey")
_ = os.Setenv("ENV_CONFIG_TIMEOUT", "2m")
_ = os.Setenv("ENV_CONFIG_ADMINUSERS", "John Adam Will")
_ = os.Setenv("ENV_CONFIG_MAGICNUMBERS", "5 10 20")
_ = os.Setenv("ENV_CONFIG_COLORCODES", "red:1,green:2,blue:3")
_ = os.Setenv("SERVICE_HOST", "127.0.0.1")
_ = os.Setenv("ENV_CONFIG_TTL", "30")
_ = os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
_ = os.Setenv("ENV_CONFIG_IGNORED", "was-not-ignored")
_ = os.Setenv("ENV_CONFIG_OUTER_INNER", "iamnested")
_ = os.Setenv("ENV_CONFIG_AFTERNESTED", "after")
_ = os.Setenv("ENV_CONFIG_HONOR", "honor")
_ = os.Setenv("ENV_CONFIG_DATETIME", "2016-08-16T18:57:05Z")
_ = os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "24")
for i := 0; i < b.N; i++ {
var s Specification
_, _ = gatherInfo("env_config", &s)
}
}