configo

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 23, 2019 License: MIT Imports: 24 Imported by: 0

README

Build Status

configo

-- import "github.com/smartystreets/configo"

Package configo provides flexible configurtion for go applications from any number of 'sources', each of which implement the Source interface also provided by this package.

Sources provided in this package:

- JSONSource (key/value pairs in JSON content)
- EnvironmentSource (key/value pairs from the environment)
- CLISource (key/value pairs via command line flags)
- DefaultSource (key/value pairs manually configured by the application)
- ConditionalSource (filters key/value retrieval based on a condition)

These basic sources have been composed into additional sources, made available via the following constructor methods:

- FromDevelopmentOnlyDefaults()
- FromRequiredInProductionJSONFile()
- FromDefaultCLIConfigFileSource()
- FromCLIConfigFileSource(path string)
- etc...

Any of these sources may be provided to a Reader which is then used to retrieve configuration values based on keys contained in the sources.

The reader can fetch values of various types:

func (*Reader) Strings(key string) []string
func (*Reader) String(key string) string
func (*Reader) Ints(key string) []int
func (*Reader) Int(key string) int
func (*Reader) Bool(key string) bool
func (*Reader) URLs(key string) []net.url.URL
func (*Reader) URL(key string) net.url.URL

For each of the types returned above there are different ways to handle the scenario when a key is not found. I'll illustrate this with the applicable Int functions (but similar methods are implemented for each returned type):

// returns zero value if key not found or values are malformed.
func (*Reader) Int(key string) int

// returns the value or the specified default if the key is not found.
func (*Reader) IntDefault(key string, Default int) int

// returns 0 and an error if key not found or values are malformed.
func (*Reader) IntError(key string) (int, error)

// returns the value or panics if the key is not found or the values are malformed.
func (*Reader) IntPanic(key string) int

// returns the value or calls log.Fatal() if the key is not found or the values are malformed.
func (*Reader) IntFatal(key string) int

Here's a full example:

reader := configo.NewReader(
    configo.FromDefaultCLIConfigFileSource(),
    configo.FromCLI(
        configo.Flag("s3-storage-address", "The address of the s3 bucket"),
    ),
    configo.FromOptionalJSONFile("config-prod.json"),
)
value := reader.URL("s3-storage-address")

Usage

const (
	DateFormat     = "2006-01-02"
	TimeFormat     = "15:04:05"
	DateTimeFormat = DateFormat + " " + TimeFormat
)

A few useful Date/Time stamp formats:

var (
	KeyNotFoundError    = errors.New("The specified key was not found.")
	MalformedValueError = errors.New("The specified value could not be parsed.")
)
type CLI
type CLI func(*CLISource)
func BoolFlag
func BoolFlag(name, description string) CLI

BoolFlag registers a boolean flag and corresponding usage description with the CLISource. The advantage of this method over Flag for boolean values is that the user can merely supply the flag without a value to set the boolean flag to true. This doesn't work with Flag.

func ContinueOnError
func ContinueOnError() CLI

ContinueOnError sets the flag.ErrorHandling mode of the internal *flag.FlagSet to flag.ContinueOnError. Must be called before Initialize is called.

func Flag
func Flag(name, description string) CLI

Flag registers a flag and corresponding usage description with the CLISource.

func PanicOnError
func PanicOnError() CLI

PanicOnError sets the flag.ErrorHandling mode of the internal *flag.FlagSet to flag.PanicOnError. Must be called before Initialize is called.

func SetOutput
func SetOutput(writer io.Writer) CLI

SetOutput allows printing to an io.Writer other than os.Stderr, the default.

func Usage
func Usage(message string) CLI

Usage appends a custom message to the end of what is normally printed by flag.PrintDefaults().

type CLIConfigFileSource
type CLIConfigFileSource struct {
}

