mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-24 15:44: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>
65 lines
2.1 KiB
Go
65 lines
2.1 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 (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"golang.org/x/exp/slog"
|
|
|
|
"github.com/ava-labs/libevm/log"
|
|
)
|
|
|
|
type tbRecorder struct {
|
|
testing.TB
|
|
logged, errored []string
|
|
}
|
|
|
|
func (r *tbRecorder) Logf(format string, a ...any) {
|
|
r.logged = append(r.logged, fmt.Sprintf(format, a...))
|
|
}
|
|
|
|
func (r *tbRecorder) Errorf(format string, a ...any) {
|
|
r.errored = append(r.errored, fmt.Sprintf(format, a...))
|
|
}
|
|
|
|
func TestTBLogHandler(t *testing.T) {
|
|
got := &tbRecorder{}
|
|
l := log.NewLogger(NewTBLogHandler(got, slog.LevelDebug))
|
|
|
|
l.Debug("Cockroach") // Logf
|
|
l.Info("Hello", "who", "world") // Logf
|
|
l.Warn("Smoke") // Errorf
|
|
l.Error("Fire") // Errorf
|
|
// Crit will call os.Exit(1) so we don't test it.
|
|
|
|
require.Len(t, got.logged, 2, "Logf() calls")
|
|
require.Len(t, got.errored, 2, "Errorf() calls")
|
|
|
|
// Check simplest elements without being brittle about exact formatting
|
|
// See https://testing.googleblog.com/2015/01/testing-on-toilet-change-detector-tests.html.
|
|
assert.Contains(t, got.logged[0], "Cockroach")
|
|
assert.Contains(t, got.logged[1], "Hello")
|
|
assert.Contains(t, got.logged[1], "who")
|
|
assert.Contains(t, got.logged[1], "world")
|
|
|
|
assert.Contains(t, got.errored[0], "Smoke")
|
|
assert.Contains(t, got.errored[1], "Fire")
|
|
}
|