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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package zaptest
import (
"errors"
"fmt"
"io"
"strings"
"testing"
"go.uber.org/zap"
"go.uber.org/zap/internal/ztest"
"go.uber.org/zap/zapcore"
"github.com/stretchr/testify/assert"
)
func TestTestLogger(t *testing.T) {
ts := newTestLogSpy(t)
defer ts.AssertPassed()
log := NewLogger(ts)
log.Info("received work order")
log.Debug("starting work")
log.Warn("work may fail")
log.Error("work failed", zap.Error(errors.New("great sadness")))
assert.Panics(t, func() {
log.Panic("failed to do work")
}, "log.Panic should panic")
ts.AssertMessages(
"INFO received work order",
"DEBUG starting work",
"WARN work may fail",
`ERROR work failed {"error": "great sadness"}`,
"PANIC failed to do work",
)
}
func TestTestLoggerSupportsLevels(t *testing.T) {
ts := newTestLogSpy(t)
defer ts.AssertPassed()
log := NewLogger(ts, Level(zap.WarnLevel))
log.Info("received work order")
log.Debug("starting work")
log.Warn("work may fail")
log.Error("work failed", zap.Error(errors.New("great sadness")))
assert.Panics(t, func() {
log.Panic("failed to do work")
}, "log.Panic should panic")
ts.AssertMessages(
"WARN work may fail",
`ERROR work failed {"error": "great sadness"}`,
"PANIC failed to do work",
)
}
func TestTestLoggerSupportsWrappedZapOptions(t *testing.T) {
ts := newTestLogSpy(t)
defer ts.AssertPassed()
log := NewLogger(ts, WrapOptions(zap.AddCaller(), zap.Fields(zap.String("k1", "v1"))))
log.Info("received work order")
log.Debug("starting work")
log.Warn("work may fail")
log.Error("work failed", zap.Error(errors.New("great sadness")))
assert.Panics(t, func() {
log.Panic("failed to do work")
}, "log.Panic should panic")
ts.AssertMessages(
`INFO zaptest/logger_test.go:89 received work order {"k1": "v1"}`,
`DEBUG zaptest/logger_test.go:90 starting work {"k1": "v1"}`,
`WARN zaptest/logger_test.go:91 work may fail {"k1": "v1"}`,
`ERROR zaptest/logger_test.go:92 work failed {"k1": "v1", "error": "great sadness"}`,
`PANIC zaptest/logger_test.go:95 failed to do work {"k1": "v1"}`,
)
}
func TestTestingWriter(t *testing.T) {
ts := newTestLogSpy(t)
w := newTestingWriter(ts)
n, err := io.WriteString(w, "hello\n\n")
assert.NoError(t, err, "WriteString must not fail")
assert.Equal(t, 7, n)
}
func TestTestLoggerErrorOutput(t *testing.T) {
// This test verifies that the test logger logs internal messages to the
// testing.T and marks the test as failed.
ts := newTestLogSpy(t)
defer ts.AssertFailed()
log := NewLogger(ts)
// Replace with a core that fails.
log = log.WithOptions(zap.WrapCore(func(zapcore.Core) zapcore.Core {
return zapcore.NewCore(
zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig()),
zapcore.Lock(zapcore.AddSync(ztest.FailWriter{})),
zapcore.DebugLevel,
)
}))
log.Info("foo") // this fails
if assert.Len(t, ts.Messages, 1, "expected a log message") {
assert.Regexp(t, `write error: failed`, ts.Messages[0])
}
}
// testLogSpy is a testing.TB that captures logged messages.
type testLogSpy struct {
testing.TB
failed bool
Messages []string
}
func newTestLogSpy(t testing.TB) *testLogSpy {
return &testLogSpy{TB: t}
}
func (t *testLogSpy) Fail() {
t.failed = true
}
func (t *testLogSpy) Failed() bool {
return t.failed
}
func (t *testLogSpy) FailNow() {
t.Fail()
t.TB.FailNow()
}
func (t *testLogSpy) Logf(format string, args ...interface{}) {
// Log messages are in the format,
//
// 2017-10-27T13:03:01.000-0700 DEBUG your message here {data here}
//
// We strip the first part of these messages because we can't really test
// for the timestamp from these tests.
m := fmt.Sprintf(format, args...)
m = m[strings.IndexByte(m, '\t')+1:]
t.Messages = append(t.Messages, m)
t.TB.Log(m)
}
func (t *testLogSpy) AssertMessages(msgs ...string) {
assert.Equal(t.TB, msgs, t.Messages, "logged messages did not match")
}
func (t *testLogSpy) AssertPassed() {
t.assertFailed(false, "expected test to pass")
}
func (t *testLogSpy) AssertFailed() {
t.assertFailed(true, "expected test to fail")
}
func (t *testLogSpy) assertFailed(v bool, msg string) {
assert.Equal(t.TB, v, t.failed, msg)
}
|