CLIConfigFileSource registers a command line flag for specifying an optional json config file, beyond any other config file definitions that follow this one. It is intended to be used to provide an override to the regularly used config file(s), like when you might be debugging in production (admit it, you've been there too).

func FromCLIConfigFileSource
func FromCLIConfigFileSource(flagName string) *CLIConfigFileSource

FromDefaultCLIConfigFileSource registers a command line flag with the given flagName for specifying an alternate JSON config file.

func FromDefaultCLIConfigFileSource
func FromDefaultCLIConfigFileSource() *CLIConfigFileSource

FromDefaultCLIConfigFileSource registers a command line flag called "config" for specifying an alternate JSON config file.

func (*CLIConfigFileSource) Initialize
func (this *CLIConfigFileSource) Initialize()

Initialize parses the command line flag and reads the altnerate JSON source.

func (*CLIConfigFileSource) Strings
func (this *CLIConfigFileSource) Strings(key string) ([]string, error)

Strings reads the key from the JSON source if it was successfully loaded during Initialize.

type CLISource
type CLISource struct {
}

CLISource allows for registration of command line flags and stores their actual values, if supplied on the command line. It implements the Source interface so it can be used by a Reader.

func FromCLI
func FromCLI(options ...CLI) *CLISource

FromCLI creates a new CLISource for use in a Reader. It uses a *flag.FlagSet internally to register and parse the flags. Be default the flag.ErrorHandling mode is set to flag.ExitOnError

func (*CLISource) Initialize
func (this *CLISource) Initialize()

Parses the internal *flag.FlagSet. Call only after making all Flag calls.

func (*CLISource) Strings
func (this *CLISource) Strings(key string) ([]string, error)

Strings returns the matching command line flag value, or KeyNotFound.

type Client
type Client interface {
	Do(*http.Request) (*http.Response, error)
}
type ConditionalSource
type ConditionalSource struct {
}

ConditionalSource resolves values based on a condition supplied as a callback.

func FromDevelopmentOnlyDefaults
func FromDevelopmentOnlyDefaults(pairs ...DefaultPair) *ConditionalSource

A conditional source which determines if we are running in a development environment

func NewConditionalSource
func NewConditionalSource(condition func() bool, pairs ...DefaultPair) *ConditionalSource

NewConditionalSource creates a conditional source with the provided condition callback and key/value pairs.

func (*ConditionalSource) Initialize
func (this *ConditionalSource) Initialize()
func (*ConditionalSource) Strings
func (this *ConditionalSource) Strings(key string) ([]string, error)

Strings returns the value of the corresponding key, or KeyNotFoundError if the condition is false.

type DefaultPair
type DefaultPair func(*DefaultSource)
func Default
func Default(key string, values ...interface{}) DefaultPair

Default registers the provided values (which will be converted to strings) to the given key. It does NOT overwrite existing values, it appends.

type DefaultSource
type DefaultSource struct {
}

DefaultSource is allows registration of specified default values of various types.

func NewDefaultSource
func NewDefaultSource(pairs ...DefaultPair) *DefaultSource

NewDefaultSource initializes a new DefaultSource.

func (*DefaultSource) Initialize
func (this *DefaultSource) Initialize()
func (*DefaultSource) Strings
func (this *DefaultSource) Strings(key string) ([]string, error)

Strings returns all values associated with the given key, or KeyNotFoundError.

type EnvironmentSource
type EnvironmentSource struct {
}

EnvironmentSource reads key-value pairs from the environment.

func FromEnvironment
func FromEnvironment() *EnvironmentSource

FromEnvironment creates an envirnoment source capable of parsing values separated by the pipe character.

func FromEnvironmentCustomSeparator
func FromEnvironmentCustomSeparator(prefix, separator string) *EnvironmentSource

FromEnvironmentWithPrefix creates an envirnoment source capable of parsing values separated by the specified character.

func FromEnvironmentWithPrefix
func FromEnvironmentWithPrefix(prefix string) *EnvironmentSource

FromEnvironmentWithPrefix creates an envirnoment source capable of: - reading values with keys all beginning with the provided prefix, - parsing values separated by the pipe character.

func (*EnvironmentSource) Initialize
func (this *EnvironmentSource) Initialize()
func (*EnvironmentSource) Strings
func (this *EnvironmentSource) Strings(key string) ([]string, error)

Strings reads the environment variable specified by key and returns the value or KeyNotFoundError.

type JSONSource
type JSONSource struct {
}

JSONSource houses key-value pairs unmarshaled from JSON data.

func FromConditionalJSONFile
func FromConditionalJSONFile(filename string, condition func() bool) *JSONSource

If the provided condition returns true, the specified filename is required and must be found; otherwise loading the file is optional.

func FromConfigurableJSONFile
func FromConfigurableJSONFile() *JSONSource

FromConfigurableJSONFile allows the user to configure the config file path via the -config command line flag.

func FromJSONContent
func FromJSONContent(raw []byte) *JSONSource

FromJSONContent unmarshals the provided json content into a JSONSource. Any resulting error results in a panic.

func FromJSONFile
func FromJSONFile(filename string) *JSONSource

FromJSONFile reads and unmarshals the file at the provided path into a JSONSource. Any resulting error results in a panic.

func FromJSONObject
func FromJSONObject(values map[string]interface{}) *JSONSource
func FromOptionalJSONFile
func FromOptionalJSONFile(filename string) *JSONSource

FromOptionalJSONFile is like FromJSONFile but it does not panic if the file is not found.

type VaultSource
type VaultSource struct {
}
func FromVaultDocument
func FromVaultDocument(token, address, documentName string) *JSONSource

VaultSource Example

# Vault server CLI reading from document at secret/test
$ vault read secret/test
Key                 Value
---                 -----
testkey             testvalue

// VaultSource reading from document at secret/test
reader := configo.NewReader(
        configo.FromVaultDocument("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", "127.0.0.1", "secret/test"),
)
log.Println(reader.String("testkey"))
// result: testvalue
func (*JSONSource) Initialize
func (this *JSONSource) Initialize()
func (*JSONSource) Strings
func (this *JSONSource) Strings(key string) ([]string, error)
type Reader
type Reader struct {
}

Reader retrieves values from the provided sources, handling conversions to the type identified by the method being called (Strings, Ints, etc...).

func NewReader
func NewReader(sources ...Source) *Reader

NewReader initializes a new reader using the provided sources. It calls each non-nil source's Initialize() method.

func (*Reader) Bool
func (this *Reader) Bool(key string) bool

Bool returns the boolean value associated with the given key or false if the key does not exist or the value could not be parsed as a bool.

func (*Reader) BoolDefault
func (this *Reader) BoolDefault(key string, Default bool) bool

BoolDefault returns the boolean value associated with the given key or returns the provided default if the key does not exist or the value could not be parsed as a bool.

func (*Reader) BoolError
func (this *Reader) BoolError(key string) (bool, error)

BoolError returns the boolean value associated with the given key with an error if the key does not exist or the value could not be parsed as a bool (according to strconv.ParseBool).

func (*Reader) BoolFatal
func (this *Reader) BoolFatal(key string) bool

BoolFatal returns the boolean value associated with the given key or calls log.Fatal() if the key does not exist or the value could not be parsed as a bool.

func (*Reader) BoolPanic
func (this *Reader) BoolPanic(key string) bool

BoolPanic returns the boolean value associated with the given key or panics if the key does not exist or the value could not be parsed as a bool.

func (*Reader) Duration
func (this *Reader) Duration(key string) time.Duration

Duration returns the first Duration associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a Duration. For examples of duration strings see http://golang.org/pkg/time/#ParseDuration

func (*Reader) DurationDefault
func (this *Reader) DurationDefault(key string, Default time.Duration) time.Duration

DurationDefault returns the first Duration associated with the given key or returns provided default if the key does not exist or the values could not be parsed as Durations.

func (*Reader) DurationError
func (this *Reader) DurationError(key string) (time.Duration, error)

DurationError returns the first Duration associated with the given key with an error if the key does not exist or the values could not be parsed as Durations.

func (*Reader) DurationFatal
func (this *Reader) DurationFatal(key string) time.Duration

DurationFatal returns the first Duration associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as Durations.

func (*Reader) DurationPanic
func (this *Reader) DurationPanic(key string) time.Duration

DurationPanic returns the first Duration associated with the given key or panics if the key does not exist or the values could not be parsed as Durations.

func (*Reader) Int
func (this *Reader) Int(key string) int

Int returns the first integer value associated with the given key or returns 0 if the key does not exist.

func (*Reader) IntDefault
func (this *Reader) IntDefault(key string, Default int) int

IntDefault returns the first integer values associated with the given key or returns the provided default if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntError
func (this *Reader) IntError(key string) (int, error)

IntError returns the first integer value associated with the given key with an error if the key does not exist or the values could not be parsed as integers (according to strconv.Atoi).

func (*Reader) IntFatal
func (this *Reader) IntFatal(key string) int

IntFatal returns the first integer value associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntPanic
func (this *Reader) IntPanic(key string) int

IntPanic returns the first integer value associated with the given key or panics if the key does not exist or the values could not be parsed as integers.

func (*Reader) Ints
func (this *Reader) Ints(key string) []int

Ints returns all integer values associated with the given key or returns 0 if the key does not exist.

func (*Reader) IntsDefault
func (this *Reader) IntsDefault(key string, Default []int) []int

IntsDefault returns all integer values associated with the given key or returns provided defaults if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntsError
func (this *Reader) IntsError(key string) ([]int, error)

IntsError returns all integer values associated with the given key with an error if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntsFatal
func (this *Reader) IntsFatal(key string) []int

IntsFatal returns all integer values associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntsPanic
func (this *Reader) IntsPanic(key string) []int

IntsPanic returns all integer values associated with the given key or panics if the key does not exist or the values could not be parsed as integers.

func (*Reader) RegisterAlias
func (this *Reader) RegisterAlias(key, alias string)
func (*Reader) String
func (this *Reader) String(key string) string

String returns the first value associated with the given key or an empty string if the key does not exist.

func (*Reader) StringDefault
func (this *Reader) StringDefault(key string, Default string) string

StringDefault returns the first value associated with the given key or the provided default if the key does not exist.

func (*Reader) StringError
func (this *Reader) StringError(key string) (string, error)

StringError returns the first value associated with the given key with an an error if the key does not exist.

func (*Reader) StringFatal
func (this *Reader) StringFatal(key string) string

StringFatal returns the first value associated with the given key or calls log.Fatal() if the key does not exist.

func (*Reader) StringPanic
func (this *Reader) StringPanic(key string) string

StringPanic returns the first value associated with the given key or panics if the key does not exist.

func (*Reader) Strings
func (this *Reader) Strings(key string) []string

Strings returns all values associated with the given key or nil if the key does not exist.

func (*Reader) StringsDefault
func (this *Reader) StringsDefault(key string, Default []string) []string

StringsDefault returns all values associated with the given key or the provided defaults if the key does not exist.

func (*Reader) StringsError
func (this *Reader) StringsError(key string) ([]string, error)

StringsError returns all values associated with the given key with an error if the key does not exist. It does so by searching it sources, in the order they were provided, and returns the first non-error result or KeyNotFoundError.

func (*Reader) StringsFatal
func (this *Reader) StringsFatal(key string) []string

StringsFatal returns all values associated with the given key or log.Fatal() if the key does not exist.

func (*Reader) StringsPanic
func (this *Reader) StringsPanic(key string) []string

StringsPanic returns all values associated with the given key or panics if the key does not exist.

func (*Reader) Time
func (this *Reader) Time(key string, format string) time.Time

Time returns the first Time associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a Time using the provided format. For examples of format strings see http://golang.org/pkg/time/#pkg-constants

func (*Reader) TimeDefault
func (this *Reader) TimeDefault(key string, format string, Default time.Time) time.Time

TimeDefault returns the first Time associated with the given key or returns provided default if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) TimeError
func (this *Reader) TimeError(key string, format string) (time.Time, error)

