/
logger.go
96 lines (86 loc) · 2.54 KB
/
logger.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package systemtest
import (
"strings"
"sync"
"testing"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zaptest"
)
var loggerInstanceMu sync.Mutex
var loggerInstance *zap.SugaredLogger
var logger = func() *zap.SugaredLogger {
loggerInstanceMu.Lock()
defer loggerInstanceMu.Unlock()
if loggerInstance != nil {
return loggerInstance
}
l, err := zap.NewDevelopment()
if err != nil {
panic(err)
}
loggerInstance = l.Sugar()
return loggerInstance
}
// TestLogger creates a new zap.Logger meant to be used for tests. It only
// prints logs when the tests fails, or the logger calls t.Error
func TestLogger(t testing.TB) *zap.Logger {
writer := newTestingWriter(t)
t.Cleanup(func() {
defer writer.buf.Reset()
if t.Failed() {
for _, line := range writer.buf.Lines() {
// Strip trailing newline because t.Log always adds one.
t.Log(strings.TrimRight(line, "\n"))
}
}
})
return zap.New(
zapcore.NewCore(
zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig()),
writer,
zapcore.InfoLevel,
),
zap.ErrorOutput(writer.withMarkFailed(true)),
)
}
// testingWriter is a WriteSyncer that writes to the given testing.TB.
type testingWriter struct {
t testing.TB
buf *zaptest.Buffer
// If true, the test will be marked as failed.
markFailed bool
}
func newTestingWriter(t testing.TB) testingWriter {
return testingWriter{t: t, buf: new(zaptest.Buffer)}
}
// withMarkFailed returns a copy of this testingWriter with markFailed set to
// the provided value.
func (w testingWriter) withMarkFailed(v bool) testingWriter {
w.markFailed = v
return w
}
func (w testingWriter) Write(p []byte) (int, error) {
w.buf.Write(p)
if w.markFailed {
w.t.Fail()
}
return len(p), nil
}
func (w testingWriter) Sync() error { return w.buf.Sync() }