Merge pull request #112 from akkinoc/fix-issue-110

Fixed a bug that the file system path cannot be specified for the location of the configuration file

Author: akkinoc

README.md

@@ -175,6 +175,7 @@ logback.access:
   # Defaults to true.
   enabled: true
   # The location of the configuration file.
+  # Specify a URL that starts with "classpath:" or "file:".
   # Auto-detected by default:
   #   1. "classpath:logback-access-test.xml"
   #   2. "classpath:logback-access.xml"

src/main/kotlin/dev/akkinoc/spring/boot/logback/access/LogbackAccessContext.kt

@@ -10,6 +10,7 @@ import org.slf4j.Logger
 import org.slf4j.LoggerFactory.getLogger
 import org.springframework.core.env.Environment
 import org.springframework.core.io.ResourceLoader
+import org.springframework.util.ResourceUtils.getURL
 
 /**
  * The Logback-access context.
@@ -30,7 +31,7 @@ class LogbackAccessContext(
     private val raw: AccessContext = AccessContext()
 
     init {
-        val (name, resource) = properties.config?.let { it to resourceLoader.getResource(it) }
+        val (name, resource) = properties.config?.let { it to resourceLoader.getResource("${getURL(it)}") }
                 ?: DEFAULT_CONFIGS.asSequence()
                         .map { it to resourceLoader.getResource(it) }
                         .firstOrNull { (_, resource) -> resource.exists() }

src/main/kotlin/dev/akkinoc/spring/boot/logback/access/LogbackAccessProperties.kt

@@ -14,6 +14,7 @@ import org.springframework.boot.context.properties.ConstructorBinding
  *  Whether to enable auto-configuration.
  * @property config
  *  The location of the configuration file.
+ *  Specify a URL that starts with "classpath:" or "file:".
  *  Auto-detected by default:
  *      1. "classpath:logback-access-test.xml"
  *      2. "classpath:logback-access.xml"

src/main/resources/META-INF/spring-configuration-metadata.json

@@ -37,7 +37,7 @@
       "name": "logback.access.config",
       "type": "java.lang.String",
       "sourceType": "dev.akkinoc.spring.boot.logback.access.LogbackAccessProperties",
-      "description": "The location of the configuration file. Auto-detected by default: 1. \"classpath:logback-access-test.xml\" 2. \"classpath:logback-access.xml\" 3. \"classpath:logback-access-test-spring.xml\" 4. \"classpath:logback-access-spring.xml\" 5. \"classpath:dev/akkinoc/spring/boot/logback/access/logback-access-spring.xml\""
+      "description": "The location of the configuration file. Specify a URL that starts with \"classpath:\" or \"file:\". Auto-detected by default: 1. \"classpath:logback-access-test.xml\" 2. \"classpath:logback-access.xml\" 3. \"classpath:logback-access-test-spring.xml\" 4. \"classpath:logback-access-spring.xml\" 5. \"classpath:dev/akkinoc/spring/boot/logback/access/logback-access-spring.xml\""
     },
     {
       "name": "logback.access.local-port-strategy",

src/test/kotlin/dev/akkinoc/spring/boot/logback/access/ConfigurationFileLocationTest.kt

@@ -0,0 +1,123 @@
+package dev.akkinoc.spring.boot.logback.access
+
+import dev.akkinoc.spring.boot.logback.access.test.assertion.Assertions
+import dev.akkinoc.spring.boot.logback.access.test.extension.EventsCapture
+import dev.akkinoc.spring.boot.logback.access.test.extension.EventsCaptureExtension
+import dev.akkinoc.spring.boot.logback.access.test.type.JettyReactiveWebTest
+import dev.akkinoc.spring.boot.logback.access.test.type.JettyServletWebTest
+import dev.akkinoc.spring.boot.logback.access.test.type.TomcatReactiveWebTest
+import dev.akkinoc.spring.boot.logback.access.test.type.TomcatServletWebTest
+import dev.akkinoc.spring.boot.logback.access.test.type.UndertowReactiveWebTest
+import dev.akkinoc.spring.boot.logback.access.test.type.UndertowServletWebTest
+import io.kotest.matchers.collections.shouldBeSingleton
+import io.kotest.matchers.shouldBe
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.web.client.TestRestTemplate
+import org.springframework.boot.test.web.client.exchange
+import org.springframework.http.RequestEntity
+import org.springframework.test.context.TestPropertySource
+
+/**
+ * Tests the case where the location of the configuration file is specified.
+ */
+@ExtendWith(EventsCaptureExtension::class)
+sealed class ConfigurationFileLocationTest {
+
+    @Test
+    fun `Appends a Logback-access event according to the configuration file found`(
+            @Autowired rest: TestRestTemplate,
+            capture: EventsCapture,
+    ) {
+        val request = RequestEntity.get("/mock-controller/text").build()
+        val response = rest.exchange<String>(request)
+        response.statusCodeValue.shouldBe(200)
+        Assertions.assertLogbackAccessEventsEventually { capture.shouldBeSingleton() }
+    }
+
+}
+
+/**
+ * Tests the case where the location of the configuration file is specified as a file system path.
+ */
+@TestPropertySource(properties = ["logback.access.config=target/test-classes/logback-access-test.capture.xml"])
+sealed class ConfigurationFilePathTest : ConfigurationFileLocationTest()
+
+/**
+ * Tests the [ConfigurationFilePathTest] using the Tomcat servlet web server.
+ */
+@TomcatServletWebTest
+class TomcatServletWebConfigurationFilePathTest : ConfigurationFilePathTest()
+
+/**
+ * Tests the [ConfigurationFilePathTest] using the Tomcat reactive web server.
+ */
+@TomcatReactiveWebTest
+class TomcatReactiveWebConfigurationFilePathTest : ConfigurationFilePathTest()
+
+/**
+ * Tests the [ConfigurationFilePathTest] using the Jetty servlet web server.
+ */
+@JettyServletWebTest
+class JettyServletWebConfigurationFilePathTest : ConfigurationFilePathTest()
+
+/**
+ * Tests the [ConfigurationFilePathTest] using the Jetty reactive web server.
+ */
+@JettyReactiveWebTest
+class JettyReactiveWebConfigurationFilePathTest : ConfigurationFilePathTest()
+
+/**
+ * Tests the [ConfigurationFilePathTest] using the Undertow servlet web server.
+ */
+@UndertowServletWebTest
+class UndertowServletWebConfigurationFilePathTest : ConfigurationFilePathTest()
+
+/**
+ * Tests the [ConfigurationFilePathTest] using the Undertow reactive web server.
+ */
+@UndertowReactiveWebTest
+class UndertowReactiveWebConfigurationFilePathTest : ConfigurationFilePathTest()
+
+/**
+ * Tests the case where the location of the configuration file is specified as a file scheme URI.
+ */
+@TestPropertySource(properties = ["logback.access.config=file:target/test-classes/logback-access-test.capture.xml"])
+sealed class ConfigurationFileUriTest : ConfigurationFileLocationTest()
+
+/**
+ * Tests the [ConfigurationFileUriTest] using the Tomcat servlet web server.
+ */
+@TomcatServletWebTest
+class TomcatServletWebConfigurationFileUriTest : ConfigurationFileUriTest()
+
+/**
+ * Tests the [ConfigurationFileUriTest] using the Tomcat reactive web server.
+ */
+@TomcatReactiveWebTest
+class TomcatReactiveWebConfigurationFileUriTest : ConfigurationFileUriTest()
+
+/**
+ * Tests the [ConfigurationFileUriTest] using the Jetty servlet web server.
+ */
+@JettyServletWebTest
+class JettyServletWebConfigurationFileUriTest : ConfigurationFileUriTest()
+
+/**
+ * Tests the [ConfigurationFileUriTest] using the Jetty reactive web server.
+ */
+@JettyReactiveWebTest
+class JettyReactiveWebConfigurationFileUriTest : ConfigurationFileUriTest()
+
+/**
+ * Tests the [ConfigurationFileUriTest] using the Undertow servlet web server.
+ */
+@UndertowServletWebTest
+class UndertowServletWebConfigurationFileUriTest : ConfigurationFileUriTest()
+
+/**
+ * Tests the [ConfigurationFileUriTest] using the Undertow reactive web server.
+ */
+@UndertowReactiveWebTest
+class UndertowReactiveWebConfigurationFileUriTest : ConfigurationFileUriTest()