Merge pull request #1 from M-Porter/v2-prep-configure-setup

configure v2: update library and usages

Author: M-Porter

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2022 Matthew Porter
+Copyright 2024 Matthew Porter
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -5,9 +5,9 @@ Dead simple configuration library.
 # Install
 
 ```
-go get -u github.com/m-porter/configure
+go get -u github.com/m-porter/configure/v2
 ```
 
 # Usage
 
-See examples in the [examples](./examples) directory.
+See [`configure_test.go`](./configure_test.go) for example usage.

configuration.go renamed to configure.go

@@ -5,8 +5,6 @@ import (
 	"github.com/spf13/viper"
 )
 
-var instance *interface{}
-
 type Options struct {
 	ConfigName    string
 	ConfigType    string
@@ -15,7 +13,7 @@ type Options struct {
 	Defaults      interface{}
 }
 
-func Setup(options Options, conf interface{}) error {
+func Setup(options Options, conf any) error {
 	viper.SetConfigName(options.ConfigName)
 	viper.SetConfigType(options.ConfigType)
 	viper.AddConfigPath(options.ConfigAbsPath)
@@ -46,14 +44,5 @@ func Setup(options Options, conf interface{}) error {
 		return err
 	}
 
-	instance = &conf
-
 	return nil
 }
-
-func Config() interface{} {
-	if instance == nil {
-		return nil
-	}
-	return *instance
-}

configure_test.go

@@ -0,0 +1,120 @@
+package configure_test
+
+import (
+	"os"
+	"testing"
+
+	"github.com/m-porter/configure/v2"
+)
+
+func TestDefaults(t *testing.T) {
+	type Config struct {
+		HostName string `mapstructure:"host_name"`
+	}
+
+	expected := "my.test.host"
+
+	options := configure.Options{
+		Defaults: Config{
+			HostName: expected,
+		},
+	}
+
+	conf := &Config{}
+
+	if err := configure.Setup(options, conf); err != nil {
+		t.Fatalf("error setting up config: %v", err)
+	}
+
+	if conf.HostName != expected {
+		t.Errorf("expected %s, got %s", expected, conf.HostName)
+	}
+}
+
+func TestFromEnv(t *testing.T) {
+	type Config struct {
+		Secret string `mapstructure:"app_secret"`
+	}
+
+	key := "APP_SECRET"
+	_ = os.Unsetenv(key)
+	expected := "987xyz"
+	_ = os.Setenv(key, expected)
+
+	options := configure.Options{
+		EnvPrefix: "",
+		Defaults: Config{
+			Secret: "abc123",
+		},
+	}
+
+	conf := &Config{}
+
+	if err := configure.Setup(options, conf); err != nil {
+		t.Fatalf("error setting up config: %v", err)
+	}
+
+	if conf.Secret != expected {
+		t.Errorf("expected %s, got %s", expected, conf.Secret)
+	}
+
+	_ = os.Unsetenv(key)
+}
+
+func TestFromEnvWithNoEnvPrefix(t *testing.T) {
+	type Config struct {
+		AnotherSecret string `mapstructure:"another_secret"`
+	}
+
+	key := "APP_ANOTHER_SECRET"
+	_ = os.Unsetenv(key)
+	expected := "987xyz"
+	_ = os.Setenv(key, expected)
+
+	options := configure.Options{
+		EnvPrefix: "APP",
+		Defaults: Config{
+			AnotherSecret: "abc123",
+		},
+	}
+
+	conf := &Config{}
+
+	if err := configure.Setup(options, conf); err != nil {
+		t.Fatalf("error setting up config: %v", err)
+	}
+
+	if conf.AnotherSecret != expected {
+		t.Errorf("expected %s, got %s", expected, conf.AnotherSecret)
+	}
+
+	_ = os.Unsetenv(key)
+}
+
+func TestFromFile(t *testing.T) {
+	type Config struct {
+		SomeValue string `mapstructure:"some_value"`
+	}
+
+	dir, err := os.Getwd()
+	if err != nil {
+		t.Fatalf("Unable to get working dir: %v", err)
+	}
+
+	options := configure.Options{
+		ConfigName:    "test_config",
+		ConfigType:    "yaml",
+		ConfigAbsPath: dir,
+	}
+
+	conf := &Config{}
+
+	if err := configure.Setup(options, conf); err != nil {
+		t.Fatalf("error setting up config: %v", err)
+	}
+
+	expected := "foo foo foo"
+	if conf.SomeValue != expected {
+		t.Errorf("expected %s, got %s", expected, conf.SomeValue)
+	}
+}

examples/defaults/main.go

@@ -1,21 +1,28 @@
-module github.com/m-porter/configure
+module github.com/m-porter/configure/v2
 
-go 1.17
+go 1.20
 
 require (
-	github.com/fsnotify/fsnotify v1.5.1 // indirect
+	github.com/mitchellh/mapstructure v1.5.0
+	github.com/spf13/viper v1.18.2
+)
+
+require (
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/magiconair/properties v1.8.5 // indirect
-	github.com/mitchellh/mapstructure v1.4.3 // indirect
-	github.com/pelletier/go-toml v1.9.4 // indirect
-	github.com/spf13/afero v1.8.0 // indirect
-	github.com/spf13/cast v1.4.1 // indirect
-	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/pelletier/go-toml/v2 v2.1.1 // indirect
+	github.com/sagikazarmark/locafero v0.4.0 // indirect
+	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
+	github.com/spf13/cast v1.6.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/spf13/viper v1.10.1 // indirect
-	github.com/subosito/gotenv v1.2.0 // indirect
-	golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
-	golang.org/x/text v0.3.7 // indirect
-	gopkg.in/ini.v1 v1.66.3 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	golang.org/x/exp v0.0.0-20240119083558-1b970713d09a // indirect
+	golang.org/x/sys v0.16.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )