Skip to content

Refactor tests to use Mockito for mocking and assertions #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slachiewicz merged 1 commit into from
Jan 1, 2026
Merged

Refactor tests to use Mockito for mocking and assertions #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,11 +227,6 @@ under the License.
<artifactId>commons-io</artifactId>
<version>2.21.0</version>
</dependency>
<dependency>
<groupId>org.easymock</groupId>
<artifactId>easymock</artifactId>
<version>5.6.0</version>
</dependency>

<dependency>
<groupId>org.eclipse.jetty.aggregate</groupId>
Expand Down
6 changes: 3 additions & 3 deletions wagon-provider-api/src/test/java/org/apache/maven/wagon/StreamWagonTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public void fillInputData(InputData inputData) {
} finally {
wagon.disconnect();
}
verify(listener, times(1)).transferInitiated(any(TransferEvent.class));
verify(listener).transferInitiated(any(TransferEvent.class));
verify(listener, never()).transferStarted(any(TransferEvent.class));
verify(listener, never()).transferCompleted(any(TransferEvent.class));
}
Expand Down Expand Up @@ -127,7 +127,7 @@ public void fillOutputData(OutputData inputData) {
} finally {
wagon.disconnect();
}
verify(listener, times(1)).transferInitiated(any(TransferEvent.class));
verify(listener).transferInitiated(any(TransferEvent.class));
verify(listener, never()).transferStarted(any(TransferEvent.class));
verify(listener, never()).transferCompleted(any(TransferEvent.class));
}
Expand Down Expand Up @@ -212,7 +212,7 @@ public void fillInputData(InputData inputData)
} finally {
wagon.disconnect();
}
verify(listener, times(1)).transferInitiated(any(TransferEvent.class));
verify(listener).transferInitiated(any(TransferEvent.class));
}

@Test
Expand Down
4 changes: 2 additions & 2 deletions wagon-provider-test/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ under the License.
<artifactId>plexus-utils</artifactId>
</dependency>
<dependency>
<groupId>org.easymock</groupId>
<artifactId>easymock</artifactId>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
Expand Down
4 changes: 2 additions & 2 deletions wagon-provider-test/src/main/java/org/apache/maven/wagon/StreamingWagonTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ private int putStream() throws Exception {

disconnectWagon(wagon);

verifyMock(progressAnswer, content.length());
assertEquals(content.length(), progressAnswer.getSize());
return content.length();
}

Expand Down Expand Up @@ -261,6 +261,6 @@ private void getStream(int expectedSize) throws Exception {

disconnectWagon(wagon);

verifyMock(progressAnswer, expectedSize);
assertEquals(expectedSize, progressAnswer.getSize());
}
}
92 changes: 32 additions & 60 deletions wagon-provider-test/src/main/java/org/apache/maven/wagon/WagonTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,33 +39,29 @@
import org.apache.maven.wagon.resource.Resource;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
import org.easymock.IAnswer;
import org.junit.Assume;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.easymock.EasyMock.anyInt;
import static org.easymock.EasyMock.anyObject;
import static org.easymock.EasyMock.anyString;
import static org.easymock.EasyMock.createMock;
import static org.easymock.EasyMock.eq;
import static org.easymock.EasyMock.expectLastCall;
import static org.easymock.EasyMock.getCurrentArguments;
import static org.easymock.EasyMock.replay;
import static org.easymock.EasyMock.reset;
import static org.easymock.EasyMock.verify;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;

/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
*/
public abstract class WagonTestCase extends PlexusTestCase {
protected static Logger logger = LoggerFactory.getLogger(WagonTestCase.class);

static final class ProgressAnswer implements IAnswer {
static final class ProgressAnswer implements Answer<Object> {
private int size;

public Object answer() throws Throwable {
int length = (Integer) getCurrentArguments()[2];
public Object answer(InvocationOnMock invocation) {
int length = invocation.getArgument(2);
size += length;
return null;
}
Expand Down Expand Up @@ -110,7 +106,7 @@ public int getSize() {
protected void setUp() throws Exception {
checksumObserver = new ChecksumObserver();

mockTransferListener = createMock(TransferListener.class);
mockTransferListener = mock(TransferListener.class);

super.setUp();
}
Expand Down Expand Up @@ -315,7 +311,7 @@ protected ProgressAnswer setupGetIfNewerTest(Wagon wagon, boolean expectedResult
protected void assertGetIfNewerTest(ProgressAnswer progressAnswer, boolean expectedResult, int expectedSize)
throws IOException {
if (expectedResult) {
verifyMock(progressAnswer, expectedSize);
assertEquals(expectedSize, progressAnswer.getSize());

assertNotNull("check checksum is not null", checksumObserver.getActualChecksum());

Expand All @@ -329,10 +325,6 @@ protected void assertGetIfNewerTest(ProgressAnswer progressAnswer, boolean expec
String destContent = FileUtils.fileRead(destFile);
assertEquals(sourceContent, destContent);
} else {
verify(mockTransferListener);

reset(mockTransferListener);

assertNull("check checksum is null", checksumObserver.getActualChecksum());

assertFalse(destFile.exists());
Expand All @@ -349,11 +341,6 @@ private void replaceMockForSkippedGetIfNewer(Wagon wagon, int expectedSize) {
// TODO: transfer skipped event?
// mockTransferListener.transferSkipped( createTransferEvent( wagon, resource, TransferEvent.TRANSFER_STARTED,
// TransferEvent.REQUEST_GET, destFile ) );

mockTransferListener.debug(anyString());
expectLastCall().anyTimes();

replay(mockTransferListener);
}

public void testWagonPutDirectory() throws Exception {
Expand Down Expand Up @@ -802,7 +789,7 @@ protected void putFile(String resourceName, String testFileName, String content)

disconnectWagon(wagon);

verifyMock(progressAnswer, content.length());
assertEquals(content.length(), progressAnswer.getSize());
}

protected ProgressAnswer replayMockForPut(String resourceName, String content, Wagon wagon) {
Expand All @@ -814,21 +801,22 @@ protected ProgressAnswer replayMockForPut(String resourceName, String content, W
resource.setLastModified(sourceFile.lastModified());
mockTransferListener.transferStarted(createTransferEvent(
wagon, resource, TransferEvent.TRANSFER_STARTED, TransferEvent.REQUEST_PUT, sourceFile));
mockTransferListener.transferProgress(
eq(createTransferEvent(
wagon, resource, TransferEvent.TRANSFER_PROGRESS, TransferEvent.REQUEST_PUT, sourceFile)),
anyObject(byte[].class),
anyInt());
ProgressAnswer progressAnswer = new ProgressAnswer();
expectLastCall().andStubAnswer(progressAnswer);

mockTransferListener.debug(anyString());
expectLastCall().anyTimes();
doAnswer(progressAnswer)
.when(mockTransferListener)
.transferProgress(
eq(createTransferEvent(
wagon,
resource,
TransferEvent.TRANSFER_PROGRESS,
TransferEvent.REQUEST_PUT,
sourceFile)),
any(byte[].class),
anyInt());

mockTransferListener.transferCompleted(createTransferEvent(
wagon, resource, TransferEvent.TRANSFER_COMPLETED, TransferEvent.REQUEST_PUT, sourceFile));

replay(mockTransferListener);
return progressAnswer;
}

Expand Down Expand Up @@ -861,15 +849,7 @@ protected void getFile(int expectedSize) throws Exception {

disconnectWagon(wagon);

verifyMock(progressAnswer, expectedSize);
}

protected void verifyMock(ProgressAnswer progressAnswer, int length) {
verify(mockTransferListener);

assertEquals(length, progressAnswer.getSize());

reset(mockTransferListener);
assertEquals(expectedSize, progressAnswer.getSize());
}

protected void disconnectWagon(Wagon wagon) throws ConnectionException {
Expand Down Expand Up @@ -907,26 +887,18 @@ protected ProgressAnswer replaceMockForGet(Wagon wagon, int expectedSize) {
TransferEvent te =
createTransferEvent(wagon, resource, TransferEvent.TRANSFER_STARTED, TransferEvent.REQUEST_GET, null);
mockTransferListener.transferStarted(te);
mockTransferListener.transferProgress(
eq(new TransferEvent(wagon, resource, TransferEvent.TRANSFER_PROGRESS, TransferEvent.REQUEST_GET)),
anyObject(byte[].class),
anyInt());

ProgressAnswer progressAnswer = new ProgressAnswer();

if (assertOnTransferProgress()) {
expectLastCall().andAnswer(progressAnswer);
} else {
expectLastCall().andAnswer(progressAnswer);
expectLastCall().anyTimes();
}
mockTransferListener.debug(anyString());
expectLastCall().anyTimes();
doAnswer(progressAnswer)
.when(mockTransferListener)
.transferProgress(
eq(new TransferEvent(
wagon, resource, TransferEvent.TRANSFER_PROGRESS, TransferEvent.REQUEST_GET)),
any(byte[].class),
anyInt());

mockTransferListener.transferCompleted(createTransferEvent(
wagon, resource, TransferEvent.TRANSFER_COMPLETED, TransferEvent.REQUEST_GET, destFile));

replay(mockTransferListener);
return progressAnswer;
}

Expand Down