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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
// Copyright (c) 2016 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 zapcore
import (
"bytes"
"flag"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
func TestLevelString(t *testing.T) {
tests := map[Level]string{
DebugLevel: "debug",
InfoLevel: "info",
WarnLevel: "warn",
ErrorLevel: "error",
DPanicLevel: "dpanic",
PanicLevel: "panic",
FatalLevel: "fatal",
Level(-42): "Level(-42)",
InvalidLevel: "Level(6)", // InvalidLevel does not have a name
}
for lvl, stringLevel := range tests {
assert.Equal(t, stringLevel, lvl.String(), "Unexpected lowercase level string.")
assert.Equal(t, strings.ToUpper(stringLevel), lvl.CapitalString(), "Unexpected all-caps level string.")
}
}
func TestLevelText(t *testing.T) {
tests := []struct {
text string
level Level
}{
{"debug", DebugLevel},
{"info", InfoLevel},
{"", InfoLevel}, // make the zero value useful
{"warn", WarnLevel},
{"error", ErrorLevel},
{"dpanic", DPanicLevel},
{"panic", PanicLevel},
{"fatal", FatalLevel},
}
for _, tt := range tests {
if tt.text != "" {
lvl := tt.level
marshaled, err := lvl.MarshalText()
assert.NoError(t, err, "Unexpected error marshaling level %v to text.", &lvl)
assert.Equal(t, tt.text, string(marshaled), "Marshaling level %v to text yielded unexpected result.", &lvl)
}
var unmarshaled Level
err := unmarshaled.UnmarshalText([]byte(tt.text))
assert.NoError(t, err, `Unexpected error unmarshaling text %q to level.`, tt.text)
assert.Equal(t, tt.level, unmarshaled, `Text %q unmarshaled to an unexpected level.`, tt.text)
}
}
func TestParseLevel(t *testing.T) {
tests := []struct {
text string
level Level
err string
}{
{"info", InfoLevel, ""},
{"DEBUG", DebugLevel, ""},
{"FOO", 0, `unrecognized level: "FOO"`},
}
for _, tt := range tests {
parsedLevel, err := ParseLevel(tt.text)
if len(tt.err) == 0 {
assert.NoError(t, err)
assert.Equal(t, tt.level, parsedLevel)
} else {
assert.Error(t, err)
assert.Contains(t, err.Error(), tt.err)
}
}
}
func TestCapitalLevelsParse(t *testing.T) {
tests := []struct {
text string
level Level
}{
{"DEBUG", DebugLevel},
{"INFO", InfoLevel},
{"WARN", WarnLevel},
{"ERROR", ErrorLevel},
{"DPANIC", DPanicLevel},
{"PANIC", PanicLevel},
{"FATAL", FatalLevel},
}
for _, tt := range tests {
var unmarshaled Level
err := unmarshaled.UnmarshalText([]byte(tt.text))
assert.NoError(t, err, `Unexpected error unmarshaling text %q to level.`, tt.text)
assert.Equal(t, tt.level, unmarshaled, `Text %q unmarshaled to an unexpected level.`, tt.text)
}
}
func TestWeirdLevelsParse(t *testing.T) {
tests := []struct {
text string
level Level
}{
// I guess...
{"Debug", DebugLevel},
{"Info", InfoLevel},
{"Warn", WarnLevel},
{"Error", ErrorLevel},
{"Dpanic", DPanicLevel},
{"Panic", PanicLevel},
{"Fatal", FatalLevel},
// What even is...
{"DeBuG", DebugLevel},
{"InFo", InfoLevel},
{"WaRn", WarnLevel},
{"ErRor", ErrorLevel},
{"DpAnIc", DPanicLevel},
{"PaNiC", PanicLevel},
{"FaTaL", FatalLevel},
}
for _, tt := range tests {
var unmarshaled Level
err := unmarshaled.UnmarshalText([]byte(tt.text))
assert.NoError(t, err, `Unexpected error unmarshaling text %q to level.`, tt.text)
assert.Equal(t, tt.level, unmarshaled, `Text %q unmarshaled to an unexpected level.`, tt.text)
}
}
func TestLevelNils(t *testing.T) {
var l *Level
// The String() method will not handle nil level properly.
assert.Panics(t, func() {
assert.Equal(t, "Level(nil)", l.String(), "Unexpected result stringifying nil *Level.")
}, "Level(nil).String() should panic")
assert.Panics(t, func() {
l.MarshalText()
}, "Expected to panic when marshalling a nil level.")
err := l.UnmarshalText([]byte("debug"))
assert.Equal(t, errUnmarshalNilLevel, err, "Expected to error unmarshalling into a nil Level.")
}
func TestLevelUnmarshalUnknownText(t *testing.T) {
var l Level
err := l.UnmarshalText([]byte("foo"))
assert.Contains(t, err.Error(), "unrecognized level", "Expected unmarshaling arbitrary text to fail.")
}
func TestLevelAsFlagValue(t *testing.T) {
var (
buf bytes.Buffer
lvl Level
)
fs := flag.NewFlagSet("levelTest", flag.ContinueOnError)
fs.SetOutput(&buf)
fs.Var(&lvl, "level", "log level")
for _, expected := range []Level{DebugLevel, InfoLevel, WarnLevel, ErrorLevel, DPanicLevel, PanicLevel, FatalLevel} {
assert.NoError(t, fs.Parse([]string{"-level", expected.String()}))
assert.Equal(t, expected, lvl, "Unexpected level after parsing flag.")
assert.Equal(t, expected, lvl.Get(), "Unexpected output using flag.Getter API.")
assert.Empty(t, buf.String(), "Unexpected error output parsing level flag.")
buf.Reset()
}
assert.Error(t, fs.Parse([]string{"-level", "nope"}))
assert.Equal(
t,
`invalid value "nope" for flag -level: unrecognized level: "nope"`,
strings.Split(buf.String(), "\n")[0], // second line is help message
"Unexpected error output from invalid flag input.",
)
}
// enablerWithCustomLevel is a LevelEnabler that implements a custom Level
// method.
type enablerWithCustomLevel struct{ lvl Level }
var _ leveledEnabler = (*enablerWithCustomLevel)(nil)
func (l *enablerWithCustomLevel) Enabled(lvl Level) bool {
return l.lvl.Enabled(lvl)
}
func (l *enablerWithCustomLevel) Level() Level {
return l.lvl
}
func TestLevelOf(t *testing.T) {
tests := []struct {
desc string
give LevelEnabler
want Level
}{
{desc: "debug", give: DebugLevel, want: DebugLevel},
{desc: "info", give: InfoLevel, want: InfoLevel},
{desc: "warn", give: WarnLevel, want: WarnLevel},
{desc: "error", give: ErrorLevel, want: ErrorLevel},
{desc: "dpanic", give: DPanicLevel, want: DPanicLevel},
{desc: "panic", give: PanicLevel, want: PanicLevel},
{desc: "fatal", give: FatalLevel, want: FatalLevel},
{
desc: "leveledEnabler",
give: &enablerWithCustomLevel{lvl: InfoLevel},
want: InfoLevel,
},
{
desc: "noop",
give: NewNopCore(), // always disabled
want: InvalidLevel,
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.desc, func(t *testing.T) {
t.Parallel()
assert.Equal(t, tt.want, LevelOf(tt.give), "Reported level did not match.")
})
}
}
|
