Add fallback to Common Log Format

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

Author: dmitrysulman

README.md

@@ -80,9 +80,9 @@ HttpServer.create()
 
 The library can be configured in several ways:
 
-1. **Default configuration** uses `logback-access.xml` file on the classpath.
+1. **Default configuration** uses the `logback-access.xml` file from the classpath or the current directory, with a fallback to the [Common Log Format](https://en.wikipedia.org/wiki/Common_Log_Format).
 2. **System property.** Set `-Dlogback.access.reactor.netty.config` property to specify configuration file location.
-3. **Programmatic configuration.** Provide configuration file filename or URL of the resource directly:
+3. **Programmatic configuration.** Provide configuration file filename or URL of the classpath resource directly:
 ```java
 // Using specific configuration file by the filename
 var factory = new ReactorNettyAccessLogFactory("/path/to/logback-access.xml");

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

@@ -6,7 +6,6 @@ import ch.qos.logback.core.status.ErrorStatus
 import ch.qos.logback.core.status.InfoStatus
 import ch.qos.logback.core.status.OnConsoleStatusListener
 import ch.qos.logback.core.status.Status
-import ch.qos.logback.core.status.WarnStatus
 import ch.qos.logback.core.util.StatusListenerConfigHelper
 import ch.qos.logback.core.util.StatusPrinter2
 import reactor.netty.http.server.logging.AccessLogArgProvider
@@ -120,19 +119,15 @@ class ReactorNettyAccessLogFactory : AccessLogFactory {
     }
 
     private fun initialize(
-        config: URL?,
+        config: URL,
         joranConfigurator: JoranConfigurator,
         debug: Boolean,
     ) {
         try {
-            if (config != null) {
-                addStatus(InfoStatus("Start configuring with configuration file [${config.file}]", this::class.java.simpleName))
-                accessContext.name = config.file
-                joranConfigurator.context = accessContext
-                joranConfigurator.doConfigure(config)
-            } else {
-                addStatus(WarnStatus("No configuration file provided, skipping configuration", this::class.java.simpleName))
-            }
+            addStatus(InfoStatus("Start configuring with configuration file [${config.file}]", this::class.java.simpleName))
+            accessContext.name = config.file
+            joranConfigurator.context = accessContext
+            joranConfigurator.doConfigure(config)
             if (debug) {
                 StatusListenerConfigHelper.addOnConsoleListenerInstance(accessContext, OnConsoleStatusListener())
             }
@@ -147,7 +142,7 @@ class ReactorNettyAccessLogFactory : AccessLogFactory {
         }
     }
 
-    private fun getDefaultConfig(): URL? {
+    private fun getDefaultConfig(): URL {
         val fileNameFromSystemProperty =
             System.getProperty(CONFIG_FILE_NAME_PROPERTY)?.also {
                 addStatus(
@@ -173,9 +168,11 @@ class ReactorNettyAccessLogFactory : AccessLogFactory {
             )
             try {
                 getConfigFromFileName(DEFAULT_CONFIG_FILE_NAME)
-            } catch (e: FileNotFoundException) {
-                addStatus(WarnStatus(e.message, this::class.java.simpleName))
-                null
+            } catch (_: FileNotFoundException) {
+                addStatus(
+                    InfoStatus("Not found [$DEFAULT_CONFIG_FILE_NAME], fallback to the default configuration", this::class.java.simpleName),
+                )
+                getResource(DEFAULT_CONFIGURATION)
             }
         }
     }
@@ -187,12 +184,15 @@ class ReactorNettyAccessLogFactory : AccessLogFactory {
             file.toURI().toURL()
         } else {
             addStatus(InfoStatus("Not found file [$fileName], checking resource", this::class.java.simpleName))
-            this::class.java.classLoader.getResource(fileName)?.also {
-                addStatus(InfoStatus("Found resource [${it.file}]", this::class.java.simpleName))
-            } ?: throw FileNotFoundException("Configuration file $fileName not found")
+            getResource(fileName)
         }
     }
 
+    private fun getResource(fileName: String) =
+        this::class.java.classLoader.getResource(fileName)?.also {
+            addStatus(InfoStatus("Found resource [${it.file}]", this::class.java.simpleName))
+        } ?: throw FileNotFoundException("Configuration file $fileName not found")
+
     private fun addStatus(status: Status) {
         accessContext.statusManager.add(status)
     }
@@ -215,5 +215,10 @@ class ReactorNettyAccessLogFactory : AccessLogFactory {
          * The default configuration file name used for the Logback Access configuration.
          */
         const val DEFAULT_CONFIG_FILE_NAME = "logback-access.xml"
+
+        /**
+         * The fallback configuration file path.
+         */
+        const val DEFAULT_CONFIGURATION = "logback-access-reactor-netty/logback-access-default-config.xml"
     }
 }

logback-access-reactor-netty/src/main/resources/logback-access-reactor-netty/logback-access-default-config.xml

@@ -0,0 +1,9 @@
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>common</pattern>
+        </encoder>
+    </appender>
+
+    <appender-ref ref="STDOUT" />
+</configuration>

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

@@ -3,19 +3,18 @@ package io.github.dmitrysulman.logback.access.reactor.netty
 import ch.qos.logback.access.common.joran.JoranConfigurator
 import ch.qos.logback.core.joran.spi.JoranException
 import ch.qos.logback.core.status.OnConsoleStatusListener
-import ch.qos.logback.core.status.Status
 import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLogFactory.Companion.CONFIG_FILE_NAME_PROPERTY
+import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLogFactory.Companion.DEFAULT_CONFIGURATION
 import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLogFactory.Companion.DEFAULT_CONFIG_FILE_NAME
 import io.github.dmitrysulman.logback.access.reactor.netty.integration.EventCaptureAppender
 import io.kotest.assertions.throwables.shouldThrowExactly
 import io.kotest.matchers.booleans.shouldBeTrue
-import io.kotest.matchers.nulls.shouldBeNull
 import io.kotest.matchers.nulls.shouldNotBeNull
+import io.kotest.matchers.shouldBe
+import io.kotest.matchers.string.shouldEndWith
 import io.kotest.matchers.types.shouldBeTypeOf
 import io.mockk.every
-import io.mockk.mockk
 import io.mockk.spyk
-import io.mockk.verify
 import org.junit.jupiter.api.Test
 import java.io.FileNotFoundException
 import java.net.URL
@@ -36,6 +35,7 @@ class ReactorNettyAccessLogFactoryTests {
         val defaultAppender = reactorNettyAccessLogFactory.accessContext.getAppender("PROPERTY")
         defaultAppender.shouldNotBeNull()
         defaultAppender.shouldBeTypeOf<EventCaptureAppender>()
+        System.clearProperty(CONFIG_FILE_NAME_PROPERTY)
     }
 
     @Test
@@ -113,6 +113,7 @@ class ReactorNettyAccessLogFactoryTests {
     fun `test not existing filename from configuration property`() {
         System.setProperty(CONFIG_FILE_NAME_PROPERTY, "logback-access-not-exist.xml")
         shouldThrowExactly<FileNotFoundException> { ReactorNettyAccessLogFactory() }
+        System.clearProperty(CONFIG_FILE_NAME_PROPERTY)
     }
 
     @Test
@@ -121,36 +122,26 @@ class ReactorNettyAccessLogFactoryTests {
     }
 
     @Test
-    fun `test not existing default config file`() {
+    fun `test not existing default config file fallback to default configuration`() {
         val reactorNettyAccessLogFactory = spyk<ReactorNettyAccessLogFactory>(recordPrivateCalls = true)
         every { reactorNettyAccessLogFactory["getConfigFromFileName"](DEFAULT_CONFIG_FILE_NAME) } throws FileNotFoundException()
         val getDefaultConfigMethod = reactorNettyAccessLogFactory::class.java.getDeclaredMethod("getDefaultConfig")
         getDefaultConfigMethod.trySetAccessible()
-        val defaultConfigUrl = getDefaultConfigMethod.invoke(reactorNettyAccessLogFactory) as URL?
-        defaultConfigUrl.shouldBeNull()
-    }
-
-    @Test
-    fun `test initialization without config`() {
-        val reactorNettyAccessLogFactory = ReactorNettyAccessLogFactory()
-        val joranConfigurator = mockk<JoranConfigurator>(relaxed = true)
-        val initializeMethod =
-            reactorNettyAccessLogFactory::class.java.getDeclaredMethod(
-                "initialize",
-                URL::class.java,
-                JoranConfigurator::class.java,
-                Boolean::class.java,
-            )
-        initializeMethod.trySetAccessible()
-        initializeMethod.invoke(reactorNettyAccessLogFactory, null, joranConfigurator, false)
-
-        verify(exactly = 0) { joranConfigurator.context }
-        verify(exactly = 0) { joranConfigurator.doConfigure(any<URL>()) }
-
-        reactorNettyAccessLogFactory.accessContext.statusManager.copyOfStatusList
-            .any {
-                it.effectiveLevel == Status.WARN &&
-                    it.message == "No configuration file provided, skipping configuration"
-            }.shouldBeTrue()
+        val defaultConfigUrl = getDefaultConfigMethod.invoke(reactorNettyAccessLogFactory) as URL
+        defaultConfigUrl.toString() shouldEndWith DEFAULT_CONFIGURATION
+        defaultConfigUrl.openStream().reader().use {
+            it.readText() shouldBe
+                """
+                <configuration>
+                    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+                        <encoder>
+                            <pattern>common</pattern>
+                        </encoder>
+                    </appender>
+
+                    <appender-ref ref="STDOUT" />
+                </configuration>
+                """.trimIndent()
+        }
     }
 }