test log4j2

Author: lcian

sentry-log4j2/src/test/kotlin/io/sentry/log4j2/SentryAppenderTest.kt

@@ -29,6 +29,7 @@ import org.apache.logging.log4j.core.LoggerContext
 import org.apache.logging.log4j.core.config.AppenderRef
 import org.apache.logging.log4j.core.config.Configuration
 import org.apache.logging.log4j.core.config.LoggerConfig
+import org.apache.logging.log4j.core.layout.PatternLayout
 import org.apache.logging.log4j.spi.ExtendedLogger
 import org.mockito.kotlin.any
 import org.mockito.kotlin.anyOrNull
@@ -60,6 +61,7 @@ class SentryAppenderTest {
       }
       loggerContext.start()
       val config: Configuration = loggerContext.configuration
+
       val appender =
         SentryAppender(
           "sentry",
@@ -533,4 +535,59 @@ class SentryAppenderTest {
     fixture.getSut(debug = true)
     assertTrue(ScopesAdapter.getInstance().options.isDebug)
   }
+
+  @Test
+  fun `does not set template on log when logging message without parameters`() {
+    val logger = fixture.getSut(minimumLevel = Level.ERROR)
+    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`() {
+    val logger = fixture.getSut(minimumLevel = Level.ERROR)
+    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`() {
+    val logger = fixture.getSut(minimumLevel = Level.ERROR)
+    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"))
+        }
+      )
+  }
 }