Test code clean up

simasch · simasch · commit 5f6299c745ae · 2021-11-23T10:27:11.000+01:00
diff --git a/src/test/java/org/utplsql/maven/plugin/UtPLSQLMojoIT.java b/src/test/java/org/utplsql/maven/plugin/UtPLSQLMojoIT.java
@@ -7,7 +7,6 @@
 import org.apache.maven.model.Model;
 import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
-import org.junit.Assert;
 import org.junit.BeforeClass;
 import org.junit.Test;
 
@@ -19,6 +18,10 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
 public class UtPLSQLMojoIT {
 
     private static String pluginVersion = null;
@@ -44,16 +47,13 @@ public void testSimpleProject() {
             final String PROJECT_NAME = "simple-project";
             File testProject = ResourceExtractor.simpleExtractResources(getClass(), "/" + PROJECT_NAME);
 
-            Verifier verifier;
-            verifier = createVerifier(testProject);
-
+            Verifier verifier = createVerifier(testProject);
             verifier.executeGoal("test");
 
-            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml",
-                    "utplsql/coverage-sonar-reporter.xml");
+            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml", "utplsql/coverage-sonar-reporter.xml");
         } catch (Exception e) {
             e.printStackTrace();
-            Assert.fail("Unexpected Exception running the test of Definition " + e.getMessage());
+            fail("Unexpected Exception running the test of Definition " + e.getMessage());
         }
     }
 
@@ -66,11 +66,10 @@ public void testRegexProject() {
             Verifier verifier = createVerifier(testProject);
             verifier.executeGoal("test");
 
-            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml",
-                    "utplsql/coverage-sonar-reporter.xml");
+            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml", "utplsql/coverage-sonar-reporter.xml");
         } catch (Exception e) {
             e.printStackTrace();
-            Assert.fail("Unexpected Exception running the test : " + e.getMessage());
+            fail("Unexpected Exception running the test : " + e.getMessage());
         }
     }
 
@@ -83,11 +82,10 @@ public void testTypeMappingProject() {
             Verifier verifier = createVerifier(testProject);
             verifier.executeGoal("test");
 
-            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml",
-                    "utplsql/coverage-sonar-reporter.xml");
+            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml", "utplsql/coverage-sonar-reporter.xml");
         } catch (Exception e) {
             e.printStackTrace();
-            Assert.fail("Unexpected Exception running the test : " + e.getMessage());
+            fail("Unexpected Exception running the test : " + e.getMessage());
         }
     }
 
@@ -100,11 +98,10 @@ public void testOwnerParameterProject() {
             Verifier verifier = createVerifier(testProject);
             verifier.executeGoal("test");
 
-            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml",
-                    "utplsql/coverage-sonar-reporter.xml");
+            checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml", "utplsql/coverage-sonar-reporter.xml");
         } catch (Exception e) {
             e.printStackTrace();
-            Assert.fail("Unexpected Exception running the test : " + e.getMessage());
+            fail("Unexpected Exception running the test : " + e.getMessage());
         }
     }
 
@@ -118,7 +115,7 @@ public void testMinimalistProject() {
             verifier.executeGoal("test");
         } catch (Exception e) {
             e.printStackTrace();
-            Assert.fail("Unexpected Exception running the test : " + e.getMessage());
+            fail("Unexpected Exception running the test : " + e.getMessage());
         }
     }
 
@@ -134,38 +131,42 @@ public void testTagsProject() {
             checkReportsGenerated(PROJECT_NAME, "utplsql/sonar-test-reporter.xml");
         } catch (Exception e) {
             e.printStackTrace();
-            Assert.fail("Unexpected Exception running the test of Definition " + e.getMessage());
+            fail("Unexpected Exception running the test of Definition " + e.getMessage());
         }
     }
 