TimeError returns the first Time associated with the given key with an error if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) TimeFatal
func (this *Reader) TimeFatal(key string, format string) time.Time

TimeFatal returns the first Time associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) TimePanic
func (this *Reader) TimePanic(key string, format string) time.Time

TimePanic returns the first Time associated with the given key or panics if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) URL
func (this *Reader) URL(key string) url.URL

URL returns the first URL associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a URL.

func (*Reader) URLDefault
func (this *Reader) URLDefault(key string, Default url.URL) url.URL

URLDefault returns the first URL associated with the given key or returns provided defaults if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLError
func (this *Reader) URLError(key string) (url.URL, error)

URLError returns the first URL associated with the given key with an error if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLFatal
func (this *Reader) URLFatal(key string) url.URL

URLFatal returns the first URL associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLPanic
func (this *Reader) URLPanic(key string) url.URL

URLPanic returns the first URL associated with the given key or panics if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLs
func (this *Reader) URLs(key string) []url.URL

URLs returns all URL values associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a URL.

func (*Reader) URLsDefault
func (this *Reader) URLsDefault(key string, Default []url.URL) []url.URL

URLsDefault returns all URL values associated with the given key or returns provided defaults if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLsError
func (this *Reader) URLsError(key string) ([]url.URL, error)

