Migrate tests to JUnit5 (assertThrows)

* Replace try / fail(expected exception) / catch pattern with assertThrows
* Reduce usage of fail()

Author: strangelookingnerd

ant/src/test/java/org/owasp/dependencycheck/taskdefs/DependencyCheckTaskIT.java

@@ -29,7 +29,6 @@
 
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.fail;
 
 /**
  *
@@ -127,12 +126,11 @@ void testNestedReportFormat() throws Exception {
 
     @Test
     void testNestedBADReportFormat() {
-        try {
-            buildFileRule.executeTarget("test.formatBADNested");
-            fail("Should have had a buildExceotion for a bad format attribute");
-        } catch (BuildException e) {
-            assertTrue(e.getMessage().contains("BAD is not a legal value for this attribute"), "Message did not have BAD, unexpected exception: " + e.getMessage());
-        }
+        BuildException e = assertThrows(BuildException.class,
+                () -> buildFileRule.executeTarget("test.formatBADNested"),
+                "Should have had a buildException for a bad format attribute");
+        assertTrue(e.getMessage().contains("BAD is not a legal value for this attribute"),
+                "Message did not have BAD, unexpected exception: " + e.getMessage());
     }
 
     /**

cli/src/test/java/org/owasp/dependencycheck/CliParserTest.java

@@ -30,6 +30,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
 
@@ -99,20 +100,17 @@ void testParse_version() throws Exception {
     /**
      * Test of parse method with failOnCVSS without an argument
      *
-     * @throws Exception thrown when an exception occurs.
      */
     @Test
