fix LOGBACK-1698, [Nested appenders are not allowed] warning using SiftingAppender

ceki · ceki · commit 4313ecb74ea2 · 2022-11-18T21:48:42.000+01:00
Signed-off-by: Ceki Gulcu &lt;ceki@qos.ch&gt;
diff --git a/logback-classic/src/test/input/joran/sift/completeCycle.xml b/logback-classic/src/test/input/joran/sift/completeCycle.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/compositeProperty.xml b/logback-classic/src/test/input/joran/sift/compositeProperty.xml
@@ -1,5 +1,5 @@
 
-<configuration debug="true">
+<configuration debug="false">
 
   <property name="X" value="composite"/>  
 
diff --git a/logback-classic/src/test/input/joran/sift/defaultLayoutRule.xml b/logback-classic/src/test/input/joran/sift/defaultLayoutRule.xml
@@ -1,4 +1,4 @@
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
     <discriminator>
diff --git a/logback-classic/src/test/input/joran/sift/fileAppender.xml b/logback-classic/src/test/input/joran/sift/fileAppender.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
 	<appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/hoard0.xml b/logback-classic/src/test/input/joran/sift/hoard0.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/lingering.xml b/logback-classic/src/test/input/joran/sift/lingering.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/maxAppenderCount.xml b/logback-classic/src/test/input/joran/sift/maxAppenderCount.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
     <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
         <discriminator>
diff --git a/logback-classic/src/test/input/joran/sift/multipleNesting.xml b/logback-classic/src/test/input/joran/sift/multipleNesting.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/propertyDefinedInSiftElement.xml b/logback-classic/src/test/input/joran/sift/propertyDefinedInSiftElement.xml
@@ -1,4 +1,4 @@
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
     <discriminator>
diff --git a/logback-classic/src/test/input/joran/sift/propertyPropagation.xml b/logback-classic/src/test/input/joran/sift/propertyPropagation.xml
@@ -1,4 +1,4 @@
-<configuration debug="true">
+<configuration debug="false">
 
 
   <property name="X" value="Y"/>  
diff --git a/logback-classic/src/test/input/joran/sift/smoke.xml b/logback-classic/src/test/input/joran/sift/smoke.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/timeout.xml b/logback-classic/src/test/input/joran/sift/timeout.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
     <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/unsetDefaultValueProperty.xml b/logback-classic/src/test/input/joran/sift/unsetDefaultValueProperty.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/input/joran/sift/zeroNesting.xml b/logback-classic/src/test/input/joran/sift/zeroNesting.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE configuration>
 
-<configuration debug="true">
+<configuration debug="false">
 
   <appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">
 
diff --git a/logback-classic/src/test/java/ch/qos/logback/classic/sift/SiftingAppenderTest.java b/logback-classic/src/test/java/ch/qos/logback/classic/sift/SiftingAppenderTest.java
@@ -103,6 +103,7 @@ public void smoke() throws JoranException {
         List<ILoggingEvent> eventList = listAppender.list;
         assertEquals(1, listAppender.list.size());
         assertEquals("smoke", eventList.get(0).getMessage());
+        statusChecker.assertIsWarningOrErrorFree();
     }
 
     private AppenderTracker<ILoggingEvent> getAppenderTracker() {
diff --git a/logback-core/src/main/java/ch/qos/logback/core/joran/sanity/AppenderWithinAppenderSanityChecker.java b/logback-core/src/main/java/ch/qos/logback/core/joran/sanity/AppenderWithinAppenderSanityChecker.java
@@ -19,6 +19,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 public class AppenderWithinAppenderSanityChecker extends ContextAwareBase implements SanityChecker  {
 
@@ -34,13 +35,26 @@ public void check(Model model) {
 
         List<Pair<Model, Model>> nestedPairs = deepFindNestedSubModelsOfType(AppenderModel.class, appenderModels);
 
-        if(nestedPairs.isEmpty())
-            return;
+        List<Pair<Model, Model>> filteredNestedPairs = nestedPairs.stream().filter(pair -> !isSiftingAppender(pair.first)).collect(Collectors.toList());
 
+        if(filteredNestedPairs.isEmpty()) {
+            return;
+        }
         addWarn(NESTED_APPENDERS_WARNING);
-        for(Pair<Model, Model> pair: nestedPairs) {
+        for(Pair<Model, Model> pair: filteredNestedPairs) {
             addWarn("Appender at line "+pair.first.getLineNumber() + " contains a nested appender at line "+pair.second.getLineNumber());
         }
     }
 
+    private boolean isSiftingAppender(Model first) {
+        if(first instanceof  AppenderModel) {
+            AppenderModel appenderModel = (AppenderModel) first;
+            String classname = appenderModel.getClassName();
+            if(classname == null)
+                return false;
+            return appenderModel.getClassName().contains("SiftingAppender");
+        }
+        return false;
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`
`2`		`-<configuration debug="true">`
	`2`	`+<configuration debug="false">`
`3`	`3`
`4`	`4`	`<property name="X" value="composite"/>`
`5`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<configuration debug="true">`
	`1`	`+<configuration debug="false">`
`2`	`2`
`3`	`3`	`<appender name="SIFT" class="ch.qos.logback.classic.sift.SiftingAppender">`
`4`	`4`	`<discriminator>`