mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-23 15:14:32 +00:00
b4a7f35411
This adds a test logger for libevm, that treats errors as they _should_
be treated.
- Logs at `log.LevelWarn` and above trigger `t.Errorf()`, causing tests
to fail
- Critical logs fail immediately: Logs at `log.LevelCrit` trigger
`t.Fatalf()`
- Info/debug logs pass through: Lower severity logs use `t.Logf()` for
informational output
You can use the logger like this:
```go
import (
"github.com/ava-labs/libevm/ethtest"
"github.com/ava-labs/libevm/log"
)
func TestSomething(t *testing.T) {
logger := log.NewLogger(ethtest.NewTBLogHandler(t, log.LevelDebug))
// Or to set globally
log.SetDefault(log.NewLogger(ethtest.NewTBLogHandler(t, log.LevelDebug))
}
```
I was thinking about adding tests to show this works, but it seemed
silly to test a testing utility.
---------
Signed-off-by: Jonathan Oppenheimer <147infiniti@gmail.com>
Co-authored-by: Arran Schlosberg <519948+ARR4N@users.noreply.github.com>
85 lines
2.4 KiB
Go
85 lines
2.4 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 logs to [testing.TB].
|
|
// Logs at [log.LevelWarn] or above go to [testing.TB.Errorf], except
|
|
// [log.LevelCrit] which goes to [testing.TB.Fatalf]. All other logs go to
|
|
// [testing.TB.Logf]. The level parameter controls which logs are enabled.
|
|
//
|
|
//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, level slog.Level) bool {
|
|
return level >= min(h.level, slog.LevelWarn)
|
|
}
|
|
|
|
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 >= log.LevelWarn:
|
|
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 }
|