config

Documentation

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func ConfigFileDir() string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ConfigError
  • func (c *ConfigError) RootError() error
• type Loader
  • func NewLoader() Loader
• type MockLoader
  • func (m *MockLoader) Load() (ProctorConfig, ConfigError)
• type ProctorConfig

Constants

const (
	Environment                  = "ENVIRONMENT"
	ProctorHost                  = "PROCTOR_HOST"
	EmailId                      = "EMAIL_ID"
	AccessToken                  = "ACCESS_TOKEN"
	ConnectionTimeoutSecs        = "CONNECTION_TIMEOUT_SECS"
	ProcExecutionStatusPollCount = "PROC_EXECUTION_STATUS_POLL_COUNT"
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func ConfigFileDir

func ConfigFileDir() string

Returns Config file directory This allows to test on dev environment without conflicting with installed proctor config file

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ConfigError

type ConfigError struct {
	Message string
	// contains filtered or unexported fields
}

func (*ConfigError) RootError

func (c *ConfigError) RootError() error

type Loader

type Loader interface {
	Load() (ProctorConfig, ConfigError)
}

func NewLoader

func NewLoader() Loader

type MockLoader

type MockLoader struct {
	mock.Mock
}

func (*MockLoader) Load

func (m *MockLoader) Load() (ProctorConfig, ConfigError)

type ProctorConfig

type ProctorConfig struct {
	Host                         string
	Email                        string
	AccessToken                  string
	ConnectionTimeoutSecs        time.Duration
	ProcExecutionStatusPollCount int
}