Add tests

Signed-off-by: Dmitry Sulman <[email protected]>

Author: dmitrysulman

buildSrc/src/main/kotlin/conventions.gradle.kts

@@ -23,14 +23,10 @@ repositories {
 }
 
 kotlin {
-    compilerOptions {
-        jvmTarget = JvmTarget.JVM_17
-    }
-    jvmToolchain(21)
+    jvmToolchain(17)
 }
 
 java {
-    targetCompatibility = JavaVersion.VERSION_17
     withSourcesJar()
 }
 

gradle/libs.versions.toml

@@ -4,6 +4,7 @@ jreleaser = "1.18.0"
 junit = "5.12.2"
 kotest = "5.9.1"
 kotlin = "2.1.20"
+kotlinxCoroutines = "1.10.2"
 ktlint = "12.2.0"
 logbackAccess = "2.0.6"
 logbackClassic = "1.5.18"
@@ -18,6 +19,8 @@ junit-jupiter = { group = "org.junit.jupiter", name = "junit-jupiter", version.r
 junit-platformLauncher = { group = "org.junit.platform", name = "junit-platform-launcher" }
 kotest-assertions-core-jvm = { group = "io.kotest", name = "kotest-assertions-core-jvm", version.ref = "kotest" }
 kotlin-gradlePlugin = { group = "org.jetbrains.kotlin", name = "kotlin-gradle-plugin", version.ref = "kotlin" }
+kotlinx-coroutines-core = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-core", version.ref = "kotlinxCoroutines" }
+kotlinx-coroutines-reactor = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-reactor", version.ref = "kotlinxCoroutines" }
 ktlintPlugin = { group = "org.jlleitschuh.gradle.ktlint", name = "org.jlleitschuh.gradle.ktlint.gradle.plugin", version.ref = "ktlint" }
 logback-access-common = { group = "ch.qos.logback.access", name = "logback-access-common", version.ref = "logbackAccess" }
 logback-classic = { group = "ch.qos.logback", name = "logback-classic", version.ref = "logbackClassic" }

logback-access-reactor-netty/build.gradle.kts

@@ -11,7 +11,8 @@ dependencies {
 
     testImplementation(libs.junit.jupiter)
     testImplementation(libs.kotest.assertions.core.jvm)
-    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
+    testImplementation(libs.kotlinx.coroutines.core)
+    testImplementation(libs.kotlinx.coroutines.reactor)
     testImplementation(libs.logback.classic)
     testImplementation(libs.logback.core)
     testImplementation(libs.mockk)

logback-access-reactor-netty/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/AccessEvent.kt

@@ -3,6 +3,8 @@ package io.github.dmitrysulman.logback.access.reactor.netty
 import ch.qos.logback.access.common.spi.AccessContext
 import ch.qos.logback.access.common.spi.IAccessEvent
 import jakarta.servlet.http.Cookie
+import jakarta.servlet.http.HttpServletRequest
+import jakarta.servlet.http.HttpServletResponse
 import reactor.netty.http.server.logging.AccessLogArgProvider
 import java.io.Serializable
 import java.net.InetSocketAddress
@@ -122,8 +124,7 @@ class AccessEvent(
             ?: emptyMap()
     }
 
-    @Transient
-    private val _serverAdapter = ReactorNettyServerAdapter(argProvider)
+    private val _serverAdapter by lazy { ReactorNettyServerAdapter(argProvider) }
 
     private fun String.decodeCatching() =
         try {
@@ -150,11 +151,12 @@ class AccessEvent(
         responseHeaderMap
         requestHeaderMap
         threadName
+        serverAdapter.requestTimestamp
     }
 
-    override fun getRequest() = null
+    override fun getRequest(): HttpServletRequest? = null
 
-    override fun getResponse() = null
+    override fun getResponse(): HttpServletResponse? = null
 
     override fun getTimeStamp() = _timeStamp
 

logback-access-reactor-netty/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/Extensions.kt

@@ -0,0 +1,11 @@
+package io.github.dmitrysulman.logback.access.reactor.netty
+
+import reactor.netty.http.server.HttpServer
+
+/**
+ * Extension for [HttpServer] providing [HttpServer.accessLog] method alternative.
+ *
+ * @param reactorNettyAccessLogFactory The [ReactorNettyAccessLogFactory] instance for access log configuration.
+ */
+fun HttpServer.enableLogbackAccess(reactorNettyAccessLogFactory: ReactorNettyAccessLogFactory): HttpServer =
+    accessLog(true, reactorNettyAccessLogFactory)

logback-access-reactor-netty/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/ReactorNettyServerAdapter.kt

@@ -2,17 +2,17 @@ package io.github.dmitrysulman.logback.access.reactor.netty
 
 import ch.qos.logback.access.common.spi.ServerAdapter
 import reactor.netty.http.server.logging.AccessLogArgProvider
+import java.io.Serializable
 
 class ReactorNettyServerAdapter(
+    @Transient
     private val argProvider: AccessLogArgProvider,
-) : ServerAdapter {
-    override fun getRequestTimestamp() = argProvider.accessDateTime()?.toInstant()?.toEpochMilli() ?: 0
-
-    override fun getContentLength() = argProvider.contentLength()
-
-    override fun getStatusCode() = argProvider.status()?.toString()?.toIntOrNull() ?: -1
-
-    override fun buildResponseHeaderMap() =
+) : ServerAdapter,
+    Serializable {
+    private val _requestTimestamp by lazy { argProvider.accessDateTime()?.toInstant()?.toEpochMilli() ?: 0 }
+    private val _contentLength by lazy { argProvider.contentLength() }
+    private val _statusCode by lazy { argProvider.status()?.toString()?.toIntOrNull() ?: -1 }
+    private val _responseHeaderMap by lazy {
         argProvider
             .responseHeaderIterator()
             ?.asSequence()
@@ -22,4 +22,13 @@ class ReactorNettyServerAdapter(
                 name.toString() to value.toString()
             }?.toMap()
             ?: emptyMap()
+    }
+
+    override fun getRequestTimestamp() = _requestTimestamp
+
+    override fun getContentLength() = _contentLength
+
+    override fun getStatusCode() = _statusCode
+
+    override fun buildResponseHeaderMap() = _responseHeaderMap
 }

logback-access-reactor-netty/src/test/java/io/github/dmitrysulman/logback/access/reactor/netty/integration/JavaIntegrationTests.java

@@ -0,0 +1,46 @@
+package io.github.dmitrysulman.logback.access.reactor.netty.integration;
+
+import ch.qos.logback.access.common.joran.JoranConfigurator;
+import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLogFactory;
+import org.junit.jupiter.api.Test;
+import reactor.core.publisher.Mono;
+import reactor.netty.http.client.HttpClient;
+import reactor.netty.http.server.HttpServer;
+
+import java.time.Duration;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+public class JavaIntegrationTests {
+    @Test
+    public void smokeTest() throws InterruptedException {
+        var accessLogFactory =
+                new ReactorNettyAccessLogFactory("logback-access-stdout.xml", new JoranConfigurator(), true);
+        var eventCaptureAppender = (EventCaptureAppender) accessLogFactory.getAccessContext().getAppender("CAPTURE");
+        var responseBody = "test";
+        var server = HttpServer
+                .create()
+                .accessLog(true, accessLogFactory)
+                .handle((request, response) -> response.sendByteArray(Mono.just(responseBody.getBytes())))
+                .bindNow();
+        var uri = "/test";
+        var response = HttpClient
+                .create()
+                .port(server.port())
+                .get()
+                .uri(uri)
+                .response()
+                .block(Duration.ofSeconds(10));
+
+        assertNotNull(response);
+        assertEquals(200, response.status().code());
+
+        Thread.sleep(100);
+        assertEquals(1, eventCaptureAppender.getList().size());
+        assertEquals(uri, eventCaptureAppender.getList().get(0).getRequestURI());
+        assertEquals(responseBody.length(), eventCaptureAppender.getList().get(0).getContentLength());
+
+        server.disposeNow();
+    }
+}

logback-access-reactor-netty/src/test/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/AccessEventTests.kt

@@ -1,9 +1,16 @@
 package io.github.dmitrysulman.logback.access.reactor.netty
 
 import ch.qos.logback.access.common.spi.AccessContext
+import io.kotest.matchers.booleans.shouldBeFalse
+import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.collections.shouldContain
+import io.kotest.matchers.longs.shouldBeZero
+import io.kotest.matchers.maps.shouldBeEmpty
 import io.kotest.matchers.maps.shouldContainKey
+import io.kotest.matchers.nulls.shouldBeNull
+import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.shouldBe
+import io.kotest.matchers.string.shouldBeEmpty
 import io.mockk.every
 import io.mockk.mockk
 import io.mockk.verify
@@ -17,6 +24,9 @@ import java.io.ByteArrayOutputStream
 import java.io.ObjectInputStream
 import java.io.ObjectOutputStream
 import java.net.SocketAddress
+import java.time.Instant
+import java.time.ZoneId
+import java.time.ZonedDateTime
 import java.util.Collections
 import io.netty.handler.codec.http.cookie.Cookie as NettyCookie
 
@@ -142,9 +152,9 @@ class AccessEventTests {
 
         val accessEvent = AccessEvent(mockArgProvider, mockContext)
 
-        accessEvent.requestURI.isEmpty() shouldBe true
-        accessEvent.queryString.isEmpty() shouldBe true
-        accessEvent.requestParameterMap.isEmpty() shouldBe true
+        accessEvent.requestURI.shouldBeEmpty()
+        accessEvent.queryString.shouldBeEmpty()
+        accessEvent.requestParameterMap.shouldBeEmpty()
         accessEvent.getRequestParameter(PARAM) shouldBe NA_ARRAY
     }
 
@@ -157,7 +167,7 @@ class AccessEventTests {
         val accessEvent = AccessEvent(mockArgProvider, mockContext)
 
         accessEvent.queryString shouldBe "?"
-        accessEvent.requestParameterMap.isEmpty() shouldBe true
+        accessEvent.requestParameterMap.shouldBeEmpty()
         accessEvent.getRequestParameter(PARAM) shouldBe NA_ARRAY
     }
 
@@ -169,8 +179,8 @@ class AccessEventTests {
 
         val accessEvent = AccessEvent(mockArgProvider, mockContext)
 
-        accessEvent.queryString.isEmpty() shouldBe true
-        accessEvent.requestParameterMap.isEmpty() shouldBe true
+        accessEvent.queryString.shouldBeEmpty()
+        accessEvent.requestParameterMap.shouldBeEmpty()
         accessEvent.getRequestParameter(PARAM) shouldBe NA_ARRAY
     }
 
@@ -227,7 +237,7 @@ class AccessEventTests {
         val accessEvent = AccessEvent(mockArgProvider, mockContext)
 
         accessEvent.queryString shouldBe "?param1="
-        accessEvent.requestParameterMap.isEmpty() shouldBe true
+        accessEvent.requestParameterMap.shouldBeEmpty()
         accessEvent.getRequestParameter("param1") shouldBe NA_ARRAY
     }
 
@@ -315,10 +325,11 @@ class AccessEventTests {
         accessEvent.remoteUser shouldBe NA
         accessEvent.getRequestHeader(HEADER) shouldBe NA
         accessEvent.getResponseHeader(HEADER) shouldBe NA
-        accessEvent.requestHeaderMap.isEmpty() shouldBe true
-        accessEvent.requestHeaderNames.hasMoreElements() shouldBe false
-        accessEvent.responseHeaderMap.isEmpty() shouldBe true
-        accessEvent.responseHeaderNameList.isEmpty() shouldBe true
+        accessEvent.requestHeaderMap.shouldBeEmpty()
+        accessEvent.requestHeaderNames.hasMoreElements().shouldBeFalse()
+        accessEvent.responseHeaderMap.shouldBeEmpty()
+        accessEvent.responseHeaderNameList.shouldBeEmpty()
+        accessEvent.cookies.shouldBeEmpty()
         accessEvent.getCookie(COOKIE) shouldBe NA
     }
 
@@ -348,6 +359,7 @@ class AccessEventTests {
                         add(DefaultCookie("cookie2", "value21"))
                         add(DefaultCookie("cookie2", "value22"))
                     },
+                "cookie3" to emptySet(),
             )
 
         val accessEvent = AccessEvent(mockArgProvider, mockContext)
@@ -357,6 +369,7 @@ class AccessEventTests {
         accessEvent.cookies shouldContain Cookie("cookie2", "value21")
         accessEvent.getCookie("cookie1") shouldBe "value1"
         accessEvent.getCookie("cookie2") shouldBe "value21"
+        accessEvent.getCookie("cookie3") shouldBe NA
         accessEvent.getCookie("not_exist") shouldBe NA
     }
 
@@ -451,7 +464,7 @@ class AccessEventTests {
         accessEvent.getRequestParameter("no_param") shouldBe NA_ARRAY
         accessEvent.protocol shouldBe HTTP11
         accessEvent.requestURL shouldBe "$GET $REQUEST_URI$QUERY_STRING $HTTP11"
-        accessEvent.statusCode shouldBe OK.toInt()
+        accessEvent.statusCode shouldBe OK_STATUS_CODE.toInt()
         accessEvent.contentLength shouldBe CONTENT_LENGTH
         accessEvent.elapsedTime shouldBe DURATION
         accessEvent.elapsedSeconds shouldBe DURATION_SECONDS
@@ -460,22 +473,27 @@ class AccessEventTests {
         accessEvent.serverName shouldBe IP_ADDRESS
         accessEvent.localPort shouldBe PORT
         accessEvent.remoteUser shouldBe USERNAME
-        accessEvent.sequenceNumber shouldBe 0
+        accessEvent.sequenceNumber.shouldBeZero()
         accessEvent.getRequestHeader(HEADER) shouldBe NA
         accessEvent.getResponseHeader(HEADER) shouldBe NA
-        accessEvent.requestHeaderMap.isEmpty() shouldBe true
-        accessEvent.requestHeaderNames.hasMoreElements() shouldBe false
-        accessEvent.responseHeaderMap.isEmpty() shouldBe true
-        accessEvent.responseHeaderNameList.isEmpty() shouldBe true
-        accessEvent.cookies.isEmpty() shouldBe true
+        accessEvent.requestHeaderMap.shouldBeEmpty()
+        accessEvent.requestHeaderNames.hasMoreElements().shouldBeFalse()
+        accessEvent.responseHeaderMap.shouldBeEmpty()
+        accessEvent.responseHeaderNameList.shouldBeEmpty()
+        accessEvent.cookies.shouldBeEmpty()
         accessEvent.getCookie(COOKIE) shouldBe NA
         accessEvent.threadName shouldBe THREAD
-        accessEvent.request shouldBe null
-        accessEvent.response shouldBe null
+        accessEvent.request.shouldBeNull()
+        accessEvent.response.shouldBeNull()
         accessEvent.sessionID shouldBe NA
         accessEvent.getAttribute(ATTRIBUTE) shouldBe NA
-        accessEvent.requestContent.isEmpty() shouldBe true
-        accessEvent.responseContent.isEmpty() shouldBe true
+        accessEvent.requestContent.shouldBeEmpty()
+        accessEvent.responseContent.shouldBeEmpty()
+        accessEvent.serverAdapter.shouldNotBeNull()
+        accessEvent.serverAdapter.requestTimestamp shouldBe TIMESTAMP
+        accessEvent.serverAdapter.contentLength shouldBe CONTENT_LENGTH
+        accessEvent.serverAdapter.statusCode shouldBe OK_STATUS_CODE.toInt()
+        accessEvent.serverAdapter.buildResponseHeaderMap().shouldBeEmpty()
     }
 
     private fun mockArgProvider(mockArgProvider: AccessLogArgProvider) {
@@ -488,10 +506,11 @@ class AccessEventTests {
         every { mockArgProvider.method() } returns GET
         every { mockArgProvider.uri() } returns "$REQUEST_URI$QUERY_STRING"
         every { mockArgProvider.protocol() } returns HTTP11
-        every { mockArgProvider.status() } returns OK
+        every { mockArgProvider.status() } returns OK_STATUS_CODE
         every { mockArgProvider.contentLength() } returns CONTENT_LENGTH
         every { mockArgProvider.duration() } returns DURATION
         every { mockArgProvider.user() } returns USERNAME
+        every { mockArgProvider.accessDateTime() } returns ZonedDateTime.ofInstant(Instant.ofEpochMilli(TIMESTAMP), ZoneId.of("UTC"))
         every { mockArgProvider.requestHeaderIterator() } returns Collections.emptyIterator()
         every { mockArgProvider.responseHeaderIterator() } returns Collections.emptyIterator()
         every { mockArgProvider.cookies() } returns emptyMap()
@@ -503,7 +522,7 @@ class AccessEventTests {
         private val NA_ARRAY = arrayOf(NA)
         private const val GET = "GET"
         private const val HTTP11 = "HTTP/1.1"
-        private const val OK = "200"
+        private const val OK_STATUS_CODE = "200"
         private const val IP_ADDRESS = "192.168.1.1"
         private const val USERNAME = "username"
         private const val PORT = 1000
@@ -518,5 +537,6 @@ class AccessEventTests {
         private const val REQUEST_URI = "/test"
         private const val QUERY_STRING = "?param=value"
         private const val DURATION_SECONDS = 1L
+        private const val TIMESTAMP = 1746734856000
     }
 }