Add Jetty/Tomcat WAR integration tests for Maven (#1100)

Author: chanseokoh

jib-gradle-plugin/src/integration-test/java/com/google/cloud/tools/jib/gradle/WarProjectIntegrationTest.java

@@ -18,12 +18,11 @@
 
 import com.google.cloud.tools.jib.Command;
 import com.google.cloud.tools.jib.IntegrationTestingConfiguration;
-import com.google.common.io.ByteStreams;
-import java.io.ByteArrayOutputStream;
+import com.google.cloud.tools.jib.blob.Blobs;
 import java.io.IOException;
+import java.io.InputStream;
 import java.net.HttpURLConnection;
 import java.net.URL;
-import java.nio.charset.StandardCharsets;
 import javax.annotation.Nullable;
 import org.junit.After;
 import org.junit.Assert;
@@ -41,48 +40,46 @@ private static String getContent(URL url) throws InterruptedException {
       Thread.sleep(500);
       try {
         HttpURLConnection connection = (HttpURLConnection) url.openConnection();
-        int code = connection.getResponseCode();
-        if (code == HttpURLConnection.HTTP_OK) {
-          ByteArrayOutputStream out = new ByteArrayOutputStream();
-          ByteStreams.copy(connection.getInputStream(), out);
-          return new String(out.toByteArray(), StandardCharsets.UTF_8);
+        if (connection.getResponseCode() == HttpURLConnection.HTTP_OK) {
+          try (InputStream in = connection.getInputStream()) {
+            return Blobs.writeToString(Blobs.from(in));
+          }
         }
       } catch (IOException ex) {
       }
     }
     return null;
   }
 
-  private String containerName;
+  @Nullable private String containerName;
 
   @After
   public void tearDown() throws IOException, InterruptedException {
     if (containerName != null) {
-      new Command("docker", "stop", containerName.trim()).run();
+      new Command("docker", "stop", containerName).run();
     }
   }
 
   @Test
   public void testBuild_jettyServlet25Project() throws IOException, InterruptedException {
     buildAndRunDetached(servlet25Project, "war_jetty_servlet25:gradle", "build.gradle");
 
-    String content = getContent(new URL("http://localhost:8080/hello"));
-    Assert.assertEquals("Hello world", content);
+    Assert.assertEquals("Hello world", getContent(new URL("http://localhost:8080/hello")));
   }
 
   @Test
   public void testBuild_tomcatServlet25Project() throws IOException, InterruptedException {
     buildAndRunDetached(servlet25Project, "war_tomcat_servlet25:gradle", "build-tomcat.gradle");
 
-    String content = getContent(new URL("http://localhost:8080/hello"));
-    Assert.assertEquals("Hello world", content);
+    Assert.assertEquals("Hello world", getContent(new URL("http://localhost:8080/hello")));
   }
 
-  private void buildAndRunDetached(TestProject project, String imageName, String gradleBuildFile)
+  private void buildAndRunDetached(TestProject project, String label, String gradleBuildFile)
       throws IOException, InterruptedException {
-    String repository = "gcr.io/" + IntegrationTestingConfiguration.getGCPProject() + '/';
-    String targetImage = repository + imageName + System.nanoTime();
-    containerName =
+    String nameBase = "gcr.io/" + IntegrationTestingConfiguration.getGCPProject() + '/';
+    String targetImage = nameBase + label + System.nanoTime();
+    String output =
         JibRunHelper.buildAndRun(project, targetImage, gradleBuildFile, "--detach", "-p8080:8080");
+    containerName = output.trim();
   }
 }

jib-gradle-plugin/src/integration-test/resources/projects/war_servlet25/src/main/webapp/META-INF/MANIFEST.MF

@@ -1,2 +1,2 @@
 Manifest-Version: 1.0
-Class-Path:
+Class-Path: 

jib-maven-plugin/src/test/java/com/google/cloud/tools/jib/maven/BuildImageMojoIntegrationTest.java

@@ -18,10 +18,14 @@
 
 import com.google.cloud.tools.jib.Command;
 import com.google.cloud.tools.jib.IntegrationTestingConfiguration;