URLsError returns all URL values associated with the given key with an error if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLsFatal
func (this *Reader) URLsFatal(key string) []url.URL

URLsFatal returns all URL values associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLsPanic
func (this *Reader) URLsPanic(key string) []url.URL

URLsPanic returns all URL values associated with the given key or panics if the key does not exist or the values could not be parsed as URLs.

type RetryClient
type RetryClient struct {
}
func NewRetryClient
func NewRetryClient(inner Client, retries, timeout int) *RetryClient
func (*RetryClient) Do
func (this *RetryClient) Do(request *http.Request) (response *http.Response, err error)
type Source
type Source interface {
	Initialize()
	Strings(key string) ([]string, error)
}

Source defines the methods required by a Reader. The Strings method returns all values associated with the given key with an error if the key does not exist.

func FromRequiredInProductionJSONFile
func FromRequiredInProductionJSONFile(filename string) Source

If we are running in a production (non-development) environment the specified JSON filename is required; otherwise it's optional.

Documentation

Overview

Package configo provides flexible configurtion for go applications from any number of 'sources', each of which implement the Source interface also provided by this package.

Sources provided in this package:

  • JSONSource (key/value pairs in JSON content)
  • EnvironmentSource (key/value pairs from the environment)
  • CLISource (key/value pairs via command line flags)
  • DefaultSource (key/value pairs manually configured by the application)
  • ConditionalSource (filters key/value retrieval based on a condition)

These basic sources have been composed into additional sources, made available via the following constructor methods:

  • FromDevelopmentOnlyDefaults()
  • FromRequiredInProductionJSONFile()
  • FromDefaultCLIConfigFileSource()
  • FromCLIConfigFileSource(path string)
  • etc...

Any of these sources may be provided to a Reader which is then used to retrieve configuration values based on keys contained in the sources.

The reader can fetch values of various types: 

func (*Reader) Strings(key string) []string
func (*Reader) String(key string) string
func (*Reader) Ints(key string) []int
func (*Reader) Int(key string) int
func (*Reader) Bool(key string) bool
func (*Reader) URLs(key string) []net.url.URL
func (*Reader) URL(key string) net.url.URL

