Migrate log4j-slf4j-impl to JUnit 5

log4j-slf4j-impl/pom.xml

@@ -109,11 +109,6 @@
       <artifactId>junit-jupiter-engine</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.junit.vintage</groupId>
-      <artifactId>junit-vintage-engine</artifactId>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
   <build>
     <plugins>

log4j-slf4j-impl/src/test/java/org/apache/logging/other/pkg/LoggerContextAnchorTest.java

@@ -16,15 +16,15 @@
  */
 package org.apache.logging.other.pkg;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.status.StatusData;
 import org.apache.logging.log4j.status.StatusListener;
 import org.apache.logging.log4j.status.StatusLogger;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.slf4j.LoggerFactory;
 
 /**

log4j-slf4j-impl/src/test/java/org/apache/logging/slf4j/CallerInformationTest.java

@@ -16,51 +16,46 @@
  */
 package org.apache.logging.slf4j;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.util.List;
 import org.apache.logging.log4j.core.test.appender.ListAppender;
-import org.apache.logging.log4j.core.test.junit.LoggerContextRule;
-import org.junit.ClassRule;
-import org.junit.Test;
+import org.apache.logging.log4j.core.test.junit.LoggerContextSource;
+import org.apache.logging.log4j.core.test.junit.Named;
+import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@LoggerContextSource("log4j2-calling-class.xml")
 public class CallerInformationTest {
 
-    // config from log4j-core test-jar
-    private static final String CONFIG = "log4j2-calling-class.xml";
-
-    @ClassRule
-    public static final LoggerContextRule ctx = new LoggerContextRule(CONFIG);
-
     @Test
-    public void testClassLogger() throws Exception {
-        final ListAppender app = ctx.getListAppender("Class").clear();
+    public void testClassLogger(@Named("Class") final ListAppender app) throws Exception {
+        app.clear();
         final Logger logger = LoggerFactory.getLogger("ClassLogger");
         logger.info("Ignored message contents.");
         logger.warn("Verifying the caller class is still correct.");
         logger.error("Hopefully nobody breaks me!");
         final List<String> messages = app.getMessages();
-        assertEquals("Incorrect number of messages.", 3, messages.size());
+        assertEquals(3, messages.size(), "Incorrect number of messages.");
         for (final String message : messages) {
-            assertEquals("Incorrect caller class name.", this.getClass().getName(), message);
+            assertEquals(this.getClass().getName(), message, "Incorrect caller class name.");
         }
     }
 
     @Test
-    public void testMethodLogger() throws Exception {
-        final ListAppender app = ctx.getListAppender("Method").clear();
+    public void testMethodLogger(@Named("Method") final ListAppender app) throws Exception {
+        app.clear();
         final Logger logger = LoggerFactory.getLogger("MethodLogger");
         logger.info("More messages.");
         logger.warn("CATASTROPHE INCOMING!");
         logger.error("ZOMBIES!!!");
         logger.warn("brains~~~");
         logger.info("Itchy. Tasty.");
         final List<String> messages = app.getMessages();
-        assertEquals("Incorrect number of messages.", 5, messages.size());
+        assertEquals(5, messages.size(), "Incorrect number of messages.");
         for (final String message : messages) {
-            assertEquals("Incorrect caller method name.", "testMethodLogger", message);
+            assertEquals("testMethodLogger", message, "Incorrect caller method name.");
         }
     }
 }

log4j-slf4j-impl/src/test/java/org/apache/logging/slf4j/Log4j1222Test.java

@@ -16,9 +16,9 @@
  */
 package org.apache.logging.slf4j;
 
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -47,7 +47,10 @@ public void run() {
 
         private void trigger() {
             Holder.LOGGER.info("Attempt to trigger");
-            assertTrue("Logger is of type " + Holder.LOGGER.getClass().getName(), Holder.LOGGER instanceof Log4jLogger);
+            assertInstanceOf(
+                    Log4jLogger.class,
+                    Holder.LOGGER,
+                    "Logger is of type " + Holder.LOGGER.getClass().getName());
         }
     }
 }

log4j-slf4j-impl/src/test/java/org/apache/logging/slf4j/Log4jMarkerTest.java

@@ -16,17 +16,19 @@
  */
 package org.apache.logging.slf4j;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
 import org.apache.logging.log4j.Marker;
 import org.apache.logging.log4j.MarkerManager;
-import org.junit.Assert;
-import org.junit.BeforeClass;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
 
 public class Log4jMarkerTest {
 
     private static Log4jMarkerFactory markerFactory;
 
-    @BeforeClass
+    @BeforeAll
     public static void startup() {
         markerFactory = ((Log4jLoggerFactory) org.slf4j.LoggerFactory.getILoggerFactory()).getMarkerFactory();
     }
@@ -38,9 +40,9 @@ public void testEquals() {
         final Log4jMarker marker1 = new Log4jMarker(markerFactory, markerA);
         final Log4jMarker marker2 = new Log4jMarker(markerFactory, markerA);
         final Log4jMarker marker3 = new Log4jMarker(markerFactory, markerB);
-        Assert.assertEquals(marker1, marker2);
-        Assert.assertNotEquals(marker1, null);
-        Assert.assertNotEquals(null, marker1);
-        Assert.assertNotEquals(marker1, marker3);
+        assertEquals(marker1, marker2);
+        assertNotEquals(marker1, null);
+        assertNotEquals(null, marker1);
+        assertNotEquals(marker1, marker3);
     }
 }

log4j-slf4j-impl/src/test/java/org/apache/logging/slf4j/LoggerContextTest.java

@@ -16,12 +16,13 @@
  */
 package org.apache.logging.slf4j;
 
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.util.Set;
 import org.apache.logging.log4j.core.LifeCycle;
 import org.apache.logging.log4j.spi.LoggerContext;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.slf4j.LoggerFactory;
 
 /**
@@ -35,9 +36,9 @@ public void testCleanup() throws Exception {
         factory.getLogger("test");
         Set<LoggerContext> set = factory.getLoggerContexts();
         final LoggerContext ctx1 = set.toArray(LoggerContext.EMPTY_ARRAY)[0];
-        assertTrue("LoggerContext is not enabled for shutdown", ctx1 instanceof LifeCycle);
+        assertInstanceOf(LifeCycle.class, ctx1, "LoggerContext is not enabled for shutdown");
         ((LifeCycle) ctx1).stop();
         set = factory.getLoggerContexts();
-        assertTrue("Expected no LoggerContexts", set.isEmpty());
+        assertTrue(set.isEmpty(), "Expected no LoggerContexts");
     }
 }

log4j-slf4j-impl/src/test/java/org/apache/logging/slf4j/LoggerTest.java

@@ -16,18 +16,19 @@
  */
 package org.apache.logging.slf4j;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import java.util.List;
 import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.LoggerContext;
 import org.apache.logging.log4j.core.test.appender.ListAppender;
-import org.apache.logging.log4j.core.test.junit.LoggerContextRule;
+import org.apache.logging.log4j.core.test.junit.LoggerContextSource;
+import org.apache.logging.log4j.core.test.junit.Named;
 import org.apache.logging.log4j.util.Strings;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.ClassRule;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
@@ -37,14 +38,16 @@
 /**
  *
  */
+@LoggerContextSource("log4j-test1.xml")
 public class LoggerTest {
 
-    private static final String CONFIG = "log4j-test1.xml";
+    private final Logger logger;
+    private final LoggerContext ctx;
 
-    @ClassRule
-    public static LoggerContextRule ctx = new LoggerContextRule(CONFIG);
-
-    Logger logger = LoggerFactory.getLogger("LoggerTest");
+    public LoggerTest(final LoggerContext context) {
+        this.ctx = context;
+        this.logger = LoggerFactory.getLogger("LoggerTest");
+    }
 
     @Test
     public void debug() {
@@ -93,7 +96,7 @@ public void supportsCustomSLF4JMarkers() {
     @Test
     public void testRootLogger() {
         final Logger l = LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
-        assertNotNull("No Root Logger", l);
+        assertNotNull(l, "No Root Logger");
         assertEquals(Logger.ROOT_LOGGER_NAME, l.getName());
     }
 
@@ -138,34 +141,35 @@ public void testThrowable() {
     }
 
     private ListAppender getAppenderByName(final String name) {
-        final ListAppender listApp = ctx.getListAppender(name);
-        assertNotNull("Missing Appender", listApp);
+        final ListAppender listApp = ctx.getConfiguration().getAppender(name);
+        assertNotNull(listApp, "Missing Appender");
         return listApp;
     }
 
     private void verify(final String expected) {
         final ListAppender listApp = getAppenderByName("List");
         final List<String> events = listApp.getMessages();
-        assertEquals("Incorrect number of messages. Expected 1 Actual " + events.size(), 1, events.size());
+        assertEquals(1, events.size(), "Incorrect number of messages. Expected 1 Actual " + events.size());
         final String actual = events.get(0);
-        assertEquals("Incorrect message. Expected " + expected + ". Actual " + actual, expected, actual);
+        assertEquals(expected, actual, "Incorrect message. Expected " + expected + ". Actual " + actual);
         listApp.clear();
     }
 
     private void verifyThrowable(final Throwable expected) {
         final ListAppender listApp = getAppenderByName("UnformattedList");
         final List<LogEvent> events = listApp.getEvents();
-        assertEquals("Incorrect number of messages", 1, events.size());
+        assertEquals(1, events.size(), "Incorrect number of messages");
         final LogEvent actual = events.get(0);
-        assertEquals("Incorrect throwable.", expected, actual.getThrown());
+        assertEquals(expected, actual.getThrown(), "Incorrect throwable.");
         listApp.clear();
     }
 
-    @Before
-    @After
-    public void cleanup() {
+    @BeforeEach
+    @AfterEach
+    public void cleanup(
+            @Named("List") final ListAppender list, @Named("UnformattedList") final ListAppender unformattedList) {
         MDC.clear();
-        ctx.getListAppender("List").clear();
-        ctx.getListAppender("UnformattedList").clear();
+        list.clear();
+        unformattedList.clear();
     }
 }