Add springProfile SanityChecker

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

Author: dmitrysulman

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/autoconfigure/ReactorNettyAccessLogFactoryAutoConfiguration.kt

@@ -1,7 +1,7 @@
 package io.github.dmitrysulman.logback.access.reactor.netty.autoconfigure
 
 import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLogFactory
-import io.github.dmitrysulman.logback.access.reactor.netty.joran.ReactorNettyJoranConfigurator
+import io.github.dmitrysulman.logback.access.reactor.netty.joran.LogbackAccessJoranConfigurator
 import org.springframework.boot.autoconfigure.AutoConfiguration
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass
@@ -16,23 +16,23 @@ import org.springframework.util.ResourceUtils
 import reactor.netty.http.server.HttpServer
 
 /**
- * [Auto-configuration][EnableAutoConfiguration] for a Logback Access Reactor Netty integration.
+ * [Auto-configuration][EnableAutoConfiguration] for the Logback Access integration with Reactor Netty.
  */
 @AutoConfiguration
 @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
 @ConditionalOnClass(HttpServer::class)
 @ConditionalOnProperty(prefix = "logback.access.reactor.netty", name = ["enabled"], havingValue = "true", matchIfMissing = true)
-@EnableConfigurationProperties(LogbackAccessReactorNettyProperties::class)
+@EnableConfigurationProperties(ReactorNettyAccessLogProperties::class)
 class ReactorNettyAccessLogFactoryAutoConfiguration {
     @Bean
     @ConditionalOnMissingBean
     fun reactorNettyAccessLogFactory(
-        properties: LogbackAccessReactorNettyProperties,
+        properties: ReactorNettyAccessLogProperties,
         resourceLoader: ResourceLoader,
         environment: Environment,
     ) = ReactorNettyAccessLogFactory(
         getConfigUrl(properties, resourceLoader),
-        ReactorNettyJoranConfigurator(environment),
+        LogbackAccessJoranConfigurator(environment),
         properties.debug ?: false,
     )
 
@@ -42,7 +42,7 @@ class ReactorNettyAccessLogFactoryAutoConfiguration {
         ReactorNettyAccessLogWebServerFactoryCustomizer(true, reactorNettyAccessLogFactory)
 
     private fun getConfigUrl(
-        properties: LogbackAccessReactorNettyProperties,
+        properties: ReactorNettyAccessLogProperties,
         resourceLoader: ResourceLoader,
     ) = properties.config?.let { ResourceUtils.getURL(it) }
         ?: getDefaultConfigurationResource(resourceLoader).url

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/autoconfigure/LogbackAccessReactorNettyProperties.kt renamed to logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/autoconfigure/ReactorNettyAccessLogProperties.kt

@@ -2,20 +2,23 @@ package io.github.dmitrysulman.logback.access.reactor.netty.autoconfigure
 
 import org.springframework.boot.context.properties.ConfigurationProperties
 
+/**
+ * [@ConfigurationProperties][ConfigurationProperties] for the Logback Access integration with Reactor Netty.
+ */
 @ConfigurationProperties("logback.access.reactor.netty")
-class LogbackAccessReactorNettyProperties {
+class ReactorNettyAccessLogProperties {
     /**
-     * Enable Logback Access Reactor Netty auto-configuration
+     * Enable Logback Access Reactor Netty auto-configuration.
      */
     var enabled: Boolean? = null
 
     /**
-     * Config file name
+     * Config file name.
      */
     var config: String? = null
 
     /**
-     * Enable debug mode
+     * Enable debug mode.
      */
     var debug: Boolean? = null
 }

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/autoconfigure/ReactorNettyAccessLogWebServerFactoryCustomizer.kt

@@ -4,6 +4,9 @@ import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLog
 import org.springframework.boot.web.embedded.netty.NettyReactiveWebServerFactory
 import org.springframework.boot.web.server.WebServerFactoryCustomizer
 
+/**
+ * [WebServerFactoryCustomizer] of the [NettyReactiveWebServerFactory] for the Logback Access integration.
+ */
 class ReactorNettyAccessLogWebServerFactoryCustomizer(
     private val enableAccessLog: Boolean,
     private val reactorNettyAccessLogFactory: ReactorNettyAccessLogFactory,

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/ReactorNettyJoranConfigurator.kt renamed to logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessJoranConfigurator.kt

@@ -12,9 +12,8 @@ import java.util.function.Supplier
  * Extended version of the Logback Access [JoranConfigurator] that adds support of `<springProfile>` tags.
  *
  * See [SpringBootJoranConfigurator](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/SpringBootJoranConfigurator.java).
- *
  */
-class ReactorNettyJoranConfigurator(
+class LogbackAccessJoranConfigurator(
     private val environment: Environment,
 ) : JoranConfigurator() {
     override fun addElementSelectorAndActionAssociations(rs: RuleStore) {
@@ -25,6 +24,7 @@ class ReactorNettyJoranConfigurator(
 
     override fun sanityCheck(topModel: Model) {
         super.sanityCheck(topModel)
+        performCheck(LogbackAccessSpringProfileWithinSecondPhaseElementSanityChecker(), topModel)
     }
 
     override fun addModelHandlerAssociations(defaultProcessor: DefaultProcessor) {
@@ -38,7 +38,7 @@ class ReactorNettyJoranConfigurator(
         super.buildModelInterpretationContext()
         modelInterpretationContext.configuratorSupplier =
             Supplier {
-                ReactorNettyJoranConfigurator(environment).also { it.context = this.context }
+                LogbackAccessJoranConfigurator(environment).also { it.context = this.context }
             }
     }
 }

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessSpringProfileModelHandler.kt

@@ -23,14 +23,13 @@ class LogbackAccessSpringProfileModelHandler(
         mic: ModelInterpretationContext,
         model: Model,
     ) {
-        if (model is LogbackAccessSpringProfileModel) {
-            val profiles =
-                model.name
-                    .split(",")
-                    .map { OptionHelper.substVars(it.trim(), mic, context) }
-            if (profiles.isEmpty() || !environment.matchesProfiles(*profiles.toTypedArray())) {
-                model.deepMarkAsSkipped()
-            }
+        val profiles =
+            (model as LogbackAccessSpringProfileModel)
+                .name
+                .split(",")
+                .map { OptionHelper.substVars(it.trim(), mic, context) }
+        if (profiles.isEmpty() || !environment.matchesProfiles(*profiles.toTypedArray())) {
+            model.deepMarkAsSkipped()
         }
     }
 }

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessSpringProfileWithinSecondPhaseElementSanityChecker.kt

@@ -0,0 +1,45 @@
+package io.github.dmitrysulman.logback.access.reactor.netty.joran
+
+import ch.qos.logback.core.joran.sanity.SanityChecker
+import ch.qos.logback.core.model.AppenderModel
+import ch.qos.logback.core.model.Model
+import ch.qos.logback.core.spi.ContextAwareBase
+
+/**
+ * [SanityChecker] to ensure that `springProfile` elements are not nested
+ * within second-phase elements.
+ *
+ * See [SpringProfileIfNestedWithinSecondPhaseElementSanityChecker](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/SpringProfileIfNestedWithinSecondPhaseElementSanityChecker.java).
+ */
+class LogbackAccessSpringProfileWithinSecondPhaseElementSanityChecker :
+    ContextAwareBase(),
+    SanityChecker {
+    override fun check(model: Model?) {
+        if (model == null) return
+
+        val secondsPhaseModels = mutableListOf<Model>()
+
+        SECOND_PHASE_TYPES.forEach {
+            deepFindAllModelsOfType(it, secondsPhaseModels, model)
+        }
+
+        deepFindNestedSubModelsOfType(LogbackAccessSpringProfileModel::class.java, secondsPhaseModels)
+            ?.takeIf { it.isNotEmpty() }
+            ?.also {
+                addWarn("<springProfile> elements cannot be nested within an <appender> element")
+            }?.forEach {
+                val first = it.first
+                val second = it.second
+                addWarn(
+                    "Element <${first.tag}> at line ${first.lineNumber} contains a nested <${second.tag}> element at line ${second.lineNumber}",
+                )
+            }
+    }
+
+    companion object {
+        private val SECOND_PHASE_TYPES =
+            listOf(
+                AppenderModel::class.java,
+            )
+    }
+}

logback-access-reactor-netty-spring-boot-starter/src/test/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/autoconfigure/LogbackAccessReactorNettyPropertiesTests.kt

@@ -16,10 +16,10 @@ import org.springframework.context.annotation.Configuration
         "logback.access.reactor.netty.debug=true",
     ],
 )
-@EnableConfigurationProperties(LogbackAccessReactorNettyProperties::class)
+@EnableConfigurationProperties(ReactorNettyAccessLogProperties::class)
 @Configuration
 class LogbackAccessReactorNettyPropertiesTests(
-    @Autowired private val properties: LogbackAccessReactorNettyProperties,
+    @Autowired private val properties: ReactorNettyAccessLogProperties,
 ) {
     @Test
     fun `smoke test`() {

logback-access-reactor-netty-spring-boot-starter/src/test/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessSpringProfileWithinSecondPhaseElementSanityCheckerTests.kt

@@ -0,0 +1,26 @@
+package io.github.dmitrysulman.logback.access.reactor.netty.joran
+
+import io.github.dmitrysulman.logback.access.reactor.netty.ReactorNettyAccessLogFactory
+import io.github.dmitrysulman.logback.access.reactor.netty.autoconfigure.ReactorNettyAccessLogFactoryAutoConfiguration
+import io.kotest.matchers.booleans.shouldBeTrue
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.getBean
+import org.springframework.boot.autoconfigure.AutoConfigurations
+import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner
+
+class LogbackAccessSpringProfileWithinSecondPhaseElementSanityCheckerTests {
+    @Test
+    fun `should add warning status on nested springProfile element within appender element`() {
+        ReactiveWebApplicationContextRunner()
+            .withConfiguration(AutoConfigurations.of(ReactorNettyAccessLogFactoryAutoConfiguration::class.java))
+            .withPropertyValues("logback.access.reactor.netty.config=classpath:logback-access-springprofile-in-appender.xml")
+            .run { context ->
+                val factory = context.getBean<ReactorNettyAccessLogFactory>()
+                factory.accessContext.statusManager.copyOfStatusList
+                    .any {
+                        it.message ==
+                            "<springProfile> elements cannot be nested within an <appender> element"
+                    }.shouldBeTrue()
+            }
+    }
+}

logback-access-reactor-netty-spring-boot-starter/src/test/resources/logback-access-springprofile-in-appender.xml

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