For each of the types returned above there are different ways to handle the scenario when a key is not found. I'll illustrate this with the applicable Int functions (but similar methods are implemented for each returned type): 

// returns zero value if key not found or values are malformed.
func (*Reader) Int(key string) int

// returns the value or the specified default if the key is not found.
func (*Reader) IntDefault(key string, Default int) int

// returns 0 and an error if key not found or values are malformed.
func (*Reader) IntError(key string) (int, error)

// returns the value or panics if the key is not found or the values are malformed.
func (*Reader) IntPanic(key string) int

// returns the value or calls log.Fatal() if the key is not found or the values are malformed.
func (*Reader) IntFatal(key string) int

Here's a full example: 

reader := configo.NewReader(
    configo.FromDefaultCLIConfigFileSource(),
    configo.FromCLI(
        configo.Flag("s3-storage-address", "The address of the s3 bucket"),
    ),
    configo.FromOptionalJSONFile("config-prod.json"),
)
value := reader.URL("s3-storage-address")

Index

Constants

View Source 
const (
	DateFormat     = "2006-01-02"
	TimeFormat     = "15:04:05"
	DateTimeFormat = DateFormat + " " + TimeFormat
)

A few useful Date/Time stamp formats:

Variables

View Source 
var (
	KeyNotFoundError    = errors.New("The specified key was not found.")
	MalformedValueError = errors.New("The specified value could not be parsed.")
)

Functions

func Hostname 

func Hostname() string

Types

type CLI 

type CLI func(*CLISource)

func BoolFlag 

func BoolFlag(name, description string) CLI

BoolFlag registers a boolean flag and corresponding usage description with the CLISource. The advantage of this method over Flag for boolean values is that the user can merely supply the flag without a value to set the boolean flag to true. This doesn't work with Flag.

func ContinueOnError 

func ContinueOnError() CLI

ContinueOnError sets the flag.ErrorHandling mode of the internal *flag.FlagSet to flag.ContinueOnError. Must be called before Initialize is called.

func Flag 

func Flag(name, description string) CLI

Flag registers a flag and corresponding usage description with the CLISource.

func PanicOnError 

func PanicOnError() CLI

PanicOnError sets the flag.ErrorHandling mode of the internal *flag.FlagSet to flag.PanicOnError. Must be called before Initialize is called.

func SetOutput 

func SetOutput(writer io.Writer) CLI

SetOutput allows printing to an io.Writer other than os.Stderr, the default.

func Usage 

func Usage(message string) CLI

Usage appends a custom message to the end of what is normally printed by flag.PrintDefaults().

type CLIConfigFileSource 

type CLIConfigFileSource struct {
	// contains filtered or unexported fields
}

