testlog

README

testlog

github.com/ethereum/go-ethereum/internal/testlog: a Go-ethereum util for logging in tests.

Since we use the same logging, but as an external package, we have to move the test utility to our own internal package.

This fork also made minor modifications:

• Enable color by default.
• Add estimateInfoLen and use this for message padding in flush() to align the contents of the log entries, compensating for the different lengths of the log decoration that the Go library adds.

Documentation

Overview

Package testlog provides a log handler for unit tests.

Index

• func Handler(t Testing, level log.Lvl) log.Handler
• func Logger(t Testing, level log.Lvl) log.Logger
• type CapturingHandler
  • func (c *CapturingHandler) Clear()
  • func (c *CapturingHandler) FindLog(lvl log.Lvl, msg string) *HelperRecord
  • func (c *CapturingHandler) Log(r *log.Record) error
• type HelperRecord
  • func (h *HelperRecord) GetContextValue(name string) any
• type Testing

Functions

func Handler

func Handler(t Testing, level log.Lvl) log.Handler

Handler returns a log handler which logs to the unit test log of t.

func Logger

func Logger(t Testing, level log.Lvl) log.Logger

Logger returns a logger which logs to the unit test log of t.

Types

type CapturingHandler

type CapturingHandler struct {
	Delegate log.Handler
	Logs     []*log.Record
}

CapturingHandler provides a log handler that captures all log records and optionally forwards them to a delegate. Note that it is not thread safe.

func (*CapturingHandler) Clear

func (c *CapturingHandler) Clear()

func (*CapturingHandler) FindLog

func (c *CapturingHandler) FindLog(lvl log.Lvl, msg string) *HelperRecord

func (*CapturingHandler) Log

func (c *CapturingHandler) Log(r *log.Record) error

type HelperRecord

type HelperRecord struct {
	*log.Record
}

func (*HelperRecord) GetContextValue

func (h *HelperRecord) GetContextValue(name string) any

type Testing

type Testing interface {
	Logf(format string, args ...any)
	Helper()
}

Testing interface to log to. Some functions are marked as Helper function to log the call site accurately. Standard Go testing.TB implements this, as well as Hive and other Go-like test frameworks.