environment

Documentation

Overview

Code generated by MockGen. DO NOT EDIT. Source: ssm.go

Generated by this command:

mockgen -source=ssm.go -package environment -destination ssmclient_mock.gen.go

Package environment is a generated GoMock package.

Index

• Constants
• func Get(key string, defaultVal string) string
• func GetEnvMap() map[string]string
• func NewInvalidSpecificationError() errors.TracerError
• func NewMissingEnvironmentVariableError(field string, tag string) errors.TracerError
• func NewUnsupportedDataTypeError(dataType reflect.Kind, field string) errors.TracerError
• func Process(config interface{}, logger log.Logger) error
• func ProcessMap(config interface{}, envVars map[string]string, logger log.Logger) error
• func Push(config interface{}) error
• func RedisAddress() string
• func RedisHost() string
• func RedisPort() int
• type Bucket
  • func NewBucket(bucketName, environment, project string) *Bucket
  • func (b *Bucket) Add(project string, data map[string]interface{})
  • func (b *Bucket) Get(project, key string, logger log.Logger) interface{}
  • func (b *Bucket) Has(project, key string) (interface{}, bool)
• type InvalidSpecificationError
  • func (err *InvalidSpecificationError) Error() string
  • func (err *InvalidSpecificationError) Trace() []string
• type MissingEnvironmentVariableError
  • func (err MissingEnvironmentVariableError) Error() string
  • func (err *MissingEnvironmentVariableError) Trace() []string
• type MockssmClient
  • func NewMockssmClient(ctrl *gomock.Controller) *MockssmClient
  • func (m *MockssmClient) EXPECT() *MockssmClientMockRecorder
  • func (m *MockssmClient) GetParametersByPath(arg0 *ssm.GetParametersByPathInput) (*ssm.GetParametersByPathOutput, error)
• type MockssmClientMockRecorder
  • func (mr *MockssmClientMockRecorder) GetParametersByPath(arg0 any) *gomock.Call
• type SSM
  • func NewSSM(environment, project string) *SSM
  • func (s *SSM) Add(path string, data map[string]string)
  • func (s *SSM) Get(project, name string, logger log.Logger) string
  • func (s *SSM) Has(project, name string) (string, bool)
• type UnsupportedDataTypeError
  • func (err UnsupportedDataTypeError) Error() string
  • func (err *UnsupportedDataTypeError) Trace() []string

Constants

const (
	// NoS3EnvVar is the environment variable to set when you do not want to try and pull from S3.
	NoS3EnvVar = "NO_S3_ENV_VARS"
	// NoSSMEnvVar is the environment variable to set when you do not want to try and pull from SSM.
	NoSSMEnvVar = "NO_SSM_ENV_VARS"
	// S3GlobalEnvironmentBucketVar is an environment variable for the global environment in S3.
	S3GlobalEnvironmentBucketVar = "S3_GLOBAL_ENV_BUCKET"
	// GlobalEnvironmentVar is the environment variable to set the environment for S3 and SSM.
	GlobalEnvironmentVar = "GLOBAL_ENVIRONMENT"
	// GlobalProjectVar is the environment variable to set the project for S3 and SSM.
	GlobalProjectVar = "GLOBAL_PROJECT"
)

Functions

func Get

func Get(key string, defaultVal string) string

Get returns the value of an environment variable if the variable is set, else the default value

func GetEnvMap

func GetEnvMap() map[string]string

GetEnvMap returns a map of all environment variables to their values

func NewInvalidSpecificationError

func NewInvalidSpecificationError() errors.TracerError

NewInvalidSpecificationError instantiates a InvalidSpecificationError with a stack trace

func NewMissingEnvironmentVariableError

func NewMissingEnvironmentVariableError(field string, tag string) errors.TracerError

NewMissingEnvironmentVariableError instantiates a MissingEnvironmentVariableError with a stack trace

func NewUnsupportedDataTypeError

func NewUnsupportedDataTypeError(dataType reflect.Kind, field string) errors.TracerError

NewUnsupportedDataTypeError instantiates a UnsupportedDataTypeError with a stack trace

func Process

func Process(config interface{}, logger log.Logger) error

