12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316 |
- // 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.
- // Viper is a application configuration system.
- // It believes that applications can be configured a variety of ways
- // via flags, ENVIRONMENT variables, configuration files retrieved
- // from the file system, or a remote key/value store.
- // Each item takes precedence over the item below it:
- // overrides
- // flag
- // env
- // config
- // key/value store
- // default
- package viper
- import (
- "bytes"
- "fmt"
- "io"
- "log"
- "os"
- "path/filepath"
- "reflect"
- "strings"
- "time"
- "github.com/fsnotify/fsnotify"
- "github.com/mitchellh/mapstructure"
- "github.com/spf13/afero"
- "github.com/spf13/cast"
- jww "github.com/spf13/jwalterweatherman"
- "github.com/spf13/pflag"
- )
- var v *Viper
- func init() {
- v = New()
- }
- 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))
- }
- // 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",
- // "endpoint": "https://localhost"
- // }
- // Config : {
- // "user": "root"
- // "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
- // The filesystem to read config from.
- fs afero.Fs
- // A set of remote providers to search for the configuration
- remoteProviders []*defaultRemoteProvider
- // Name of file to look for inside the path
- configName string
- configFile string
- configType string
- envPrefix string
- automaticEnvApplied bool
- envKeyReplacer *strings.Replacer
- config map[string]interface{}
- override map[string]interface{}
- defaults map[string]interface{}
- kvstore map[string]interface{}
- pflags map[string]FlagValue
- 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.fs = afero.NewOsFs()
- 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)
- 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()
- SupportedExts = []string{"json", "toml", "yaml", "yml", "hcl"}
- SupportedRemoteProviders = []string{"etcd", "consul"}
- }
- type defaultRemoteProvider struct {
- provider string
- endpoint string
- path string
- secretKeyring string
- }
- 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.
- var SupportedExts []string = []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl"}
- // Universally supported remote providers.
- var SupportedRemoteProviders []string = []string{"etcd", "consul"}
- 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
- }()
- }
- // 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) {
- if in != "" {
- v.configFile = in
- }
- }
- // 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)
- }
- // 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 {
- 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 }
- // Add a path for Viper to search for the config file in.
- // Can be called multiple times to define multiple search paths.
- func AddConfigPath(in string) { v.AddConfigPath(in) }
- func (v *Viper) AddConfigPath(in string) {
- 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)
- }
- }
- }
- // 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 {
- if !stringInSlice(provider, SupportedRemoteProviders) {
- return UnsupportedRemoteProviderError(provider)
- }
- if provider != "" && endpoint != "" {
- jww.INFO.Printf("adding %s:%s to remote provider list", provider, endpoint)
- rp := &defaultRemoteProvider{
- endpoint: endpoint,
- provider: provider,
- path: path,
- }
- if !v.providerPathExists(rp) {
- v.remoteProviders = append(v.remoteProviders, rp)
- }
- }
- 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
- 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 {
- if !stringInSlice(provider, SupportedRemoteProviders) {
- return UnsupportedRemoteProviderError(provider)
- }
- if provider != "" && endpoint != "" {
- jww.INFO.Printf("adding %s:%s to remote provider list", provider, endpoint)
- rp := &defaultRemoteProvider{
- endpoint: endpoint,
- provider: provider,
- path: path,
- secretKeyring: secretkeyring,
- }
- if !v.providerPathExists(rp) {
- v.remoteProviders = append(v.remoteProviders, rp)
- }
- }
- return nil
- }
- func (v *Viper) providerPathExists(p *defaultRemoteProvider) bool {
- for _, y := range v.remoteProviders {
- 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
- }
- }
- // 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
- }
- // GetViper gets the global Viper instance.
- func GetViper() *Viper {
- return v
- }
- // 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)
- 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
- }
- 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)
- case time.Duration:
- return cast.ToDuration(val)
- case []string:
- 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))
- }
- // Returns the value associated with the key as a boolean
- func GetBool(key string) bool { return v.GetBool(key) }
- func (v *Viper) GetBool(key string) bool {
- return cast.ToBool(v.Get(key))
- }
- // 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))
- }
- // Returns the value associated with the key as an integer
- func GetInt64(key string) int64 { return v.GetInt64(key) }
- func (v *Viper) GetInt64(key string) int64 {
- return cast.ToInt64(v.Get(key))
- }
- // 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))
- }
- // 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))
- }
- // Returns the value associated with the key as a duration
- func GetDuration(key string) time.Duration { return v.GetDuration(key) }
- func (v *Viper) GetDuration(key string) time.Duration {
- 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))
- }
- // 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))
- }
- // 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))
- }
- // Returns the value associated with the key as a map to a slice of strings.
- func GetStringMapStringSlice(key string) map[string][]string { return v.GetStringMapStringSlice(key) }
- func (v *Viper) GetStringMapStringSlice(key string) map[string][]string {
- 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 {
- err := mapstructure.WeakDecode(v.AllSettings(), 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)
- 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):
- //
- // serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
- // Viper.BindFlagValue("port", serverCmd.Flags().Lookup("port"))
- //
- 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
- // 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) {
- var key, envkey string
- if len(input) == 0 {
- return fmt.Errorf("BindEnv missing key to bind to")
- }
- key = strings.ToLower(input[0])
- if len(input) == 1 {
- envkey = v.mergeWithEnvPrefix(key)
- } else {
- envkey = input[1]
- }
- v.env[key] = envkey
- 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{} {
- var val interface{}
- var exists bool
- // if the requested key is an alias, then return the proper key
- key = v.realKey(key)
- // 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]
- 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
- 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]
- if exists {
- jww.TRACE.Println(key, "registered as env var", envkey)
- if val = v.getEnv(envkey); val != "" {
- jww.TRACE.Println(envkey, "found in environment with val:", val)
- return val
- } else {
- jww.TRACE.Println(envkey, "env value unset:")
- }
- }
- val, exists = v.config[key]
- 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]
- if exists {
- jww.TRACE.Println(key, "found in key/value store:", val)
- return val
- }
- val, exists = v.defaults[key]
- 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
- }
- // Have Viper check ENV variables for all
- // keys set in config, default & flags
- func AutomaticEnv() { v.AutomaticEnv() }
- func (v *Viper) AutomaticEnv() {
- v.automaticEnvApplied = true
- }
- // SetEnvKeyReplacer sets the strings.Replacer on the viper object
- // Useful for mapping an environmental variable to a key that does
- // not match it.
- func SetEnvKeyReplacer(r *strings.Replacer) { v.SetEnvKeyReplacer(r) }
- func (v *Viper) SetEnvKeyReplacer(r *strings.Replacer) {
- v.envKeyReplacer = r
- }
- // 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))
- }
- func (v *Viper) registerAlias(alias string, key string) {
- alias = strings.ToLower(alias)
- if alias != key && alias != v.realKey(key) {
- _, exists := v.aliases[alias]
- 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
- }
- 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
- }
- } else {
- jww.WARN.Println("Creating circular reference alias", alias, key, v.realKey(key))
- }
- }
- func (v *Viper) realKey(key string) string {
- newkey, exists := v.aliases[key]
- if exists {
- jww.DEBUG.Println("Alias", key, "to", newkey)
- return v.realKey(newkey)
- } else {
- return key
- }
- }
- // 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 {
- // if the requested key is an alias, then return the proper key
- key = v.realKey(key)
- _, exists := v.config[key]
- return exists
- }
- // 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{}) {
- // If alias passed in, then set the proper default
- key = v.realKey(strings.ToLower(key))
- v.defaults[key] = value
- }
- // Sets the value for the key in the override regiser.
- // 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{}) {
- // If alias passed in, then set the proper override
- key = v.realKey(strings.ToLower(key))
- v.override[key] = value
- }
- // Viper will discover and load the configuration file from disk
- // and key/value stores, searching in one of the defined paths.
- func ReadInConfig() error { return v.ReadInConfig() }
- func (v *Viper) ReadInConfig() error {
- jww.INFO.Println("Attempting to read in config file")
- if !stringInSlice(v.getConfigType(), SupportedExts) {
- return UnsupportedConfigError(v.getConfigType())
- }
- file, err := afero.ReadFile(v.fs, v.getConfigFile())
- if err != nil {
- return err
- }
- v.config = make(map[string]interface{})
- return v.unmarshalReader(bytes.NewReader(file), v.config)
- }
- // 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 := afero.ReadFile(v.fs, 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.
- func ReadConfig(in io.Reader) error { return v.ReadConfig(in) }
- func (v *Viper) ReadConfig(in io.Reader) error {
- v.config = make(map[string]interface{})
- return v.unmarshalReader(in, v.config)
- }
- // 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
- }
- }
- }
- }
- // 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)
- // }
- // 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
- }
- 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)
- }
- 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)
- }
- // retrieve the first found remote configuration
- func (v *Viper) getKeyValueConfig() error {
- 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)
- if err != nil {
- continue
- }
- v.kvstore = val
- return nil
- }
- return RemoteConfigError("No Files Found")
- }
- func (v *Viper) getRemoteConfig(provider *defaultRemoteProvider) (map[string]interface{}, error) {
- reader, err := RemoteConfig.Get(provider)
- if err != nil {
- return nil, err
- }
- err = v.unmarshalReader(reader, v.kvstore)
- return v.kvstore, err
- }
- // 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")
- }
- func (v *Viper) watchRemoteConfig(provider *defaultRemoteProvider) (map[string]interface{}, error) {
- reader, err := RemoteConfig.Watch(provider)
- if err != nil {
- return nil, err
- }
- err = v.unmarshalReader(reader, v.kvstore)
- return v.kvstore, err
- }
- // 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{}{}
- }
- 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
- }
- // Se the filesystem to use to read configuration.
- func SetFs(fs afero.Fs) { v.SetFs(fs) }
- func (v *Viper) SetFs(fs afero.Fs) {
- v.fs = fs
- }
- // Name for the config file.
- // Does not include extension.
- func SetConfigName(in string) { v.SetConfigName(in) }
- func (v *Viper) SetConfigName(in string) {
- if in != "" {
- v.configName = in
- v.configFile = ""
- }
- }
- // 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) {
- if in != "" {
- v.configType = in
- }
- }
- func (v *Viper) getConfigType() string {
- if v.configType != "" {
- return v.configType
- }
- cf := v.getConfigFile()
- ext := filepath.Ext(cf)
- if len(ext) > 1 {
- return ext[1:]
- } else {
- return ""
- }
- }
- func (v *Viper) getConfigFile() string {
- // if explicitly set, then use it
- if v.configFile != "" {
- return v.configFile
- }
- cf, err := v.findConfigFile()
- if err != nil {
- return ""
- }
- v.configFile = cf
- return v.getConfigFile()
- }
- func (v *Viper) searchInPath(in string) (filename string) {
- 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)
- }
- }
- 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) {
- jww.INFO.Println("Searching for config in ", v.configPaths)
- for _, cp := range v.configPaths {
- file := v.searchInPath(cp)
- if file != "" {
- return file, nil
- }
- }
- 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:")
- fmt.Printf("Aliases:\n%#v\n", v.aliases)
- fmt.Printf("Override:\n%#v\n", v.override)
- fmt.Printf("PFlags:\n%#v\n", v.pflags)
- fmt.Printf("Env:\n%#v\n", v.env)
- fmt.Printf("Key/Value Store:\n%#v\n", v.kvstore)
- fmt.Printf("Config:\n%#v\n", v.config)
- fmt.Printf("Defaults:\n%#v\n", v.defaults)
- }
|