CLIConfigFileSource registers a command line flag for specifying an optional json config file, beyond any other config file definitions that follow this one. It is intended to be used to provide an override to the regularly used config file(s), like when you might be debugging in production (admit it, you've been there too).

func FromCLIConfigFileSource 

func FromCLIConfigFileSource(flagName string) *CLIConfigFileSource

FromCLIConfigFileSource registers a command line flag with the given flagName for specifying an alternate JSON config file.

func FromDefaultCLIConfigFileSource 

func FromDefaultCLIConfigFileSource() *CLIConfigFileSource

FromDefaultCLIConfigFileSource registers a command line flag called "config" for specifying an alternate JSON config file.

func (*CLIConfigFileSource) Initialize 

func (this *CLIConfigFileSource) Initialize()

Initialize parses the command line flag and reads the altnerate JSON source.

func (*CLIConfigFileSource) Strings 

func (this *CLIConfigFileSource) Strings(key string) ([]string, error)

Strings reads the key from the JSON source if it was successfully loaded during Initialize.

type CLISource 

type CLISource struct {
	// contains filtered or unexported fields
}

CLISource allows for registration of command line flags and stores their actual values, if supplied on the command line. It implements the Source interface so it can be used by a Reader.

func FromCLI 

func FromCLI(options ...CLI) *CLISource

FromCLI creates a new CLISource for use in a Reader. It uses a *flag.FlagSet internally to register and parse the flags. Be default the flag.ErrorHandling mode is set to flag.ExitOnError

func (*CLISource) Initialize 

func (this *CLISource) Initialize()

Parses the internal *flag.FlagSet. Call only after making all Flag calls.

func (*CLISource) Strings 

func (this *CLISource) Strings(key string) ([]string, error)

Strings returns the matching command line flag value, or KeyNotFound.

type Client 

type Client interface {
	Do(*http.Request) (*http.Response, error)
}

type ConditionalSource 

type ConditionalSource struct {
	// contains filtered or unexported fields
}

ConditionalSource resolves values based on a condition supplied as a callback.

func FromDevelopmentOnlyDefaults 

func FromDevelopmentOnlyDefaults(pairs ...DefaultPair) *ConditionalSource

A conditional source which determines if we are running in a development environment.

func NewConditionalSource 

func NewConditionalSource(condition func() bool, pairs ...DefaultPair) *ConditionalSource

NewConditionalSource creates a conditional source with the provided condition callback and key/value pairs.

func (*ConditionalSource) Initialize 

func (this *ConditionalSource) Initialize()

func (*ConditionalSource) Strings 

func (this *ConditionalSource) Strings(key string) ([]string, error)

Strings returns the value of the corresponding key, or KeyNotFoundError if the condition is false.

type DefaultPair 

type DefaultPair func(*DefaultSource)

func Default 

func Default(key string, values ...interface{}) DefaultPair

Default registers the provided values (which will be converted to strings) to the given key. It does NOT overwrite existing values, it appends.

type DefaultSource 

type DefaultSource struct {
	// contains filtered or unexported fields
}

DefaultSource is allows registration of specified default values of various types.

func NewDefaultSource 

func NewDefaultSource(pairs ...DefaultPair) *DefaultSource

NewDefaultSource initializes a new DefaultSource.

func (*DefaultSource) Initialize 

func (this *DefaultSource) Initialize()

func (*DefaultSource) Strings 

func (this *DefaultSource) Strings(key string) ([]string, error)

Strings returns all values associated with the given key, or KeyNotFoundError.

type DirectorySource 

type DirectorySource struct {
	// contains filtered or unexported fields
}

DirectorySource makes a key-value mapping available of filename (key) to file contents (value).

func FromDirectory 

func FromDirectory(path string) *DirectorySource

FromDirectory reads the directory path provided. If the path does not exist, a panic will result.

func FromOptionalDirectory 

func FromOptionalDirectory(path string) *DirectorySource

FromOptionalDirectory reads the directory path provided, if it exists.

func (*DirectorySource) Initialize 

func (this *DirectorySource) Initialize()

func (*DirectorySource) Strings 

func (this *DirectorySource) Strings(key string) ([]string, error)

type EnvironmentSource 

type EnvironmentSource struct {
	// contains filtered or unexported fields
}

EnvironmentSource reads key-value pairs from the environment.

func FromEnvironment 

func FromEnvironment() *EnvironmentSource

FromEnvironment creates an envirnoment source capable of parsing values separated by the pipe character.

func FromEnvironmentCustomSeparator 

func FromEnvironmentCustomSeparator(prefix, separator string) *EnvironmentSource

FromEnvironmentCustomSeparator creates an envirnoment source capable of parsing values separated by the specified character.

func FromEnvironmentWithPrefix 

func FromEnvironmentWithPrefix(prefix string) *EnvironmentSource

FromEnvironmentWithPrefix creates an envirnoment source capable of: - reading values with keys all beginning with the provided prefix, - parsing values separated by the pipe character.

func (*EnvironmentSource) Initialize 

func (this *EnvironmentSource) Initialize()

func (*EnvironmentSource) Strings 

func (this *EnvironmentSource) Strings(key string) ([]string, error)

Strings reads the environment variable specified by key and returns the value or KeyNotFoundError.

type JSONSource 

type JSONSource struct {
	// contains filtered or unexported fields
}

JSONSource houses key-value pairs unmarshaled from JSON data.

func FromConditionalJSONFile 

func FromConditionalJSONFile(filename string, condition func() bool) *JSONSource

If the provided condition returns true, the specified filename is required and must be found; otherwise loading the file is optional.

func FromConfigurableJSONFile 

func FromConfigurableJSONFile() *JSONSource

FromConfigurableJSONFile allows the user to configure the config file path via the -config command line flag.

func FromJSONContent 

func FromJSONContent(raw []byte) *JSONSource

FromJSONContent unmarshals the provided json content into a JSONSource. Any resulting error results in a panic.

func FromJSONFile 

func FromJSONFile(filename string) *JSONSource

FromJSONFile reads and unmarshals the file at the provided path into a JSONSource. Any resulting error results in a panic.

func FromJSONObject 

func FromJSONObject(values map[string]interface{}) *JSONSource

func FromOptionalJSONFile 

func FromOptionalJSONFile(filename string) *JSONSource

FromOptionalJSONFile is like FromJSONFile but it does not panic if the file is not found.

func FromTemplateJSON 

func FromTemplateJSON(item *Template) *JSONSource

Parses the provided go json template, substituting data from provided sources, and returning it as a JSON source. Panics if there is a template error.

func FromTemplateJSONFileWithSources 

func FromTemplateJSONFileWithSources(templatePath, confJson string, directories ...string) *JSONSource

func FromVaultDocument 

func FromVaultDocument(token, address, documentName string) *JSONSource

func (*JSONSource) Initialize 

func (this *JSONSource) Initialize()

func (*JSONSource) Strings 

func (this *JSONSource) Strings(key string) ([]string, error)

type MultiSource 

type MultiSource []Source

func FromOptionalDirectories 

func FromOptionalDirectories(paths ...string) MultiSource

func (MultiSource) Initialize 

func (this MultiSource) Initialize()

func (MultiSource) Strings 

func (this MultiSource) Strings(key string) (result []string, err error)

type Reader 

type Reader struct {
	// contains filtered or unexported fields
}

Reader retrieves values from the provided sources, handling conversions to the type identified by the method being called (Strings, Ints, etc...).

func NewReader 

func NewReader(sources ...Source) *Reader

NewReader initializes a new reader using the provided sources. It calls each non-nil source's Initialize() method.

func (*Reader) Bool 

func (this *Reader) Bool(key string) bool

Bool returns the boolean value associated with the given key or false if the key does not exist or the value could not be parsed as a bool.

func (*Reader) BoolDefault 

func (this *Reader) BoolDefault(key string, Default bool) bool

BoolDefault returns the boolean value associated with the given key or returns the provided default if the key does not exist or the value could not be parsed as a bool.

func (*Reader) BoolError 

func (this *Reader) BoolError(key string) (bool, error)

BoolError returns the boolean value associated with the given key with an error if the key does not exist or the value could not be parsed as a bool (according to strconv.ParseBool).

func (*Reader) BoolFatal 

func (this *Reader) BoolFatal(key string) bool

BoolFatal returns the boolean value associated with the given key or calls log.Fatal() if the key does not exist or the value could not be parsed as a bool.

func (*Reader) BoolPanic 

func (this *Reader) BoolPanic(key string) bool

BoolPanic returns the boolean value associated with the given key or panics if the key does not exist or the value could not be parsed as a bool.

func (*Reader) Duration 

func (this *Reader) Duration(key string) time.Duration

Duration returns the first Duration associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a Duration. For examples of duration strings see http://golang.org/pkg/time/#ParseDuration

func (*Reader) DurationDefault 

func (this *Reader) DurationDefault(key string, Default time.Duration) time.Duration

DurationDefault returns the first Duration associated with the given key or returns provided default if the key does not exist or the values could not be parsed as Durations.

func (*Reader) DurationError 

func (this *Reader) DurationError(key string) (time.Duration, error)

DurationError returns the first Duration associated with the given key with an error if the key does not exist or the values could not be parsed as Durations.

func (*Reader) DurationFatal 

func (this *Reader) DurationFatal(key string) time.Duration

DurationFatal returns the first Duration associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as Durations.

func (*Reader) DurationPanic 

func (this *Reader) DurationPanic(key string) time.Duration

DurationPanic returns the first Duration associated with the given key or panics if the key does not exist or the values could not be parsed as Durations.

func (*Reader) Int 

func (this *Reader) Int(key string) int

Int returns the first integer value associated with the given key or returns 0 if the key does not exist.

func (*Reader) IntDefault 

func (this *Reader) IntDefault(key string, Default int) int

IntDefault returns the first integer values associated with the given key or returns the provided default if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntError 

func (this *Reader) IntError(key string) (int, error)

IntError returns the first integer value associated with the given key with an error if the key does not exist or the values could not be parsed as integers (according to strconv.Atoi).

func (*Reader) IntFatal 

func (this *Reader) IntFatal(key string) int

IntFatal returns the first integer value associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntPanic 

func (this *Reader) IntPanic(key string) int

IntPanic returns the first integer value associated with the given key or panics if the key does not exist or the values could not be parsed as integers.

func (*Reader) Ints 

func (this *Reader) Ints(key string) []int

Ints returns all integer values associated with the given key or returns 0 if the key does not exist.

func (*Reader) IntsDefault 

func (this *Reader) IntsDefault(key string, Default []int) []int

IntsDefault returns all integer values associated with the given key or returns provided defaults if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntsError 

func (this *Reader) IntsError(key string) ([]int, error)

IntsError returns all integer values associated with the given key with an error if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntsFatal 

func (this *Reader) IntsFatal(key string) []int

IntsFatal returns all integer values associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as integers.

func (*Reader) IntsPanic 

func (this *Reader) IntsPanic(key string) []int

IntsPanic returns all integer values associated with the given key or panics if the key does not exist or the values could not be parsed as integers.

func (*Reader) RegisterAlias 

func (this *Reader) RegisterAlias(key, alias string)

func (*Reader) String 

func (this *Reader) String(key string) string

String returns the first value associated with the given key or an empty string if the key does not exist.

func (*Reader) StringDefault 

func (this *Reader) StringDefault(key string, Default string) string

StringDefault returns the first value associated with the given key or the provided default if the key does not exist.

func (*Reader) StringError 

func (this *Reader) StringError(key string) (string, error)

StringError returns the first value associated with the given key with an an error if the key does not exist.

func (*Reader) StringFatal 

func (this *Reader) StringFatal(key string) string

StringFatal returns the first value associated with the given key or calls log.Fatal() if the key does not exist.

func (*Reader) StringPanic 

func (this *Reader) StringPanic(key string) string

StringPanic returns the first value associated with the given key or panics if the key does not exist.

func (*Reader) Strings 

func (this *Reader) Strings(key string) []string

Strings returns all values associated with the given key or nil if the key does not exist.

func (*Reader) StringsDefault 

func (this *Reader) StringsDefault(key string, Default []string) []string

StringsDefault returns all values associated with the given key or the provided defaults if the key does not exist.

func (*Reader) StringsError 

func (this *Reader) StringsError(key string) ([]string, error)

StringsError returns all values associated with the given key with an error if the key does not exist. It does so by searching it sources, in the order they were provided, and returns the first non-error result or KeyNotFoundError.

func (*Reader) StringsFatal 

func (this *Reader) StringsFatal(key string) []string

StringsFatal returns all values associated with the given key or log.Fatal() if the key does not exist.

func (*Reader) StringsPanic 

func (this *Reader) StringsPanic(key string) []string

StringsPanic returns all values associated with the given key or panics if the key does not exist.

func (*Reader) Time 

func (this *Reader) Time(key string, format string) time.Time

Time returns the first Time associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a Time using the provided format. For examples of format strings see http://golang.org/pkg/time/#pkg-constants

func (*Reader) TimeDefault 

func (this *Reader) TimeDefault(key string, format string, Default time.Time) time.Time

TimeDefault returns the first Time associated with the given key or returns provided default if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) TimeError 

