status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-02-21 09:58:26 +00:00
Code Issues Projects Releases Wiki Activity

testutil: Set the environment variable NOLOGBUFFER=1 to have test agent logs go straight to stdout

Browse Source 
This is a followup to the testing feature added in #5304.

While it is very nice to have test agent logs to through testing.T.Logf
so that only logs from failed tests are emitted, if a test is hanging or
taking a long time those logs are delayed. In that case setting
NOLOGBUFFER=1 will temporarily redirect them to stdout so you can see
immediate feedback about hangs when running the tests in verbose mode.

One current example of a test where this can be relevant is:

    $ go test ./agent/consul -run 'TestCatalog_ListServices_Stale' -v
This commit is contained in:
R.B. Boyer 2019-02-01 12:25:04 -06:00
parent a7de668260
commit 82c17d94e1
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
testutil/testlog.go
View File

@ -1,12 +1,20 @@
package testutil package testutil
import ( import (
"fmt"
"io" "io"
"log" "log"
"os"
"strings" "strings"
"testing" "testing"
) )
var sendTestLogsToStdout bool
func init() {
sendTestLogsToStdout = os.Getenv("NOLOGBUFFER") == "1"
}
func TestLogger(t testing.TB) *log.Logger { func TestLogger(t testing.TB) *log.Logger {
return log.New(&testWriter{t}, "test: ", log.LstdFlags) return log.New(&testWriter{t}, "test: ", log.LstdFlags)
} }
@ -25,6 +33,10 @@ type testWriter struct {
func (tw *testWriter) Write(p []byte) (n int, err error) { func (tw *testWriter) Write(p []byte) (n int, err error) {
tw.t.Helper() tw.t.Helper()
if sendTestLogsToStdout {
fmt.Fprint(os.Stdout, strings.TrimSpace(string(p))+"\n")
} else {
tw.t.Log(strings.TrimSpace(string(p))) tw.t.Log(strings.TrimSpace(string(p)))
}
return len(p), nil return len(p), nil
} }