refactor: Migrate to JUnit 5 (#483)

* Use JUnit 5 dependency * Fix warnings raised by IntelliJ * Use JUnit5 assertions
Vonage · Sep 28, 2023 · 9e13fcd · 9e13fcd
1 parent 76e3150
commit 9e13fcd
Show file tree

Hide file tree

Showing 186 changed files with 517 additions and 625 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Deprecated public internal request classes in Account API
 - Internal refactoring of Verify v1 and Account API implementations
 - Added `/v1` to Meetings API endpoint URL paths
+- Migrated assertions and test dependencies to JUnit 5
 
 # [7.8.0] - 2023-09-07
 - Added capability to configure request timeouts (default is 60 seconds)

diff --git a/build.gradle b/build.gradle
@@ -34,7 +34,8 @@ dependencies {
     implementation 'io.openapitools.jackson.dataformat:jackson-dataformat-hal:1.0.9'
     implementation 'com.vonage:jwt:1.0.2'
 
-    testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'
+    testImplementation 'org.junit.vintage:junit-vintage-engine:5.10.0'
     testImplementation 'org.mockito:mockito-inline:4.11.0'
     testImplementation 'jakarta.servlet:jakarta.servlet-api:4.0.4'
 }

diff --git a/src/test/java/com/vonage/client/AbstractMethodTest.java b/src/test/java/com/vonage/client/AbstractMethodTest.java
@@ -32,9 +32,8 @@
 import org.apache.http.entity.StringEntity;
 import org.apache.http.message.BasicHttpResponse;
 import org.apache.http.message.BasicStatusLine;
-import static org.junit.Assert.*;
-import org.junit.Before;
-import org.junit.Test;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.*;
 import org.mockito.ArgumentCaptor;
 import static org.mockito.Mockito.*;
 import java.io.*;
@@ -48,10 +47,6 @@
 
 public class AbstractMethodTest {
 
-    static {
-        TestUtils.mockStaticLoggingUtils();
-    }
-
     private static class ConcreteMethod extends AbstractMethod<String, String> {
         public ConcreteMethod(HttpWrapper httpWrapper) {
             super(httpWrapper);
@@ -95,15 +90,15 @@ static String getEntityContentsAsString(HttpEntity entity) throws IOException {
     private HttpClient mockHttpClient;
     private AuthCollection mockAuthMethods;
     private AuthMethod mockAuthMethod;
-    private HttpResponse basicResponse = new BasicHttpResponse(
+    private final HttpResponse basicResponse = new BasicHttpResponse(
             new BasicStatusLine(
                     new ProtocolVersion("1.1", 1, 1),
                     200,
                     "OK"
             )
     );
 
-    @Before
+    @BeforeEach
     public void setUp() throws Exception {
         mockWrapper = mock(HttpWrapper.class);
         mockAuthMethods = mock(AuthCollection.class);

diff --git a/src/test/java/com/vonage/client/ClientTest.java b/src/test/java/com/vonage/client/ClientTest.java
@@ -23,8 +23,8 @@
 import org.apache.http.StatusLine;
 import org.apache.http.client.HttpClient;
 import org.apache.http.client.methods.HttpUriRequest;
-import static org.junit.Assert.*;
-import org.junit.function.ThrowingRunnable;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.function.Executable;
 import static org.mockito.Mockito.*;
 import java.io.ByteArrayInputStream;
 import java.io.InputStream;
@@ -35,8 +35,9 @@
 import java.util.function.Supplier;
 
 public abstract class ClientTest<T> {
-    protected String applicationId = UUID.randomUUID().toString();
-    protected String apiKey = "a1b2c3d4", apiSecret = "1234567890abcdef";
+    protected final String applicationId = UUID.randomUUID().toString();
+    protected final String apiKey = "a1b2c3d4";
+    protected final String apiSecret = "1234567890abcdef";
     protected HttpWrapper wrapper;
     protected T client;
 
@@ -83,24 +84,24 @@ protected void stubResponse(int code) throws Exception {
         wrapper.setHttpClient(stubHttpClient(code));
     }
 
-    protected void stubResponseAndAssertThrows(ThrowingRunnable invocation,
+    protected void stubResponseAndAssertThrows(Executable invocation,
                                                Class<? extends Exception> exceptionClass) throws Exception {
         stubResponseAndAssertThrows(200, invocation, exceptionClass);
     }
 
-    protected void stubResponseAndAssertThrows(int statusCode, ThrowingRunnable invocation,
+    protected void stubResponseAndAssertThrows(int statusCode, Executable invocation,
                                                Class<? extends Exception> exceptionClass) throws Exception {
         stubResponse(statusCode);
         assertThrows(exceptionClass, invocation);
     }
 
-    protected void stubResponseAndAssertThrows(String response, ThrowingRunnable invocation,
+    protected void stubResponseAndAssertThrows(String response, Executable invocation,
                                                Class<? extends Exception> exceptionClass) throws Exception {
         stubResponse(200, response);
         assertThrows(exceptionClass, invocation);
     }
 
-    protected void stubResponseAndAssertThrows(int statusCode, String response, ThrowingRunnable invocation,
+    protected void stubResponseAndAssertThrows(int statusCode, String response, Executable invocation,
                                                Class<? extends Exception> exceptionClass) throws Exception {
         stubResponse(statusCode, response);
         assertThrows(exceptionClass, invocation);
@@ -127,7 +128,7 @@ protected <R> R stubResponseAndGet(int statusCode, String response, Supplier<? e
 
     @SuppressWarnings("unchecked")
     protected <E extends VonageApiResponseException> E assertApiResponseException(
-            int statusCode, String response, Class<E> exClass, ThrowingRunnable invocation) throws Exception {
+            int statusCode, String response, Class<E> exClass, Executable invocation) throws Exception {
         E expectedResponse = (E) exClass.getDeclaredMethod("fromJson", String.class).invoke(exClass, response);
         String expectedJson = expectedResponse.toJson();
         assertTrue(expectedJson.length() > 1 && expectedJson.length() <= response.length());
@@ -138,11 +139,11 @@ protected <E extends VonageApiResponseException> E assertApiResponseException(
         String failPrefix = "Expected "+exClass.getSimpleName()+", but got ";
 
         try {
-            invocation.run();
+            invocation.execute();
             fail(failPrefix + "nothing.");
         }
         catch (Throwable ex) {
-            assertEquals(failPrefix + ex.getClass(), exClass, ex.getClass());
+            assertEquals(exClass, ex.getClass(), failPrefix + ex.getClass());
             assertEquals(expectedResponse, ex);
             assertEquals(expectedJson, ((E) ex).toJson());
         }

diff --git a/src/test/java/com/vonage/client/DynamicEndpointTestSpec.java b/src/test/java/com/vonage/client/DynamicEndpointTestSpec.java
@@ -22,7 +22,7 @@
 import org.apache.http.client.methods.RequestBuilder;
 import org.apache.http.entity.ContentType;
 import org.apache.http.util.EntityUtils;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 import java.io.IOException;
 import java.lang.reflect.Constructor;
 import java.util.*;
@@ -191,13 +191,13 @@ private RequestBuilder makeTestRequest(T request) throws Exception {
 		String expectedContentTypeHeader = expectedContentTypeHeader(request);
 		if (expectedContentTypeHeader != null) {
 			Header contentTypeHeader = builder.getFirstHeader("Content-Type");
-			assertNotNull("Content-Type header is null", contentTypeHeader);
+			assertNotNull(contentTypeHeader, "Content-Type header is null");
 			assertEquals(expectedContentTypeHeader, contentTypeHeader.getValue());
 		}
 		String expectedAcceptHeader = expectedAcceptHeader();
 		if (expectedAcceptHeader != null) {
 			Header acceptHeader = builder.getFirstHeader("Accept");
-			assertNotNull("Accept header is null", acceptHeader);
+			assertNotNull(acceptHeader, "Accept header is null");
 			assertEquals(expectedAcceptHeader, acceptHeader.getValue());
 		}
 		return builder;

diff --git a/src/test/java/com/vonage/client/HttpConfigTest.java b/src/test/java/com/vonage/client/HttpConfigTest.java
@@ -15,8 +15,8 @@
  */
 package com.vonage.client;
 
-import org.junit.Test;
-import static org.junit.Assert.assertEquals;
+import org.junit.jupiter.api.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class HttpConfigTest {
     static final String EXPECTED_DEFAULT_API_BASE_URI = "https://api.nexmo.com";

diff --git a/src/test/java/com/vonage/client/HttpWrapperTest.java b/src/test/java/com/vonage/client/HttpWrapperTest.java
@@ -16,15 +16,13 @@
 package com.vonage.client;
 
 import com.vonage.client.auth.AuthCollection;
-import org.junit.Before;
-import org.junit.Test;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
+import org.junit.jupiter.api.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class HttpWrapperTest {
     private HttpWrapper wrapper;
 
-    @Before
+    @BeforeEach
     public void setUp() {
         wrapper = new HttpWrapper(new AuthCollection());
     }

diff --git a/src/test/java/com/vonage/client/LoggingUtilTest.java b/src/test/java/com/vonage/client/LoggingUtilTest.java
@@ -21,20 +21,17 @@
 import org.apache.http.entity.BasicHttpEntity;
 import org.apache.http.message.BasicHttpResponse;
 import org.apache.http.message.BasicStatusLine;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
-import org.junit.Test;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.*;
 
 public class LoggingUtilTest {
 
-  @BeforeClass
+  @BeforeAll
   public static void setupBeforeClass() {
     TestUtils.unmockStaticLoggingUtils();
   }
 
-  @AfterClass
+  @AfterAll
   public static void cleanupAfterClass() {
     TestUtils.mockStaticLoggingUtils();
   }

diff --git a/src/test/java/com/vonage/client/TestUtils.java b/src/test/java/com/vonage/client/TestUtils.java
@@ -23,7 +23,7 @@
 import org.apache.http.entity.BasicHttpEntity;
 import org.apache.http.message.BasicHttpResponse;
 import org.apache.http.message.BasicStatusLine;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.*;
 import org.mockito.MockedStatic;
 import static org.mockito.Mockito.mockStatic;
 import java.io.ByteArrayInputStream;
@@ -38,6 +38,10 @@
 
 public class TestUtils {
 
+    static {
+        mockStaticLoggingUtils();
+    }
+
     private static MockedStatic<LoggingUtils> staticMockLoggingUtils;
 
     public static void mockStaticLoggingUtils() {

diff --git a/src/test/java/com/vonage/client/VonageApiResponseExceptionTest.java b/src/test/java/com/vonage/client/VonageApiResponseExceptionTest.java
@@ -18,7 +18,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 import org.junit.Test;
 import java.net.URI;
 import java.util.Collections;

diff --git a/src/test/java/com/vonage/client/VonageClientTest.java b/src/test/java/com/vonage/client/VonageClientTest.java
@@ -31,7 +31,7 @@
 import org.apache.http.client.methods.HttpUriRequest;
 import org.apache.http.client.methods.RequestBuilder;
 import org.apache.http.message.BasicNameValuePair;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 import org.junit.Test;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
@@ -165,7 +165,7 @@ public void testApiKeyWithSecret() throws VonageUnacceptableAuthException {
     }
 
     @Test
-    public void testApiKeyWithSignatureSecret() throws VonageUnacceptableAuthException, NoSuchAlgorithmException, InvalidKeyException {
+    public void testApiKeyWithSignatureSecret() throws Exception {
         VonageClient vonageClient = VonageClient.builder().apiKey("api-key").signatureSecret("api-secret").build();
         AuthCollection authCollection = vonageClient.getHttpWrapper().getAuthCollection();
 
@@ -190,7 +190,7 @@ public void testApiKeyWithSignatureSecret() throws VonageUnacceptableAuthExcepti
     }
 
     @Test
-    public void testApiKeyWithSignatureSecretAsHMACSHA256() throws VonageUnacceptableAuthException, NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException {
+    public void testApiKeyWithSignatureSecretAsHMACSHA256() throws Exception {
         VonageClient vonageClient = VonageClient.builder().hashType(HashUtil.HashType.HMAC_SHA256).apiKey("api-key").signatureSecret("api-secret").build();
         AuthCollection authCollection = vonageClient.getHttpWrapper().getAuthCollection();
 
@@ -215,7 +215,7 @@ public void testApiKeyWithSignatureSecretAsHMACSHA256() throws VonageUnacceptabl
     }
 
     @Test
-    public void testApiKeyWithSignatureSecretAsHmacSHA256() throws VonageUnacceptableAuthException, NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException {
+    public void testApiKeyWithSignatureSecretAsHmacSHA256() throws Exception {
         VonageClient vonageClient = VonageClient.builder().hashType(HashUtil.HashType.HMAC_SHA256).apiKey("api-key").signatureSecret("api-secret").build();
         AuthCollection authCollection = vonageClient.getHttpWrapper().getAuthCollection();
 
@@ -348,6 +348,6 @@ public void testSubClientGetters() {
 
     private void assertContainsParam(List<NameValuePair> params, String key, String value) {
         NameValuePair item = new BasicNameValuePair(key, value);
-        assertTrue(params + " should contain " + item, params.contains(item));
+        assertTrue(params.contains(item), params + " should contain " + item);
     }
 }
diff --git a/src/test/java/com/vonage/client/account/AccountClientTest.java b/src/test/java/com/vonage/client/account/AccountClientTest.java
@@ -19,7 +19,7 @@
 import com.vonage.client.RestEndpoint;
 import com.vonage.client.VonageResponseParseException;
 import com.vonage.client.common.HttpMethod;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 import org.junit.Test;
 import java.math.BigDecimal;
 import java.util.*;

diff --git a/src/test/java/com/vonage/client/application/ApplicationClientTest.java b/src/test/java/com/vonage/client/application/ApplicationClientTest.java
@@ -20,10 +20,13 @@
 import com.vonage.client.application.capabilities.*;
 import com.vonage.client.common.HttpMethod;
 import com.vonage.client.common.Webhook;
-import static org.junit.Assert.*;
-import org.junit.Test;
-import org.junit.function.ThrowingRunnable;
-import java.util.*;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.*;
+import org.junit.jupiter.api.function.Executable;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
 
 public class ApplicationClientTest extends ClientTest<ApplicationClient> {
     static final UUID SAMPLE_APPLICATION_ID = UUID.randomUUID();
@@ -133,7 +136,7 @@ static void assertEqualsSampleApplication(Application response) {
         assertTrue(privacy.getImproveAi());
     }
 
-    void assert400ResponseException(ThrowingRunnable invocation) throws Exception {
+    void assert400ResponseException(Executable invocation) throws Exception {
         String response = "{\n" +
                 "   \"type\": \"https://developer.nexmo.com/api-errors/application#payload-validation\",\n" +
                 "   \"title\": \"Bad Request\",\n" +

diff --git a/src/test/java/com/vonage/client/application/ApplicationTest.java b/src/test/java/com/vonage/client/application/ApplicationTest.java
@@ -21,8 +21,8 @@
 import com.vonage.client.application.capabilities.Voice;
 import com.vonage.client.common.HttpMethod;
 import com.vonage.client.common.Webhook;
-import static org.junit.Assert.*;
-import org.junit.Test;
+import org.junit.jupiter.api.*;
+import static org.junit.jupiter.api.Assertions.*;
 import java.util.UUID;
 
 public class ApplicationTest {

diff --git a/src/test/java/com/vonage/client/application/capabilities/MessagesTest.java b/src/test/java/com/vonage/client/application/capabilities/MessagesTest.java
@@ -17,9 +17,8 @@
 
 import com.vonage.client.common.HttpMethod;
 import com.vonage.client.common.Webhook;
-import org.junit.Test;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNull;
+import org.junit.jupiter.api.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class MessagesTest {
     @Test

diff --git a/src/test/java/com/vonage/client/application/capabilities/RtcTest.java b/src/test/java/com/vonage/client/application/capabilities/RtcTest.java
@@ -17,9 +17,8 @@
 
 import com.vonage.client.common.HttpMethod;
 import com.vonage.client.common.Webhook;
-import org.junit.Test;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNull;
+import org.junit.jupiter.api.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class RtcTest {
     @Test

diff --git a/src/test/java/com/vonage/client/application/capabilities/VbcTest.java b/src/test/java/com/vonage/client/application/capabilities/VbcTest.java
@@ -15,8 +15,8 @@
  */
 package com.vonage.client.application.capabilities;
 
-import org.junit.Test;
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.*;
 
 public class VbcTest {
     @Test

diff --git a/src/test/java/com/vonage/client/application/capabilities/VoiceTest.java b/src/test/java/com/vonage/client/application/capabilities/VoiceTest.java
@@ -19,8 +19,8 @@
 import com.vonage.client.Jsonable;
 import com.vonage.client.common.HttpMethod;
 import com.vonage.client.common.Webhook;
-import static org.junit.Assert.*;
-import org.junit.Test;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.*;
 
 public class VoiceTest {