+    /**
+     * Duration is set to 1 before comparing contents as it is always different.
+     * Path separator is set to "/" to ensure windows / linux / mac compatibility.
+     * \r and \n are removed to provide simpler comparison.
+     *
+     * @param projectName Project name
+     * @param files       Files to compare
+     */
     private void checkReportsGenerated(String projectName, String... files) {
         for (String filename : files) {
             File outputFile = new File("target/test-classes/" + projectName + "/target", filename);
             File expectedOutputFile = new File("target/test-classes/" + projectName + "/expected-output", filename);
 
-            Assert.assertTrue("The reporter for " + filename + " was not generated", outputFile.exists());
+            assertTrue("The reporter for " + filename + " was not generated", outputFile.exists());
+
             try {
-                // Duration is set to 1 before comparing contents as it is always different.
-                // Path separator is set to "/" to ensure windows / linux / mac compatibility.
-                Stream<String> stream = Files
-                        .lines(Paths.get("target", "test-classes", projectName, "target", filename));
-
-                String outputContent = stream
-                        .filter(line -> !line.contains("<?xml"))
-                        .map(line -> line.replaceAll("(duration=\"[0-9.]*\")", "duration=\"1\""))
-                        .map(line -> line.replaceAll("\\\\", "/"))
-                        .map(line -> line.replaceAll("\r", "").replaceAll("\n", ""))
-                        .collect(Collectors.joining("\n"));
-
-                stream.close();
-                Assert.assertEquals("The files differ!",
-                        FileUtils.readFileToString(expectedOutputFile, "utf-8")
-                                .replace("\r", "")
-                                .replace("\n", ""),
-                        outputContent.replace("\n", ""));
+                try (Stream<String> stream = Files.lines(Paths.get("target", "test-classes", projectName, "target", filename))) {
+                    String outputContent = stream
+                            .filter(line -> !line.contains("<?xml"))
+                            .map(line -> line.replaceAll("(duration=\"[0-9.]*\")", "duration=\"1\""))
+                            .map(line -> line.replaceAll("\\\\", "/"))
+                            .map(line -> line.replaceAll("\r", "").replaceAll("\n", ""))
+                            .collect(Collectors.joining("\n"));
+                    assertEquals("The files differ!",
+                            FileUtils.readFileToString(expectedOutputFile, "utf-8")
+                                    .replace("\r", "")
+                                    .replace("\n", ""),
+                            outputContent.replace("\n", ""));
+                }
             } catch (IOException e) {
                 e.printStackTrace();
-                Assert.fail("Unexpected Exception running the test : " + e.getMessage());
+                fail("Unexpected Exception running the test : " + e.getMessage());
             }
         }
     }
diff --git a/src/test/java/org/utplsql/maven/plugin/UtPLSQLMojoTest.java b/src/test/java/org/utplsql/maven/plugin/UtPLSQLMojoTest.java
@@ -3,7 +3,6 @@
 import org.apache.commons.lang3.tuple.Pair;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.testing.MojoRule;
-import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -29,6 +28,8 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
@@ -64,7 +65,7 @@ public void setUp() throws Exception {
     }
 
     /**
-     * testInvalidSourcesDirectory.
+     * Invalid Sources Directory
      * <p>
      * Given : a pom.xml with invalid sources' directory
      * When : pom is read and buildSourcesOptions is run
@@ -74,15 +75,15 @@ public void setUp() throws Exception {
     public void testInvalidSourcesDirectory() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/invalidTestsSourcesDirectories/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
-        MojoExecutionException exception = Assert.assertThrows(MojoExecutionException.class, () -> Whitebox.invokeMethod(utplsqlMojo, "buildSourcesOptions"));
+        MojoExecutionException exception = assertThrows(MojoExecutionException.class, () -> Whitebox.invokeMethod(utplsqlMojo, "buildSourcesOptions"));
 
-        Assert.assertEquals("Invalid <SOURCES> in your pom.xml", exception.getMessage());
+        assertEquals("Invalid <SOURCES> in your pom.xml", exception.getMessage());
     }
 
     /**
-     * testInvalidTestsDirectory.
+     * Invalid Tests Directory
      * <p>
      * Given : a pom.xml with invalid tests' directory
      * When : pom is read and buildTestsOptions is run
@@ -92,15 +93,15 @@ public void testInvalidSourcesDirectory() throws Exception {
     public void testInvalidTestsDirectory() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/invalidTestsSourcesDirectories/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
-        MojoExecutionException exception = Assert.assertThrows(MojoExecutionException.class, () -> Whitebox.invokeMethod(utplsqlMojo, "buildTestsOptions"));
+        MojoExecutionException exception = assertThrows(MojoExecutionException.class, () -> Whitebox.invokeMethod(utplsqlMojo, "buildTestsOptions"));
 
-        Assert.assertEquals("Invalid <TESTS> in your pom.xml: Invalid <directory> bar in resource. Check your pom.xml", exception.getMessage());
+        assertEquals("Invalid <TESTS> in your pom.xml: Invalid <directory> bar in resource. Check your pom.xml", exception.getMessage());
     }
 
     /**
-     * testSourcesTestsParameters.
+     * Sources Tests Parameters
      * <p>
      * Given : a pom.xml with sources and tests with a lot of parameters
      * When : pom is read and buildSourcesOptions / buildTestsOptions are run
@@ -110,7 +111,7 @@ public void testInvalidTestsDirectory() throws Exception {
     public void testSourcesTestsParameters() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/testSourcesTestsParams/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         // TODO : move to another test about reporters
         List<String> reporters = Whitebox.getInternalState(utplsqlMojo, "reporters");
@@ -122,9 +123,9 @@ public void testSourcesTestsParameters() throws Exception {
         assertEquals("srcs/foo.sql", sources.getFilePaths().get(0));
         assertEquals("code_owner", sources.getObjectOwner());
         assertEquals(".*/\\w+/(\\w+)/(\\w+)\\.\\w{3}", sources.getRegexPattern());
