Add Integration Tests to replicate behaviour.

Signed-off-by: Rahul Krishna <[email protected]>

Author: rahlk

build.gradle

@@ -62,6 +62,15 @@ sourceSets {
     }
 }
 
+tasks.register('integrationTest', Test) {
+    description = 'Runs integration tests.'
+    group = 'verification'
+    testClassesDirs = sourceSets.integrationTest.output.classesDirs
+    classpath = sourceSets.integrationTest.runtimeClasspath
+}
+
+tasks.check { dependsOn integrationTest }
+
 // Remove that nagging bin folder vscode seems to generate every single time
 clean.doFirst {
     delete "${rootDir}/bin"

src/it/java/com/ibm/cldk/CodeAnalyzerIntegrationTest.java

@@ -8,6 +8,7 @@
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
+import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.nio.file.Path;
@@ -23,10 +24,25 @@ public class CodeAnalyzerIntegrationTest {
      * Creates a Java 11 test container that mounts the build/libs folder.
      */
     static String codeanalyzerVersion;
+
+    static {
+        // Build project first
+        try {
+            Process process = new ProcessBuilder("./gradlew", "clean", "fatJar")
+                    .directory(new File(System.getProperty("user.dir")))
+                    .start();
+            if (process.waitFor() != 0) {
+                throw new RuntimeException("Build failed");
+            }
+        } catch (IOException | InterruptedException e) {
+            throw new RuntimeException("Failed to build codeanalyzer", e);
+        }
+    }
+
     @Container
     static final GenericContainer<?> container = new GenericContainer<>("openjdk:11-jdk")
             .withCreateContainerCmdModifier(cmd -> cmd.withEntrypoint("sh"))
-            .withCommand("-c", "while true; do sleep 1; done")  // Keep container running
+            .withCommand("-c", "while true; do sleep 1; done")
             .withFileSystemBind(
                     String.valueOf(Paths.get(System.getProperty("user.dir")).resolve("build/libs")),
                     "/opt/jars",
@@ -35,14 +51,12 @@ public class CodeAnalyzerIntegrationTest {
     @BeforeAll
     static void setUp() {
         Properties properties = new Properties();
-        Path propertiesPath = Paths.get(System.getProperty("user.dir"), "gradle.properties");
-
-        try (FileInputStream fis = new FileInputStream(propertiesPath.toFile())) {
+        try (FileInputStream fis = new FileInputStream(
+                Paths.get(System.getProperty("user.dir"), "gradle.properties").toFile())) {
             properties.load(fis);
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
-
         codeanalyzerVersion = properties.getProperty("version");
     }
 

src/it/java/com/ibm/cldk/MavenApplicationIntegrationTest.java

@@ -7,13 +7,19 @@
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.MountableFile;
 
+import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.net.URL;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Objects;
 import java.util.Properties;
 
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
 @Testcontainers
 @SuppressWarnings("resource")
 public class MavenApplicationIntegrationTest {
@@ -22,40 +28,88 @@ public class MavenApplicationIntegrationTest {
      * Creates a Java 11 test container that mounts the build/libs folder.
      */
     static String codeanalyzerVersion;
+
+    static {
+        // Build project first
+        try {
+            Process process = new ProcessBuilder("./gradlew", "clean", "fatJar")
+                    .directory(new File(System.getProperty("user.dir")))
+                    .start();
+            if (process.waitFor() != 0) {
+                throw new RuntimeException("Build failed");
+            }
+        } catch (IOException | InterruptedException e) {
+            throw new RuntimeException("Failed to build codeanalyzer", e);
+        }
+    }
     @Container
-    static final GenericContainer<?> baseJavaContainer = new GenericContainer<>("openjdk:11-jdk")
-            .withCreateContainerCmdModifier(cmd -> cmd.withEntrypoint("sh"))
-            .withCommand("-c", "while true; do sleep 1; done")  // Keep container running
-            .withFileSystemBind(
-                    String.valueOf(Paths.get(System.getProperty("user.dir")).resolve("build/libs")),
-                    "/opt/jars",
-                    BindMode.READ_WRITE)
-            // Copy the java project to the
-            .withFileSystemBind(
-            MavenApplicationIntegrationTest.class.getResource("/test-applications/simple-maven-project").getPath(),
-               "/projects/simple-maven-project",
-            BindMode.READ_ONLY);
+    static final GenericContainer<?> baseJavaContainerNoMaven = new GenericContainer<>("openjdk:17-jdk").withCreateContainerCmdModifier(cmd -> cmd.withEntrypoint("sh")).withCommand("-c", "while true; do sleep 1; done")  // Keep container running
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("build/libs")), "/opt/jars")
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/it/resources/test-applications/mvnw-corrupt-test")), "/test-applications/mvnw-corrupt-test")
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/it/resources/test-applications/mvnw-working-test")), "/test-applications/mvnw-working-test");
+
 
     @Container
-    static final GenericContainer<?> mavenContainer = new GenericContainer<>("maven:3.9-eclipse-temurin-11")
+    static final GenericContainer<?> mavenContainer = new GenericContainer<>("maven:3.8.3-openjdk-17")
             .withCreateContainerCmdModifier(cmd -> cmd.withEntrypoint("sh"))
             .withCommand("-c", "while true; do sleep 1; done")
-            .withFileSystemBind(
-                    String.valueOf(Paths.get(System.getProperty("user.dir")).resolve("build/libs")),
-                    "/opt/jars",
-                    BindMode.READ_WRITE);
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("build/libs")), "/opt/jars")
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/it/resources/test-applications/mvnw-corrupt-test")), "/test-applications/mvnw-corrupt-test")
+            .withCopyFileToContainer(MountableFile.forHostPath(Paths.get(System.getProperty("user.dir")).resolve("src/it/resources/test-applications/mvnw-working-test")), "/test-applications/mvnw-working-test");
 
     @BeforeAll
     static void setUp() {
         Properties properties = new Properties();
-        Path propertiesPath = Paths.get(System.getProperty("user.dir"), "gradle.properties");
-
-        try (FileInputStream fis = new FileInputStream(propertiesPath.toFile())) {
+        try (FileInputStream fis = new FileInputStream(
+                Paths.get(System.getProperty("user.dir"), "gradle.properties").toFile())) {
             properties.load(fis);
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
-
         codeanalyzerVersion = properties.getProperty("version");
     }
+
+    @Test
+    void corruptMavenShouldNotBuildWithWrapper() throws IOException, InterruptedException {
+        // Make executable
+        mavenContainer.execInContainer("chmod", "+x", "/test-applications/mvnw-corrupt-test/mvnw");
+        // Let's start by building the project by itself
+        var mavenProjectBuildWithWrapper = mavenContainer.withWorkingDirectory("/test-applications/mvnw-corrupt-test").execInContainer("/test-applications/mvnw-corrupt-test/mvnw", "clean", "compile");
+        Assertions.assertNotEquals(0, mavenProjectBuildWithWrapper.getExitCode());
+    }
+
+    @Test
+    void corruptMavenShouldProduceAnalysisArtifactsWhenMVNCommandIsInPath() throws IOException, InterruptedException {
+        // Let's start by building the project by itself
+        var corruptMavenProjectBuild = mavenContainer.withWorkingDirectory("/test-applications/mvnw-corrupt-test").execInContainer("mvn", "-f", "/test-applications/mvnw-corrupt-test/pom.xml", "clean", "compile");
+        Assertions.assertEquals(0, corruptMavenProjectBuild.getExitCode(), "Failed to build the project with system's default Maven.");
+        // NOw run codeanalyzer and assert if analysis.json is generated.
+        mavenContainer.execInContainer("java", "-jar", String.format("/opt/jars/codeanalyzer-%s.jar", codeanalyzerVersion), "--input=/test-applications/mvnw-corrupt-test", "--output=/tmp/", "--analysis-level=2", "--no-build");
+        var codeAnalyzerOutputDirContents = mavenContainer.execInContainer("ls", "/tmp/analysis.json");
+        String codeAnalyzerOutputDirContentsStdOut = codeAnalyzerOutputDirContents.getStdout();
+        Assertions.assertTrue(codeAnalyzerOutputDirContentsStdOut.length() > 0, "Could not find 'analysis.json'.");
+        Assertions.assertTrue(codeAnalyzerOutputDirContentsStdOut.contains("Building the project using") && codeAnalyzerOutputDirContentsStdOut.contains("/mvn."));
+        Assertions.assertFalse(codeAnalyzerOutputDirContentsStdOut.contains("Building the project using") && codeAnalyzerOutputDirContentsStdOut.contains("/test-applications/mvnw-corrupt-test/mvnw."));
+    }
+
+    @Test
+    void corruptMavenShouldNotTerminateWithErrorWhenMavenIsNotPresentUnlessAnalysisLevel2() throws IOException, InterruptedException {
+        // When analysis level 2, we should get a Runtime Exception
+        assertThrows(RuntimeException.class, () ->
+                baseJavaContainerNoMaven.execInContainer(
+                        "java",
+                        "-jar",
+                        String.format("/opt/jars/codeanalyzer-%s.jar", codeanalyzerVersion),
+                        "--input=/test-applications/mvnw-corrupt-test",
+                        "--output=/tmp/",
+                        "--analysis-level=2"
+                )
+        );
+        // When analysis level is 1, we should still be able to generate an analysis.json file.
+        baseJavaContainerNoMaven.execInContainer("java", "-jar", String.format("/opt/jars/codeanalyzer-%s.jar", codeanalyzerVersion), "--input=/test-applications/mvnw-corrupt-test", "--output=/tmp/", "--analysis-level=1");
+        var codeAnalyzerOutputDirContents = baseJavaContainerNoMaven.execInContainer("ls", "/tmp/analysis.json");
+        String codeAnalyzerOutputDirContentsStdOut = codeAnalyzerOutputDirContents.getStdout();
+        Assertions.assertTrue(codeAnalyzerOutputDirContentsStdOut.length() > 0, "Could not find 'analysis.json'.");
+        Assertions.assertTrue(codeAnalyzerOutputDirContentsStdOut.contains("Could not find Maven or a valid Maven Wrapper"));
+    }
 }