Migrate unit tests to Mockito 2.x

This commit completely migrates from EasyMock to Mockito 2.x. Unit tests
have been updated to use the BDD-style of Mockito's API
(given/when/then). Various test cleanups were also included during the
migration.

Related to LOG4J2-1646.

Author: jvz

log4j-core/pom.xml

@@ -203,8 +203,8 @@
     </dependency>
     <!-- Mocking framework for use with JUnit -->
     <dependency>
-      <groupId>org.easymock</groupId>
-      <artifactId>easymock</artifactId>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
       <scope>test</scope>
     </dependency>
     <!-- Embedded JDBC drivers for database appender tests -->

log4j-core/src/test/java/org/apache/logging/log4j/core/appender/ConsoleAppenderTest.java

@@ -27,22 +27,25 @@
 import org.apache.logging.log4j.core.layout.PatternLayout;
 import org.apache.logging.log4j.message.SimpleMessage;
 import org.apache.logging.log4j.util.Strings;
-import org.easymock.EasyMockSupport;
 import org.junit.AfterClass;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.easymock.EasyMock.anyInt;
-import static org.easymock.EasyMock.anyObject;
-import static org.easymock.EasyMock.expectLastCall;
 import static org.junit.Assert.*;
-
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyInt;
+import static org.mockito.BDDMockito.then;
+import static org.mockito.Mockito.atLeastOnce;
 
 /**
  *
  */
