config

Documentation

Index

• func FetchPropertyFromContext(ctx context.Context, property string) (interface{}, error)
• func StoreInContext(ctx context.Context, c Config) context.Context
• type Config
  • func FetchFromContext(ctx context.Context) (Config, error)
• type MockConfig
  • func NewMockConfig(t interface{ ... }) *MockConfig
  • func (_m *MockConfig) Get(_a0 string) (interface{}, error)
  • func (_m *MockConfig) Refresh(_a0 context.Context) error
  • func (_m *MockConfig) Set(_a0 string, _a1 interface{}) error
  • func (_m *MockConfig) Upgrade() error
  • func (_m *MockConfig) Validate() error

Functions

func FetchPropertyFromContext

func FetchPropertyFromContext(ctx context.Context, property string) (interface{}, error)

FetchPropertyFromContext is a helper function to retrieve a specific config property from the Config store in ctx, rather than retrieving the entire Config object.

func StoreInContext

func StoreInContext(ctx context.Context, c Config) context.Context

StoreInContext returns a new Context that stores the Config, c.

Types

type Config

type Config interface {
	Get(string) (interface{}, error)
	Set(string, interface{}) error
	Validate() error
	Refresh(context.Context) error
	Upgrade() error
}

func FetchFromContext

func FetchFromContext(ctx context.Context) (Config, error)

FetchFromContext returns the Config value stored in ctx, if any.

type MockConfig

type MockConfig struct {
	mock.Mock
}

MockConfig is an autogenerated mock type for the Config type

func NewMockConfig

func NewMockConfig(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockConfig

NewMockConfig creates a new instance of MockConfig. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockConfig) Get

func (_m *MockConfig) Get(_a0 string) (interface{}, error)

Get provides a mock function with given fields: _a0

func (*MockConfig) Refresh

func (_m *MockConfig) Refresh(_a0 context.Context) error

Refresh provides a mock function with given fields: _a0

func (*MockConfig) Set

func (_m *MockConfig) Set(_a0 string, _a1 interface{}) error

Set provides a mock function with given fields: _a0, _a1

func (*MockConfig) Upgrade

func (_m *MockConfig) Upgrade() error

Upgrade provides a mock function with given fields:

func (*MockConfig) Validate

func (_m *MockConfig) Validate() error

Validate provides a mock function with given fields: