Migrate tests to JUnit5 (core)

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

Author: strangelookingnerd

core/pom.xml

@@ -335,7 +335,7 @@ Copyright (c) 2012 Jeremy Long. All Rights Reserved.
         </dependency>
         <dependency>
             <groupId>org.mockito</groupId>
-            <artifactId>mockito-core</artifactId>
+            <artifactId>mockito-junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>

core/src/test/java/org/owasp/dependencycheck/AnalysisTaskTest.java

@@ -1,23 +1,23 @@
 package org.owasp.dependencycheck;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
-import org.mockito.junit.MockitoJUnitRunner;
+import org.mockito.junit.jupiter.MockitoExtension;
 import org.owasp.dependencycheck.analyzer.FileTypeAnalyzer;
 import org.owasp.dependencycheck.analyzer.HintAnalyzer;
 import org.owasp.dependencycheck.dependency.Dependency;
 
 import java.io.File;
 
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
-import static org.mockito.Mockito.when;
-import static org.mockito.Mockito.verify;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
-@RunWith(MockitoJUnitRunner.class)
-public class AnalysisTaskTest extends BaseTest {
+@ExtendWith(MockitoExtension.class)
+class AnalysisTaskTest extends BaseTest {
 
     @Mock
     private FileTypeAnalyzer fileTypeAnalyzer;
@@ -30,14 +30,14 @@ public class AnalysisTaskTest extends BaseTest {
 
 
     @Test
-    public void shouldAnalyzeReturnsTrueForNonFileTypeAnalyzers() {
+    void shouldAnalyzeReturnsTrueForNonFileTypeAnalyzers() {
         AnalysisTask instance = new AnalysisTask(new HintAnalyzer(), null, null, null);
         boolean shouldAnalyze = instance.shouldAnalyze();
         assertTrue(shouldAnalyze);
     }
 
     @Test
-    public void shouldAnalyzeReturnsTrueIfTheFileTypeAnalyzersAcceptsTheDependency() {
+    void shouldAnalyzeReturnsTrueIfTheFileTypeAnalyzersAcceptsTheDependency() {
         final File dependencyFile = new File("");
         when(dependency.getActualFile()).thenReturn(dependencyFile);
         when(fileTypeAnalyzer.accept(dependencyFile)).thenReturn(true);
@@ -49,7 +49,7 @@ public void shouldAnalyzeReturnsTrueIfTheFileTypeAnalyzersAcceptsTheDependency()
     }
 
     @Test
-    public void shouldAnalyzeReturnsFalseIfTheFileTypeAnalyzerDoesNotAcceptTheDependency() {
+    void shouldAnalyzeReturnsFalseIfTheFileTypeAnalyzerDoesNotAcceptTheDependency() {
         final File dependencyFile = new File("");
         when(dependency.getActualFile()).thenReturn(dependencyFile);
         when(fileTypeAnalyzer.accept(dependencyFile)).thenReturn(false);
@@ -61,7 +61,7 @@ public void shouldAnalyzeReturnsFalseIfTheFileTypeAnalyzerDoesNotAcceptTheDepend
     }
 
     @Test
-    public void taskAnalyzes() throws Exception {
+    void taskAnalyzes() throws Exception {
         final AnalysisTask analysisTask = new AnalysisTask(fileTypeAnalyzer, dependency, engine, null);
         when(fileTypeAnalyzer.accept(dependency.getActualFile())).thenReturn(true);
 
@@ -71,7 +71,7 @@ public void taskAnalyzes() throws Exception {
     }
 
     @Test
-    public void taskDoesNothingIfItShouldNotAnalyze() throws Exception {
+    void taskDoesNothingIfItShouldNotAnalyze() throws Exception {
         final AnalysisTask analysisTask = new AnalysisTask(fileTypeAnalyzer, dependency, engine, null);
         when(fileTypeAnalyzer.accept(dependency.getActualFile())).thenReturn(false);
 

core/src/test/java/org/owasp/dependencycheck/BaseDBTestCase.java

@@ -17,20 +17,21 @@
  */
 package org.owasp.dependencycheck;
 
+import org.apache.commons.io.IOUtils;
+import org.junit.jupiter.api.BeforeEach;
+import org.owasp.dependencycheck.data.nvdcve.DatabaseManager;
+import org.owasp.dependencycheck.utils.Settings;
+import org.owasp.dependencycheck.utils.WriteLock;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
-import org.apache.commons.io.IOUtils;
-import org.junit.Before;
-import org.owasp.dependencycheck.data.nvdcve.DatabaseManager;
-import org.owasp.dependencycheck.utils.WriteLock;
-import org.owasp.dependencycheck.utils.Settings;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * An abstract database test case that is used to ensure the H2 DB exists prior
@@ -40,11 +41,11 @@
  */
 public abstract class BaseDBTestCase extends BaseTest {
 
-    protected final static int BUFFER_SIZE = 2048;
+    protected static final int BUFFER_SIZE = 2048;
 
-    private final static Logger LOGGER = LoggerFactory.getLogger(BaseDBTestCase.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(BaseDBTestCase.class);
 
-    @Before
+    @BeforeEach
     @Override
     public void setUp() throws Exception {
         super.setUp();

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

@@ -16,15 +16,16 @@
 package org.owasp.dependencycheck;
 
 import io.github.jeremylong.jcs3.slf4j.Slf4jAdapter;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.owasp.dependencycheck.utils.Settings;
+
 import java.io.File;
 import java.io.InputStream;
 import java.net.URISyntaxException;
-import org.junit.After;
 
-import org.junit.AfterClass;
-import org.junit.Assume;
-import org.junit.Before;
-import org.owasp.dependencycheck.utils.Settings;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
 /**
  *
@@ -40,7 +41,7 @@ public abstract class BaseTest {
     /**
      * Initialize the {@link Settings}.
      */
-    @Before
+    @BeforeEach
     public void setUp() throws Exception {
         System.setProperty("jcs.logSystem", "slf4j");
         Slf4jAdapter.muteLogging(true);
@@ -50,13 +51,13 @@ public void setUp() throws Exception {
     /**
      * Clean the {@link Settings}.
      */
-    @After
+    @AfterEach
     public void tearDown() throws Exception {
         settings.cleanup(true);
     }
 
-    @AfterClass
-    public static void tearDownClass() throws Exception {
+    @AfterAll
+    public static void tearDownClass() {
         File f = new File("./target/data/odc.mv.db");
         if (f.exists() && f.isFile() && f.length() < 71680) {
             System.err.println("------------------------------------------------");
@@ -93,7 +94,7 @@ public static InputStream getResourceAsStream(Object o, String resource) {
     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);

core/src/test/java/org/owasp/dependencycheck/EngineIT.java

@@ -17,40 +17,38 @@
  */
 package org.owasp.dependencycheck;
 
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.owasp.dependencycheck.analyzer.Analyzer;
+import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
+import org.owasp.dependencycheck.exception.ExceptionCollection;
+import org.owasp.dependencycheck.exception.ReportException;
+import org.owasp.dependencycheck.utils.Settings;
+
 import java.io.File;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.doThrow;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.Mock;
-import org.mockito.junit.MockitoJUnitRunner;
-import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
-import org.owasp.dependencycheck.exception.ExceptionCollection;
-import org.owasp.dependencycheck.exception.ReportException;
-import org.owasp.dependencycheck.utils.InvalidSettingException;
-import org.owasp.dependencycheck.utils.Settings;
-import org.owasp.dependencycheck.analyzer.Analyzer;
-
 /**
  *
  * @author Jeremy Long
  */
-@RunWith(MockitoJUnitRunner.class)
-public class EngineIT extends BaseDBTestCase {
+@ExtendWith(MockitoExtension.class)
+class EngineIT extends BaseDBTestCase {
 
     @Mock
     private Analyzer analyzer;
@@ -60,7 +58,7 @@ public class EngineIT extends BaseDBTestCase {
 
 
     @Test
-    public void exceptionDuringAnalysisTaskExecutionIsFatal() throws DatabaseException, ExceptionCollection {
+    void exceptionDuringAnalysisTaskExecutionIsFatal() throws DatabaseException {
          final ExecutorService executorService = Executors.newFixedThreadPool(3);
          try (Engine instance = spy(new Engine(new Settings()))) {
              final List<Throwable> exceptions = new ArrayList<>();
@@ -88,14 +86,12 @@ public void exceptionDuringAnalysisTaskExecutionIsFatal() throws DatabaseExcepti
     /**
      * Test running the entire engine.
      *
-     * @throws java.io.IOException
-     * @throws org.owasp.dependencycheck.utils.InvalidSettingException
      * @throws org.owasp.dependencycheck.data.nvdcve.DatabaseException
      * @throws org.owasp.dependencycheck.exception.ReportException
      * @throws org.owasp.dependencycheck.exception.ExceptionCollection
      */
     @Test
-    public void testEngine() throws IOException, InvalidSettingException, DatabaseException, ReportException, ExceptionCollection {
+    void testEngine() throws DatabaseException, ReportException, ExceptionCollection {
         String testClasses = "target/test-classes";
         getSettings().setBoolean(Settings.KEYS.AUTO_UPDATE, false);
         getSettings().setBoolean(Settings.KEYS.ANALYZER_CENTRAL_ENABLED, false);

core/src/test/java/org/owasp/dependencycheck/EngineTest.java

@@ -17,20 +17,19 @@
  */
 package org.owasp.dependencycheck;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.owasp.dependencycheck.analyzer.JarAnalyzer;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 import org.owasp.dependencycheck.dependency.Dependency;
 
 import java.io.File;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
  * @author Jeremy Long
  */
-public class EngineTest extends BaseDBTestCase {
-
+class EngineTest extends BaseDBTestCase {
 
 
     /**
@@ -40,7 +39,7 @@ public class EngineTest extends BaseDBTestCase {
      * there is an exception
      */
     @Test
-    public void testScanFile() throws DatabaseException {
+    void testScanFile() throws DatabaseException {
         try (Engine instance = new Engine(getSettings())) {
             instance.addFileTypeAnalyzer(new JarAnalyzer());
             File file = BaseTest.getResourceAsFile(this, "dwr.jar");

core/src/test/java/org/owasp/dependencycheck/agent/DependencyCheckScanAgentIT.java

@@ -17,43 +17,46 @@
  */
 package org.owasp.dependencycheck.agent;
 
-import org.junit.Assert;
-import org.junit.BeforeClass;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.owasp.dependencycheck.BaseDBTestCase;
 import org.owasp.dependencycheck.dependency.Confidence;
 import org.owasp.dependencycheck.dependency.Dependency;
 import org.owasp.dependencycheck.dependency.EvidenceType;
 import org.owasp.dependencycheck.reporting.ReportGenerator;
 import org.owasp.dependencycheck.utils.FileUtils;
+
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
-import org.owasp.dependencycheck.BaseDBTestCase;
 
-public class DependencyCheckScanAgentIT extends BaseDBTestCase {
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class DependencyCheckScanAgentIT extends BaseDBTestCase {
 
     private static final File REPORT_DIR = new File("target/test-scan-agent/report");
 
-    @BeforeClass
-    public static void beforeClass() {
+    @BeforeAll
+    static void beforeClass() {
         if (!REPORT_DIR.exists()) {
             REPORT_DIR.mkdirs();
         }
     }
 
     @Test
-    public void testComponentMetadata() throws Exception {
+    void testComponentMetadata() throws Exception {
         List<Dependency> dependencies = new ArrayList<>();
         dependencies.add(createDependency("apache", "tomcat", "5.0.5"));
         DependencyCheckScanAgent scanAgent = createScanAgent();
         scanAgent.setDependencies(dependencies);
         scanAgent.execute();
 
         Dependency tomcat = scanAgent.getDependencies().get(0);
-        Assert.assertTrue(tomcat.getVulnerableSoftwareIdentifiers().size() >= 1);
+        assertFalse(tomcat.getVulnerableSoftwareIdentifiers().isEmpty());
 
         // This will change over time
-        Assert.assertTrue(tomcat.getVulnerabilities().size() > 5);
+        assertTrue(tomcat.getVulnerabilities().size() > 5);
     }
 
     private DependencyCheckScanAgent createScanAgent() {

core/src/test/java/org/owasp/dependencycheck/analyzer/AbstractFileTypeAnalyzerTest.java

@@ -17,23 +17,25 @@
  */
 package org.owasp.dependencycheck.analyzer;
 
-import java.util.Set;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.owasp.dependencycheck.BaseTest;
 
+import java.util.Set;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 /**
  *
  * @author Jeremy Long
  */
-public class AbstractFileTypeAnalyzerTest extends BaseTest {
+class AbstractFileTypeAnalyzerTest extends BaseTest {
 
     /**
      * Test of newHashSet method, of class AbstractAnalyzer.
      */
     @Test
-    public void testNewHashSet() {
+    void testNewHashSet() {
         Set<String> result = AbstractFileTypeAnalyzer.newHashSet("one", "two");
         assertEquals(2, result.size());
         assertTrue(result.contains("one"));