mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-05 21:14:53 +00:00
0bded371c5
This contains two major changes: - Remove the legacy test logging method, and just explicitly call the noop logger. This is just to make the test logging behavior more coherent and clear. - Move the logging in the light package from the testing.T logger to the noop logger. It's really the case that we very rarely need/want to consider test logs unless we're doing reproductions and running a narrow set of tests. In most cases, I (for one) prefer to run in verbose mode so I can watch progress of tests, but I basically never need to consider logs. If I do want to see logs, then I can edit in the testing.T logger locally (which is what you have to do today, anyway.)
52 lines
1.4 KiB
Go
52 lines
1.4 KiB
Go
package log
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/rs/zerolog"
|
|
)
|
|
|
|
// NewTestingLogger converts a testing.T into a logging interface to
|
|
// make test failures and verbose provide better feedback associated
|
|
// with test failures. This logging instance is safe for use from
|
|
// multiple threads, but in general you should create one of these
|
|
// loggers ONCE for each *testing.T instance that you interact with.
|
|
//
|
|
// By default it collects only ERROR messages, or DEBUG messages in
|
|
// verbose mode, and relies on the underlying behavior of
|
|
// testing.T.Log()
|
|
//
|
|
// Users should be careful to ensure that no calls to this logger are
|
|
// made in goroutines that are running after (which, by the rules of
|
|
// testing.TB will panic.)
|
|
func NewTestingLogger(t testing.TB) Logger {
|
|
level := LogLevelError
|
|
if testing.Verbose() {
|
|
level = LogLevelDebug
|
|
}
|
|
|
|
return NewTestingLoggerWithLevel(t, level)
|
|
}
|
|
|
|
// NewTestingLoggerWithLevel creates a testing logger instance at a
|
|
// specific level that wraps the behavior of testing.T.Log().
|
|
func NewTestingLoggerWithLevel(t testing.TB, level string) Logger {
|
|
logLevel, err := zerolog.ParseLevel(level)
|
|
if err != nil {
|
|
t.Fatalf("failed to parse log level (%s): %v", level, err)
|
|
}
|
|
|
|
return defaultLogger{
|
|
Logger: zerolog.New(newSyncWriter(testingWriter{t})).Level(logLevel),
|
|
}
|
|
}
|
|
|
|
type testingWriter struct {
|
|
t testing.TB
|
|
}
|
|
|
|
func (tw testingWriter) Write(in []byte) (int, error) {
|
|
tw.t.Log(string(in))
|
|
return len(in), nil
|
|
}
|