go-ethereum/libevm/ethtest/logger.go
2026-03-02 11:39:59 -05:00

85 lines
2.3 KiB
Go

// Copyright 2026 the libevm authors.
//
// The libevm additions to go-ethereum are free software: you can redistribute
// them and/or modify them under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The libevm additions are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>.
package ethtest
import (
"context"
"runtime"
"slices"
"testing"
"golang.org/x/exp/slog"
"github.com/ava-labs/libevm/log"
)
// NewTBLogHandler constructs a [slog.Handler] that propagates all logs to
// [testing.TB]. Logs at or above `level` go to [testing.TB.Errorf], except
// [log.LevelCrit] which goes to [testing.TB.Fatalf]. All other logs go to
// [testing.TB.Logf].
//
//nolint:thelper // The outputs include the logging site while the TB site is most useful if here
func NewTBLogHandler(tb testing.TB, level slog.Level) slog.Handler {
return &tbHandler{
tb: tb,
level: level,
}
}
type tbHandler struct {
tb testing.TB
level slog.Level
attrs []slog.Attr
}
func (h *tbHandler) Enabled(_ context.Context, _ slog.Level) bool {
return true
}
func (h *tbHandler) Handle(_ context.Context, rec slog.Record) error {
to := h.tb.Logf
switch {
case rec.Level >= log.LevelCrit:
to = h.tb.Fatalf
case rec.Level >= h.level:
to = h.tb.Errorf
}
_, file, line, _ := runtime.Caller(3)
fields := make(map[string]any, len(h.attrs)+rec.NumAttrs())
for _, a := range h.attrs {
fields[a.Key] = a.Value.Any()
}
rec.Attrs(func(a slog.Attr) bool {
fields[a.Key] = a.Value.Any()
return true
})
to("[%s] %s %v - %s:%d", log.LevelAlignedString(rec.Level), rec.Message, fields, file, line)
return nil
}
func (h *tbHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
return &tbHandler{
tb: h.tb,
level: h.level,
attrs: slices.Concat(slices.Clone(h.attrs), attrs),
}
}
func (h *tbHandler) WithGroup(string) slog.Handler { return h }