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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
// SPDX-License-Identifier: Apache-2.0
package loggertests
import logger.Logger.OutputCaptor
import logger.{LazyLogging, LogLevel, Logger}
import org.scalatest.OneInstancePerTest
import org.scalatest.freespec.AnyFreeSpec
import org.scalatest.matchers.should.Matchers
object LoggerSpec {
val ErrorMsg = "message error"
val WarnMsg = "message warn"
val InfoMsg = "message info"
val DebugMsg = "message debug"
val TraceMsg = "message trace"
val globalLevel = LogLevel.Warn
}
class Logger1 extends LazyLogging {
def run(): Unit = {
logger.error(LoggerSpec.ErrorMsg)
logger.warn(LoggerSpec.WarnMsg)
logger.info(LoggerSpec.InfoMsg)
logger.debug(LoggerSpec.DebugMsg)
logger.trace(LoggerSpec.TraceMsg)
}
}
class LogsInfo2 extends LazyLogging {
def run(): Unit = {
logger.info("logger2")
}
}
class LogsInfo3 extends LazyLogging {
def run(): Unit = {
logger.info("logger3")
}
}
class LoggerSpec extends AnyFreeSpec with Matchers with OneInstancePerTest with LazyLogging {
"Logger is a simple but powerful logging system" - {
"Following tests show how global level can control logging" - {
"setting level to None will result in warn messages" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.None)
val r1 = new Logger1
r1.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains(LoggerSpec.ErrorMsg) should be(true)
messagesLogged.contains(LoggerSpec.WarnMsg) should be(true)
messagesLogged.contains(LoggerSpec.InfoMsg) should be(false)
messagesLogged.contains(LoggerSpec.DebugMsg) should be(false)
messagesLogged.contains(LoggerSpec.TraceMsg) should be(false)
}
}
"only warn and error shows up by default" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
val r1 = new Logger1
r1.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains(LoggerSpec.ErrorMsg) should be(true)
messagesLogged.contains(LoggerSpec.WarnMsg) should be(LogLevel.Warn <= LoggerSpec.globalLevel)
messagesLogged.contains(LoggerSpec.InfoMsg) should be(LogLevel.Info <= LoggerSpec.globalLevel)
messagesLogged.contains(LoggerSpec.DebugMsg) should be(LogLevel.Debug <= LoggerSpec.globalLevel)
messagesLogged.contains(LoggerSpec.TraceMsg) should be(LogLevel.Trace <= LoggerSpec.globalLevel)
}
}
"setting level to warn will result in error and warn messages" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Warn)
val r1 = new Logger1
r1.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains(LoggerSpec.ErrorMsg) should be(true)
messagesLogged.contains(LoggerSpec.WarnMsg) should be(true)
messagesLogged.contains(LoggerSpec.InfoMsg) should be(false)
messagesLogged.contains(LoggerSpec.DebugMsg) should be(false)
}
}
"setting level to info will result in error, info, and warn messages" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Info)
val r1 = new Logger1
r1.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains(LoggerSpec.ErrorMsg) should be(true)
messagesLogged.contains(LoggerSpec.WarnMsg) should be(true)
messagesLogged.contains(LoggerSpec.InfoMsg) should be(true)
messagesLogged.contains(LoggerSpec.DebugMsg) should be(false)
}
}
"setting level to debug will result in error, info, debug, and warn messages" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Error)
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Debug)
val r1 = new Logger1
r1.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains(LoggerSpec.ErrorMsg) should be(true)
messagesLogged.contains(LoggerSpec.WarnMsg) should be(true)
messagesLogged.contains(LoggerSpec.InfoMsg) should be(true)
messagesLogged.contains(LoggerSpec.DebugMsg) should be(true)
messagesLogged.contains(LoggerSpec.TraceMsg) should be(false)
}
}
"setting level to trace will result in error, info, debug, trace, and warn messages" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Error)
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Trace)
val r1 = new Logger1
r1.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains(LoggerSpec.ErrorMsg) should be(true)
messagesLogged.contains(LoggerSpec.WarnMsg) should be(true)
messagesLogged.contains(LoggerSpec.InfoMsg) should be(true)
messagesLogged.contains(LoggerSpec.DebugMsg) should be(true)
messagesLogged.contains(LoggerSpec.TraceMsg) should be(true)
}
}
}
"the following tests show how logging can be controlled by package and class name" - {
"only capture output by class name" - {
"capture logging from LogsInfo2" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel("loggertests.LogsInfo2", LogLevel.Info)
val r2 = new LogsInfo2
val r3 = new LogsInfo3
r3.run()
r2.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger3") should be(false)
messagesLogged.contains("logger2") should be(true)
}
}
"capture logging from LogsInfo2 using class" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(classOf[LogsInfo2], LogLevel.Info)
val r2 = new LogsInfo2
val r3 = new LogsInfo3
r3.run()
r2.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger3") should be(false)
messagesLogged.contains("logger2") should be(true)
}
}
"capture logging from LogsInfo3" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel("loggertests.LogsInfo3", LogLevel.Info)
val r2 = new LogsInfo2
val r3 = new LogsInfo3
r2.run()
r3.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger2") should be(false)
messagesLogged.contains("logger3") should be(true)
}
}
}
"log based on package name" - {
"both log because of package, also showing re-run after change works" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Error)
Logger.setLevel("loggertests", LogLevel.Error)
val r2 = new LogsInfo2
val r3 = new LogsInfo3
r2.run()
r3.run()
var messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger2") should be(false)
messagesLogged.contains("logger3") should be(false)
Logger.setLevel("loggertests", LogLevel.Debug)
r2.run()
r3.run()
messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger2") should be(true)
messagesLogged.contains("logger3") should be(true)
}
}
}
"check for false positives" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel("bad-loggertests", LogLevel.Info)
val r2 = new LogsInfo2
val r3 = new LogsInfo3
r2.run()
r3.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger2") should be(false)
messagesLogged.contains("logger3") should be(false)
}
}
"show that class specific level supercedes global level" in {
Logger.makeScope() {
val captor = new OutputCaptor
Logger.setOutput(captor.printStream)
Logger.setLevel(LogLevel.Info)
Logger.setLevel("loggertests.LogsInfo2", LogLevel.Error)
val r2 = new LogsInfo2
val r3 = new LogsInfo3
r2.run()
r3.run()
val messagesLogged = captor.getOutputAsString
messagesLogged.contains("logger2") should be(false)
messagesLogged.contains("logger3") should be(true)
}
}
"Show that printstream remains across makeScopes" in {
Logger.makeScope() {
val captor = new Logger.OutputCaptor
Logger.setOutput(captor.printStream)
logger.error("message 1")
Logger.makeScope() {
logger.error("message 2")
}
val logText = captor.getOutputAsString
logText should include("message 1")
logText should include("message 2")
}
}
"Show that nested makeScopes share same state" in {
Logger.getGlobalLevel should be(LoggerSpec.globalLevel)
Logger.makeScope() {
Logger.setLevel(LogLevel.Info)
Logger.getGlobalLevel should be(LogLevel.Info)
Logger.makeScope() {
Logger.getGlobalLevel should be(LogLevel.Info)
}
Logger.makeScope() {
Logger.setLevel(LogLevel.Debug)
Logger.getGlobalLevel should be(LogLevel.Debug)
}
Logger.getGlobalLevel should be(LogLevel.Debug)
}
Logger.getGlobalLevel should be(LoggerSpec.globalLevel)
}
"Show that first makeScope starts with fresh state" in {
Logger.getGlobalLevel should be(LoggerSpec.globalLevel)
Logger.setLevel(LogLevel.Warn)
Logger.getGlobalLevel should be(LogLevel.Warn)
Logger.makeScope() {
Logger.getGlobalLevel should be(LoggerSpec.globalLevel)
Logger.setLevel(LogLevel.Trace)
Logger.getGlobalLevel should be(LogLevel.Trace)
}
Logger.getGlobalLevel should be(LogLevel.Warn)
}
}
}
}
|
