-
-
Notifications
You must be signed in to change notification settings - Fork 427
/
SentryAppenderTest.kt
482 lines (417 loc) · 16.3 KB
/
SentryAppenderTest.kt
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
package io.sentry.logback
import ch.qos.logback.classic.Level
import ch.qos.logback.classic.LoggerContext
import ch.qos.logback.classic.encoder.PatternLayoutEncoder
import ch.qos.logback.classic.spi.ILoggingEvent
import ch.qos.logback.core.encoder.Encoder
import ch.qos.logback.core.encoder.EncoderBase
import ch.qos.logback.core.status.Status
import com.nhaarman.mockitokotlin2.any
import com.nhaarman.mockitokotlin2.anyOrNull
import com.nhaarman.mockitokotlin2.mock
import com.nhaarman.mockitokotlin2.verify
import com.nhaarman.mockitokotlin2.whenever
import io.sentry.ITransportFactory
import io.sentry.Sentry
import io.sentry.SentryLevel
import io.sentry.SentryOptions
import io.sentry.checkEvent
import io.sentry.transport.ITransport
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.slf4j.MDC
import org.slf4j.MarkerFactory
import java.time.Instant
import java.time.LocalDateTime
import java.time.ZoneId
import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFalse
import kotlin.test.assertNotNull
import kotlin.test.assertNull
import kotlin.test.assertTrue
class SentryAppenderTest {
private class Fixture(dsn: String? = "http://key@localhost/proj", minimumBreadcrumbLevel: Level? = null, minimumEventLevel: Level? = null, contextTags: List<String>? = null, encoder: Encoder<ILoggingEvent>? = null) {
val logger: Logger = LoggerFactory.getLogger(SentryAppenderTest::class.java)
val loggerContext = LoggerFactory.getILoggerFactory() as LoggerContext
val transportFactory = mock<ITransportFactory>()
val transport = mock<ITransport>()
val utcTimeZone: ZoneId = ZoneId.of("UTC")
init {
whenever(this.transportFactory.create(any(), any())).thenReturn(transport)
val appender = SentryAppender()
val options = SentryOptions()
options.dsn = dsn
contextTags?.forEach { options.addContextTag(it) }
appender.setOptions(options)
appender.setMinimumBreadcrumbLevel(minimumBreadcrumbLevel)
appender.setMinimumEventLevel(minimumEventLevel)
appender.context = loggerContext
appender.setTransportFactory(transportFactory)
encoder?.context = loggerContext
appender.setEncoder(encoder)
val rootLogger = loggerContext.getLogger(Logger.ROOT_LOGGER_NAME)
rootLogger.level = Level.TRACE
rootLogger.addAppender(appender)
appender.start()
encoder?.start()
loggerContext.start()
}
}
private lateinit var fixture: Fixture
@AfterTest
fun `stop logback`() {
fixture.loggerContext.stop()
Sentry.close()
}
@BeforeTest
fun `clear MDC`() {
MDC.clear()
}
@Test
fun `does not initialize Sentry if Sentry is already enabled`() {
fixture = Fixture()
Sentry.init {
it.dsn = "http://key@localhost/proj"
it.environment = "manual-environment"
it.setTransportFactory(fixture.transportFactory)
}
fixture.logger.error("testing environment field")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals("manual-environment", event.environment)
},
anyOrNull()
)
}
@Test
fun `converts message`() {
fixture = Fixture(minimumEventLevel = Level.DEBUG)
fixture.logger.debug("testing message conversion {}, {}", 1, 2)
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.message) { message ->
assertEquals("testing message conversion 1, 2", message.formatted)
assertEquals("testing message conversion {}, {}", message.message)
assertEquals(listOf("1", "2"), message.params)
}
assertEquals("io.sentry.logback.SentryAppenderTest", event.logger)
},
anyOrNull()
)
}
@Test
fun `encodes message`() {
var encoder = PatternLayoutEncoder()
encoder.pattern = "encoderadded %msg"
fixture = Fixture(minimumEventLevel = Level.DEBUG, encoder = encoder)
fixture.logger.info("testing encoding");
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.message) { message ->
assertEquals("encoderadded testing encoding", message.formatted)
assertEquals("testing encoding", message.message)
}
assertEquals("io.sentry.logback.SentryAppenderTest", event.logger)
},
anyOrNull()
)
}
class ThrowingEncoder: EncoderBase<ILoggingEvent> {
constructor(): super()
override fun headerBytes(): ByteArray {
TODO("Not yet implemented")
}
override fun footerBytes(): ByteArray {
TODO("Not yet implemented")
}
override fun encode(event: ILoggingEvent?): ByteArray {
TODO("Not yet implemented")
}
}
@Test
fun `fallsback when encoder throws`() {
var encoder = ThrowingEncoder()
fixture = Fixture(minimumEventLevel = Level.DEBUG, encoder = encoder)
fixture.logger.info("testing when encoder throws");
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.message) { message ->
assertEquals("testing when encoder throws", message.formatted)
assertEquals("testing when encoder throws", message.message)
}
assertEquals("io.sentry.logback.SentryAppenderTest", event.logger)
},
anyOrNull()
)
}
@Test
fun `event date is in UTC`() {
fixture = Fixture(minimumEventLevel = Level.DEBUG)
val utcTime = LocalDateTime.now(fixture.utcTimeZone)
fixture.logger.debug("testing event date")
verify(fixture.transport).send(
checkEvent { event ->
val eventTime = Instant.ofEpochMilli(event.timestamp.time)
.atZone(fixture.utcTimeZone)
.toLocalDateTime()
assertTrue { eventTime.plusSeconds(1).isAfter(utcTime) }
assertTrue { eventTime.minusSeconds(1).isBefore(utcTime) }
},
anyOrNull()
)
}
@Test
fun `converts trace log level to Sentry level`() {
fixture = Fixture(minimumEventLevel = Level.TRACE)
fixture.logger.trace("testing trace level")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(SentryLevel.DEBUG, event.level)
},
anyOrNull()
)
}
@Test
fun `converts debug log level to Sentry level`() {
fixture = Fixture(minimumEventLevel = Level.DEBUG)
fixture.logger.debug("testing debug level")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(SentryLevel.DEBUG, event.level)
},
anyOrNull()
)
}
@Test
fun `converts info log level to Sentry level`() {
fixture = Fixture(minimumEventLevel = Level.INFO)
fixture.logger.info("testing info level")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(SentryLevel.INFO, event.level)
},
anyOrNull()
)
}
@Test
fun `converts warn log level to Sentry level`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
fixture.logger.warn("testing warn level")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(SentryLevel.WARNING, event.level)
},
anyOrNull()
)
}
@Test
fun `converts error log level to Sentry level`() {
fixture = Fixture(minimumEventLevel = Level.ERROR)
fixture.logger.error("testing error level")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(SentryLevel.ERROR, event.level)
},
anyOrNull()
)
}
@Test
fun `attaches thread information`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
fixture.logger.warn("testing thread information")
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.getExtra("thread_name"))
},
anyOrNull()
)
}
@Test
fun `sets tags from MDC`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
MDC.put("key", "value")
fixture.logger.warn("testing MDC tags")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(mapOf("key" to "value"), event.contexts["MDC"])
},
anyOrNull()
)
}
@Test
fun `sets tags as sentry tags from MDC`() {
fixture = Fixture(minimumEventLevel = Level.WARN, contextTags = listOf("contextTag1"))
MDC.put("key", "value")
MDC.put("contextTag1", "contextTag1Value")
fixture.logger.warn("testing MDC tags")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals(mapOf("key" to "value"), event.contexts["MDC"])
assertEquals(mapOf("contextTag1" to "contextTag1Value"), event.tags)
},
anyOrNull()
)
}
@Test
fun `ignore set tags with null values from MDC`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
MDC.put("key1", null)
MDC.put("key2", "value")
fixture.logger.warn("testing MDC tags")
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.contexts["MDC"]) {
val contextData = it as Map<*, *>
assertNull(contextData["key1"])
assertEquals("value", contextData["key2"])
}
},
anyOrNull()
)
}
@Test
fun `does not set MDC if all context entries are null`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
MDC.put("key1", null)
MDC.put("key2", null)
fixture.logger.warn("testing MDC tags")
verify(fixture.transport).send(
checkEvent { event ->
assertNull(event.contexts["MDC"])
},
anyOrNull()
)
}
@Test
fun `does not create MDC context when no MDC tags are set`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
fixture.logger.warn("testing without MDC tags")
verify(fixture.transport).send(
checkEvent { event ->
assertFalse(event.contexts.containsKey("MDC"))
},
anyOrNull()
)
}
@Test
fun `attaches marker information`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
val sqlMarker = MarkerFactory.getDetachedMarker("SQL")
sqlMarker.add(MarkerFactory.getDetachedMarker("SQL_UPDATE"))
sqlMarker.add(MarkerFactory.getDetachedMarker("SQL_QUERY"))
fixture.logger.warn(sqlMarker, "testing marker tags")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals("SQL [ SQL_UPDATE, SQL_QUERY ]", event.getExtra("marker"))
},
anyOrNull()
)
}
@Test
fun `sets SDK version`() {
fixture = Fixture(minimumEventLevel = Level.INFO)
fixture.logger.info("testing sdk version")
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.sdk) {
assertEquals(BuildConfig.SENTRY_LOGBACK_SDK_NAME, it.name)
assertEquals(BuildConfig.VERSION_NAME, it.version)
assertNotNull(it.packages)
assertTrue(
it.packages!!.any { pkg ->
"maven:io.sentry:sentry-logback" == pkg.name &&
BuildConfig.VERSION_NAME == pkg.version
}
)
}
},
anyOrNull()
)
}
@Test
fun `attaches breadcrumbs with level higher than minimumBreadcrumbLevel`() {
fixture = Fixture(minimumBreadcrumbLevel = Level.DEBUG, minimumEventLevel = Level.WARN)
val utcTime = LocalDateTime.now(fixture.utcTimeZone)
fixture.logger.debug("this should be a breadcrumb #1")
fixture.logger.info("this should be a breadcrumb #2")
fixture.logger.warn("testing message with breadcrumbs")
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.breadcrumbs) { breadcrumbs ->
assertEquals(2, breadcrumbs.size)
val breadcrumb = breadcrumbs[0]
val breadcrumbTime = Instant.ofEpochMilli(event.timestamp.time)
.atZone(fixture.utcTimeZone)
.toLocalDateTime()
assertTrue { breadcrumbTime.plusSeconds(1).isAfter(utcTime) }
assertTrue { breadcrumbTime.minusSeconds(1).isBefore(utcTime) }
assertEquals("this should be a breadcrumb #1", breadcrumb.message)
assertEquals("io.sentry.logback.SentryAppenderTest", breadcrumb.category)
assertEquals(SentryLevel.DEBUG, breadcrumb.level)
}
},
anyOrNull()
)
}
@Test
fun `does not attach breadcrumbs with level lower than minimumBreadcrumbLevel`() {
fixture = Fixture(minimumBreadcrumbLevel = Level.INFO, minimumEventLevel = Level.WARN)
fixture.logger.debug("this should NOT be a breadcrumb")
fixture.logger.info("this should be a breadcrumb")
fixture.logger.warn("testing message with breadcrumbs")
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.breadcrumbs) { breadcrumbs ->
assertEquals(1, breadcrumbs.size)
assertEquals("this should be a breadcrumb", breadcrumbs[0].message)
}
},
anyOrNull()
)
}
@Test
fun `attaches breadcrumbs for default appender configuration`() {
fixture = Fixture()
fixture.logger.debug("this should not be a breadcrumb as the level is lower than the minimum INFO")
fixture.logger.info("this should be a breadcrumb")
fixture.logger.warn("this should not be sent as the event but be a breadcrumb")
fixture.logger.error("this should be sent as the event")
verify(fixture.transport).send(
checkEvent { event ->
assertNotNull(event.breadcrumbs) { breadcrumbs ->
assertEquals(2, breadcrumbs.size)
assertEquals("this should be a breadcrumb", breadcrumbs[0].message)
assertEquals("this should not be sent as the event but be a breadcrumb", breadcrumbs[1].message)
}
},
anyOrNull()
)
}
@Test
fun `uses options set in properties file`() {
fixture = Fixture()
fixture.logger.error("some event")
verify(fixture.transport).send(
checkEvent { event ->
assertEquals("release from sentry.properties", event.release)
},
anyOrNull()
)
}
@Test
fun `does not initialize Sentry when environment variable with DSN is passed through environment variable that is not set`() {
// environment variables referenced in the logback.xml that are not set in the OS, have value "ENV_NAME_IS_UNDEFINED"
fixture = Fixture(dsn = "DSN_IS_UNDEFINED", minimumEventLevel = Level.DEBUG)
assertTrue(fixture.loggerContext.statusManager.copyOfStatusList.none { it.level == Status.WARN })
}
@Test
fun `does initialize Sentry when DSN is not set`() {
System.setProperty("sentry.dsn", "http://key@localhost/proj")
fixture = Fixture(dsn = null, minimumEventLevel = Level.DEBUG)
assertTrue(Sentry.isEnabled())
System.clearProperty("sentry.dsn")
}
}