-        assertEquals(new Integer(9), sources.getNameSubExpression());
-        assertEquals(new Integer(1), sources.getTypeSubExpression());
-        assertEquals(new Integer(4), sources.getOwnerSubExpression());
+        assertEquals(Integer.valueOf(9), sources.getNameSubExpression());
+        assertEquals(Integer.valueOf(1), sources.getTypeSubExpression());
+        assertEquals(Integer.valueOf(4), sources.getOwnerSubExpression());
         assertEquals(1, sources.getTypeMappings().size());
         assertEquals("bar", sources.getTypeMappings().get(0).getKey());
         assertEquals("foo", sources.getTypeMappings().get(0).getValue());
@@ -136,16 +137,16 @@ public void testSourcesTestsParameters() throws Exception {
         assertTrue(tests.getFilePaths().contains("te/st/spec.spc"));
         assertEquals("tests_owner", tests.getObjectOwner());
         assertEquals(".*/\\w+/(\\w+)/(\\w+)\\.\\w{3}", tests.getRegexPattern());
-        assertEquals(new Integer(54), tests.getNameSubExpression());
-        assertEquals(new Integer(21), tests.getTypeSubExpression());
-        assertEquals(new Integer(24), tests.getOwnerSubExpression());
+        assertEquals(Integer.valueOf(54), tests.getNameSubExpression());
+        assertEquals(Integer.valueOf(21), tests.getTypeSubExpression());
+        assertEquals(Integer.valueOf(24), tests.getOwnerSubExpression());
         assertEquals(1, tests.getTypeMappings().size());
         assertEquals("def", tests.getTypeMappings().get(0).getKey());
         assertEquals("abc", tests.getTypeMappings().get(0).getValue());
     }
 
     /**
-     * testSourcesAndTestsParameterDoesNotExist.
+     * Sources and Tests Parameter does not exist
      * <p>
      * Given : a pom.xml with no sources / tests tags and default directory does not exist.
      * When : pom is read and buildSourcesOptions / buildTestsOptions are run
@@ -155,7 +156,7 @@ public void testSourcesTestsParameters() throws Exception {
     public void testSourcesAndTestsParameterDoesNotExist() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule.lookupConfiguredMojo(
                 new File("src/test/resources/unit-tests/testNoSourcesTestsParams/directoryDoesNotExist/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         // check sources
         FileMapperOptions sources = Whitebox.invokeMethod(utplsqlMojo, "buildSourcesOptions");
@@ -167,7 +168,7 @@ public void testSourcesAndTestsParameterDoesNotExist() throws Exception {
     }
 
     /**
-     * testSourcesAndTestsParameterDoesNotExistButDefaultDirectoryExists.
+     * Sources and Tests Parameter does not exist but Default Directory exists
      * <p>
      * Given : a pom.xml with no sources / tests tags but default directory exists.
      * When : pom is read and buildSourcesOptions / buildTestsOptions are run
@@ -177,7 +178,7 @@ public void testSourcesAndTestsParameterDoesNotExist() throws Exception {
     public void testSourcesAndTestsParameterDoesNotExistButDefaultDirectoryExists() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/testNoSourcesTestsParams/directoryExists/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         // check sources
         FileMapperOptions sources = Whitebox.invokeMethod(utplsqlMojo, "buildSourcesOptions");
@@ -193,7 +194,7 @@ public void testSourcesAndTestsParameterDoesNotExistButDefaultDirectoryExists()
     }
 
     /**
-     * testSourcesAndTestsParameterHaveNotDirectoryTag.
+     * Sources and Tests Parameter have not Directory Tag
      * <p>
      * Given : a pom.xml with source and test tag not containing a directory tag.
      * When : pom is read and buildSourcesOptions / buildTestsOptions are run
@@ -203,7 +204,7 @@ public void testSourcesAndTestsParameterDoesNotExistButDefaultDirectoryExists()
     public void testSourcesAndTestsParameterHaveNotDirectoryTag() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/partialSourceAndTestTag/missingDirectory/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         // check sources
         FileMapperOptions sources = Whitebox.invokeMethod(utplsqlMojo, "buildSourcesOptions");
@@ -220,7 +221,7 @@ public void testSourcesAndTestsParameterHaveNotDirectoryTag() throws Exception {
     }
 
     /**
-     * testSourcesAndTestsParameterHaveNotDirectoryTag.
+     * Sources and Tests Parameter have not Directory Tag
      * <p>
      * Given : a pom.xml with source and test tag not containing a directory tag.
      * When : pom is read and buildSourcesOptions / buildTestsOptions are run
@@ -230,7 +231,7 @@ public void testSourcesAndTestsParameterHaveNotDirectoryTag() throws Exception {
     public void testSourcesAndTestsParameterHaveNotIncludesTag() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/partialSourceAndTestTag/missingIncludes/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         // check sources
         FileMapperOptions sources = Whitebox.invokeMethod(utplsqlMojo, "buildSourcesOptions");
@@ -245,11 +246,14 @@ public void testSourcesAndTestsParameterHaveNotIncludesTag() throws Exception {
         assertTrue(tests.getFilePaths().contains("src/test/bar/f2.pkg"));
     }
 
+    /**
+     * Default Console Behaviour
+     */
     @Test
     public void testDefaultConsoleBehaviour() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/defaultConsoleOutputBehaviour/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         List<Reporter> reporterList = new ArrayList<>();
         when(mockReporterFactory.createReporter(anyString())).thenAnswer(invocation -> {
@@ -290,11 +294,14 @@ public void testDefaultConsoleBehaviour() throws Exception {
         assertTrue(reporterParameter3.isFileOutput());
     }
 
+    /**
+     * Add Default Reporter
+     */
     @Test
     public void testAddDefaultReporter() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/defaultConsoleOutputBehaviour/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         List<Reporter> reporterList = new ArrayList<>();
         when(mockReporterFactory.createReporter(anyString())).thenAnswer(invocation -> {
@@ -314,11 +321,14 @@ public void testAddDefaultReporter() throws Exception {
         verify(reporterList.get(0)).init(mockConnection);
     }
 
+    /**
+     * Skip utPLSQL Tests
+     */
     @Test
     public void testSkipUtplsqlTests() throws Exception {
         UtPLSQLMojo utplsqlMojo = (UtPLSQLMojo) rule
                 .lookupConfiguredMojo(new File("src/test/resources/unit-tests/skipUtplsqlTests/"), "test");
-        Assert.assertNotNull(utplsqlMojo);
+        assertNotNull(utplsqlMojo);
 
         final ByteArrayOutputStream console = new ByteArrayOutputStream();
         System.setOut(new PrintStream(console));
@@ -327,6 +337,6 @@ public void testSkipUtplsqlTests() throws Exception {
 
         String standardOutput = console.toString();
 
-        Assert.assertTrue(standardOutput.contains("utPLSQLTests are skipped."));
+        assertTrue(standardOutput.contains("utPLSQLTests are skipped."));
     }
 }
