testutil

Documentation

Index

• func NewTestContext(opts ...TestContextOpt) context.Context
• type TestContextOpt
  • func WithConfig(cfg *config.DefaultConfig) TestContextOpt
  • func WithLogLevel(level log.Level) TestContextOpt
  • func WithLogPayload(log bool) TestContextOpt
• type TestLogEntries
• type TestLogEntry
• type TestLogger
  • func NewTestContextWithLogger(opts ...TestContextOpt) (context.Context, *TestLogger)
  • func NewTestLogger() *TestLogger
  • func (l *TestLogger) Debug(message string)
  • func (l *TestLogger) Entries() []TestLogEntry
  • func (l *TestLogger) EntryCount() int
  • func (l *TestLogger) Error(err error, message string)
  • func (l *TestLogger) Info(message string)
  • func (l *TestLogger) Inject(ctx context.Context) (context.Context, func(ctx context.Context) log.Logger)
  • func (l *TestLogger) LastEntry() *TestLogEntry
  • func (l *TestLogger) WithDuration(key string, value time.Duration) log.Logger
  • func (l *TestLogger) WithInt(key string, value int) log.Logger
  • func (l *TestLogger) WithLevel(level log.Level) log.Logger
  • func (l *TestLogger) WithStr(key string, value string) log.Logger

Functions

func NewTestContext

func NewTestContext(opts ...TestContextOpt) context.Context

NewTestContext returns a context suitable for use within unit tests. The context comes equipped with the following: 1. Logger To modify the test context further, pass additional TestContextOpt values.

Types

type TestContextOpt

type TestContextOpt interface {
	Apply(ctx context.Context) context.Context
}

TestContextOpt is an interface to help configure the test context.

func WithConfig

func WithConfig(cfg *config.DefaultConfig) TestContextOpt

WithConfig returns a TestContextOpt that adds the given configuration into the test context.

func WithLogLevel

func WithLogLevel(level log.Level) TestContextOpt

WithLogLevel returns a TestContextOpt that sets the log level within the test context.

func WithLogPayload

func WithLogPayload(log bool) TestContextOpt

WithLogPayload returns a TestContextOpt that sets the configuration option within the test context to log the payload contents or not.

type TestLogEntries

type TestLogEntries struct {
	Entries []TestLogEntry
}

type TestLogEntry

type TestLogEntry struct {
	Level   log.Level
	Message string
	Error   error
	Fields  map[string]interface{}
}

type TestLogger

type TestLogger struct {
	Level  log.Level
	Fields map[string]interface{}
	// contains filtered or unexported fields
}

The TestLogger is an implementation of log.Logger suitable for use within unit tests. Provision with NewTestLogger or NewTestContext.

func NewTestContextWithLogger

func NewTestContextWithLogger(opts ...TestContextOpt) (context.Context, *TestLogger)

NewTestContext returns a context (and logger) suitable for use within unit tests. The context comes equipped with the following: 1. Logger To modify the test context further, pass additional TestContextOpt values.

func NewTestLogger

func NewTestLogger() *TestLogger

func (*TestLogger) Debug

func (l *TestLogger) Debug(message string)

func (*TestLogger) Entries

func (l *TestLogger) Entries() []TestLogEntry

func (*TestLogger) EntryCount

func (l *TestLogger) EntryCount() int

func (*TestLogger) Error

func (l *TestLogger) Error(err error, message string)

func (*TestLogger) Info

func (l *TestLogger) Info(message string)

func (*TestLogger) Inject

func (l *TestLogger) Inject(ctx context.Context) (context.Context, func(ctx context.Context) log.Logger)

func (*TestLogger) LastEntry

func (l *TestLogger) LastEntry() *TestLogEntry

func (*TestLogger) WithDuration

func (l *TestLogger) WithDuration(key string, value time.Duration) log.Logger

func (*TestLogger) WithInt

func (l *TestLogger) WithInt(key string, value int) log.Logger

func (*TestLogger) WithLevel

func (l *TestLogger) WithLevel(level log.Level) log.Logger

func (*TestLogger) WithStr

func (l *TestLogger) WithStr(key string, value string) log.Logger