Migrate from logback to log4j2 in test-frame

Signed-off-by: David Kornel <kornys@outlook.com>

Author: kornys

pom.xml

@@ -68,7 +68,7 @@
         <maven.compiler.target>17</maven.compiler.target>
 
         <fabric8.version>6.12.0</fabric8.version>
-        <logback.version>1.4.12</logback.version>
+        <log4j.version>2.17.2</log4j.version>
 
         <!--   Build tools' properties     -->
         <spotbugs.version>4.7.3</spotbugs.version>
@@ -172,10 +172,19 @@
             </dependency>
             <!--    Logger      -->
             <dependency>
-                <groupId>ch.qos.logback</groupId>
-                <artifactId>logback-classic</artifactId>
-                <scope>runtime</scope>
-                <version>${logback.version}</version>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-api</artifactId>
+                <version>${log4j.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-core</artifactId>
+                <version>${log4j.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-slf4j-impl</artifactId>
+                <version>${log4j.version}</version>
             </dependency>
         </dependencies>
     </dependencyManagement>

test-frame-common/pom.xml

@@ -85,17 +85,24 @@
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
         </dependency>
-        <!-- Logger -->
-        <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-classic</artifactId>
-            <scope>runtime</scope>
-        </dependency>
         <dependency>
             <groupId>io.fabric8</groupId>
             <artifactId>kubernetes-server-mock</artifactId>
             <scope>test</scope>
         </dependency>
+        <!-- Logger -->
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j-impl</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

test-frame-common/src/main/java/io/skodjob/testframe/LoggerUtils.java

@@ -7,15 +7,15 @@
 import java.util.Collections;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * Utility methods for logging.
  */
 public final class LoggerUtils {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(LoggerUtils.class);
+    private static final Logger LOGGER = LogManager.getLogger(LoggerUtils.class);
     static final String SEPARATOR_CHAR = "#";
 
     /**

test-frame-common/src/main/java/io/skodjob/testframe/TestFrameEnv.java

@@ -14,16 +14,16 @@
 import java.util.Objects;
 import java.util.function.Function;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.yaml.snakeyaml.Yaml;
 
 /**
  * Class which holds environment variables for system tests.
  */
 public final class TestFrameEnv {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(TestFrameEnv.class);
+    private static final Logger LOGGER = LogManager.getLogger(TestFrameEnv.class);
     private static final Map<String, String> VALUES = new HashMap<>();
     private static final Map<String, Object> YAML_DATA = loadConfigurationFile();
 

test-frame-common/src/main/java/io/skodjob/testframe/clients/KubeClient.java

@@ -26,15 +26,15 @@
 import io.skodjob.testframe.TestFrameConstants;
 import io.skodjob.testframe.TestFrameEnv;
 import io.skodjob.testframe.executor.Exec;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * Provides functionality to interact with Kubernetes and OpenShift clusters.
  * This includes creating clients, reading resources from files, and managing kubeconfig for authentication.
  */
 public class KubeClient {
-    private static final Logger LOGGER = LoggerFactory.getLogger(KubeClient.class);
+    private static final Logger LOGGER = LogManager.getLogger(KubeClient.class);
 
 
     private KubernetesClient client;

test-frame-common/src/main/java/io/skodjob/testframe/clients/cmdClient/BaseCmdKubeClient.java

@@ -19,8 +19,8 @@
 import io.skodjob.testframe.clients.KubeClusterException;
 import io.skodjob.testframe.executor.Exec;
 import io.skodjob.testframe.executor.ExecResult;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import static java.lang.String.join;
 import static java.util.Arrays.asList;
@@ -32,7 +32,7 @@
  */
 public abstract class BaseCmdKubeClient<K extends BaseCmdKubeClient<K>> implements KubeCmdClient<K> {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(BaseCmdKubeClient.class);
+    private static final Logger LOGGER = LogManager.getLogger(BaseCmdKubeClient.class);
 
     private static final String CREATE = "create";
     private static final String APPLY = "apply";
@@ -425,7 +425,7 @@ public ExecResult exec(boolean throwError, boolean logToOutput, String... comman
      *
      * @param throwError  Whether to throw errors.
      * @param logToOutput Whether to log the output.
-     * @param timeout timeout in milis
+     * @param timeout     timeout in milis
      * @param command     The command to execute.
      * @return The execution result.
      */

test-frame-common/src/main/java/io/skodjob/testframe/executor/Exec.java

@@ -30,8 +30,8 @@
 
 import io.fabric8.kubernetes.api.model.EnvVar;
 import io.skodjob.testframe.clients.KubeClusterException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import static java.lang.String.join;
 
@@ -40,7 +40,7 @@
  */
 public class Exec {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(Exec.class);
+    private static final Logger LOGGER = LogManager.getLogger(Exec.class);
 
     private static final Pattern ERROR_PATTERN = Pattern.compile("Error from server \\(([a-zA-Z0-9]+)\\):");
     private static final Pattern INVALID_PATTERN = Pattern

test-frame-common/src/main/java/io/skodjob/testframe/listeners/TestVisualSeparatorExtension.java

@@ -5,17 +5,17 @@
 package io.skodjob.testframe.listeners;
 
 import io.skodjob.testframe.LoggerUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.junit.jupiter.api.extension.AfterEachCallback;
 import org.junit.jupiter.api.extension.BeforeEachCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * jUnit5 specific class which listening on test callbacks
  */
 public class TestVisualSeparatorExtension implements BeforeEachCallback, AfterEachCallback {
-    private final Logger logger = LoggerFactory.getLogger(TestVisualSeparatorExtension.class);
+    private final Logger logger = LogManager.getLogger(TestVisualSeparatorExtension.class);
     @Override
     public void beforeEach(ExtensionContext extensionContext) {
         LoggerUtils.logSeparator();

test-frame-common/src/main/java/io/skodjob/testframe/resources/KubeResourceManager.java

@@ -26,9 +26,9 @@
 import io.skodjob.testframe.interfaces.NamespacedResourceType;
 import io.skodjob.testframe.interfaces.ResourceType;
 import io.skodjob.testframe.wait.Wait;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.junit.jupiter.api.extension.ExtensionContext;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -37,7 +37,7 @@
  * Manages Kubernetes resources for testing purposes.
  */
 public class KubeResourceManager {
-    private static final Logger LOGGER = LoggerFactory.getLogger(KubeResourceManager.class);
+    private static final Logger LOGGER = LogManager.getLogger(KubeResourceManager.class);
     private static KubeResourceManager instance;
     private static KubeClient client;
     private static KubeCmdClient<?> kubeCmdClient;

test-frame-common/src/main/java/io/skodjob/testframe/utils/KubeUtils.java

@@ -11,15 +11,15 @@
 import io.skodjob.testframe.TestFrameConstants;
 import io.skodjob.testframe.resources.KubeResourceManager;
 import io.skodjob.testframe.wait.Wait;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * Utility methods for Kubernetes and Openshift clusters.
  */
 public final class KubeUtils {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(KubeUtils.class);
+    private static final Logger LOGGER = LogManager.getLogger(KubeUtils.class);
 
     private KubeUtils() {
     }

test-frame-common/src/main/java/io/skodjob/testframe/utils/TestFrameUtils.java

@@ -12,16 +12,16 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.exc.InvalidFormatException;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * Utility methods for TestFrame.
  */
 @SuppressWarnings({"checkstyle:ClassFanOutComplexity"})
 public final class TestFrameUtils {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(TestFrameUtils.class);
+    private static final Logger LOGGER = LogManager.getLogger(TestFrameUtils.class);
 
     /**
      * Default timeout for asynchronous tests.

test-frame-common/src/main/java/io/skodjob/testframe/wait/Wait.java

@@ -16,14 +16,14 @@
 import java.util.concurrent.TimeoutException;
 import java.util.function.BooleanSupplier;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 /**
  * Wait utils
  */
 public class Wait {
-    private static final Logger LOGGER = LoggerFactory.getLogger(Wait.class);
+    private static final Logger LOGGER = LogManager.getLogger(Wait.class);
 
     /**
      * For every poll (happening once each {@code pollIntervalMs}) checks if supplier {@code ready} is true.

test-frame-common/src/main/resources/log4j2.properties

@@ -0,0 +1,28 @@
+name = TFConfig
+
+appender.console.type = Console
+appender.console.name = STDOUT
+appender.console.layout.type = PatternLayout
+appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss}{GMT} [%thread] %highlight{%-5p} [%c{1}:%L] %m%n
+
+appender.rolling.type = RollingFile
+appender.rolling.name = RollingFile
+appender.rolling.fileName = ${env:TEST_LOG_DIR:-target/logs}/tf-debug-${env:BUILD_ID:-0}.log
+appender.rolling.filePattern = ${env:TEST_LOG_DIR:-target/logs}/tf-debug-%d{yyyy-MM-dd-HH-mm-ss}-%i.log.gz
+appender.rolling.policies.type = Policies
+appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
+appender.rolling.policies.size.size=100MB
+appender.rolling.strategy.type = DefaultRolloverStrategy
+appender.rolling.strategy.max = 5
+appender.rolling.layout.type = PatternLayout
+appender.rolling.layout.pattern=%d{yyyy-MM-dd HH:mm:ss}{GMT} %-5p [%c{1}:%L] %m%n
+
+rootLogger.level = ${env:TEST_ROOT_LOG_LEVEL:-DEBUG}
+rootLogger.appenderRef.console.ref = STDOUT
+rootLogger.appenderRef.console.level = ${env:TEST_LOG_LEVEL:-INFO}
+rootLogger.appenderRef.rolling.ref = RollingFile
+rootLogger.appenderRef.rolling.level = DEBUG
+rootLogger.additivity = false
+
+logger.fabric8.name = io.fabric8.kubernetes.client
+logger.fabric8.level = OFF

test-frame-common/src/main/resources/logback.xml

@@ -83,9 +83,16 @@
         </dependency>
         <!-- Logger -->
         <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-classic</artifactId>
-            <scope>test</scope>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j-impl</artifactId>
         </dependency>
     </dependencies>