-    void testParse_failOnCVSSNoArg() throws Exception {
+    void testParse_failOnCVSSNoArg() {
 
         String[] args = {"--failOnCVSS"};
 
         CliParser instance = new CliParser(getSettings());
-        try {
-            instance.parse(args);
-            fail("an argument for failOnCVSS was missing and an exception was not thrown");
-        } catch (ParseException ex) {
-            assertTrue(ex.getMessage().contains("Missing argument"));
-        }
+        ParseException ex = assertThrows(ParseException.class, () -> instance.parse(args),
+                "an argument for failOnCVSS was missing and an exception was not thrown");
+        assertTrue(ex.getMessage().contains("Missing argument"));
+
         assertFalse(instance.isGetVersion());
         assertFalse(instance.isGetHelp());
         assertFalse(instance.isRunScan());
@@ -159,10 +157,9 @@ void testParse_failOnCVSSValidArgument() throws Exception {
     /**
      * Test of parse method with jar and cpe args, of class CliParser.
      *
-     * @throws Exception thrown when an exception occurs.
      */
     @Test
-    void testParse_unknown() throws Exception {
+    void testParse_unknown() {
 
         String[] args = {"-unknown"};
 
@@ -173,12 +170,10 @@ void testParse_unknown() throws Exception {
 
         CliParser instance = new CliParser(getSettings());
 
-        try {
-            instance.parse(args);
-            fail("Unrecognized option should have caused an exception");
-        } catch (ParseException ex) {
-            assertTrue(ex.getMessage().contains("Unrecognized option"));
-        }
+        ParseException ex = assertThrows(ParseException.class, () -> instance.parse(args) ,
+                "Unrecognized option should have caused an exception");
+        assertTrue(ex.getMessage().contains("Unrecognized option"));
+
         assertFalse(instance.isGetVersion());
         assertFalse(instance.isGetHelp());
         assertFalse(instance.isRunScan());
@@ -187,21 +182,17 @@ void testParse_unknown() throws Exception {
     /**
      * Test of parse method with scan arg, of class CliParser.
      *
-     * @throws Exception thrown when an exception occurs.
      */
     @Test
-    void testParse_scan() throws Exception {
+    void testParse_scan() {
 
         String[] args = {"-scan"};
 
         CliParser instance = new CliParser(getSettings());
 
-        try {
-            instance.parse(args);
-            fail("Missing argument should have caused an exception");
-        } catch (ParseException ex) {
-            assertTrue(ex.getMessage().contains("Missing argument"));
-        }
+        ParseException ex = assertThrows(ParseException.class, () -> instance.parse(args),
+                "Missing argument should have caused an exception");
+        assertTrue(ex.getMessage().contains("Missing argument"));
 
         assertFalse(instance.isGetVersion());
         assertFalse(instance.isGetHelp());
@@ -211,20 +202,17 @@ void testParse_scan() throws Exception {
     /**
      * Test of parse method with jar arg, of class CliParser.
      *
-     * @throws Exception thrown when an exception occurs.
      */
     @Test
-    void testParse_scan_unknownFile() throws Exception {
+    void testParse_scan_unknownFile() {
 
         String[] args = {"-scan", "jar.that.does.not.exist", "--project", "test"};
 
         CliParser instance = new CliParser(getSettings());
-        try {
-            instance.parse(args);
-            fail("An exception should have been thrown");
-        } catch (FileNotFoundException ex) {
-            assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
-        }
+
+        FileNotFoundException ex = assertThrows(FileNotFoundException.class, () -> instance.parse(args),
+                "An exception should have been thrown");
+        assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
 
         assertFalse(instance.isGetVersion());
         assertFalse(instance.isGetHelp());
@@ -274,7 +262,7 @@ void testParse_printVersionInfo() {
             assertFalse(text.contains("unknown"));
         } catch (IOException ex) {
             System.setOut(out);
-            fail("CliParser.printVersionInfo did not write anything to system.out.");
+            fail("CliParser.printVersionInfo did not write anything to system.out.", ex);
         } finally {
             System.setOut(out);
         }
@@ -318,16 +306,15 @@ void testParse_printHelp() throws Exception {
      * Test of getBooleanArgument method, of class CliParser.
      */
     @Test
-    void testGetBooleanArgument() throws ParseException {
+    void testGetBooleanArgument() {
         String[] args = {"--scan", "missing.file", "--artifactoryUseProxy", "false", "--artifactoryParallelAnalysis", "true", "--project", "test"};
 
         CliParser instance = new CliParser(getSettings());
-        try {
-            instance.parse(args);
-            fail("invalid scan should have caused an error");
-        } catch (FileNotFoundException ex) {
-            assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
-        }
+
+        FileNotFoundException ex = assertThrows(FileNotFoundException.class, () -> instance.parse(args),
+                "invalid scan should have caused an error");
+        assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
+
         boolean expResult;
         Boolean result = instance.getBooleanArgument("missingArgument");
         assertNull(result);
@@ -344,17 +331,16 @@ void testGetBooleanArgument() throws ParseException {
      * Test of getStringArgument method, of class CliParser.
      */
     @Test
-    void testGetStringArgument() throws ParseException {
+    void testGetStringArgument() {
 
         String[] args = {"--scan", "missing.file", "--artifactoryUsername", "blue42", "--project", "test"};
 
         CliParser instance = new CliParser(getSettings());
-        try {
-            instance.parse(args);
-            fail("invalid scan argument should have caused an exception");
-        } catch (FileNotFoundException ex) {
-            assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
-        }
+
+        FileNotFoundException ex = assertThrows(FileNotFoundException.class, () -> instance.parse(args),
+                "invalid scan argument should have caused an exception");
+        assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
+
         String expResult;
         String result = instance.getStringArgument("missingArgument");
         assertNull(result);
@@ -365,17 +351,15 @@ void testGetStringArgument() throws ParseException {
     }
 
     @Test
-    void testHasOption() throws ParseException {
+    void testHasOption() {
 
         String[] args = {"--scan", "missing.file", "--artifactoryUsername", "blue42", "--project", "test"};
 
         CliParser instance = new CliParser(getSettings());
-        try {
-            instance.parse(args);
-            fail("invalid scan argument should have caused an exception");
-        } catch (FileNotFoundException ex) {
-            assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
-        }
+
+        FileNotFoundException ex = assertThrows(FileNotFoundException.class, () -> instance.parse(args),
+                "invalid scan argument should have caused an exception");
+        assertTrue(ex.getMessage().contains("Invalid 'scan' argument"));
 
         Boolean result = instance.hasOption("missingOption");
         assertNull(result);

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

@@ -36,8 +36,8 @@
 import java.util.concurrent.Executors;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 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;
@@ -72,9 +72,9 @@ void exceptionDuringAnalysisTaskExecutionIsFatal() throws DatabaseException {
              when(instance.getExecutorService(analyzer)).thenReturn(executorService);
              doReturn(failingAnalysisTask).when(instance).getAnalysisTasks(analyzer, exceptions);
 
-             instance.executeAnalysisTasks(analyzer, exceptions);
-             fail("ExceptionCollection exception was expected");
-         } catch (ExceptionCollection expected) {
+             ExceptionCollection expected = assertThrows(ExceptionCollection.class,
+                     () -> instance.executeAnalysisTasks(analyzer, exceptions),
+                     "ExceptionCollection exception was expected");
              List<Throwable> collected = expected.getExceptions();
              assertEquals(1, collected.size());
              assertEquals(java.util.concurrent.ExecutionException.class, collected.get(0).getClass());

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

@@ -22,7 +22,6 @@
 import org.owasp.dependencycheck.BaseTest;
 import org.owasp.dependencycheck.Engine;
 import org.owasp.dependencycheck.dependency.Dependency;
-import org.owasp.dependencycheck.exception.InitializationException;
 import org.owasp.dependencycheck.utils.Settings;
 
 import java.io.File;
@@ -34,7 +33,6 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.fail;
 
 /**
  *
@@ -113,9 +111,7 @@ void testInitialize() {
         try {
             instance.setEnabled(true);
             instance.setFilesMatched(true);
-            instance.prepare(null);
-        } catch (InitializationException ex) {
-            fail(ex.getMessage());
+            assertDoesNotThrow(() -> instance.prepare(null));
         } finally {
             assertDoesNotThrow(instance::close);
         }

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

@@ -35,8 +35,8 @@
 import java.io.File;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.fail;
 import static org.junit.jupiter.api.Assumptions.assumeFalse;
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
@@ -129,9 +129,8 @@ void testNonexistent() {
         Dependency d = new Dependency(test);
 
         try {
-            analyzer.analyze(d, null);
-            fail("Expected an AnalysisException");
-        } catch (AnalysisException ae) {
+            AnalysisException ae = assertThrows(AnalysisException.class, () -> analyzer.analyze(d, null),
+                "Expected an AnalysisException");
             assertTrue(ae.getMessage().contains("nonexistent.dll does not exist and cannot be analyzed by dependency-check"));
         } finally {
             System.setProperty(LOG_KEY, oldProp);
@@ -159,9 +158,9 @@ void testWithSettingMono() {
             AssemblyAnalyzer aanalyzer = new AssemblyAnalyzer();
             aanalyzer.initialize(getSettings());
             aanalyzer.accept(new File("test.dll")); // trick into "thinking it is active"
-            aanalyzer.prepare(null);
-            fail("Expected an InitializationException");
-        } catch (InitializationException ae) {
+
+            InitializationException ae = assertThrows(InitializationException.class, () -> aanalyzer.prepare(null),
+                    "Expected an InitializationException");
             assertEquals("An error occurred with the .NET AssemblyAnalyzer, is the dotnet 8.0 runtime or sdk installed?", ae.getMessage());
         } finally {
             System.setProperty(LOG_KEY, oldProp);

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

@@ -159,7 +159,7 @@ private void callDetermineCPE_full(String depName, String expResult, CPEAnalyzer
             }
             assertTrue(found, "Match not found: { dep:'" + dep.getFileName() + "', exp:'" + expResult + "' }");
         } else {
-            dep.getVulnerableSoftwareIdentifiers().forEach((id) -> fail("Unexpected match found: { dep:'" + dep.getFileName() + "', found:'" + id + "' }"));
+            dep.getVulnerableSoftwareIdentifiers().forEach(id -> fail("Unexpected match found: { dep:'" + dep.getFileName() + "', found:'" + id + "' }"));
         }
     }
 
@@ -222,7 +222,7 @@ void testDetermineCPE() throws Exception {
             instance.close();
 
             suppressionAnalyzer.analyze(commonValidator, engine);
-            commonValidator.getVulnerableSoftwareIdentifiers().forEach((i) -> fail("Apache Common Validator found an unexpected CPE identifier - " + i.getValue()));
+            commonValidator.getVulnerableSoftwareIdentifiers().forEach(i -> fail("Apache Common Validator found an unexpected CPE identifier - " + i.getValue()));
 
             String expResult = "cpe:2.3:a:apache:struts:2.1.2:*:*:*:*:*:*:*";
             assertFalse(struts.getVulnerableSoftwareIdentifiers().isEmpty(), "Incorrect match size - struts");

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

@@ -23,9 +23,9 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.fail;
 
 class OssIndexAnalyzerTest extends BaseTest {
 
@@ -141,9 +141,8 @@ void should_analyzeDependency_only_warn_when_transport_error_from_sonatype() thr
         // When
         try (engine) {
             engine.setDependencies(Collections.singletonList(dependency));
-            analyzer.analyzeDependency(dependency, engine);
-        } catch (AnalysisException e) {
-            fail("Analysis exception thrown upon remote error although only a warning should have been logged");
+            assertDoesNotThrow(() -> analyzer.analyzeDependency(dependency, engine),
+                    "Analysis exception thrown upon remote error although only a warning should have been logged");
         } finally {
             analyzer.close();
         }
@@ -169,9 +168,8 @@ void should_analyzeDependency_only_warn_when_socket_error_from_sonatype() throws
         // When
         try (engine) {
             engine.setDependencies(Collections.singletonList(dependency));
-            analyzer.analyzeDependency(dependency, engine);
-        } catch (AnalysisException e) {
-            fail("Analysis exception thrown upon remote error although only a warning should have been logged");
+            assertDoesNotThrow(() -> analyzer.analyzeDependency(dependency, engine),
+                    "Analysis exception thrown upon remote error although only a warning should have been logged");
         } finally {
             analyzer.close();
         }

core/src/test/java/org/owasp/dependencycheck/data/artifactory/ArtifactorySearchIT.java

@@ -28,7 +28,7 @@
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.fail;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 @Disabled
 class ArtifactorySearchIT {
@@ -63,7 +63,7 @@ void testWithRealInstanceUsingBearerToken() throws IOException {
     }
 
     @Test
-    void testWithRealInstanceAnonymous() throws IOException {
+    void testWithRealInstanceAnonymous() {
         // Given
         Dependency dependency = new Dependency();
         dependency.setSha1sum("c5b4c491aecb72e7c32a78da0b5c6b9cda8dee0f");
@@ -72,13 +72,10 @@ void testWithRealInstanceAnonymous() throws IOException {
         settings.setString(Settings.KEYS.ANALYZER_ARTIFACTORY_URL, "https://artifactory.techno.ingenico.com/artifactory");
         final ArtifactorySearch artifactorySearch = new ArtifactorySearch(settings);
         // When
-        try {
-            artifactorySearch.search(dependency);
-            fail("No Match found, should throw an exception!");
-        } catch (FileNotFoundException e) {
-            // Then
-            assertEquals("Artifact Dependency{ fileName='null', actualFilePath='null', filePath='null', packagePath='null'} not found in Artifactory", e.getMessage());
-        }
+        FileNotFoundException e = assertThrows(FileNotFoundException.class, () -> artifactorySearch.search(dependency),
+                "No Match found, should throw an exception!");
+        // Then
+        assertEquals("Artifact Dependency{ fileName='null', actualFilePath='null', filePath='null', packagePath='null'} not found in Artifactory", e.getMessage());
     }
 
     @Test