Fixing Logback 1.1 support and add legacy tests (#122)

elastic · Feb 23, 2021 · b7c2e21 · b7c2e21
1 parent f0c9be3
commit b7c2e21
Show file tree

Hide file tree

Showing 8 changed files with 131 additions and 4 deletions.
diff --git a/logback-ecs-encoder/pom.xml b/logback-ecs-encoder/pom.xml
@@ -14,6 +14,23 @@
         <parent.base.dir>${project.basedir}/..</parent.base.dir>
     </properties>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.1.2</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>test-jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
     <dependencies>
         <dependency>
             <groupId>${project.groupId}</groupId>

diff --git a/logback-ecs-encoder/src/main/java/co/elastic/logging/logback/EcsEncoder.java b/logback-ecs-encoder/src/main/java/co/elastic/logging/logback/EcsEncoder.java
@@ -75,9 +75,14 @@ public void init(OutputStream os) {
     /**
      * This method has been removed in logback 1.2.
      * To make this lib backwards compatible with logback 1.1 we have implement this method.
+     * However, since we compile with 1.2.x, this method is not compiled as an interface method, which means that there won't be type
+     * erasure. Therefore, we must use a {@link Object} argument for it to be compatible with 1.1.x.
      */
-    public void doEncode(ILoggingEvent event) throws IOException {
-        os.write(encode(event));
+    public void doEncode(Object event) throws IOException {
+        os.write(encode((ILoggingEvent) event));
+        // on logback 1.1.x versions this encoder always works as if immediateFlush == true. In later versions, flushing is only handled by
+        // the appender rather than the encoder
+        os.flush();
     }
 
     /**

diff --git a/logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderIntegrationTest.java b/logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderIntegrationTest.java
@@ -32,7 +32,7 @@
 
 import java.io.IOException;
 
-class EcsEncoderIntegrationTest extends AbstractEcsEncoderTest {
+public class EcsEncoderIntegrationTest extends AbstractEcsEncoderTest {
     private OutputStreamAppender appender;
 
     @BeforeEach

diff --git a/logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderTest.java b/logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderTest.java
@@ -31,7 +31,7 @@
 
 import java.io.IOException;
 
-class EcsEncoderTest extends AbstractEcsEncoderTest {
+public class EcsEncoderTest extends AbstractEcsEncoderTest {
 
     private OutputStreamAppender appender;
 

diff --git a/logback-legacy-tests/pom.xml b/logback-legacy-tests/pom.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>ecs-logging-java-parent</artifactId>
+        <groupId>co.elastic.logging</groupId>
+        <version>1.0.1-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>logback-legacy-tests</artifactId>
+
+    <properties>
+        <parent.base.dir>${project.basedir}/..</parent.base.dir>
+        <maven-deploy-plugin.skip>true</maven-deploy-plugin.skip>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>ecs-logging-core</artifactId>
+            <version>${project.version}</version>
+            <type>test-jar</type>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>logback-ecs-encoder</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>logback-ecs-encoder</artifactId>
+            <version>${project.version}</version>
+            <type>test-jar</type>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>1.1.0</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/...egacy-tests/src/test/java/co/elastic/logging/logback/LegacyEcsEncoderIntegrationTest.java b/...egacy-tests/src/test/java/co/elastic/logging/logback/LegacyEcsEncoderIntegrationTest.java
@@ -0,0 +1,29 @@
+/*-
+ * #%L
+ * Java ECS logging
+ * %%
+ * Copyright (C) 2019 - 2020 Elastic and contributors
+ * %%
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * #L%
+ */
+package co.elastic.logging.logback;
+
+class LegacyEcsEncoderIntegrationTest extends EcsEncoderIntegrationTest {
+
+}
diff --git a/logback-legacy-tests/src/test/java/co/elastic/logging/logback/LegacyEcsEncoderTest.java b/logback-legacy-tests/src/test/java/co/elastic/logging/logback/LegacyEcsEncoderTest.java
@@ -0,0 +1,29 @@
+/*-
+ * #%L
+ * Java ECS logging
+ * %%
+ * Copyright (C) 2019 - 2020 Elastic and contributors
+ * %%
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * #L%
+ */
+package co.elastic.logging.logback;
+
+class LegacyEcsEncoderTest extends EcsEncoderTest {
+
+}
diff --git a/pom.xml b/pom.xml
@@ -15,6 +15,7 @@
         <module>jboss-logmanager-ecs-formatter</module>
         <module>log4j2-legacy-tests</module>
         <module>log4j-legacy-tests</module>
+        <module>logback-legacy-tests</module>
     </modules>
     <packaging>pom</packaging>
     <inceptionYear>2019</inceptionYear>