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

Adds inline support for loading config from ENV. #71

Merged
merged 3 commits into from
Jul 1, 2024
Merged

Adds inline support for loading config from ENV. #71

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
87cbf63
Adds inline support for loading config from ENV.
KevinJoiner Jun 27, 2024
dcb9667
Add '-' ignore
KevinJoiner Jun 27, 2024
ed18320
Update IGNORE test
KevinJoiner Jun 27, 2024
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
11 changes: 9 additions & 2 deletions config_loader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"os"
"reflect"
"strconv"
"strings"

"github.com/pkg/errors"
"gopkg.in/yaml.v3"
Expand Down Expand Up @@ -51,12 +52,18 @@ func loadFromEnvVars[S any](settings S) error {
for i := 0; i < valueOfConfig.NumField(); i++ {
field := valueOfConfig.Field(i)
fieldYamlName := typeOfT.Field(i).Tag.Get("yaml")

if fieldYamlName == "-" {
continue
}
if field.Kind() == reflect.Struct {
// iterate through the fields - like above, prepend fieldYamlName
for i := 0; i < field.NumField(); i++ {
subField := field.Field(i)
subFieldYamlName := fieldYamlName + "_" + field.Type().Field(i).Tag.Get("yaml")
subFieldYamlName := field.Type().Field(i).Tag.Get("yaml")
if !strings.HasSuffix(fieldYamlName, ",inline") {
subFieldYamlName = fieldYamlName + "_" + subFieldYamlName
}

err = matchEnvVarToField(subFieldYamlName, subField)
}
} else {
Expand Down
22 changes: 18 additions & 4 deletions config_loader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ DB_CONNECT_STRING: mydb.aws.net
ENV: dev
REDIS:
URL: redis.bobby
INLINE_URL: inline.bobby
IGNORE: ignoreme
`
settings, err := loadFromYaml[TestSettings]([]byte(data))
assert.NoError(t, err, "no error expected")
Expand All @@ -22,6 +24,8 @@ REDIS:
assert.Equal(t, "mydb.aws.net", settings.DbConnectString)
assert.Equal(t, "dev", settings.Env)
assert.Equal(t, "redis.bobby", settings.Redis.URL)
assert.Equal(t, "inline.bobby", settings.Inline.URL)
assert.Equal(t, "", settings.Ignore)
}

func Test_loadFromEnvVars(t *testing.T) {
Expand All @@ -34,6 +38,8 @@ func Test_loadFromEnvVars(t *testing.T) {
t.Setenv("ENV", "test")
t.Setenv("PORT", "5000")
t.Setenv("REDIS_URL", "redis.bobby")
t.Setenv("INLINE_URL", "inline.bobby")
t.Setenv("IGNORE", "ignoreme")

err := loadFromEnvVars(&settings) // b/c of type inference we don't need to specify the type
assert.NoError(t, err)
Expand All @@ -42,6 +48,8 @@ func Test_loadFromEnvVars(t *testing.T) {
assert.Equal(t, 5000, settings.Port)
assert.Equal(t, "mydb.aws.net", settings.DbConnectString)
assert.Equal(t, "redis.bobby", settings.Redis.URL)
assert.Equal(t, "inline.bobby", settings.Inline.URL)
assert.Equal(t, "", settings.Ignore)
}

func Test_loadFromEnvVars_errIfNotPointer(t *testing.T) {
Expand All @@ -65,12 +73,18 @@ func Test_matchEnvVarToField(t *testing.T) {
}

type TestSettings struct {
Port int `yaml:"PORT"`
DbConnectString string `yaml:"DB_CONNECT_STRING"`
Env string `yaml:"ENV"`
Redis RedisSubProp `yaml:"REDIS"`
Port int `yaml:"PORT"`
DbConnectString string `yaml:"DB_CONNECT_STRING"`
Env string `yaml:"ENV"`
Redis RedisSubProp `yaml:"REDIS"`
Inline InlineSubProp `yaml:",inline"`
Ignore string `yaml:"-"`
}

type RedisSubProp struct {
URL string `yaml:"URL"`
}

type InlineSubProp struct {
URL string `yaml:"INLINE_URL"`
}
Loading