Migrate tests to JUnit5 (utils)

* Migrate annotations and imports
* Migrate assertions
* Remove public visibility for test classes and methods
* Minor code cleanup

Author: strangelookingnerd

utils/pom.xml

@@ -100,7 +100,7 @@ Copyright (c) 2014 - Jeremy Long. All Rights Reserved.
         </dependency>
         <dependency>
             <groupId>org.mock-server</groupId>
-            <artifactId>mockserver-junit-rule</artifactId>
+            <artifactId>mockserver-junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
     </dependencies>

utils/src/test/java/org/owasp/dependencycheck/utils/BaseTest.java

@@ -15,11 +15,13 @@
  */
 package org.owasp.dependencycheck.utils;
 
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+
 import java.io.File;
 import java.net.URISyntaxException;
-import org.junit.After;
-import org.junit.Assume;
-import org.junit.Before;
+
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
 /**
  *
@@ -35,15 +37,15 @@ public abstract class BaseTest {
     /**
      * Initialize the {@link Settings}.
      */
-    @Before
+    @BeforeEach
     public void setUp() {
         settings = new Settings();
     }
 
     /**
      * Clean the {@link Settings}.
      */
-    @After
+    @AfterEach
     public void tearDown() {
         settings.cleanup(true);
     }
@@ -56,7 +58,7 @@ public void tearDown() {
     protected Settings getSettings() {
         return settings;
     }
-    
+
     /**
      * Returns the given resource as a File using the object's class loader. The
      * org.junit.Assume API is used so that test cases are skipped if the
@@ -69,7 +71,7 @@ protected Settings getSettings() {
     public static File getResourceAsFile(Object o, String resource) {
         try {
             File f = new File(o.getClass().getClassLoader().getResource(resource).toURI().getPath());
-            Assume.assumeTrue(String.format("%n%n[SEVERE] Unable to load resource for test case: %s%n%n", resource), f.exists());
+            assumeTrue(f.exists(), String.format("%n%n[SEVERE] Unable to load resource for test case: %s%n%n", resource));
             return f;
         } catch (URISyntaxException e) {
             throw new UnsupportedOperationException(e);

utils/src/test/java/org/owasp/dependencycheck/utils/ChecksumTest.java

@@ -17,48 +17,45 @@
  */
 package org.owasp.dependencycheck.utils;
 
+import org.junit.jupiter.api.Test;
+
 import java.io.File;
 import java.io.IOException;
 import java.security.NoSuchAlgorithmException;
-import org.junit.Assert;
-import static org.junit.Assert.assertArrayEquals;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-import org.junit.Test;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  *
  * @author Jeremy Long
  */
-public class ChecksumTest {
+class ChecksumTest {
 
     /**
      * Test of getChecksum method, of class Checksum. This checks that an
      * exception is thrown when an invalid path is specified.
      *
-     * @throws Exception is thrown when an exception occurs.
      */
     @Test
-    public void testGetChecksum_FileNotFound() throws Exception {
+    void testGetChecksum_FileNotFound() {
         String algorithm = "MD5";
         File file = new File("not a valid file");
-        Exception exception = Assert.assertThrows(IOException.class, () -> Checksum.getChecksum(algorithm, file));
+        Exception exception = assertThrows(IOException.class, () -> Checksum.getChecksum(algorithm, file));
         assertTrue(exception.getMessage().contains("not a valid file"));
     }
 
     /**
      * Test of getChecksum method, of class Checksum. This checks that an
      * exception is thrown when an invalid algorithm is specified.
      *
-     * @throws Exception is thrown when an exception occurs.
      */
     @Test
-    public void testGetChecksum_NoSuchAlgorithm() throws Exception {
+    void testGetChecksum_NoSuchAlgorithm() {
         String algorithm = "some unknown algorithm";
         File file = new File(this.getClass().getClassLoader().getResource("checkSumTest.file").getPath());
-        Exception exception = Assert.assertThrows(NoSuchAlgorithmException.class, () -> Checksum.getChecksum(algorithm, file));
+        Exception exception = assertThrows(NoSuchAlgorithmException.class, () -> Checksum.getChecksum(algorithm, file));
         assertTrue(exception.getMessage().contains("some unknown algorithm"));
     }
 
@@ -68,7 +65,7 @@ public void testGetChecksum_NoSuchAlgorithm() throws Exception {
      * @throws Exception is thrown when an exception occurs.
      */
     @Test
-    public void testGetMD5Checksum() throws Exception {
+    void testGetMD5Checksum() throws Exception {
         File file = new File(this.getClass().getClassLoader().getResource("checkSumTest.file").toURI().getPath());
         //String expResult = "F0915C5F46B8CFA283E5AD67A09B3793";
         String expResult = "f0915c5f46b8cfa283e5ad67a09b3793";
@@ -82,7 +79,7 @@ public void testGetMD5Checksum() throws Exception {
      * @throws Exception is thrown when an exception occurs.
      */
     @Test
-    public void testGetSHA1Checksum() throws Exception {
+    void testGetSHA1Checksum() throws Exception {
         File file = new File(this.getClass().getClassLoader().getResource("checkSumTest.file").toURI().getPath());
         //String expResult = "B8A9FF28B21BCB1D0B50E24A5243D8B51766851A";
         String expResult = "b8a9ff28b21bcb1d0b50e24a5243d8b51766851a";
@@ -94,7 +91,7 @@ public void testGetSHA1Checksum() throws Exception {
      * Test of getHex method, of class Checksum.
      */
     @Test
-    public void testGetHex() {
+    void testGetHex() {
         byte[] raw = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16};
         //String expResult = "000102030405060708090A0B0C0D0E0F10";
         String expResult = "000102030405060708090a0b0c0d0e0f10";
@@ -106,7 +103,7 @@ public void testGetHex() {
      * Test of getChecksum method, of class Checksum.
      */
     @Test
-    public void testGetChecksum_String_File() throws Exception {
+    void testGetChecksum_String_File() throws Exception {
         String algorithm = "MD5";
         File file = new File(this.getClass().getClassLoader().getResource("checkSumTest.file").toURI().getPath());
         String expResult = "f0915c5f46b8cfa283e5ad67a09b3793";
@@ -121,7 +118,7 @@ public void testGetChecksum_String_File() throws Exception {
      * Test of getMD5Checksum method, of class Checksum.
      */
     @Test
-    public void testGetMD5Checksum_File() throws Exception {
+    void testGetMD5Checksum_File() throws Exception {
         File file = new File(this.getClass().getClassLoader().getResource("checkSumTest.file").toURI().getPath());
         String expResult = "f0915c5f46b8cfa283e5ad67a09b3793";
         String result = Checksum.getMD5Checksum(file);
@@ -132,7 +129,7 @@ public void testGetMD5Checksum_File() throws Exception {
      * Test of getSHA1Checksum method, of class Checksum.
      */
     @Test
-    public void testGetSHA1Checksum_File() throws Exception {
+    void testGetSHA1Checksum_File() throws Exception {
         File file = new File(this.getClass().getClassLoader().getResource("checkSumTest.file").toURI().getPath());
         String expResult = "b8a9ff28b21bcb1d0b50e24a5243d8b51766851a";
         String result = Checksum.getSHA1Checksum(file);
@@ -143,7 +140,7 @@ public void testGetSHA1Checksum_File() throws Exception {
      * Test of getChecksum method, of class Checksum.
      */
     @Test
-    public void testGetChecksum_String_byteArr() {
+    void testGetChecksum_String_byteArr() {
         String algorithm = "SHA1";
         byte[] bytes = {-16, -111, 92, 95, 70, -72, -49, -94, -125, -27, -83, 103, -96, -101, 55, -109};
         String expResult = "89268a389a97f0bfba13d3ff2370d8ad436e36f6";
@@ -155,7 +152,7 @@ public void testGetChecksum_String_byteArr() {
      * Test of getMD5Checksum method, of class Checksum.
      */
     @Test
-    public void testGetMD5Checksum_String() {
+    void testGetMD5Checksum_String() {
         String text = "test string";
         String expResult = "6f8db599de986fab7a21625b7916589c";
         String result = Checksum.getMD5Checksum(text);
@@ -166,7 +163,7 @@ public void testGetMD5Checksum_String() {
      * Test of getSHA1Checksum method, of class Checksum.
      */
     @Test
-    public void testGetSHA1Checksum_String() {
+    void testGetSHA1Checksum_String() {
         String text = "test string";
         String expResult = "661295c9cbf9d6b2f6428414504a8deed3020641";
         String result = Checksum.getSHA1Checksum(text);

utils/src/test/java/org/owasp/dependencycheck/utils/DownloaderIT.java

@@ -17,29 +17,29 @@
  */
 package org.owasp.dependencycheck.utils;
 
+import org.apache.hc.client5.http.impl.classic.AbstractHttpClientResponseHandler;
+import org.apache.hc.core5.http.HttpEntity;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
 
-import org.apache.hc.client5.http.impl.classic.AbstractHttpClientResponseHandler;
-import org.apache.hc.core5.http.HttpEntity;
-import org.junit.Test;
-
 import static java.nio.charset.StandardCharsets.UTF_8;
-import static org.junit.Assert.assertTrue;
-import org.junit.Before;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  *
  * @author Jeremy Long
  */
-public class DownloaderIT extends BaseTest {
+class DownloaderIT extends BaseTest {
 
     /**
      * Initialize the {@link Settings}.
      */
-    @Before
+    @BeforeEach
     @Override
     public void setUp() {
         super.setUp();
@@ -51,7 +51,7 @@ public void setUp() {
      * @throws Exception thrown when an exception occurs.
      */
     @Test
-    public void testFetchFile() throws Exception {
+    void testFetchFile() throws Exception {
         final String str = getSettings().getString(Settings.KEYS.ENGINE_VERSION_CHECK_URL, "https://dependency-check.github.io/DependencyCheck/current.txt");
         URL url = new URL(str);
         File outputPath = new File("target/current.txt");
@@ -66,9 +66,9 @@ public void testFetchFile() throws Exception {
      * @throws Exception thrown when an exception occurs.
      */
     @Test
-    public void testfetchAndHandleContent() throws Exception {
+    void testfetchAndHandleContent() throws Exception {
         URL url = new URL(getSettings().getString(Settings.KEYS.ENGINE_VERSION_CHECK_URL));
-        AbstractHttpClientResponseHandler<String> versionHandler = new AbstractHttpClientResponseHandler<String>() {
+        AbstractHttpClientResponseHandler<String> versionHandler = new AbstractHttpClientResponseHandler<>() {
             @Override
             public String handleEntity(HttpEntity entity) throws IOException {
                 try (InputStream in = entity.getContent()) {

utils/src/test/java/org/owasp/dependencycheck/utils/ExpectedObjectInputStreamTest.java

@@ -17,28 +17,30 @@
  */
 package org.owasp.dependencycheck.utils;
 
+import org.junit.jupiter.api.Test;
+
 import java.io.BufferedOutputStream;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.ObjectOutputStream;
 import java.util.ArrayList;
 import java.util.List;
-import static org.junit.Assert.fail;
-import org.junit.Test;
-import static org.junit.Assert.fail;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.fail;
 
 /**
  *
  * @author jeremy
  */
-public class ExpectedObjectInputStreamTest {
+class ExpectedObjectInputStreamTest {
 
     /**
      * Test of resolveClass method, of class ExpectedObjectInputStream.
      */
     @Test
-    public void testResolveClass() {
+    void testResolveClass() {
         List<SimplePojo> data = new ArrayList<>();
         data.add(new SimplePojo());
         try (ByteArrayOutputStream mem = new ByteArrayOutputStream();
@@ -57,21 +59,19 @@ public void testResolveClass() {
     /**
      * Test of resolveClass method, of class ExpectedObjectInputStream.
      */
-    @Test(expected = java.io.InvalidClassException.class)
-    public void testResolveClassException() throws Exception {
+    @Test
+    void testResolveClassException() throws Exception {
         List<SimplePojo> data = new ArrayList<>();
         data.add(new SimplePojo());
-
         ByteArrayOutputStream mem = new ByteArrayOutputStream();
         byte[] buf;
         try (ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(mem))) {
-            out.writeObject(data);
-            out.flush();
-            buf = mem.toByteArray();
-        }
+                out.writeObject(data);
+                out.flush();
+                buf = mem.toByteArray();
+            }
         ByteArrayInputStream in = new ByteArrayInputStream(buf);
-
         ExpectedObjectInputStream instance = new ExpectedObjectInputStream(in, "java.util.ArrayList", "org.owasp.dependencycheck.utils.SimplePojo");
-        instance.readObject();
+        assertThrows(java.io.InvalidClassException.class, instance::readObject);
     }
 }