logtest

Documentation

Overview

logtest provides the ability to test logs

Usage:

func MyTestFunc(t *testing.T) {
    logs := logTest.NewLogRecorder(t)
    defer logs.Close()
    .....
    if diff := logs.Diff(expected); diff != "" {
        t.Fatal("logs unexpected", diff);
    }
}

Index

• func Map(m log.Marshaler) map[string]interface{}
• type LogRecorder
  • func NewLogRecorder(t *testing.T) *LogRecorder
  • func (l *LogRecorder) Close()
  • func (l *LogRecorder) Entries() []log.F
  • func (l *LogRecorder) Write(b []byte) (n int, err error)

Functions

func Map

func Map(m log.Marshaler) map[string]interface{}

MarshalToMap uses the given arguments `MarshalLog` function to serialize it into a map, which it returns.

The serialization is similar to the one performed by logs. Any nesting is flattened by representing it as dot-separated key prefixes in a flat map.

Types

type LogRecorder

type LogRecorder struct {
	*testing.T

	sync.Mutex
	// contains filtered or unexported fields
}

LogRecorder holds the state

func NewLogRecorder

func NewLogRecorder(t *testing.T) *LogRecorder

NewLogRecorder starts a new log recorder.

Logs must be stopped by calling Close() on the recorder

func (*LogRecorder) Close

func (l *LogRecorder) Close()

Close closes the recorder

func (*LogRecorder) Entries

func (l *LogRecorder) Entries() []log.F

Entries returns the log entries.

func (*LogRecorder) Write

func (l *LogRecorder) Write(b []byte) (n int, err error)