Process takes a Specification that describes the configuration for the application only attributes tagged with `env:""` will be imported from the environment Example Specification:

type Specification struct {
    DatabaseURL string `env:"DATABASE_URL"`
    ServiceID   string `env:"SERVICE_ID,optional"`
}

Supported options: optional

func ProcessMap

func ProcessMap(config interface{}, envVars map[string]string, logger log.Logger) error

ProcessMap is the same as Process except that the environment variable map is supplied instead of retrieved

func Push

func Push(config interface{}) error

Push the passed specification object onto the environment, note that these changes will not live past the life of this process.

func RedisAddress

func RedisAddress() string

RedisAddress returns the combined host and port from the environment

func RedisHost

func RedisHost() string

RedisHost returns the host value from the environment

func RedisPort

func RedisPort() int

RedisPort returns the port value from the environment

Types

type Bucket

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

Bucket wraps the S3 downloader with an in memory cache

func NewBucket

func NewBucket(bucketName, environment, project string) *Bucket

NewBucket returns a Bucket with an S3 downloader and an initialized cache

func (*Bucket) Add

func (b *Bucket) Add(project string, data map[string]interface{})

Add a map of data from S3 to the cache

func (*Bucket) Get

func (b *Bucket) Get(project, key string, logger log.Logger) interface{}

Get pulls a value from a map loaded from an S3 bucket

func (*Bucket) Has

func (b *Bucket) Has(project, key string) (interface{}, bool)

Has checks for a given key in the cache

type InvalidSpecificationError

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

InvalidSpecificationError indicates that a config is of the wrong type.

func (*InvalidSpecificationError) Error

func (err *InvalidSpecificationError) Error() string

func (*InvalidSpecificationError) Trace

func (err *InvalidSpecificationError) Trace() []string

Trace returns the stack trace for the error

type MissingEnvironmentVariableError

type MissingEnvironmentVariableError struct {
	Field string
	Tag   string
	// contains filtered or unexported fields
}

MissingEnvironmentVariableError indicates that a non-optional variable was not found in the environment

func (MissingEnvironmentVariableError) Error

func (err MissingEnvironmentVariableError) Error() string

func (*MissingEnvironmentVariableError) Trace

func (err *MissingEnvironmentVariableError) Trace() []string

Trace returns the stack trace for the error

type MockssmClient

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

MockssmClient is a mock of ssmClient interface.

func NewMockssmClient

func NewMockssmClient(ctrl *gomock.Controller) *MockssmClient

NewMockssmClient creates a new mock instance.

func (*MockssmClient) EXPECT

func (m *MockssmClient) EXPECT() *MockssmClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockssmClient) GetParametersByPath

func (m *MockssmClient) GetParametersByPath(arg0 *ssm.GetParametersByPathInput) (*ssm.GetParametersByPathOutput, error)

GetParametersByPath mocks base method.

type MockssmClientMockRecorder

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

MockssmClientMockRecorder is the mock recorder for MockssmClient.

func (*MockssmClientMockRecorder) GetParametersByPath

func (mr *MockssmClientMockRecorder) GetParametersByPath(arg0 any) *gomock.Call

GetParametersByPath indicates an expected call of GetParametersByPath.

type SSM

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

SSM wraps the SSM client with an in memory cache

func NewSSM

func NewSSM(environment, project string) *SSM

NewSSM returns a SSM for the environment with a client and an initialized cache

func (*SSM) Add

func (s *SSM) Add(path string, data map[string]string)

Add a map of data from SSM to the cache

func (*SSM) Get

func (s *SSM) Get(project, name string, logger log.Logger) string

Get a value from the cache, if it is not found it will load from SSM

func (*SSM) Has

func (s *SSM) Has(project, name string) (string, bool)

Has checks for a given key in the cache

type UnsupportedDataTypeError

type UnsupportedDataTypeError struct {
	Type  reflect.Kind
	Field string
	// contains filtered or unexported fields
}

UnsupportedDataTypeError indicates that no conversion from string to the given type has been implemented

func (UnsupportedDataTypeError) Error

func (err UnsupportedDataTypeError) Error() string

func (*UnsupportedDataTypeError) Trace

func (err *UnsupportedDataTypeError) Trace() []string

Trace returns the stack trace for the error