spf13--viper/viper.go

1306 lines
36 KiB
Go
Raw Normal View History

2014-04-04 21:21:59 +00:00
// Copyright © 2014 Steve Francia <spf@spf13.com>.
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.
2014-09-27 21:03:00 +00:00
// Viper is a application configuration system.
// It believes that applications can be configured a variety of ways
2014-10-24 19:38:01 +00:00
// via flags, ENVIRONMENT variables, configuration files retrieved
// from the file system, or a remote key/value store.
2014-09-27 21:03:00 +00:00
// Each item takes precedence over the item below it:
// overrides
2014-09-27 21:03:00 +00:00
// flag
// env
// config
2014-10-24 19:38:01 +00:00
// key/value store
2014-09-27 21:03:00 +00:00
// default
2014-04-04 21:21:59 +00:00
package viper
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"log"
2014-04-04 21:21:59 +00:00
"os"
"path/filepath"
2014-10-24 19:38:01 +00:00
"reflect"
2014-04-05 05:19:39 +00:00
"strings"
2014-04-04 21:21:59 +00:00
"time"
"github.com/kr/pretty"
"github.com/mitchellh/mapstructure"
2015-07-30 20:44:12 +00:00
"github.com/spf13/cast"
2014-04-04 21:21:59 +00:00
jww "github.com/spf13/jwalterweatherman"
"github.com/spf13/pflag"
"gopkg.in/fsnotify.v1"
"github.com/doublerebel/bellows"
2014-04-04 21:21:59 +00:00
)
var v *Viper
func init() {
v = New()
}
2015-05-30 19:28:33 +00:00
type remoteConfigFactory interface {
Get(rp RemoteProvider) (io.Reader, error)
Watch(rp RemoteProvider) (io.Reader, error)
}
// RemoteConfig is optional, see the remote package
var RemoteConfig remoteConfigFactory
// Denotes encountering an unsupported
// configuration filetype.
type UnsupportedConfigError string
// Returns the formatted configuration error.
func (str UnsupportedConfigError) Error() string {
return fmt.Sprintf("Unsupported Config Type %q", string(str))
}
// Denotes encountering an unsupported remote
// provider. Currently only etcd and Consul are
// supported.
type UnsupportedRemoteProviderError string
// Returns the formatted remote provider error.
func (str UnsupportedRemoteProviderError) Error() string {
return fmt.Sprintf("Unsupported Remote Provider Type %q", string(str))
}
// Denotes encountering an error while trying to
// pull the configuration from the remote provider.
type RemoteConfigError string
// Returns the formatted remote provider error
func (rce RemoteConfigError) Error() string {
return fmt.Sprintf("Remote Configurations Error: %s", string(rce))
}
2015-08-02 00:37:27 +00:00
// Denotes failing to find configuration file.
type ConfigFileNotFoundError struct {
name, locations string
}
// Returns the formatted configuration error.
func (fnfe ConfigFileNotFoundError) Error() string {
return fmt.Sprintf("Config File %q Not Found in %q", fnfe.name, fnfe.locations)
}
// Viper is a prioritized configuration registry. It
// maintains a set of configuration sources, fetches
// values to populate those, and provides them according
// to the source's priority.
// The priority of the sources is the following:
// 1. overrides
// 2. flags
// 3. env. variables
// 4. config file
// 5. key/value store
// 6. defaults
//
// For example, if values from the following sources were loaded:
//
// Defaults : {
// "secret": "",
// "user": "default",
2015-12-02 10:15:48 +00:00
// "endpoint": "https://localhost"
// }
// Config : {
// "user": "root"
2015-12-02 10:15:48 +00:00
// "secret": "defaultsecret"
// }
// Env : {
// "secret": "somesecretkey"
// }
//
// The resulting config will have the following values:
//
// {
// "secret": "somesecretkey",
// "user": "root",
// "endpoint": "https://localhost"
// }
type Viper struct {
// Delimiter that separates a list of keys
// used to access a nested value in one go
keyDelim string
// A set of paths to look for the config file in
configPaths []string
// A set of remote providers to search for the configuration
2015-05-30 19:28:33 +00:00
remoteProviders []*defaultRemoteProvider
// Name of file to look for inside the path
configName string
configFile string
configType string
envPrefix string
automaticEnvApplied bool
2015-03-06 19:21:17 +00:00
envKeyReplacer *strings.Replacer
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
config map[string]interface{}
override map[string]interface{}
defaults map[string]interface{}
kvstore map[string]interface{}
pflags map[string]FlagValue
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
env map[string]string
aliases map[string]string
typeByDefValue bool
onConfigChange func(fsnotify.Event)
}
// Returns an initialized Viper instance.
func New() *Viper {
v := new(Viper)
v.keyDelim = "."
v.configName = "config"
v.config = make(map[string]interface{})
v.override = make(map[string]interface{})
v.defaults = make(map[string]interface{})
v.kvstore = make(map[string]interface{})
v.pflags = make(map[string]FlagValue)
v.env = make(map[string]string)
v.aliases = make(map[string]string)
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
v.typeByDefValue = false
return v
}
// Intended for testing, will reset all to default settings.
// In the public interface for the viper package so applications
// can use it in their testing as well.
func Reset() {
v = New()
2015-12-11 22:51:11 +00:00
SupportedExts = []string{"json", "toml", "yaml", "yml", "hcl"}
SupportedRemoteProviders = []string{"etcd", "consul"}
}
2015-05-30 19:28:33 +00:00
type defaultRemoteProvider struct {
2014-10-24 19:38:01 +00:00
provider string
endpoint string
path string
secretKeyring string
}
2015-05-30 19:28:33 +00:00
func (rp defaultRemoteProvider) Provider() string {
return rp.provider
}
func (rp defaultRemoteProvider) Endpoint() string {
return rp.endpoint
}
func (rp defaultRemoteProvider) Path() string {
return rp.path
}
func (rp defaultRemoteProvider) SecretKeyring() string {
return rp.secretKeyring
}
// RemoteProvider stores the configuration necessary
// to connect to a remote key/value store.
// Optional secretKeyring to unencrypt encrypted values
// can be provided.
type RemoteProvider interface {
Provider() string
Endpoint() string
Path() string
SecretKeyring() string
}
// Universally supported extensions.
2015-12-11 22:51:11 +00:00
var SupportedExts []string = []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl"}
2014-04-04 21:21:59 +00:00
// Universally supported remote providers.
var SupportedRemoteProviders []string = []string{"etcd", "consul"}
2014-04-04 21:21:59 +00:00
func OnConfigChange(run func(in fsnotify.Event)) { v.OnConfigChange(run) }
func (v *Viper) OnConfigChange(run func(in fsnotify.Event)) {
v.onConfigChange = run
}
func WatchConfig() { v.WatchConfig() }
func (v *Viper) WatchConfig() {
go func() {
watcher, err := fsnotify.NewWatcher()
if err != nil {
log.Fatal(err)
}
defer watcher.Close()
// we have to watch the entire directory to pick up renames/atomic saves in a cross-platform way
configFile := filepath.Clean(v.getConfigFile())
configDir, _ := filepath.Split(configFile)
done := make(chan bool)
go func() {
for {
select {
case event := <-watcher.Events:
// we only care about the config file
if filepath.Clean(event.Name) == configFile {
if event.Op&fsnotify.Write == fsnotify.Write || event.Op&fsnotify.Create == fsnotify.Create {
err := v.ReadInConfig()
if err != nil {
log.Println("error:", err)
}
v.onConfigChange(event)
}
}
case err := <-watcher.Errors:
log.Println("error:", err)
}
}
}()
watcher.Add(configDir)
<-done
}()
}
2014-07-11 14:42:07 +00:00
// Explicitly define the path, name and extension of the config file
// Viper will use this and not check any of the config paths
func SetConfigFile(in string) { v.SetConfigFile(in) }
func (v *Viper) SetConfigFile(in string) {
2014-04-04 21:21:59 +00:00
if in != "" {
v.configFile = in
2014-04-04 21:21:59 +00:00
}
}
// Define a prefix that ENVIRONMENT variables will use.
// E.g. if your prefix is "spf", the env registry
// will look for env. variables that start with "SPF_"
func SetEnvPrefix(in string) { v.SetEnvPrefix(in) }
func (v *Viper) SetEnvPrefix(in string) {
if in != "" {
v.envPrefix = in
}
}
func (v *Viper) mergeWithEnvPrefix(in string) string {
if v.envPrefix != "" {
return strings.ToUpper(v.envPrefix + "_" + in)
}
return strings.ToUpper(in)
}
2015-03-06 19:21:17 +00:00
// TODO: should getEnv logic be moved into find(). Can generalize the use of
// rewriting keys many things, Ex: Get('someKey') -> some_key
// (cammel case to snake case for JSON keys perhaps)
// getEnv s a wrapper around os.Getenv which replaces characters in the original
// key. This allows env vars which have different keys then the config object
// keys
func (v *Viper) getEnv(key string) string {
2015-03-06 19:21:17 +00:00
if v.envKeyReplacer != nil {
key = v.envKeyReplacer.Replace(key)
}
return os.Getenv(key)
}
// Return the file used to populate the config registry
func ConfigFileUsed() string { return v.ConfigFileUsed() }
func (v *Viper) ConfigFileUsed() string { return v.configFile }
2014-04-08 03:35:40 +00:00
// Add a path for Viper to search for the config file in.
2014-07-11 14:42:07 +00:00
// Can be called multiple times to define multiple search paths.
func AddConfigPath(in string) { v.AddConfigPath(in) }
func (v *Viper) AddConfigPath(in string) {
2014-04-04 21:21:59 +00:00
if in != "" {
absin := absPathify(in)
jww.INFO.Println("adding", absin, "to paths to search")
if !stringInSlice(absin, v.configPaths) {
v.configPaths = append(v.configPaths, absin)
2014-04-04 21:21:59 +00:00
}
}
}
2014-10-24 19:38:01 +00:00
// AddRemoteProvider adds a remote configuration source.
// Remote Providers are searched in the order they are added.
// provider is a string value, "etcd" or "consul" are currently supported.
// endpoint is the url. etcd requires http://ip:port consul requires ip:port
// path is the path in the k/v store to retrieve configuration
// To retrieve a config file called myapp.json from /configs/myapp.json
// you should set path to /configs and set config name (SetConfigName()) to
// "myapp"
func AddRemoteProvider(provider, endpoint, path string) error {
return v.AddRemoteProvider(provider, endpoint, path)
}
func (v *Viper) AddRemoteProvider(provider, endpoint, path string) error {
2014-10-24 19:38:01 +00:00
if !stringInSlice(provider, SupportedRemoteProviders) {
return UnsupportedRemoteProviderError(provider)
}
if provider != "" && endpoint != "" {
jww.INFO.Printf("adding %s:%s to remote provider list", provider, endpoint)
2015-05-30 19:28:33 +00:00
rp := &defaultRemoteProvider{
2014-10-24 19:38:01 +00:00
endpoint: endpoint,
provider: provider,
2014-10-27 16:21:03 +00:00
path: path,
2014-10-24 19:38:01 +00:00
}
if !v.providerPathExists(rp) {
v.remoteProviders = append(v.remoteProviders, rp)
2014-10-24 19:38:01 +00:00
}
}
return nil
}
// AddSecureRemoteProvider adds a remote configuration source.
// Secure Remote Providers are searched in the order they are added.
// provider is a string value, "etcd" or "consul" are currently supported.
// endpoint is the url. etcd requires http://ip:port consul requires ip:port
// secretkeyring is the filepath to your openpgp secret keyring. e.g. /etc/secrets/myring.gpg
// path is the path in the k/v store to retrieve configuration
// To retrieve a config file called myapp.json from /configs/myapp.json
// you should set path to /configs and set config name (SetConfigName()) to
// "myapp"
// Secure Remote Providers are implemented with github.com/xordataexchange/crypt
2014-10-27 16:21:03 +00:00
func AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error {
return v.AddSecureRemoteProvider(provider, endpoint, path, secretkeyring)
}
func (v *Viper) AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error {
2014-10-24 19:38:01 +00:00
if !stringInSlice(provider, SupportedRemoteProviders) {
return UnsupportedRemoteProviderError(provider)
}
if provider != "" && endpoint != "" {
jww.INFO.Printf("adding %s:%s to remote provider list", provider, endpoint)
2015-05-30 19:28:33 +00:00
rp := &defaultRemoteProvider{
endpoint: endpoint,
provider: provider,
path: path,
secretKeyring: secretkeyring,
2014-10-24 19:38:01 +00:00
}
if !v.providerPathExists(rp) {
v.remoteProviders = append(v.remoteProviders, rp)
2014-10-24 19:38:01 +00:00
}
}
return nil
}
2015-05-30 19:28:33 +00:00
func (v *Viper) providerPathExists(p *defaultRemoteProvider) bool {
for _, y := range v.remoteProviders {
2014-10-24 19:38:01 +00:00
if reflect.DeepEqual(y, p) {
return true
}
}
return false
}
func (v *Viper) searchMap(source map[string]interface{}, path []string) interface{} {
if len(path) == 0 {
return source
}
var ok bool
var next interface{}
for k, v := range source {
if strings.ToLower(k) == strings.ToLower(path[0]) {
ok = true
next = v
break
}
}
if ok {
switch next.(type) {
case map[interface{}]interface{}:
return v.searchMap(cast.ToStringMap(next), path[1:])
case map[string]interface{}:
// Type assertion is safe here since it is only reached
// if the type of `next` is the same as the type being asserted
return v.searchMap(next.(map[string]interface{}), path[1:])
default:
return next
}
} else {
return nil
}
}
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
// SetTypeByDefaultValue enables or disables the inference of a key value's
// type when the Get function is used based upon a key's default value as
// opposed to the value returned based on the normal fetch logic.
//
// For example, if a key has a default value of []string{} and the same key
// is set via an environment variable to "a b c", a call to the Get function
// would return a string slice for the key if the key's type is inferred by
// the default value and the Get function would return:
//
// []string {"a", "b", "c"}
//
// Otherwise the Get function would return:
//
// "a b c"
func SetTypeByDefaultValue(enable bool) { v.SetTypeByDefaultValue(enable) }
func (v *Viper) SetTypeByDefaultValue(enable bool) {
v.typeByDefValue = enable
}
// Viper is essentially repository for configurations
// Get can retrieve any value given the key to use
// Get has the behavior of returning the value associated with the first
// place from where it is set. Viper will check in the following order:
// override, flag, env, config file, key/value store, default
//
// Get returns an interface. For a specific value use one of the Get____ methods.
func Get(key string) interface{} { return v.Get(key) }
func (v *Viper) Get(key string) interface{} {
path := strings.Split(key, v.keyDelim)
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
lcaseKey := strings.ToLower(key)
val := v.find(lcaseKey)
if val == nil {
source := v.find(strings.ToLower(path[0]))
if source != nil {
if reflect.TypeOf(source).Kind() == reflect.Map {
val = v.searchMap(cast.ToStringMap(source), path[1:])
}
}
}
// if no other value is returned and a flag does exist for the value,
// get the flag's value even if the flag's value has not changed
if val == nil {
if flag, exists := v.pflags[lcaseKey]; exists {
jww.TRACE.Println(key, "get pflag default", val)
switch flag.ValueType() {
case "int", "int8", "int16", "int32", "int64":
val = cast.ToInt(flag.ValueString())
case "bool":
val = cast.ToBool(flag.ValueString())
default:
val = flag.ValueString()
}
}
}
if val == nil {
return nil
}
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
var valType interface{}
if !v.typeByDefValue {
valType = val
} else {
defVal, defExists := v.defaults[lcaseKey]
if defExists {
valType = defVal
} else {
valType = val
}
}
switch valType.(type) {
case bool:
return cast.ToBool(val)
case string:
return cast.ToString(val)
case int64, int32, int16, int8, int:
return cast.ToInt(val)
case float64, float32:
return cast.ToFloat64(val)
case time.Time:
return cast.ToTime(val)
2015-02-19 03:03:20 +00:00
case time.Duration:
return cast.ToDuration(val)
case []string:
[110] Default Values Specify Type This patch adds a feature, if enabled, will infer a value's type from its default value no matter from where else the value is set. This is particularly important when working with environment variables. For example: package main import ( "fmt" "os" "github.com/spf13/viper" ) func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) } When this program is executed the following is emitted: [0]akutz@pax:ex$ ./ex1 v1 []string [a b c] v2 string a b c [0]akutz@pax:ex$ You may wonder, why is this important? Just use the GetStringSlice function. Well, it *becomes* important when dealing with marshaling. If we update the above program to this: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d := &Data{} viper.Marshal(d) print("d.MyKey", d.MyKey) } Now we can see the issue when we execute the updated program: [0]akutz@pax:ex$ ./ex2 v1 []string [a b c] v2 string a b c d.MyKey []string [] [0]akutz@pax:ex$ The marshalled data structure's field MyKey is empty when in fact it should have a string slice equal to, in value, []string {"a", "b", "c"}. The problem is that viper's Marshal function calls AllSettings which ultimately uses the Get function. The Get function does try to infer the value's type, but it does so using the type of the value retrieved using this logic: Get has the behavior of returning the value associated with the first place from where it is set. Viper will check in the following order: * override * flag * env * config file * key/value store * default While the above order is the one we want when retrieving the values, this patch enables users to decide if it's the order they want to be used when inferring a value's type. To that end the function SetTypeByDefaultValue is introduced. When SetTypeByDefaultValue(true) is called, a call to the Get function will now first check a key's default value, if set, when inferring a value's type. This is demonstrated using a modified version of the same program above: package main import ( "fmt" "os" "github.com/spf13/viper" ) type Data struct { MyKey []string } func print(name string, val interface{}) { fmt.Printf("%-15[1]s%-15[2]T%[2]v\n", name, val) } func main() { viper.BindEnv("mykey", "MYPREFIX_MYKEY") viper.SetDefault("mykey", []string{}) os.Setenv("MYPREFIX_MYKEY", "a b c") v1 := viper.GetStringSlice("mykey") v2 := viper.Get("mykey") print("v1", v1) print("v2", v2) d1 := &Data{} viper.Marshal(d1) print("d1.MyKey", d1.MyKey) viper.SetTypeByDefaultValue(true) d2 := &Data{} viper.Marshal(d2) print("d2.MyKey", d2.MyKey) } Now the following is emitted: [0]akutz@pax:ex$ ./ex3 v1 []string [a b c] v2 string a b c d1.MyKey []string [] d2.MyKey []string [a b c] [0]akutz@pax:ex$
2015-08-29 15:54:20 +00:00
return cast.ToStringSlice(val)
}
return val
}
// Returns new Viper instance representing a sub tree of this instance
func Sub(key string) *Viper { return v.Sub(key) }
func (v *Viper) Sub(key string) *Viper {
subv := New()
data := v.Get(key)
if reflect.TypeOf(data).Kind() == reflect.Map {
subv.config = cast.ToStringMap(data)
return subv
} else {
return nil
}
}
// Returns the value associated with the key as a string
func GetString(key string) string { return v.GetString(key) }
func (v *Viper) GetString(key string) string {
return cast.ToString(v.Get(key))
2014-04-04 21:21:59 +00:00
}
// Returns the value associated with the key asa boolean
func GetBool(key string) bool { return v.GetBool(key) }
func (v *Viper) GetBool(key string) bool {
return cast.ToBool(v.Get(key))
2014-04-04 21:21:59 +00:00
}
// Returns the value associated with the key as an integer
func GetInt(key string) int { return v.GetInt(key) }
func (v *Viper) GetInt(key string) int {
return cast.ToInt(v.Get(key))
2014-04-04 21:21:59 +00:00
}
// Returns the value associated with the key as a float64
func GetFloat64(key string) float64 { return v.GetFloat64(key) }
func (v *Viper) GetFloat64(key string) float64 {
return cast.ToFloat64(v.Get(key))
2014-04-04 21:21:59 +00:00
}
// Returns the value associated with the key as time
func GetTime(key string) time.Time { return v.GetTime(key) }
func (v *Viper) GetTime(key string) time.Time {
return cast.ToTime(v.Get(key))
2014-04-04 21:21:59 +00:00
}
// Returns the value associated with the key as a duration
2015-02-19 03:03:20 +00:00
func GetDuration(key string) time.Duration { return v.GetDuration(key) }
func (v *Viper) GetDuration(key string) time.Duration {
2015-02-19 03:03:20 +00:00
return cast.ToDuration(v.Get(key))
}
// Returns the value associated with the key as a slice of strings
func GetStringSlice(key string) []string { return v.GetStringSlice(key) }
func (v *Viper) GetStringSlice(key string) []string {
return cast.ToStringSlice(v.Get(key))
2014-04-05 05:19:39 +00:00
}
// Returns the value associated with the key as a map of interfaces
func GetStringMap(key string) map[string]interface{} { return v.GetStringMap(key) }
func (v *Viper) GetStringMap(key string) map[string]interface{} {
return cast.ToStringMap(v.Get(key))
2014-04-05 05:19:39 +00:00
}
// Returns the value associated with the key as a map of strings
func GetStringMapString(key string) map[string]string { return v.GetStringMapString(key) }
func (v *Viper) GetStringMapString(key string) map[string]string {
return cast.ToStringMapString(v.Get(key))
2014-04-04 21:21:59 +00:00
}
2015-08-03 16:42:26 +00:00
// Returns the value associated with the key as a map to a slice of strings.
2015-07-30 20:43:18 +00:00
func GetStringMapStringSlice(key string) map[string][]string { return v.GetStringMapStringSlice(key) }
2015-07-30 20:46:38 +00:00
func (v *Viper) GetStringMapStringSlice(key string) map[string][]string {
2015-07-30 20:27:34 +00:00
return cast.ToStringMapStringSlice(v.Get(key))
}
// Returns the size of the value associated with the given key
// in bytes.
func GetSizeInBytes(key string) uint { return v.GetSizeInBytes(key) }
func (v *Viper) GetSizeInBytes(key string) uint {
sizeStr := cast.ToString(v.Get(key))
return parseSizeInBytes(sizeStr)
}
// Takes a single key and unmarshals it into a Struct
func UnmarshalKey(key string, rawVal interface{}) error { return v.UnmarshalKey(key, rawVal) }
func (v *Viper) UnmarshalKey(key string, rawVal interface{}) error {
return mapstructure.Decode(v.Get(key), rawVal)
}
// Unmarshals the config into a Struct. Make sure that the tags
// on the fields of the structure are properly set.
func Unmarshal(rawVal interface{}) error { return v.Unmarshal(rawVal) }
func (v *Viper) Unmarshal(rawVal interface{}) error {
expanded := bellows.Expand(v.AllSettings())
err := mapstructure.WeakDecode(expanded, rawVal)
if err != nil {
return err
}
v.insensitiviseMaps()
return nil
}
// A wrapper around mapstructure.Decode that mimics the WeakDecode functionality
// while erroring on non existing vals in the destination struct
func weakDecodeExact(input, output interface{}) error {
config := &mapstructure.DecoderConfig{
ErrorUnused: true,
Metadata: nil,
Result: output,
WeaklyTypedInput: true,
}
decoder, err := mapstructure.NewDecoder(config)
if err != nil {
return err
}
return decoder.Decode(input)
}
// Unmarshals the config into a Struct, erroring if a field is non-existant
// in the destination struct
func (v *Viper) UnmarshalExact(rawVal interface{}) error {
err := weakDecodeExact(v.AllSettings(), rawVal)
2014-10-24 19:38:01 +00:00
if err != nil {
return err
}
v.insensitiviseMaps()
return nil
}
// Bind a full flag set to the configuration, using each flag's long
// name as the config key.
func BindPFlags(flags *pflag.FlagSet) (err error) { return v.BindPFlags(flags) }
func (v *Viper) BindPFlags(flags *pflag.FlagSet) (err error) {
return v.BindFlagValues(pflagValueSet{flags})
}
// Bind a specific key to a pflag (as used by cobra)
// Example(where serverCmd is a Cobra instance):
//
// serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
// Viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))
//
func BindPFlag(key string, flag *pflag.Flag) (err error) { return v.BindPFlag(key, flag) }
func (v *Viper) BindPFlag(key string, flag *pflag.Flag) (err error) {
return v.BindFlagValue(key, pflagValue{flag})
}
// Bind a full FlagValue set to the configuration, using each flag's long
// name as the config key.
func BindFlagValues(flags FlagValueSet) (err error) { return v.BindFlagValues(flags) }
func (v *Viper) BindFlagValues(flags FlagValueSet) (err error) {
flags.VisitAll(func(flag FlagValue) {
if err = v.BindFlagValue(flag.Name(), flag); err != nil {
return
}
})
return nil
}
// Bind a specific key to a FlagValue.
// Example(where serverCmd is a Cobra instance):
2014-07-11 14:42:07 +00:00
//
// serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
// Viper.BindFlagValue("port", serverCmd.Flags().Lookup("port"))
2014-07-11 14:42:07 +00:00
//
func BindFlagValue(key string, flag FlagValue) (err error) { return v.BindFlagValue(key, flag) }
func (v *Viper) BindFlagValue(key string, flag FlagValue) (err error) {
if flag == nil {
return fmt.Errorf("flag for %q is nil", key)
}
v.pflags[strings.ToLower(key)] = flag
return nil
}
// Binds a Viper key to a ENV variable
2014-09-27 21:03:00 +00:00
// ENV variables are case sensitive
// If only a key is provided, it will use the env key matching the key, uppercased.
// EnvPrefix will be used when set when env name is not provided.
func BindEnv(input ...string) (err error) { return v.BindEnv(input...) }
func (v *Viper) BindEnv(input ...string) (err error) {
2014-09-27 21:03:00 +00:00
var key, envkey string
if len(input) == 0 {
return fmt.Errorf("BindEnv missing key to bind to")
}
key = strings.ToLower(input[0])
2014-09-27 21:03:00 +00:00
if len(input) == 1 {
envkey = v.mergeWithEnvPrefix(key)
2014-09-27 21:03:00 +00:00
} else {
envkey = input[1]
}
v.env[key] = envkey
2014-09-27 21:03:00 +00:00
return nil
}
// Given a key, find the value
// Viper will check in the following order:
// flag, env, config file, key/value store, default
// Viper will check to see if an alias exists first
func (v *Viper) find(key string) interface{} {
2014-04-04 21:21:59 +00:00
var val interface{}
var exists bool
2014-04-05 05:19:39 +00:00
// if the requested key is an alias, then return the proper key
key = v.realKey(key)
2014-04-04 21:21:59 +00:00
// PFlag Override first
flag, exists := v.pflags[key]
if exists && flag.HasChanged() {
jww.TRACE.Println(key, "found in override (via pflag):", flag.ValueString())
switch flag.ValueType() {
case "int", "int8", "int16", "int32", "int64":
return cast.ToInt(flag.ValueString())
case "bool":
return cast.ToBool(flag.ValueString())
default:
return flag.ValueString()
}
}
val, exists = v.override[key]
2014-04-04 21:21:59 +00:00
if exists {
jww.TRACE.Println(key, "found in override:", val)
return val
}
if v.automaticEnvApplied {
// even if it hasn't been registered, if automaticEnv is used,
// check any Get request
2015-03-06 19:21:17 +00:00
if val = v.getEnv(v.mergeWithEnvPrefix(key)); val != "" {
jww.TRACE.Println(key, "found in environment with val:", val)
return val
}
}
envkey, exists := v.env[key]
2014-09-27 21:03:00 +00:00
if exists {
jww.TRACE.Println(key, "registered as env var", envkey)
2015-03-06 19:21:17 +00:00
if val = v.getEnv(envkey); val != "" {
2014-11-07 18:14:27 +00:00
jww.TRACE.Println(envkey, "found in environment with val:", val)
2014-09-27 21:03:00 +00:00
return val
} else {
jww.TRACE.Println(envkey, "env value unset:")
}
}
val, exists = v.config[key]
2014-04-04 21:21:59 +00:00
if exists {
jww.TRACE.Println(key, "found in config:", val)
return val
}
// Test for nested config parameter
if strings.Contains(key, v.keyDelim) {
path := strings.Split(key, v.keyDelim)
source := v.find(path[0])
if source != nil {
if reflect.TypeOf(source).Kind() == reflect.Map {
val := v.searchMap(cast.ToStringMap(source), path[1:])
jww.TRACE.Println(key, "found in nested config:", val)
return val
}
}
}
val, exists = v.kvstore[key]
2014-10-24 19:38:01 +00:00
if exists {
jww.TRACE.Println(key, "found in key/value store:", val)
return val
}
val, exists = v.defaults[key]
2014-04-04 21:21:59 +00:00
if exists {
jww.TRACE.Println(key, "found in defaults:", val)
return val
}
return nil
}
// Check to see if the key has been set in any of the data locations
func IsSet(key string) bool { return v.IsSet(key) }
func (v *Viper) IsSet(key string) bool {
path := strings.Split(key, v.keyDelim)
lcaseKey := strings.ToLower(key)
val := v.find(lcaseKey)
if val == nil {
source := v.find(strings.ToLower(path[0]))
if source != nil {
if reflect.TypeOf(source).Kind() == reflect.Map {
val = v.searchMap(cast.ToStringMap(source), path[1:])
}
}
}
return val != nil
2014-04-04 21:21:59 +00:00
}
// Have Viper check ENV variables for all
// keys set in config, default & flags
func AutomaticEnv() { v.AutomaticEnv() }
func (v *Viper) AutomaticEnv() {
v.automaticEnvApplied = true
}
2015-03-06 19:21:17 +00:00
// SetEnvKeyReplacer sets the strings.Replacer on the viper object
// Useful for mapping an environmental variable to a key that does
// not match it.
2015-03-06 19:21:17 +00:00
func SetEnvKeyReplacer(r *strings.Replacer) { v.SetEnvKeyReplacer(r) }
func (v *Viper) SetEnvKeyReplacer(r *strings.Replacer) {
2015-03-06 19:21:17 +00:00
v.envKeyReplacer = r
}
2014-07-11 14:42:07 +00:00
// Aliases provide another accessor for the same key.
// This enables one to change a name without breaking the application
func RegisterAlias(alias string, key string) { v.RegisterAlias(alias, key) }
func (v *Viper) RegisterAlias(alias string, key string) {
v.registerAlias(alias, strings.ToLower(key))
2014-04-05 05:19:39 +00:00
}
func (v *Viper) registerAlias(alias string, key string) {
2014-04-05 05:19:39 +00:00
alias = strings.ToLower(alias)
if alias != key && alias != v.realKey(key) {
_, exists := v.aliases[alias]
2014-04-05 05:19:39 +00:00
if !exists {
// if we alias something that exists in one of the maps to another
// name, we'll never be able to get that value using the original
// name, so move the config value to the new realkey.
if val, ok := v.config[alias]; ok {
delete(v.config, alias)
v.config[key] = val
}
if val, ok := v.kvstore[alias]; ok {
delete(v.kvstore, alias)
v.kvstore[key] = val
2014-10-24 19:38:01 +00:00
}
if val, ok := v.defaults[alias]; ok {
delete(v.defaults, alias)
v.defaults[key] = val
}
if val, ok := v.override[alias]; ok {
delete(v.override, alias)
v.override[key] = val
}
v.aliases[alias] = key
2014-04-05 05:19:39 +00:00
}
} else {
jww.WARN.Println("Creating circular reference alias", alias, key, v.realKey(key))
2014-04-05 05:19:39 +00:00
}
}
func (v *Viper) realKey(key string) string {
newkey, exists := v.aliases[key]
2014-04-05 05:19:39 +00:00
if exists {
jww.DEBUG.Println("Alias", key, "to", newkey)
return v.realKey(newkey)
2014-04-05 05:19:39 +00:00
} else {
return key
}
2014-04-04 21:21:59 +00:00
}
// Check to see if the given key (or an alias) is in the config file
func InConfig(key string) bool { return v.InConfig(key) }
func (v *Viper) InConfig(key string) bool {
2014-04-05 05:19:39 +00:00
// if the requested key is an alias, then return the proper key
key = v.realKey(key)
2014-04-05 05:19:39 +00:00
_, exists := v.config[key]
2014-04-04 21:21:59 +00:00
return exists
}
2014-07-11 14:42:07 +00:00
// Set the default value for this key.
// Default only used when no value is provided by the user via flag, config or ENV.
func SetDefault(key string, value interface{}) { v.SetDefault(key, value) }
func (v *Viper) SetDefault(key string, value interface{}) {
2014-04-04 21:21:59 +00:00
// If alias passed in, then set the proper default
flat := bellows.FlattenPrefixed(value, key)
for flatkey, flatval := range flat {
flatkey = v.realKey(strings.ToLower(flatkey))
v.defaults[flatkey] = flatval
}
2014-04-04 21:21:59 +00:00
}
// Sets the value for the key in the override regiser.
2014-10-24 19:38:01 +00:00
// Will be used instead of values obtained via
// flags, config file, ENV, default, or key/value store
func Set(key string, value interface{}) { v.Set(key, value) }
func (v *Viper) Set(key string, value interface{}) {
2014-04-04 21:21:59 +00:00
// If alias passed in, then set the proper override
key = v.realKey(strings.ToLower(key))
v.override[key] = value
}
2014-07-11 14:42:07 +00:00
// Viper will discover and load the configuration file from disk
2014-10-24 19:38:01 +00:00
// and key/value stores, searching in one of the defined paths.
func ReadInConfig() error { return v.ReadInConfig() }
func (v *Viper) ReadInConfig() error {
2014-04-04 21:21:59 +00:00
jww.INFO.Println("Attempting to read in config file")
if !stringInSlice(v.getConfigType(), SupportedExts) {
return UnsupportedConfigError(v.getConfigType())
2014-04-04 21:21:59 +00:00
}
file, err := ioutil.ReadFile(v.getConfigFile())
if err != nil {
return err
2014-04-04 21:21:59 +00:00
}
v.config = make(map[string]interface{})
return v.unmarshalReader(bytes.NewReader(file), v.config)
2014-04-04 21:21:59 +00:00
}
// MergeInConfig merges a new configuration with an existing config.
func MergeInConfig() error { return v.MergeInConfig() }
func (v *Viper) MergeInConfig() error {
jww.INFO.Println("Attempting to merge in config file")
if !stringInSlice(v.getConfigType(), SupportedExts) {
return UnsupportedConfigError(v.getConfigType())
}
file, err := ioutil.ReadFile(v.getConfigFile())
if err != nil {
return err
}
return v.MergeConfig(bytes.NewReader(file))
}
// Viper will read a configuration file, setting existing keys to nil if the
// key does not exist in the file.
2015-05-14 09:40:59 +00:00
func ReadConfig(in io.Reader) error { return v.ReadConfig(in) }
func (v *Viper) ReadConfig(in io.Reader) error {
2015-05-08 09:13:33 +00:00
v.config = make(map[string]interface{})
return v.unmarshalReader(in, v.config)
2015-05-08 09:13:33 +00:00
}
// MergeConfig merges a new configuration with an existing config.
func MergeConfig(in io.Reader) error { return v.MergeConfig(in) }
func (v *Viper) MergeConfig(in io.Reader) error {
if v.config == nil {
v.config = make(map[string]interface{})
}
cfg := make(map[string]interface{})
if err := v.unmarshalReader(in, cfg); err != nil {
return err
}
mergeMaps(cfg, v.config, nil)
return nil
}
func keyExists(k string, m map[string]interface{}) string {
lk := strings.ToLower(k)
for mk := range m {
lmk := strings.ToLower(mk)
if lmk == lk {
return mk
}
}
return ""
}
func castToMapStringInterface(
src map[interface{}]interface{}) map[string]interface{} {
tgt := map[string]interface{}{}
for k, v := range src {
tgt[fmt.Sprintf("%v", k)] = v
}
return tgt
}
// mergeMaps merges two maps. The `itgt` parameter is for handling go-yaml's
// insistence on parsing nested structures as `map[interface{}]interface{}`
// instead of using a `string` as the key for nest structures beyond one level
// deep. Both map types are supported as there is a go-yaml fork that uses
// `map[string]interface{}` instead.
func mergeMaps(
src, tgt map[string]interface{}, itgt map[interface{}]interface{}) {
for sk, sv := range src {
tk := keyExists(sk, tgt)
if tk == "" {
jww.TRACE.Printf("tk=\"\", tgt[%s]=%v", sk, sv)
tgt[sk] = sv
if itgt != nil {
itgt[sk] = sv
}
continue
}
tv, ok := tgt[tk]
if !ok {
jww.TRACE.Printf("tgt[%s] != ok, tgt[%s]=%v", tk, sk, sv)
tgt[sk] = sv
if itgt != nil {
itgt[sk] = sv
}
continue
}
svType := reflect.TypeOf(sv)
tvType := reflect.TypeOf(tv)
if svType != tvType {
jww.ERROR.Printf(
"svType != tvType; key=%s, st=%v, tt=%v, sv=%v, tv=%v",
sk, svType, tvType, sv, tv)
continue
}
jww.TRACE.Printf("processing key=%s, st=%v, tt=%v, sv=%v, tv=%v",
sk, svType, tvType, sv, tv)
switch ttv := tv.(type) {
case map[interface{}]interface{}:
jww.TRACE.Printf("merging maps (must convert)")
tsv := sv.(map[interface{}]interface{})
ssv := castToMapStringInterface(tsv)
stv := castToMapStringInterface(ttv)
mergeMaps(ssv, stv, ttv)
case map[string]interface{}:
jww.TRACE.Printf("merging maps")
mergeMaps(sv.(map[string]interface{}), ttv, nil)
default:
jww.TRACE.Printf("setting value")
tgt[tk] = sv
if itgt != nil {
itgt[tk] = sv
}
}
}
}
2015-05-14 09:40:59 +00:00
// func ReadBufConfig(buf *bytes.Buffer) error { return v.ReadBufConfig(buf) }
// func (v *Viper) ReadBufConfig(buf *bytes.Buffer) error {
// v.config = make(map[string]interface{})
// return v.unmarshalReader(buf, v.config)
2015-05-14 09:40:59 +00:00
// }
// Attempts to get configuration from a remote source
// and read it in the remote configuration registry.
func ReadRemoteConfig() error { return v.ReadRemoteConfig() }
func (v *Viper) ReadRemoteConfig() error {
err := v.getKeyValueConfig()
if err != nil {
return err
}
return nil
}
2015-05-08 09:13:33 +00:00
func WatchRemoteConfig() error { return v.WatchRemoteConfig() }
func (v *Viper) WatchRemoteConfig() error {
err := v.watchKeyValueConfig()
if err != nil {
return err
}
return nil
}
// Unmarshall a Reader into a map
// Should probably be an unexported function
func unmarshalReader(in io.Reader, c map[string]interface{}) error {
return v.unmarshalReader(in, c)
2015-08-02 01:32:35 +00:00
}
func (v *Viper) unmarshalReader(in io.Reader, c map[string]interface{}) error {
return unmarshallConfigReader(in, c, v.getConfigType())
}
func (v *Viper) insensitiviseMaps() {
insensitiviseMap(v.config)
insensitiviseMap(v.defaults)
insensitiviseMap(v.override)
insensitiviseMap(v.kvstore)
2014-10-24 19:38:01 +00:00
}
// retrieve the first found remote configuration
func (v *Viper) getKeyValueConfig() error {
2015-05-30 19:28:33 +00:00
if RemoteConfig == nil {
return RemoteConfigError("Enable the remote features by doing a blank import of the viper/remote package: '_ github.com/spf13/viper/remote'")
}
for _, rp := range v.remoteProviders {
val, err := v.getRemoteConfig(rp)
2014-10-24 19:38:01 +00:00
if err != nil {
2014-10-26 13:42:03 +00:00
continue
2014-10-24 19:38:01 +00:00
}
v.kvstore = val
2014-10-26 13:42:03 +00:00
return nil
2014-10-24 19:38:01 +00:00
}
return RemoteConfigError("No Files Found")
}
2015-05-30 19:28:33 +00:00
func (v *Viper) getRemoteConfig(provider *defaultRemoteProvider) (map[string]interface{}, error) {
2014-10-26 13:42:03 +00:00
2015-05-30 19:28:33 +00:00
reader, err := RemoteConfig.Get(provider)
2014-10-26 13:42:03 +00:00
if err != nil {
return nil, err
}
err = v.unmarshalReader(reader, v.kvstore)
return v.kvstore, err
2015-05-08 09:13:33 +00:00
}
// retrieve the first found remote configuration
func (v *Viper) watchKeyValueConfig() error {
for _, rp := range v.remoteProviders {
val, err := v.watchRemoteConfig(rp)
if err != nil {
continue
}
v.kvstore = val
return nil
}
return RemoteConfigError("No Files Found")
}
2015-05-30 19:28:33 +00:00
func (v *Viper) watchRemoteConfig(provider *defaultRemoteProvider) (map[string]interface{}, error) {
reader, err := RemoteConfig.Watch(provider)
2015-05-08 09:13:33 +00:00
if err != nil {
return nil, err
}
err = v.unmarshalReader(reader, v.kvstore)
2015-05-08 09:13:33 +00:00
return v.kvstore, err
2014-10-26 13:42:03 +00:00
}
// Return all keys regardless where they are set
func AllKeys() []string { return v.AllKeys() }
func (v *Viper) AllKeys() []string {
m := map[string]struct{}{}
for key, _ := range v.defaults {
m[strings.ToLower(key)] = struct{}{}
}
for key, _ := range v.pflags {
m[strings.ToLower(key)] = struct{}{}
}
for key, _ := range v.env {
m[strings.ToLower(key)] = struct{}{}
}
for key, _ := range v.config {
m[strings.ToLower(key)] = struct{}{}
}
for key, _ := range v.kvstore {
m[strings.ToLower(key)] = struct{}{}
2014-10-24 19:38:01 +00:00
}
for key, _ := range v.override {
m[strings.ToLower(key)] = struct{}{}
}
for key, _ := range v.aliases {
m[strings.ToLower(key)] = struct{}{}
}
a := []string{}
for x, _ := range m {
a = append(a, x)
}
return a
}
// Return all settings as a map[string]interface{}
func AllSettings() map[string]interface{} { return v.AllSettings() }
func (v *Viper) AllSettings() map[string]interface{} {
m := map[string]interface{}{}
for _, x := range v.AllKeys() {
m[x] = v.Get(x)
}
return m
}
2014-07-11 14:42:07 +00:00
// Name for the config file.
// Does not include extension.
func SetConfigName(in string) { v.SetConfigName(in) }
func (v *Viper) SetConfigName(in string) {
2014-04-04 21:21:59 +00:00
if in != "" {
v.configName = in
2014-04-04 21:21:59 +00:00
}
}
// Sets the type of the configuration returned by the
// remote source, e.g. "json".
func SetConfigType(in string) { v.SetConfigType(in) }
func (v *Viper) SetConfigType(in string) {
2014-04-04 21:21:59 +00:00
if in != "" {
v.configType = in
2014-04-04 21:21:59 +00:00
}
}
func (v *Viper) getConfigType() string {
if v.configType != "" {
return v.configType
2014-04-04 21:21:59 +00:00
}
cf := v.getConfigFile()
ext := filepath.Ext(cf)
2014-04-04 21:21:59 +00:00
if len(ext) > 1 {
return ext[1:]
} else {
return ""
}
}
func (v *Viper) getConfigFile() string {
2014-04-04 21:21:59 +00:00
// if explicitly set, then use it
if v.configFile != "" {
return v.configFile
2014-04-04 21:21:59 +00:00
}
cf, err := v.findConfigFile()
2014-04-04 21:21:59 +00:00
if err != nil {
return ""
2014-04-04 21:21:59 +00:00
}
v.configFile = cf
return v.getConfigFile()
2014-04-04 21:21:59 +00:00
}
func (v *Viper) searchInPath(in string) (filename string) {
2014-04-04 21:21:59 +00:00
jww.DEBUG.Println("Searching for config in ", in)
for _, ext := range SupportedExts {
jww.DEBUG.Println("Checking for", filepath.Join(in, v.configName+"."+ext))
if b, _ := exists(filepath.Join(in, v.configName+"."+ext)); b {
jww.DEBUG.Println("Found: ", filepath.Join(in, v.configName+"."+ext))
return filepath.Join(in, v.configName+"."+ext)
2014-04-04 21:21:59 +00:00
}
}
return ""
}
// search all configPaths for any config file.
// Returns the first path that exists (and is a config file)
func (v *Viper) findConfigFile() (string, error) {
2015-08-02 00:37:27 +00:00
jww.INFO.Println("Searching for config in ", v.configPaths)
2014-04-04 21:21:59 +00:00
for _, cp := range v.configPaths {
file := v.searchInPath(cp)
2014-04-04 21:21:59 +00:00
if file != "" {
return file, nil
}
}
2015-08-02 00:37:27 +00:00
return "", ConfigFileNotFoundError{v.configName, fmt.Sprintf("%s", v.configPaths)}
}
// Prints all configuration registries for debugging
// purposes.
func Debug() { v.Debug() }
func (v *Viper) Debug() {
fmt.Println("Aliases:")
pretty.Println(v.aliases)
fmt.Println("Override:")
pretty.Println(v.override)
fmt.Println("PFlags")
pretty.Println(v.pflags)
fmt.Println("Env:")
pretty.Println(v.env)
fmt.Println("Key/Value Store:")
pretty.Println(v.kvstore)
fmt.Println("Config:")
pretty.Println(v.config)
fmt.Println("Defaults:")
pretty.Println(v.defaults)
2014-04-04 21:21:59 +00:00
}