-
-
Notifications
You must be signed in to change notification settings - Fork 468
Expand file tree
/
Copy pathSentryAppenderTest.kt
More file actions
824 lines (709 loc) · 25.8 KB
/
SentryAppenderTest.kt
File metadata and controls
824 lines (709 loc) · 25.8 KB
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
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.classic.spi.LoggingEvent
import ch.qos.logback.classic.spi.LoggingEventVO
import ch.qos.logback.classic.spi.ThrowableProxy
import ch.qos.logback.core.encoder.Encoder
import ch.qos.logback.core.encoder.EncoderBase
import ch.qos.logback.core.status.Status
import io.sentry.ITransportFactory
import io.sentry.InitPriority
import io.sentry.Sentry
import io.sentry.SentryLevel
import io.sentry.SentryLogLevel
import io.sentry.SentryOptions
import io.sentry.checkEvent
import io.sentry.checkLogs
import io.sentry.test.initForTest
import io.sentry.transport.ITransport
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
import org.mockito.kotlin.any
import org.mockito.kotlin.anyOrNull
import org.mockito.kotlin.mock
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.slf4j.MDC
import org.slf4j.MarkerFactory
class SentryAppenderTest {
private class Fixture(
dsn: String? = "http://key@localhost/proj",
minimumBreadcrumbLevel: Level? = null,
minimumEventLevel: Level? = null,
minimumLevel: Level? = null,
contextTags: List<String>? = null,
encoder: Encoder<ILoggingEvent>? = null,
sendDefaultPii: Boolean = false,
enableLogs: Boolean = false,
options: SentryOptions = SentryOptions(),
startLater: Boolean = false,
) {
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")
val appender = SentryAppender()
var encoder: Encoder<ILoggingEvent>? = null
init {
whenever(this.transportFactory.create(any(), any())).thenReturn(transport)
this.encoder = encoder
options.dsn = dsn
options.isSendDefaultPii = sendDefaultPii
options.logs.isEnabled = enableLogs
contextTags?.forEach { options.addContextTag(it) }
appender.setOptions(options)
appender.setMinimumBreadcrumbLevel(minimumBreadcrumbLevel)
appender.setMinimumEventLevel(minimumEventLevel)
appender.setMinimumLevel(minimumLevel)
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)
if (!startLater) {
start()
}
}
fun start() {
appender.start()
encoder?.start()
loggerContext.start()
}
}
private lateinit var fixture: Fixture
@AfterTest
fun `stop logback`() {
fixture.loggerContext.statusManager.clear()
fixture.loggerContext.stop()
Sentry.close()
}
@BeforeTest
fun `clear MDC`() {
MDC.clear()
Sentry.close()
}
@Test
fun `does not initialize Sentry if Sentry is already enabled with higher prio`() {
fixture =
Fixture(
startLater = true,
options =
SentryOptions().also { it.setTag("only-present-if-logger-init-was-run", "another-value") },
)
initForTest {
it.dsn = "http://key@localhost/proj"
it.environment = "manual-environment"
it.setTransportFactory(fixture.transportFactory)
it.setTag("tag-from-first-init", "some-value")
it.isEnableBackpressureHandling = false
it.initPriority = InitPriority.LOW
}
fixture.start()
fixture.logger.error("testing environment field")
verify(fixture.transport)
.send(
checkEvent { event -> assertNull(event.tags?.get("only-present-if-logger-init-was-run")) },
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, sendDefaultPii = true)
fixture.logger.info("testing encoding {}", "param1")
verify(fixture.transport)
.send(
checkEvent { event ->
assertNotNull(event.message) { message ->
assertEquals("encoderadded testing encoding param1", message.formatted)
assertEquals("testing encoding {}", message.message)
assertEquals(listOf("param1"), message.params)
}
assertEquals("io.sentry.logback.SentryAppenderTest", event.logger)
},
anyOrNull(),
)
}
@Test
fun `if encoder is set treats raw message and params as PII`() {
var encoder = PatternLayoutEncoder()
encoder.pattern = "encoderadded %msg"
fixture = Fixture(minimumEventLevel = Level.DEBUG, encoder = encoder, sendDefaultPii = false)
fixture.logger.info("testing encoding {}", "param1")
verify(fixture.transport)
.send(
checkEvent { event ->
assertNotNull(event.message) { message ->
assertEquals("encoderadded testing encoding param1", message.formatted)
assertNull(message.message)
assertNull(message.params)
}
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, sendDefaultPii = true)
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 `converts error log level to Sentry level with exception`() {
fixture = Fixture(minimumEventLevel = Level.ERROR)
fixture.logger.error("testing error level", RuntimeException("test exc"))
verify(fixture.transport)
.send(
checkEvent { event ->
assertEquals(SentryLevel.ERROR, event.level)
val exception = event.exceptions!!.first()
assertEquals(SentryAppender.MECHANISM_TYPE, exception.mechanism!!.type)
assertEquals("test exc", exception.value)
},
anyOrNull(),
)
}
@Test
fun `converts trace log level to Sentry log level`() {
fixture = Fixture(minimumLevel = Level.TRACE, enableLogs = true)
fixture.logger.trace("testing trace level")
Sentry.flush(1000)
verify(fixture.transport)
.send(checkLogs { logs -> assertEquals(SentryLogLevel.TRACE, logs.items.first().level) })
}
@Test
fun `converts debug log level to Sentry log level`() {
fixture = Fixture(minimumLevel = Level.DEBUG, enableLogs = true)
fixture.logger.debug("testing debug level")
Sentry.flush(1000)
verify(fixture.transport)
.send(checkLogs { logs -> assertEquals(SentryLogLevel.DEBUG, logs.items.first().level) })
}
@Test
fun `converts info log level to Sentry log level`() {
fixture = Fixture(minimumLevel = Level.INFO, enableLogs = true)
fixture.logger.info("testing info level")
Sentry.flush(1000)
verify(fixture.transport)
.send(checkLogs { logs -> assertEquals(SentryLogLevel.INFO, logs.items.first().level) })
}
@Test
fun `converts warn log level to Sentry log level`() {
fixture = Fixture(minimumLevel = Level.WARN, enableLogs = true)
fixture.logger.warn("testing warn level")
Sentry.flush(1000)
verify(fixture.transport)
.send(checkLogs { logs -> assertEquals(SentryLogLevel.WARN, logs.items.first().level) })
}
@Test
fun `converts error log level to Sentry log level`() {
fixture = Fixture(minimumLevel = Level.ERROR, enableLogs = true)
fixture.logger.error("testing error level")
Sentry.flush(1000)
verify(fixture.transport)
.send(checkLogs { logs -> assertEquals(SentryLogLevel.ERROR, logs.items.first().level) })
}
@Test
fun `sends formatted log message if no encoder`() {
fixture = Fixture(minimumLevel = Level.TRACE, enableLogs = true)
fixture.logger.trace("Testing {} level", "TRACE")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("Testing TRACE level", log.body)
val attributes = log.attributes!!
assertEquals("Testing {} level", attributes["sentry.message.template"]?.value)
assertEquals("TRACE", attributes["sentry.message.parameter.0"]?.value)
assertEquals("auto.log.logback", attributes["sentry.origin"]?.value)
}
)
}
@Test
fun `does not send formatted log message if encoder is available but sendDefaultPii is off`() {
var encoder = PatternLayoutEncoder()
encoder.pattern = "encoderadded %msg"
fixture = Fixture(minimumLevel = Level.TRACE, enableLogs = true, encoder = encoder)
fixture.logger.trace("Testing {} level", "TRACE")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("encoderadded Testing TRACE level", log.body)
val attributes = log.attributes!!
assertNull(attributes["sentry.message.template"])
assertNull(attributes["sentry.message.parameter.0"])
}
)
}
@Test
fun `sends formatted log message if encoder is available and sendDefaultPii is on but encoder throws`() {
var encoder = ThrowingEncoder()
fixture =
Fixture(
minimumLevel = Level.TRACE,
enableLogs = true,
sendDefaultPii = true,
encoder = encoder,
)
fixture.logger.trace("Testing {} level", "TRACE")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("Testing TRACE level", log.body)
val attributes = log.attributes!!
assertEquals("Testing {} level", attributes["sentry.message.template"]?.value)
assertEquals("TRACE", attributes["sentry.message.parameter.0"]?.value)
}
)
}
@Test
fun `sends formatted log message if encoder is available and sendDefaultPii is on`() {
var encoder = PatternLayoutEncoder()
encoder.pattern = "encoderadded %msg"
fixture =
Fixture(
minimumLevel = Level.TRACE,
enableLogs = true,
sendDefaultPii = true,
encoder = encoder,
)
fixture.logger.trace("Testing {} level", "TRACE")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("encoderadded Testing TRACE level", log.body)
val attributes = log.attributes!!
assertEquals("Testing {} level", attributes["sentry.message.template"]?.value)
assertEquals("TRACE", attributes["sentry.message.parameter.0"]?.value)
}
)
}
@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)
assertTrue(
it.packageSet.any { pkg ->
"maven:io.sentry:sentry-logback" == pkg.name &&
BuildConfig.VERSION_NAME == pkg.version
}
)
assertTrue(it.integrationSet.contains("Logback"))
}
},
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")
}
@Test
fun `does not crash on ThrowableProxyVO`() {
fixture = Fixture()
val throwableProxy = ThrowableProxy(RuntimeException("hello proxy throwable"))
val loggingEvent = LoggingEvent()
loggingEvent.level = Level.ERROR
loggingEvent.setThrowableProxy(throwableProxy)
val loggingEventVO = LoggingEventVO.build(loggingEvent)
fixture.appender.append(loggingEventVO)
verify(fixture.transport)
.send(
checkEvent { event ->
assertEquals(SentryLevel.ERROR, event.level)
assertNull(event.exceptions)
},
anyOrNull(),
)
}
@Test
fun `does not set template on log when logging message without parameters`() {
fixture = Fixture(minimumLevel = Level.ERROR, enableLogs = true)
fixture.logger.error("testing message without parameters")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("testing message without parameters", log.body)
assertNull(log.attributes?.get("sentry.message.template"))
}
)
}
@Test
fun `sets template on log when logging message with parameters`() {
fixture = Fixture(minimumLevel = Level.ERROR, enableLogs = true)
fixture.logger.error("testing message {}", "param")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("testing message param", log.body)
assertEquals("testing message {}", log.attributes?.get("sentry.message.template")?.value)
assertEquals("param", log.attributes?.get("sentry.message.parameter.0")?.value)
}
)
}
@Test
fun `sets template on log when logging message with parameters and number of parameters is wrong`() {
fixture = Fixture(minimumLevel = Level.ERROR, enableLogs = true)
fixture.logger.error("testing message {} {} {}", "param1", "param2")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("testing message param1 param2 {}", log.body)
assertEquals(
"testing message {} {} {}",
log.attributes?.get("sentry.message.template")?.value,
)
assertEquals("param1", log.attributes?.get("sentry.message.parameter.0")?.value)
assertEquals("param2", log.attributes?.get("sentry.message.parameter.1")?.value)
assertNull(log.attributes?.get("sentry.message.parameter.2"))
}
)
}
@Test
fun `does not set template or attributes on log with encoder when sendDefaultPii is false`() {
var encoder = PatternLayoutEncoder()
encoder.pattern = "encoded %msg"
fixture =
Fixture(
minimumLevel = Level.ERROR,
enableLogs = true,
encoder = encoder,
sendDefaultPii = false,
)
fixture.logger.error("testing message {}", "param")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("encoded testing message param", log.body)
assertNull(log.attributes?.get("sentry.message.template"))
assertNull(log.attributes?.get("sentry.message.parameter.0"))
}
)
}
@Test
fun `sets template and attributes on log with encoder when sendDefaultPii is true`() {
var encoder = PatternLayoutEncoder()
encoder.pattern = "encoded %msg"
fixture =
Fixture(
minimumLevel = Level.ERROR,
enableLogs = true,
encoder = encoder,
sendDefaultPii = true,
)
fixture.logger.error("testing message {}", "param")
Sentry.flush(1000)
verify(fixture.transport)
.send(
checkLogs { logs ->
val log = logs.items.first()
assertEquals("encoded testing message param", log.body)
assertEquals("testing message {}", log.attributes?.get("sentry.message.template")?.value)
assertEquals("param", log.attributes?.get("sentry.message.parameter.0")?.value)
}
)
}
}