logtest

func Captured ¶

func Captured(t testing.TB) (logger log.Logger, exportLogs func() CapturedLogs)

Captured retrieves a logger scoped to the given test, and returns a callback, exportLogs, which flushes the logger buffer and returns log entries.

The logged values are also printed to stderr in test output. The log level for stderr will be Debug if the tests are run in verbose mode, and Warn otherwise.

To suppress logging to stderr, use CapturedWith instead.

The returned callback exportLogs will return entries for all log levels.

func CapturedWith ¶

func CapturedWith(t testing.TB, stderrOptions LoggerOptions) (logger log.Logger, exportLogs func() CapturedLogs)

CapturedWith generalizes Captured but allows customizing the logging options for stderr.

To suppress logging to stderr, use LoggerOptions{Level: log.LevelNone}.

Like Captured, the exportLogs callback still captures logs for every level.

func Init ¶

func Init(_ *testing.M)

Init can be used to instantiate the log package for running tests, to be called in TestMain for the relevant package. Remember to call (*testing.M).Run() after initializing the logger!

testing.M is an unused argument, used to indicate this function should be called in TestMain.

func InitWithLevel ¶

func InitWithLevel(_ *testing.M, level log.Level)

InitWithLevel does the same thing as Init, but uses the provided log level to configur the log level for this package's tests, which can be helpful for exceptionally noisy tests.

If your loggers are parameterized, you can also use logtest.NoOp to silence output for specific tests.

func NoOp ¶

func NoOp(_ *testing.T) log.Logger

NoOp returns a no-op Logger, useful for silencing all output in a specific test.

func Scoped ¶

func Scoped(t testing.TB) log.Logger

Scoped retrieves a logger scoped to the the given test. It writes to testing.TB.

Unlike log.Scoped(), logtest.Scoped() is safe to use without initialization.

func ScopedWith ¶

func ScopedWith(t testing.TB, options LoggerOptions) log.Logger

Scoped retrieves a logger scoped to the the given test, configured with additional options. It writes to testing.TB.

Unlike log.Scoped(), logtest.Scoped() is safe to use without initialization.