context

Documentation

Overview

Package context defines a type that carries context specific data such as the logger. Inspired by Google's http://godoc.org/golang.org/x/net/context

Index

• type Mock
  • func NewMockDefault() *Mock
  • func NewMockDefaultWithContext(context []string) *Mock
  • func (m *Mock) AppConfig() appconfig.SsmagentConfig
  • func (m *Mock) CurrentContext() []string
  • func (m *Mock) Log() log.T
  • func (m *Mock) With(ctx string) T
• type T
  • func Default(logger log.T, appconfig appconfig.SsmagentConfig) T

Types

type Mock

type Mock struct {
	mock.Mock
}

Mock stands for a mocked context.

func NewMockDefault

func NewMockDefault() *Mock

NewMockDefault returns an instance of Mock with default expectations set.

func NewMockDefaultWithContext

func NewMockDefaultWithContext(context []string) *Mock

NewMockDefaultWithContext returns an instance of Mock with specified context.

func (*Mock) AppConfig

func (m *Mock) AppConfig() appconfig.SsmagentConfig

AppConfig mocks the Config function.

func (*Mock) CurrentContext

func (m *Mock) CurrentContext() []string

With mocks the With function.

func (*Mock) Log

func (m *Mock) Log() log.T

Log mocks the Log function.

func (*Mock) With

func (m *Mock) With(ctx string) T

With mocks the With function.

type T

type T interface {
	Log() log.T
	AppConfig() appconfig.SsmagentConfig
	With(context string) T
	CurrentContext() []string
}

T transfers context specific data across different execution boundaries. Instead of adding the context to specific structs, we pass Context as the first parameter to the methods themselves.

func Default

func Default(logger log.T, appconfig appconfig.SsmagentConfig) T

Default returns an empty context that use the default logger and appconfig.