func (this *Reader) TimeError(key string, format string) (time.Time, error)

TimeError returns the first Time associated with the given key with an error if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) TimeFatal 

func (this *Reader) TimeFatal(key string, format string) time.Time

TimeFatal returns the first Time associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) TimePanic 

func (this *Reader) TimePanic(key string, format string) time.Time

TimePanic returns the first Time associated with the given key or panics if the key does not exist or the values could not be parsed as Times using the provided format.

func (*Reader) URL 

func (this *Reader) URL(key string) url.URL

URL returns the first URL associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a URL.

func (*Reader) URLDefault 

func (this *Reader) URLDefault(key string, Default url.URL) url.URL

URLDefault returns the first URL associated with the given key or returns provided defaults if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLError 

func (this *Reader) URLError(key string) (url.URL, error)

URLError returns the first URL associated with the given key with an error if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLFatal 

func (this *Reader) URLFatal(key string) url.URL

URLFatal returns the first URL associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLPanic 

func (this *Reader) URLPanic(key string) url.URL

URLPanic returns the first URL associated with the given key or panics if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLs 

func (this *Reader) URLs(key string) []url.URL

URLs returns all URL values associated with the given key or returns the zero value if the key does not exist or the value could not be parsed as a URL.

func (*Reader) URLsDefault 

func (this *Reader) URLsDefault(key string, Default []url.URL) []url.URL

URLsDefault returns all URL values associated with the given key or returns provided defaults if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLsError 

func (this *Reader) URLsError(key string) ([]url.URL, error)

URLsError returns all URL values associated with the given key with an error if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLsFatal 

func (this *Reader) URLsFatal(key string) []url.URL

URLsFatal returns all URL values associated with the given key or calls log.Fatal() if the key does not exist or the values could not be parsed as URLs.

func (*Reader) URLsPanic 

func (this *Reader) URLsPanic(key string) []url.URL

URLsPanic returns all URL values associated with the given key or panics if the key does not exist or the values could not be parsed as URLs.

type RetryClient 

type RetryClient struct {
	// contains filtered or unexported fields
}

func NewRetryClient 

func NewRetryClient(inner Client, retries int, timeout time.Duration) *RetryClient

func (*RetryClient) Do 

func (this *RetryClient) Do(request *http.Request) (response *http.Response, err error)

type Source 

type Source interface {
	Initialize()
	Strings(key string) ([]string, error)
}

Source defines the methods required by a Reader. The Strings method returns all values associated with the given key with an error if the key does not exist.

func FirstOrNop 

func FirstOrNop(sources ...Source) Source

func FromRequiredInProductionJSONFile 

func FromRequiredInProductionJSONFile(filename string) Source

If we are running in a production (non-development) environment the specified JSON filename is required; otherwise it's optional.

type Template 

type Template struct {
	Content string
	// contains filtered or unexported fields
}

Template retrieves values from the provided sources, inserting data from the sources into the Template. Includes support for sprig template functions (@see http://masterminds.github.io/sprig/)

func NewTemplate 

func NewTemplate(content string, sources ...Source) *Template

NewTemplate initializes a template and the provided sources.

func (*Template) Run 

func (this *Template) Run() (ret []byte, err error)

Run executes the template

func (*Template) String 

func (this *Template) String() (ret string, err error)

String executes the template, return as string

type VaultSource 

type VaultSource struct {
	// contains filtered or unexported fields
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.