Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to JUnit5 #204

Merged
merged 1 commit into from
Dec 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ kotlin {
val jvmTest by getting {
dependencies {
implementation(kotlin("test"))
implementation(kotlin("test-junit"))
implementation("junit:junit:${extra["junit_version"]}")
implementation("org.junit.jupiter:junit-jupiter-engine:${extra["junit_version"]}")
implementation("org.junit.jupiter:junit-jupiter-params:${extra["junit_version"]}")
implementation("org.mockito:mockito-all:${extra["mockito_version"]}")
implementation("org.apache.logging.log4j:log4j-api:${extra["log4j_version"]}")
implementation("org.apache.logging.log4j:log4j-core:${extra["log4j_version"]}")
Expand Down Expand Up @@ -116,6 +116,7 @@ tasks {
}

withType<Test> {
useJUnitPlatform()
testLogging {
showStandardStreams = true
showExceptions = true
Expand Down
151 changes: 89 additions & 62 deletions src/jvmTest/kotlin/mu/KotlinLoggingMDCTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@ package mu

import org.apache.logging.log4j.Level
import org.apache.logging.log4j.core.config.Configurator
import org.junit.Assert.assertEquals
import org.junit.Assert.assertNull
import org.junit.Before
import org.junit.Test
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertNull
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertAll
import org.slf4j.MDC

class KotlinLoggingMDCTest {
init {
Configurator.setRootLevel(Level.TRACE)
}

@Before
@BeforeEach
fun setUp() {
MDC.clear()
}
Expand Down Expand Up @@ -72,42 +73,54 @@ class KotlinLoggingMDCTest {
fun `multiple pair withLoggingContext`() {
MDC.put("f", "g")

assertNull(MDC.get("a"))
assertNull(MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

{ assertNull(MDC.get("a")) },
{ assertNull(MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)

withLoggingContext("a" to "h", "c" to "i") {
assertEquals("h", MDC.get("a"))
assertEquals("i", MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertEquals("h", MDC.get("a")) },
{ assertEquals("i", MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)

withLoggingContext("a" to "b", "c" to "d", "e" to null, "f" to null) {
assertEquals("b", MDC.get("a"))
assertEquals("d", MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertEquals("b", MDC.get("a")) },
{ assertEquals("d", MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)
}
assertEquals("h", MDC.get("a"))
assertEquals("i", MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertEquals("h", MDC.get("a")) },
{ assertEquals("i", MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)
}
assertNull(MDC.get("a"))
assertNull(MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertNull(MDC.get("a")) },
{ assertNull(MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)
}

@Test
fun `multiple pair withLoggingContext (restorePrevious=false)`() {
MDC.put("f", "g")

assertNull(MDC.get("a"))
assertNull(MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertNull(MDC.get("a")) },
{ assertNull(MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)

withLoggingContext(
"a" to "b",
Expand All @@ -116,15 +129,19 @@ class KotlinLoggingMDCTest {
"f" to null,
restorePrevious = false
) {
assertEquals("b", MDC.get("a"))
assertEquals("d", MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertEquals("b", MDC.get("a")) },
{ assertEquals("d", MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)
}
assertNull(MDC.get("a"))
assertNull(MDC.get("c"))
assertNull(MDC.get("e"))
assertEquals("g", MDC.get("f"))
assertAll(
{ assertNull(MDC.get("a")) },
{ assertNull(MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertEquals("g", MDC.get("f")) },
)
}

@Test
Expand All @@ -145,41 +162,51 @@ class KotlinLoggingMDCTest {

@Test
fun `map withLoggingContext`() {
assertNull(MDC.get("a"))
assertNull(MDC.get("c"))
assertNull(MDC.get("e"))
assertNull(MDC.get("f"))
assertNull(MDC.get("k"))
assertAll(
{ assertNull(MDC.get("a")) },
{ assertNull(MDC.get("c")) },
{ assertNull(MDC.get("e")) },
{ assertNull(MDC.get("f")) },
{ assertNull(MDC.get("k")) },
)

MDC.put("e", "g")
MDC.put("k", "l")

withLoggingContext(mapOf("a" to "b", "c" to "d", "e" to null, "f" to "h")) {
assertEquals("b", MDC.get("a"))
assertEquals("d", MDC.get("c"))
assertEquals("g", MDC.get("e"))
assertEquals("h", MDC.get("f"))
assertEquals("l", MDC.get("k"))
assertAll(
{ assertEquals("b", MDC.get("a")) },
{ assertEquals("d", MDC.get("c")) },
{ assertEquals("g", MDC.get("e")) },
{ assertEquals("h", MDC.get("f")) },
{ assertEquals("l", MDC.get("k")) },
)

withLoggingContext(mapOf("a" to "b", "e" to "i", "f" to "j")) {
assertEquals("b", MDC.get("a"))
assertEquals("d", MDC.get("c"))
assertEquals("i", MDC.get("e"))
assertEquals("j", MDC.get("f"))
assertEquals("l", MDC.get("k"))
assertAll(
{ assertEquals("b", MDC.get("a")) },
{ assertEquals("d", MDC.get("c")) },
{ assertEquals("i", MDC.get("e")) },
{ assertEquals("j", MDC.get("f")) },
{ assertEquals("l", MDC.get("k")) },
)
}

assertEquals("b", MDC.get("a"))
assertEquals("d", MDC.get("c"))
assertEquals("g", MDC.get("e"))
assertEquals("h", MDC.get("f"))
assertEquals("l", MDC.get("k"))
assertAll(
{ assertEquals("b", MDC.get("a")) },
{ assertEquals("d", MDC.get("c")) },
{ assertEquals("g", MDC.get("e")) },
{ assertEquals("h", MDC.get("f")) },
{ assertEquals("l", MDC.get("k")) },
)
}

assertNull(MDC.get("a"))
assertNull(MDC.get("c"))
assertEquals("g", MDC.get("e"))
assertNull(MDC.get("f"))
assertEquals("l", MDC.get("k"))
assertAll(
{ assertNull(MDC.get("a")) },
{ assertNull(MDC.get("c")) },
{ assertEquals("g", MDC.get("e")) },
{ assertNull(MDC.get("f")) },
{ assertEquals("l", MDC.get("k")) },
)
}
}
17 changes: 10 additions & 7 deletions src/jvmTest/kotlin/mu/KotlinLoggingTest.kt
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
package mu

import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertAll
import org.slf4j.LoggerFactory

private val logger = KotlinLogging.logger { }
Expand All @@ -20,10 +21,12 @@ class KotlinLoggingTest {

@Test
fun testLoggerName() {
assertEquals("mu.KotlinLoggingTest", logger.name)
assertEquals("mu.ForKotlinLoggingTest", ForKotlinLoggingTest().loggerInClass.name)
assertEquals("mu.ForKotlinLoggingTest", ForKotlinLoggingTest.loggerInCompanion.name)
assertEquals("mu.slf4jLogger", loggerFromSlf4j.name)
assertEquals("mu.slf4jLoggerExtension", loggerFromSlf4jExtension.name)
assertAll(
{ assertEquals("mu.KotlinLoggingTest", logger.name) },
{ assertEquals("mu.ForKotlinLoggingTest", ForKotlinLoggingTest().loggerInClass.name) },
{ assertEquals("mu.ForKotlinLoggingTest", ForKotlinLoggingTest.loggerInCompanion.name) },
{ assertEquals("mu.slf4jLogger", loggerFromSlf4j.name) },
{ assertEquals("mu.slf4jLoggerExtension", loggerFromSlf4jExtension.name) },
)
}
}