Upgrade from log4j1 to 2.17.1

siddhi-io · Jan 27, 2022 · 25b0f65 · 25b0f65
1 parent 50f86a1
commit 25b0f65
Show file tree

Hide file tree

Showing 11 changed files with 143 additions and 80 deletions.
diff --git a/component/pom.xml b/component/pom.xml
@@ -39,8 +39,8 @@
             <artifactId>siddhi-query-api</artifactId>
         </dependency>
         <dependency>
-            <groupId>org.apache.log4j.wso2</groupId>
-            <artifactId>log4j</artifactId>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
         </dependency>
         <dependency>
             <groupId>org.apache.ws.commons.axiom</groupId>

diff --git a/component/src/main/java/io/siddhi/extension/map/xml/sinkmapper/XMLSinkMapper.java b/component/src/main/java/io/siddhi/extension/map/xml/sinkmapper/XMLSinkMapper.java
@@ -31,7 +31,8 @@
 import io.siddhi.core.util.transport.OptionHolder;
 import io.siddhi.core.util.transport.TemplateBuilder;
 import io.siddhi.query.api.definition.StreamDefinition;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.xml.sax.SAXException;
 
 import java.io.ByteArrayInputStream;
@@ -103,7 +104,7 @@
         }
 )
 public class XMLSinkMapper extends SinkMapper {
-    private static final Logger log = Logger.getLogger(XMLSinkMapper.class);
+    private static final Logger log = LogManager.getLogger(XMLSinkMapper.class);
 
     private static final String EVENTS_PARENT_OPENING_TAG = "<events>";
     private static final String EVENTS_PARENT_CLOSING_TAG = "</events>";

diff --git a/component/src/main/java/io/siddhi/extension/map/xml/sourcemapper/XmlSourceMapper.java b/component/src/main/java/io/siddhi/extension/map/xml/sourcemapper/XmlSourceMapper.java
@@ -40,7 +40,8 @@
 import org.apache.axiom.om.OMElement;
 import org.apache.axiom.om.util.AXIOMUtil;
 import org.apache.axiom.om.xpath.AXIOMXPath;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jaxen.JaxenException;
 
 import java.nio.charset.StandardCharsets;
@@ -264,7 +265,7 @@
 )
 public class XmlSourceMapper extends SourceMapper {
 
-    private static final Logger log = Logger.getLogger(XmlSourceMapper.class);
+    private static final Logger log = LogManager.getLogger(XmlSourceMapper.class);
     private static final String PARENT_SELECTOR_XPATH = "enclosing.element";
     private static final String NAMESPACES = "namespaces";
     private static final String EVENTS_PARENT_ELEMENT = "events";

diff --git a/...c/test/java/io/siddhi/extension/map/xml/sinkmapper/XMLSinkMapperWithSiddhiQLTestCase.java b/...c/test/java/io/siddhi/extension/map/xml/sinkmapper/XMLSinkMapperWithSiddhiQLTestCase.java
@@ -25,7 +25,8 @@
 import io.siddhi.core.stream.output.sink.InMemorySink;
 import io.siddhi.core.util.SiddhiTestHelper;
 import io.siddhi.core.util.transport.InMemoryBroker;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.testng.AssertJUnit;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
@@ -35,7 +36,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 public class XMLSinkMapperWithSiddhiQLTestCase {
-    private static final Logger log = Logger.getLogger(XMLSinkMapperWithSiddhiQLTestCase.class);
+    private static final Logger log = LogManager.getLogger(XMLSinkMapperWithSiddhiQLTestCase.class);
     private AtomicInteger wso2Count = new AtomicInteger(0);
     private AtomicInteger ibmCount = new AtomicInteger(0);
     private final int waitTime = 2000;

diff --git a/.../java/io/siddhi/extension/map/xml/sinkmapper/XMLSinkMapperWithSiddhiQueryAPITestCase.java b/.../java/io/siddhi/extension/map/xml/sinkmapper/XMLSinkMapperWithSiddhiQueryAPITestCase.java
@@ -31,7 +31,8 @@
 import io.siddhi.query.api.execution.query.input.stream.InputStream;
 import io.siddhi.query.api.execution.query.selection.Selector;
 import io.siddhi.query.api.expression.Variable;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.testng.AssertJUnit;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
@@ -42,7 +43,7 @@
 
 public class XMLSinkMapperWithSiddhiQueryAPITestCase {
 
-    private static final Logger log = Logger.getLogger(XMLSinkMapperWithSiddhiQueryAPITestCase.class);
+    private static final Logger log = LogManager.getLogger(XMLSinkMapperWithSiddhiQueryAPITestCase.class);
     private AtomicInteger wso2Count = new AtomicInteger(0);
     private AtomicInteger ibmCount = new AtomicInteger(0);
 

diff --git a/.../test/java/io/siddhi/extension/map/xml/sourcemapper/StreamingXMLSourceMapperTestCase.java b/.../test/java/io/siddhi/extension/map/xml/sourcemapper/StreamingXMLSourceMapperTestCase.java
@@ -24,7 +24,8 @@
 import io.siddhi.core.stream.output.StreamCallback;
 import io.siddhi.core.util.EventPrinter;
 import io.siddhi.core.util.transport.InMemoryBroker;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.junit.Assert;
 import org.testng.AssertJUnit;
 import org.testng.annotations.BeforeClass;
@@ -38,7 +39,7 @@
  */
 public class StreamingXMLSourceMapperTestCase {
     private String dirUri;
-    private static final Logger log = Logger.getLogger(StreamingXMLSourceMapperTestCase.class);
+    private static final Logger log = LogManager.getLogger(StreamingXMLSourceMapperTestCase.class);
     private AtomicInteger count = new AtomicInteger();
 
     @BeforeClass

diff --git a/component/src/test/java/io/siddhi/extension/map/xml/sourcemapper/UnitTestAppender.java b/component/src/test/java/io/siddhi/extension/map/xml/sourcemapper/UnitTestAppender.java
@@ -19,27 +19,49 @@
 
 package io.siddhi.extension.map.xml.sourcemapper;
 
-import org.apache.log4j.AppenderSkeleton;
-import org.apache.log4j.spi.LoggingEvent;
+import org.apache.logging.log4j.core.Appender;
+import org.apache.logging.log4j.core.Core;
+import org.apache.logging.log4j.core.Filter;
+import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.appender.AbstractAppender;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginElement;
+import org.apache.logging.log4j.core.config.plugins.PluginFactory;
+import org.mvel2.util.StringAppender;
 
-public class UnitTestAppender extends AppenderSkeleton {
-    private String messages;
+@Plugin(name = "UnitTestAppender",
+        category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE)
+public class UnitTestAppender extends AbstractAppender {
 
-    @Override
-    protected void append(LoggingEvent loggingEvent) {
-        messages = loggingEvent.getRenderedMessage();
-    }
+    private StringAppender messages = new StringAppender();
 
-    @Override
-    public void close() {
+    public UnitTestAppender(String name, Filter filter) {
+
+        super(name, filter, null);
     }
 
-    @Override
-    public boolean requiresLayout() {
-        return false;
+    @PluginFactory
+    public static UnitTestAppender createAppender(
+            @PluginAttribute("name") String name,
+            @PluginElement("Filter") Filter filter) {
+
+        return new UnitTestAppender(name, filter);
     }
 
     public String getMessages() {
-        return messages;
+
+        String results = messages.toString();
+        if (results.isEmpty()) {
+            return null;
+        }
+        return results;
+    }
+
+    @Override
+    public void append(LogEvent event) {
+
+        messages.append(event.getMessage().getFormattedMessage());
     }
+
 }
diff --git a/...onent/src/test/java/io/siddhi/extension/map/xml/sourcemapper/XmlSourceMapperTestCase.java b/...onent/src/test/java/io/siddhi/extension/map/xml/sourcemapper/XmlSourceMapperTestCase.java
@@ -26,7 +26,9 @@
 import io.siddhi.core.util.EventPrinter;
 import io.siddhi.core.util.SiddhiTestHelper;
 import io.siddhi.core.util.transport.InMemoryBroker;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.Level;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.core.Logger;
 import org.testng.Assert;
 import org.testng.AssertJUnit;
 import org.testng.annotations.BeforeMethod;
@@ -36,7 +38,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 public class XmlSourceMapperTestCase {
-    private static Logger log = Logger.getLogger(XmlSourceMapperTestCase.class);
+    private static final Logger log = (Logger) LogManager.getLogger(XmlSourceMapperTestCase.class);
     private AtomicInteger count = new AtomicInteger();
 
     @BeforeMethod
@@ -963,9 +965,11 @@ public void receive(Event[] events) {
     @Test
     public void testXmlInputMappingCustom12() throws Exception {
         log.info("Check incoming XML event");
-        log = Logger.getLogger(XmlSourceMapper.class);
-        UnitTestAppender appender = new UnitTestAppender();
-        log.addAppender(appender);
+        UnitTestAppender appender = new UnitTestAppender("UnitTestAppender", null);
+        final Logger logger = (Logger) LogManager.getRootLogger();
+        logger.setLevel(Level.ALL);
+        logger.addAppender(appender);
+        appender.start();
         String streams = "" +
                 "@App:name('TestSiddhiApp')" +
                 "@source(type='inMemory', topic='stock', @map(type='xml', namespaces = " +
@@ -986,17 +990,21 @@ public void testXmlInputMappingCustom12() throws Exception {
         executionPlanRuntime.start();
         InMemoryBroker.publish("stock", "");
         //assert event count
-        AssertJUnit.assertTrue(appender.getMessages().contains("Hence dropping message chunk"));
+        AssertJUnit.assertTrue(((UnitTestAppender) logger.getAppenders().
+                get("UnitTestAppender")).getMessages().contains("Hence dropping message chunk"));
         executionPlanRuntime.shutdown();
         siddhiManager.shutdown();
+        logger.removeAppender(appender);
     }
 
     @Test
     public void testXmlInputMappingCustom13() throws Exception {
         log.info("Test case for name space format.");
-        log = Logger.getLogger(XmlSourceMapper.class);
-        UnitTestAppender appender = new UnitTestAppender();
-        log.addAppender(appender);
+        UnitTestAppender appender = new UnitTestAppender("UnitTestAppender", null);
+        final Logger logger = (Logger) LogManager.getRootLogger();
+        logger.setLevel(Level.ALL);
+        logger.addAppender(appender);
+        appender.start();
         String streams = "" +
                 "@App:name('TestSiddhiApp')" +
                 "@source(type='inMemory', topic='stock', @map(type='xml', namespaces = " +
@@ -1040,18 +1048,22 @@ public void receive(Event[] events) {
                 "  </stock>" +
                 "</portfolio>");
         //assert event count
-        AssertJUnit.assertTrue(appender.getMessages().contains("Each namespace has to have format"));
+        AssertJUnit.assertTrue(((UnitTestAppender) logger.getAppenders().
+                get("UnitTestAppender")).getMessages().contains("Each namespace has to have format"));
         executionPlanRuntime.shutdown();
         siddhiManager.shutdown();
+        logger.removeAppender(appender);
     }
 
     @Test
     public void testXmlInputMappingCustom15() throws Exception {
         log.info("Test case for If elementObj instanceof OMElement and element.getFirstElement() "
                 + "!= null then check attribute's type not String .");
-        log = Logger.getLogger(XmlSourceMapper.class);
-        UnitTestAppender appender = new UnitTestAppender();
-        log.addAppender(appender);
+        UnitTestAppender appender = new UnitTestAppender("UnitTestAppender", null);
+        final Logger logger = (Logger) LogManager.getRootLogger();
+        logger.setLevel(Level.ALL);
+        logger.addAppender(appender);
+        appender.start();
         String streams = "" +
                 "@App:name('TestSiddhiApp')" +
                 "@source(type='inMemory', topic='stock', @map(type='xml', namespaces = " +
@@ -1081,17 +1093,21 @@ public void testXmlInputMappingCustom15() throws Exception {
                 "</portfolio>");
         //assert event count
         executionPlanRuntime.shutdown();
-        AssertJUnit.assertTrue(appender.getMessages().contains("a leaf element and stream definition is"
+        AssertJUnit.assertTrue(((UnitTestAppender) logger.getAppenders().
+                get("UnitTestAppender")).getMessages().contains("a leaf element and stream definition is"
                 + " not expecting a String attribute"));
         siddhiManager.shutdown();
+        logger.removeAppender(appender);
     }
 
     @Test
     public void testXmlInputMappingCustomForEvents() throws Exception {
         log.info("Test case for if elementObj instanceof OMAttribute but some problem occurred during convert data.");
-        log = Logger.getLogger(XmlSourceMapper.class);
-        UnitTestAppender appender = new UnitTestAppender();
-        log.addAppender(appender);
+        UnitTestAppender appender = new UnitTestAppender("UnitTestAppender", null);
+        final Logger logger = (Logger) LogManager.getRootLogger();
+        logger.setLevel(Level.ALL);
+        logger.addAppender(appender);
+        appender.start();
         String streams = "" +
                 "@App:name('TestSiddhiApp')" +
                 "@source(type='inMemory', topic='stock', @map(type='xml', namespaces = " +
@@ -1120,9 +1136,11 @@ public void testXmlInputMappingCustomForEvents() throws Exception {
                 "  </stock>" +
                 "</portfolio>");
         //assert event count
-        AssertJUnit.assertTrue(appender.getMessages().contains("Error occurred when extracting attribute value"));
+        AssertJUnit.assertTrue(((UnitTestAppender) logger.getAppenders().
+                get("UnitTestAppender")).getMessages().contains("Error occurred when extracting attribute value"));
         executionPlanRuntime.shutdown();
         siddhiManager.shutdown();
+        logger.removeAppender(appender);
     }
 
     @Test(expectedExceptions = SiddhiAppCreationException.class)

diff --git a/component/src/test/resources/log4j.properties b/component/src/test/resources/log4j.properties
diff --git a/component/src/test/resources/log4j2.xml b/component/src/test/resources/log4j2.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ /*
+  ~  * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+  ~  *
+  ~  * WSO2 Inc. 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.
+  ~  */
+  -->
+
+<Configuration status="WARN" packages="io.siddhi.extension.map.xml" >
+    <Appenders>
+        <Console name="ConsoleAppender" target="SYSTEM_OUT"/>
+        <UnitTestAppender name="UnitTestAppender"/>
+    </Appenders>
+    <Loggers>
+        <Root level="DEBUG">
+            <AppenderRef ref="ConsoleAppender" />
+        </Root>
+    </Loggers>
+</Configuration>