-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
test_logger.go
120 lines (100 loc) · 2.73 KB
/
test_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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
package logger
// Based on https://stackoverflow.com/a/52737940
import (
"bytes"
"log"
"net/url"
"sync"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zaptest/observer"
"github.com/stretchr/testify/assert"
"github.com/smartcontractkit/chainlink/core/config/envvar"
)
// MemorySink implements zap.Sink by writing all messages to a buffer.
type MemorySink struct {
m sync.Mutex
b bytes.Buffer
}
var _ zap.Sink = &MemorySink{}
func (s *MemorySink) Write(p []byte) (n int, err error) {
s.m.Lock()
defer s.m.Unlock()
return s.b.Write(p)
}
// Close is a dummy method to satisfy the zap.Sink interface
func (s *MemorySink) Close() error { return nil }
// Sync is a dummy method to satisfy the zap.Sink interface
func (s *MemorySink) Sync() error { return nil }
// String returns the full log contents, as a string
func (s *MemorySink) String() string {
s.m.Lock()
defer s.m.Unlock()
return s.b.String()
}
func (s *MemorySink) Reset() {
s.m.Lock()
defer s.m.Unlock()
s.b.Reset()
}
var testMemoryLog MemorySink
var createSinkOnce sync.Once
func registerMemorySink() {
if err := zap.RegisterSink("memory", func(*url.URL) (zap.Sink, error) {
return PrettyConsole{Sink: &testMemoryLog}, nil
}); err != nil {
panic(err)
}
}
func MemoryLogTestingOnly() *MemorySink {
createSinkOnce.Do(registerMemorySink)
return &testMemoryLog
}
// TestLogger creates a logger that directs output to PrettyConsole configured
// for test output, and to the buffer testMemoryLog. t is optional.
// Log level is derived from the LOG_LEVEL env var.
func TestLogger(t T) SugaredLogger {
return testLogger(t)
}
// TestLoggerObserved creates a logger with an observer that can be used to
// test emitted logs at the given level or above
func TestLoggerObserved(t T, lvl zapcore.Level) (Logger, *observer.ObservedLogs) {
observedZapCore, observedLogs := observer.New(lvl)
return testLogger(t, observedZapCore), observedLogs
}
func testLogger(t T, cores ...zapcore.Core) SugaredLogger {
cfg := newZapConfigTest()
ll, invalid := envvar.LogLevel.Parse()
cfg.Level.SetLevel(ll)
l, close, err := zapLoggerConfig{Config: cfg}.newLogger(cores...)
if err != nil {
if t == nil {
log.Fatal(err)
}
t.Fatal(err)
}
if invalid != "" {
l.Error(invalid)
}
if t != nil {
t.Cleanup(func() {
assert.NoError(t, close())
})
}
if t == nil {
return Sugared(l)
}
return Sugared(l.Named(verShaNameStatic()).Named(t.Name()))
}
func newZapConfigTest() zap.Config {
_ = MemoryLogTestingOnly() // Make sure memory log is created
config := newZapConfigBase()
config.OutputPaths = []string{"pretty://console", "memory://"}
return config
}
type T interface {
Name() string
Cleanup(f func())
Fatal(...interface{})
Errorf(format string, args ...interface{})
}