slogtest

Documentation

Overview

Package slogtest provides utilities for emitting test logs using clog.

func TestExample(t *testing.T) {
	ctx := slogtest.Context(t)
	clog.FromContext(ctx).With("foo", "bar").Info("hello world")
}

This produces the following test output:

=== RUN   TestExample
	slogtest.go:24: level=INFO source=/path/to/example_test.go:13 msg="hello world" foo=bar

This package is intended to be used in tests only.

Index

• func Context(t Logger) context.Context
• func RemoveTime(groups []string, a slog.Attr) slog.Attr
• func TestContextWithLogger(t Logger) context.Context
• func TestLogger(t Logger) *clog.Logger
• func TestLoggerWithOptions(t Logger, opts *slog.HandlerOptions) *clog.Logger
• type Logger

Functions

func Context

func Context(t Logger) context.Context

Context returns a context with a logger to be used in tests.

func RemoveTime

func RemoveTime(groups []string, a slog.Attr) slog.Attr

RemoveTime removes the top-level time attribute. It is intended to be used as a ReplaceAttr function, to make example output deterministic.

This is taken from slog/internal/slogtest.RemoveTime.

func TestContextWithLogger

func TestContextWithLogger(t Logger) context.Context

TestContextWithLogger returns a context with a logger to be used in tests

Deprecated: Use Context instead.

func TestLogger

func TestLogger(t Logger) *clog.Logger

TestLogger gets a logger to use in unit and end to end tests. This logger is configured to log at debug level.

func TestLoggerWithOptions

func TestLoggerWithOptions(t Logger, opts *slog.HandlerOptions) *clog.Logger

TestLoggerWithOptions gets a logger to use in unit and end to end tests.

Types

type Logger

type Logger interface{ Log(args ...any) }