+import com.google.cloud.tools.jib.blob.Blobs;
 import com.google.cloud.tools.jib.image.ImageReference;
 import com.google.cloud.tools.jib.image.InvalidImageReferenceException;
 import com.google.cloud.tools.jib.registry.LocalRegistry;
 import java.io.IOException;
+import java.io.InputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -30,9 +34,11 @@
 import java.util.Arrays;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import javax.annotation.Nullable;
 import org.apache.maven.it.VerificationException;
 import org.apache.maven.it.Verifier;
 import org.hamcrest.CoreMatchers;
+import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.ClassRule;
@@ -54,10 +60,6 @@ public class BuildImageMojoIntegrationTest {
   @ClassRule
   public static final TestProject simpleTestProject = new TestProject(testPlugin, "simple");
 
-  @ClassRule
-  public static final TestProject complexTestProject =
-      new TestProject(testPlugin, "simple", "pom-complex.xml");
-
   @ClassRule
   public static final TestProject emptyTestProject = new TestProject(testPlugin, "empty");
 
@@ -68,6 +70,31 @@ public class BuildImageMojoIntegrationTest {
   public static final TestProject defaultTargetTestProject =
       new TestProject(testPlugin, "default-target");
 
+  @ClassRule
+  public static final TestProject servlet25Project = new TestProject(testPlugin, "war_servlet25");
+
+  private static String getGcrImageReference(String label) {
+    String nameBase = "gcr.io/" + IntegrationTestingConfiguration.getGCPProject() + '/';
+    return nameBase + label + System.nanoTime();
+  }
+
+  @Nullable
+  private static String getContent(URL url) throws InterruptedException {
+    for (int i = 0; i < 40; i++) {
+      Thread.sleep(500);
+      try {
+        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
+        if (connection.getResponseCode() == HttpURLConnection.HTTP_OK) {
+          try (InputStream in = connection.getInputStream()) {
+            return Blobs.writeToString(Blobs.from(in));
+          }
+        }
+      } catch (IOException ex) {
+      }
+    }
+    return null;
+  }
+
   /**
    * Builds and runs jib:build on a project at {@code projectRoot} pushing to {@code
    * imageReference}.
@@ -81,21 +108,16 @@ private static String buildAndRun(Path projectRoot, String imageReference, boole
     verifier.executeGoals(Arrays.asList("clean", "compile"));
 
     // Builds twice, and checks if the second build took less time.
-    verifier.executeGoal("jib:" + BuildImageMojo.GOAL_NAME);
+    verifier.executeGoal("jib:build");
     float timeOne = getBuildTimeFromVerifierLog(verifier);
 
     if (runTwice) {
       verifier.resetStreams();
-      verifier.executeGoal("jib:" + BuildImageMojo.GOAL_NAME);
+      verifier.executeGoal("jib:build");
       float timeTwo = getBuildTimeFromVerifierLog(verifier);
 
-      Assert.assertTrue(
-          "First build time ("
-              + timeOne
-              + ") is not greater than second build time ("
-              + timeTwo
-              + ")",
-          timeOne > timeTwo);
+      String failMessage = "First build time (%s) is not greater than second build time (%s)";
+      Assert.assertTrue(String.format(failMessage, timeOne, timeTwo), timeOne > timeTwo);
     }
 
     verifier.verifyErrorFreeLog();
@@ -112,9 +134,7 @@ private static String buildAndRunAdditionalTag(
     verifier.setSystemProperty("_ADDITIONAL_TAG", additionalTag);
     verifier.setAutoclean(false);
     verifier.addCliOption("-X");
-    verifier.executeGoals(Arrays.asList("clean", "compile"));
-
-    verifier.executeGoal("jib:" + BuildImageMojo.GOAL_NAME);
+    verifier.executeGoals(Arrays.asList("clean", "compile", "jib:build"));
     verifier.verifyErrorFreeLog();
 
     String additionalImageReference =
@@ -134,7 +154,7 @@ private static String buildAndRunComplex(
       String imageReference, String username, String password, LocalRegistry targetRegistry)
       throws VerificationException, IOException, InterruptedException {
     Instant before = Instant.now();
-    Verifier verifier = new Verifier(complexTestProject.getProjectRoot().toString());
+    Verifier verifier = new Verifier(simpleTestProject.getProjectRoot().toString());
     verifier.setSystemProperty("_TARGET_IMAGE", imageReference);
     verifier.setSystemProperty("_TARGET_USERNAME", username);
     verifier.setSystemProperty("_TARGET_PASSWORD", password);
@@ -217,26 +237,31 @@ private static void assertCreationTimeEpoch(String imageReference)
         new Command("docker", "inspect", "-f", "{{.Created}}", imageReference).run().trim());
   }
 
+  @Nullable private String detachedContainerName;
+
   @Before
-  public void setup() throws IOException, InterruptedException {
+  public void setUp() throws IOException, InterruptedException {
     // Pull distroless to local registry so we can test 'from' credentials
     localRegistry1.pullAndPushToLocal("gcr.io/distroless/java:latest", "distroless/java");
   }
 
+  @After
+  public void tearDown() throws IOException, InterruptedException {
+    if (detachedContainerName != null) {
+      new Command("docker", "stop", detachedContainerName).run();
+    }
+  }
+
   @Test
   public void testExecute_simple() throws VerificationException, IOException, InterruptedException {
-    String targetImage =
-        "gcr.io/"
-            + IntegrationTestingConfiguration.getGCPProject()
-            + "/simpleimage:maven"
-            + System.nanoTime();
+    String targetImage = getGcrImageReference("simpleimage:maven");
 
     // Test empty output error
     try {
       Verifier verifier = new Verifier(simpleTestProject.getProjectRoot().toString());
       verifier.setSystemProperty("_TARGET_IMAGE", targetImage);
       verifier.setAutoclean(false);
-      verifier.executeGoals(Arrays.asList("clean", "jib:" + BuildImageMojo.GOAL_NAME));
+      verifier.executeGoals(Arrays.asList("clean", "jib:build"));
       Assert.fail();
 
     } catch (VerificationException ex) {
@@ -275,12 +300,7 @@ public void testExecute_simple() throws VerificationException, IOException, Inte
 
   @Test
   public void testExecute_empty() throws InterruptedException, IOException, VerificationException {
-    String targetImage =
-        "gcr.io/"
-            + IntegrationTestingConfiguration.getGCPProject()
-            + "/emptyimage:maven"
-            + System.nanoTime();
-
+    String targetImage = getGcrImageReference("emptyimage:maven");
     Assert.assertEquals("", buildAndRun(emptyTestProject.getProjectRoot(), targetImage, false));
     assertCreationTimeEpoch(targetImage);
   }
@@ -289,11 +309,7 @@ public void testExecute_empty() throws InterruptedException, IOException, Verifi
   public void testExecute_multipleTags()
       throws IOException, InterruptedException, InvalidImageReferenceException,
           VerificationException {
-    String targetImage =
-        "gcr.io/"
-            + IntegrationTestingConfiguration.getGCPProject()
-            + "/multitag-image:maven"
-            + System.nanoTime();
+    String targetImage = getGcrImageReference("multitag-image:maven");
     Assert.assertEquals(
         "",
         buildAndRunAdditionalTag(
@@ -306,7 +322,7 @@ public void testExecute_defaultTarget() throws IOException {
     try {
       Verifier verifier = new Verifier(defaultTargetTestProject.getProjectRoot().toString());
       verifier.setAutoclean(false);
-      verifier.executeGoals(Arrays.asList("clean", "jib:" + BuildImageMojo.GOAL_NAME));
+      verifier.executeGoals(Arrays.asList("clean", "jib:build"));
       Assert.fail();
 
     } catch (VerificationException ex) {
@@ -341,4 +357,34 @@ public void testExecute_complex_sameFromAndToRegistry()
   public void testExecute_skipJibGoal() throws VerificationException, IOException {
     SkippedGoalVerifier.verifyGoalIsSkipped(skippedTestProject, BuildImageMojo.GOAL_NAME);
   }
+
+  @Test
+  public void testExecute_jettyServlet25()
+      throws VerificationException, IOException, InterruptedException {
+    buildAndRunWar("jetty-servlet25:maven", "pom.xml");
+    Assert.assertEquals("Hello world", getContent(new URL("http://localhost:8080/hello")));
+  }
+
+  @Test
+  public void testExecute_tomcatServlet25()
+      throws VerificationException, IOException, InterruptedException {
+    buildAndRunWar("tomcat-servlet25:maven", "pom-tomcat.xml");
+    Assert.assertEquals("Hello world", getContent(new URL("http://localhost:8080/hello")));
+  }
+
+  private void buildAndRunWar(String label, String pomXml)
+      throws VerificationException, IOException, InterruptedException {
+    String targetImage = getGcrImageReference(label);
+
+    Verifier verifier = new Verifier(servlet25Project.getProjectRoot().toString());
+    verifier.setSystemProperty("_TARGET_IMAGE", targetImage);
+    verifier.setAutoclean(false);
+    verifier.addCliOption("-X");
+    verifier.addCliOption("--file=" + pomXml);
+    verifier.executeGoals(Arrays.asList("clean", "package", "jib:build"));
+    verifier.verifyErrorFreeLog();
+
+    detachedContainerName =
+        new Command("docker", "run", "--rm", "--detach", "-p8080:8080", targetImage).run().trim();
+  }
 }

jib-maven-plugin/src/test/java/com/google/cloud/tools/jib/maven/TestProject.java

@@ -21,6 +21,8 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import org.apache.maven.it.util.ResourceExtractor;
 import org.junit.rules.TemporaryFolder;
 
@@ -29,29 +31,32 @@ public class TestProject extends TemporaryFolder implements Closeable {
 
   private static final String PROJECTS_PATH_IN_RESOURCES = "/projects/";
 
+  private static boolean isPomXml(Path path) {
+    String filename = path.getFileName().toString();
+    return filename.startsWith("pom") && filename.endsWith(".xml");
+  }
+
   private final TestPlugin testPlugin;
   private final String projectDir;
-  private final String pomFilename;
 
   private Path projectRoot;
 
   /** Initialize to a specific project directory. */
   public TestProject(TestPlugin testPlugin, String projectDir) {
-    this(testPlugin, projectDir, "pom.xml");
-  }
-
-  /** Initialize to a specific project directory with a non-default pom.xml. */
-  TestProject(TestPlugin testPlugin, String projectDir, String pomFilename) {
     this.testPlugin = testPlugin;
     this.projectDir = projectDir;
-    this.pomFilename = pomFilename;
   }
 
   /** Get the project root resolved as a real path */
   public Path getProjectRoot() throws IOException {
     return projectRoot.toRealPath();
   }
 
+  @Override
+  public void close() {
+    after();
+  }
+
   @Override
   protected void before() throws Throwable {
     super.before();
@@ -66,16 +71,14 @@ private void copyProject() throws IOException {
             .toPath();
 
     // Puts the correct plugin version into the test project pom.xml.
-    Path pomXml = projectRoot.resolve(pomFilename);
-    Files.write(
-        pomXml,
-        new String(Files.readAllBytes(pomXml), StandardCharsets.UTF_8)
-            .replace("@@PluginVersion@@", testPlugin.getVersion())
-            .getBytes(StandardCharsets.UTF_8));
-  }
-
-  @Override
-  public void close() {
-    after();
+    try (Stream<Path> files = Files.list(projectRoot)) {
+      for (Path pomXml : files.filter(TestProject::isPomXml).collect(Collectors.toList())) {
+        Files.write(
+            pomXml,
+            new String(Files.readAllBytes(pomXml), StandardCharsets.UTF_8)
+                .replace("@@PluginVersion@@", testPlugin.getVersion())
+                .getBytes(StandardCharsets.UTF_8));
+      }
+    }
   }
 }