+@RunWith(MockitoJUnitRunner.class)
 public class ConsoleAppenderTest {
 
     private static final String LOG4J_SKIP_JANSI = "log4j.skipJansi";
@@ -59,15 +62,12 @@ public static void beforeClass() {
 
     ByteArrayOutputStream baos;
 
-    EasyMockSupport mocks;
-
+    @Mock
     PrintStream psMock;
 
     @Before
     public void before() {
         System.setProperty(LOG4J_SKIP_JANSI, "true");
-        mocks = new EasyMockSupport();
-        psMock = mocks.createMock("psMock", PrintStream.class);
         baos = new ByteArrayOutputStream();
     }
 
@@ -90,12 +90,6 @@ void systemSet(final PrintStream printStream) {
 
     private void testConsoleStreamManagerDoesNotClose(final PrintStream ps, final Target targetName, final SystemSetter systemSetter) {
         try {
-            psMock.write((byte[]) anyObject(), anyInt(), anyInt());
-            expectLastCall().anyTimes();
-            psMock.flush();
-            expectLastCall().anyTimes();
-
-            mocks.replayAll();
             systemSetter.systemSet(psMock);
             final Layout<String> layout = PatternLayout.newBuilder().withAlwaysWriteExceptions(true).build();
             final ConsoleAppender app = ConsoleAppender.newBuilder().withLayout(layout).setTarget(targetName)
@@ -116,7 +110,8 @@ private void testConsoleStreamManagerDoesNotClose(final PrintStream ps, final Ta
         } finally {
             systemSetter.systemSet(ps);
         }
-        mocks.verifyAll();
+        then(psMock).should(atLeastOnce()).write(any(byte[].class), anyInt(), anyInt());
+        then(psMock).should(atLeastOnce()).flush();
     }
 
     @Test

log4j-core/src/test/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseAppenderTest.java

@@ -16,138 +16,94 @@
  */
 package org.apache.logging.log4j.core.appender.db;
 
+import java.util.concurrent.TimeUnit;
+
 import org.apache.logging.log4j.core.Filter;
 import org.apache.logging.log4j.core.LogEvent;
-import org.junit.After;
 import org.junit.Test;
-
-import static org.easymock.EasyMock.*;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
 
 import static org.junit.Assert.*;
+import static org.mockito.ArgumentMatchers.same;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.BDDMockito.then;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.reset;
 
+@RunWith(MockitoJUnitRunner.class)
 public class AbstractDatabaseAppenderTest {
     private LocalAbstractDatabaseAppender appender;
+    @Mock
     private LocalAbstractDatabaseManager manager;
 
     public void setUp(final String name) {
-        this.manager = createMockBuilder(LocalAbstractDatabaseManager.class)
-                .withConstructor(String.class, int.class)
-                .withArgs(name, 0)
-                .addMockedMethod("close")
-                .createStrictMock();
-
-        this.appender = createMockBuilder(LocalAbstractDatabaseAppender.class)
-                .withConstructor(String.class, Filter.class, boolean.class, LocalAbstractDatabaseManager.class)
-                .withArgs(name, null, true, this.manager)
-                .createStrictMock();
-    }
-
-    @After
-    public void tearDown() {
-        verify(this.manager, this.appender);
+        appender = new LocalAbstractDatabaseAppender(name, null, true, manager);
     }
 
     @Test
     public void testNameAndGetLayout01() {
-        this.setUp("testName01");
+        setUp("testName01");
 
-        replay(this.manager, this.appender);
-
-        assertEquals("The name is not correct.", "testName01", this.appender.getName());
-        assertNull("The layout should always be null.", this.appender.getLayout());
+        assertEquals("The name is not correct.", "testName01", appender.getName());
+        assertNull("The layout should always be null.", appender.getLayout());
     }
 
     @Test
     public void testNameAndGetLayout02() {
-        this.setUp("anotherName02");
-
-        replay(this.manager, this.appender);
+        setUp("anotherName02");
 
-        assertEquals("The name is not correct.", "anotherName02", this.appender.getName());
-        assertNull("The layout should always be null.", this.appender.getLayout());
+        assertEquals("The name is not correct.", "anotherName02", appender.getName());
+        assertNull("The layout should always be null.", appender.getLayout());
     }
 
     @Test
     public void testStartAndStop() throws Exception {
-        this.setUp("name");
-
-        this.manager.startupInternal();
-        expectLastCall();
-        replay(this.manager, this.appender);
-
-        this.appender.start();
+        setUp("name");
 
-        verify(this.manager, this.appender);
-        reset(this.manager, this.appender);
-        this.manager.shutdownInternal();
-        expectLastCall().andReturn(Boolean.TRUE);
-        replay(this.manager, this.appender);
+        appender.start();
+        then(manager).should().startupInternal();
 
-        this.appender.stop();
+        appender.stop();
+        then(manager).should().stop(0L, TimeUnit.MILLISECONDS);
     }
 
     @Test
     public void testReplaceManager() throws Exception {
-        this.setUp("name");
+        setUp("name");
 
-        replay(this.manager, this.appender);
+        final LocalAbstractDatabaseManager oldManager = appender.getManager();
+        assertSame("The manager should be the same.", manager, oldManager);
 
-        final LocalAbstractDatabaseManager manager = this.appender.getManager();
+        final LocalAbstractDatabaseManager newManager = mock(LocalAbstractDatabaseManager.class);
+        appender.replaceManager(newManager);
+        then(manager).should().close();
+        then(newManager).should().startupInternal();
 
-        assertSame("The manager should be the same.", this.manager, manager);
+        appender.stop();
+        then(newManager).should().stop(0L, TimeUnit.MILLISECONDS);
+    }
 
-        verify(this.manager, this.appender);
-        reset(this.manager, this.appender);
-        this.manager.close();
-        expectLastCall();
-        final LocalAbstractDatabaseManager newManager = createMockBuilder(LocalAbstractDatabaseManager.class)
-                .withConstructor(String.class, int.class).withArgs("name", 0).addMockedMethod("close")
-                .createStrictMock();
-        newManager.startupInternal();
-        expectLastCall();
-        replay(this.manager, this.appender, newManager);
+    @Test
+    public void testAppend() {
+        setUp("name");
+        given(manager.commitAndClose()).willReturn(true);
 
-        this.appender.replaceManager(newManager);
+        final LogEvent event1 = mock(LogEvent.class);
+        final LogEvent event2 = mock(LogEvent.class);
 
-        verify(this.manager, this.appender, newManager);
-        reset(this.manager, this.appender, newManager);
-        newManager.shutdownInternal();
-        expectLastCall().andReturn(Boolean.TRUE);
-        replay(this.manager, this.appender, newManager);
+        appender.append(event1);
+        then(manager).should().connectAndStart();
+        then(manager).should().writeInternal(same(event1));
+        then(manager).should().commitAndClose();
 
-        this.appender.stop();
+        reset(manager);
 
-        verify(newManager);
-    }
-
-    @Test
-    public void testAppend() {
-        this.setUp("name");
-
-        final LogEvent event1 = createStrictMock(LogEvent.class);
-        final LogEvent event2 = createStrictMock(LogEvent.class);
-
-        this.manager.connectAndStart();
-        expectLastCall();
-        this.manager.writeInternal(same(event1));
-        expectLastCall();
-        this.manager.commitAndClose();
-        expectLastCall().andReturn(Boolean.TRUE);
-        replay(this.manager, this.appender);
-
-        this.appender.append(event1);
-
-        verify(this.manager, this.appender);
-        reset(this.manager, this.appender);
-        this.manager.connectAndStart();
-        expectLastCall();
-        this.manager.writeInternal(same(event2));
-        expectLastCall();
-        this.manager.commitAndClose();
-        expectLastCall().andReturn(Boolean.TRUE);
-        replay(this.manager, this.appender);
-
-        this.appender.append(event2);
+        appender.append(event2);
+        then(manager).should().connectAndStart();
+        then(manager).should().writeInternal(same(event2));
+        then(manager).should().commitAndClose();
     }
 
     private static abstract class LocalAbstractDatabaseManager extends AbstractDatabaseManager {
@@ -156,8 +112,7 @@ public LocalAbstractDatabaseManager(final String name, final int bufferSize) {
         }
     }
 
-    private static abstract class LocalAbstractDatabaseAppender extends
-            AbstractDatabaseAppender<LocalAbstractDatabaseManager> {
+    private static class LocalAbstractDatabaseAppender extends AbstractDatabaseAppender<LocalAbstractDatabaseManager> {
 
         public LocalAbstractDatabaseAppender(final String name, final Filter filter, final boolean exceptionSuppressed,
                                              final LocalAbstractDatabaseManager manager) {