Add Maven support for containerizing packaged JAR

examples/helloworld/src/main/java/example/HelloWorld.java

@@ -16,21 +16,21 @@
 
 package example;
 
-import com.google.common.io.Resources;
+import com.google.common.io.CharStreams;
 
+import java.io.InputStreamReader;
 import java.io.IOException;
+import java.io.Reader;
 import java.net.URISyntaxException;
 import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
 
 public class HelloWorld {
 
   public static void main(String[] args) throws URISyntaxException, IOException {
-    Path worldFile = Paths.get(Resources.getResource("world").toURI());
-    String world = new String(Files.readAllBytes(worldFile), StandardCharsets.UTF_8);
-
-    System.out.println("Hello " + world);
+    try (Reader reader = new InputStreamReader(
+        HelloWorld.class.getResourceAsStream("/world"), StandardCharsets.UTF_8)) {
+      String world = CharStreams.toString(reader);
+      System.out.println("Hello " + world);
+    }
   }
 }

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildDockerTask.java

@@ -25,6 +25,7 @@
 import com.google.cloud.tools.jib.plugins.common.IncompatibleBaseImageJavaVersionException;
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
 import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
@@ -149,6 +150,10 @@ public void buildDocker()
       throw new GradleException(
           "container.appRoot is not an absolute Unix-style path: " + ex.getInvalidPathValue(), ex);
 
+    } catch (InvalidContainerizingModeException ex) {
+      throw new GradleException(
+          "invalid value for containerizingMode: " + ex.getInvalidContainerizingMode(), ex);
+
     } catch (InvalidWorkingDirectoryException ex) {
       throw new GradleException(
           "container.workingDirectory is not an absolute Unix-style path: "

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildImageTask.java

@@ -24,6 +24,7 @@
 import com.google.cloud.tools.jib.plugins.common.IncompatibleBaseImageJavaVersionException;
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
 import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
@@ -129,6 +130,10 @@ public void buildImage()
       throw new GradleException(
           "container.appRoot is not an absolute Unix-style path: " + ex.getInvalidPathValue(), ex);
 
+    } catch (InvalidContainerizingModeException ex) {
+      throw new GradleException(
+          "invalid value for containerizingMode: " + ex.getInvalidContainerizingMode(), ex);
+
     } catch (InvalidWorkingDirectoryException ex) {
       throw new GradleException(
           "container.workingDirectory is not an absolute Unix-style path: "

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/BuildTarTask.java

@@ -23,6 +23,7 @@
 import com.google.cloud.tools.jib.plugins.common.IncompatibleBaseImageJavaVersionException;
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
 import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
@@ -147,6 +148,10 @@ public void buildTar()
       throw new GradleException(
           "container.appRoot is not an absolute Unix-style path: " + ex.getInvalidPathValue(), ex);
 
+    } catch (InvalidContainerizingModeException ex) {
+      throw new GradleException(
+          "invalid value for containerizingMode: " + ex.getInvalidContainerizingMode(), ex);
+
     } catch (InvalidWorkingDirectoryException ex) {
       throw new GradleException(
           "container.workingDirectory is not an absolute Unix-style path: "

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleProjectProperties.java

@@ -26,6 +26,7 @@
 import com.google.cloud.tools.jib.event.events.TimerEvent;
 import com.google.cloud.tools.jib.event.progress.ProgressEventHandler;
 import com.google.cloud.tools.jib.filesystem.DirectoryWalker;
+import com.google.cloud.tools.jib.plugins.common.ContainerizingMode;
 import com.google.cloud.tools.jib.plugins.common.JavaContainerBuilderHelper;
 import com.google.cloud.tools.jib.plugins.common.ProjectProperties;
 import com.google.cloud.tools.jib.plugins.common.PropertyNames;
@@ -127,12 +128,15 @@ private static boolean isProgressFooterEnabled(Project project) {
 
   @Override
   public JibContainerBuilder createContainerBuilder(
-      RegistryImage baseImage, AbsoluteUnixPath appRoot) {
+      RegistryImage baseImage, AbsoluteUnixPath appRoot, ContainerizingMode containerizingMode) {
+    JavaContainerBuilder javaContainerBuilder =
+        JavaContainerBuilder.from(baseImage).setAppRoot(appRoot);
+
     try {
       if (isWarProject()) {
         logger.info("WAR project identified, creating WAR image: " + project.getDisplayName());
         Path explodedWarPath = GradleProjectProperties.getExplodedWarDirectory(project);
-        return JavaContainerBuilderHelper.fromExplodedWar(baseImage, explodedWarPath, appRoot);
+        return JavaContainerBuilderHelper.fromExplodedWar(javaContainerBuilder, explodedWarPath);
       }
 
       JavaPluginConvention javaPluginConvention =
@@ -143,7 +147,7 @@ public JibContainerBuilder createContainerBuilder(
       FileCollection classesOutputDirectories =
           mainSourceSet.getOutput().getClassesDirs().filter(File::exists);
       Path resourcesOutputDirectory = mainSourceSet.getOutput().getResourcesDir().toPath();
-      FileCollection allFiles = mainSourceSet.getRuntimeClasspath();
+      FileCollection allFiles = mainSourceSet.getRuntimeClasspath().filter(File::exists);
 
       FileCollection allDependencyFiles =
           allFiles
@@ -154,9 +158,6 @@ public JibContainerBuilder createContainerBuilder(
           allDependencyFiles.filter(file -> file.getName().contains("SNAPSHOT"));
       FileCollection dependencyFiles = allDependencyFiles.minus(snapshotDependencyFiles);
 
-      JavaContainerBuilder javaContainerBuilder =
-          JavaContainerBuilder.from(baseImage).setAppRoot(appRoot);
-
       // Adds resource files
       if (Files.exists(resourcesOutputDirectory)) {
         javaContainerBuilder.addResources(resourcesOutputDirectory);
@@ -171,23 +172,16 @@ public JibContainerBuilder createContainerBuilder(
       }
 
       // Adds dependency files
-      javaContainerBuilder.addDependencies(
-          dependencyFiles
-              .getFiles()
-              .stream()
-              .filter(File::exists)
-              .map(File::toPath)
-              .collect(Collectors.toList()));
-
-      javaContainerBuilder.addSnapshotDependencies(
-          snapshotDependencyFiles
-              .getFiles()
-              .stream()
-              .filter(File::exists)
-              .map(File::toPath)
-              .collect(Collectors.toList()));
-
-      return javaContainerBuilder.toContainerBuilder();
+      return javaContainerBuilder
+          .addDependencies(
+              dependencyFiles.getFiles().stream().map(File::toPath).collect(Collectors.toList()))
+          .addSnapshotDependencies(
+              snapshotDependencyFiles
+                  .getFiles()
+                  .stream()
+                  .map(File::toPath)
+                  .collect(Collectors.toList()))
+          .toContainerBuilder();
 
     } catch (IOException ex) {
       throw new GradleException("Obtaining project build output files failed", ex);

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/GradleRawConfiguration.java

@@ -159,4 +159,9 @@ public List<Path> getExtraDirectories() {
   public Map<AbsoluteUnixPath, FilePermissions> getExtraDirectoryPermissions() {
     return TaskCommon.convertPermissionsMap(jibExtension.getExtraDirectories().getPermissions());
   }
+
+  @Override
+  public String getContainerizingMode() {
+    return jibExtension.getContainerizingMode();
+  }
 }

jib-gradle-plugin/src/main/java/com/google/cloud/tools/jib/gradle/JibExtension.java

@@ -64,12 +64,14 @@ public class JibExtension {
 
   // Defines default configuration values.
   private static final boolean DEFAULT_ALLOW_INSECURE_REGISTIRIES = false;
+  private static final String DEFAULT_CONTAINERIZING_MODE = "exploded";
 
   private final BaseImageParameters from;
   private final TargetImageParameters to;
   private final ContainerParameters container;
   private final ExtraDirectoriesParameters extraDirectories;
   private final Property<Boolean> allowInsecureRegistries;
+  private final Property<String> containerizingMode;
 
   @Deprecated boolean extraDirectoryConfigured;
   @Deprecated boolean extraDirectoriesConfigured;
@@ -83,9 +85,11 @@ public JibExtension(Project project) {
     extraDirectories = objectFactory.newInstance(ExtraDirectoriesParameters.class, project, this);
 
     allowInsecureRegistries = objectFactory.property(Boolean.class);
+    containerizingMode = objectFactory.property(String.class);
 
     // Sets defaults.
     allowInsecureRegistries.set(DEFAULT_ALLOW_INSECURE_REGISTIRIES);
+    containerizingMode.set(DEFAULT_CONTAINERIZING_MODE);
   }
 
   public void from(Action<? super BaseImageParameters> action) {
@@ -115,7 +119,7 @@ public void extraDirectories(Action<? super ExtraDirectoriesParameters> action)
   // for the deprecated "jib.extraDirectory" config parameter
   public void setExtraDirectory(File extraDirectory) {
     extraDirectoryConfigured = true;
-    this.extraDirectories.setPath(extraDirectory);
+    extraDirectories.setPath(extraDirectory);
   }
 
   public void setAllowInsecureRegistries(boolean allowInsecureRegistries) {
@@ -161,4 +165,11 @@ boolean getAllowInsecureRegistries() {
     }
     return allowInsecureRegistries.get();
   }
+
+  @Input
+  @Optional
+  public String getContainerizingMode() {
+    String property = System.getProperty(PropertyNames.CONTAINERIZING_MODE);
+    return property != null ? property : containerizingMode.get();
+  }
 }

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

@@ -29,6 +29,7 @@
 import com.google.cloud.tools.jib.api.LayerEntry;
 import com.google.cloud.tools.jib.api.RegistryImage;
 import com.google.cloud.tools.jib.configuration.BuildConfiguration;
+import com.google.cloud.tools.jib.plugins.common.ContainerizingMode;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
@@ -84,6 +85,8 @@
 @RunWith(MockitoJUnitRunner.class)
 public class GradleProjectPropertiesTest {
 
+  private static final ContainerizingMode DEFAULT_CONTAINERIZING_MODE = ContainerizingMode.EXPLODED;
+
   /** Implementation of {@link FileCollection} that just holds a set of {@link File}s. */
   private static class TestFileCollection extends AbstractFileCollection {
 
@@ -361,7 +364,9 @@ public void testCreateContainerBuilder_noClassesFiles() throws InvalidImageRefer
     Mockito.when(mockMainSourceSetOutput.getClassesDirs())
         .thenReturn(new TestFileCollection(ImmutableSet.of(nonexistentFile)));
     gradleProjectProperties.createContainerBuilder(
-        RegistryImage.named("base"), AbsoluteUnixPath.get("/anything"));
+        RegistryImage.named("base"),
+        AbsoluteUnixPath.get("/anything"),
+        DEFAULT_CONTAINERIZING_MODE);
     Mockito.verify(mockLogger).warn("No classes files were found - did you compile your project?");
   }
 
@@ -552,7 +557,10 @@ private BuildConfiguration setupBuildConfiguration(String appRoot)
       throws InvalidImageReferenceException, IOException, CacheDirectoryCreationException {
     JibContainerBuilder jibContainerBuilder =
         new GradleProjectProperties(mockProject, mockLogger)
-            .createContainerBuilder(RegistryImage.named("base"), AbsoluteUnixPath.get(appRoot));
+            .createContainerBuilder(
+                RegistryImage.named("base"),
+                AbsoluteUnixPath.get(appRoot),
+                DEFAULT_CONTAINERIZING_MODE);
     return JibContainerBuilderTestHelper.toBuildConfiguration(
         jibContainerBuilder,
         Containerizer.to(RegistryImage.named("to"))

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

@@ -54,6 +54,7 @@ private static void clearProperties() {
     System.clearProperty("jib.container.ports");
     System.clearProperty("jib.container.useCurrentTimestamp");
     System.clearProperty("jib.container.user");
+    System.clearProperty("jib.containerizingMode");
     System.clearProperty("jib.extraDirectory.path");
     System.clearProperty("jib.extraDirectory.permissions");
     System.clearProperty("jib.extraDirectories.paths");
@@ -152,6 +153,11 @@ public void testContainer() {
     Assert.assertEquals("some invalid appRoot value", container.getAppRoot());
   }
 
+  @Test
+  public void testContainerizingMode() {
+    Assert.assertEquals("exploded", testJibExtension.getContainerizingMode());
+  }
+
   @Test
   public void testExtraDirectories_default() {
     Assert.assertEquals(
@@ -288,6 +294,8 @@ public void testProperties() {
     Assert.assertTrue(testJibExtension.getContainer().getUseCurrentTimestamp());
     System.setProperty("jib.container.user", "myUser");
     Assert.assertEquals("myUser", testJibExtension.getContainer().getUser());
+    System.setProperty("jib.containerizingMode", "packaged");
+    Assert.assertEquals("packaged", testJibExtension.getContainerizingMode());
     System.setProperty("jib.extraDirectories.paths", "/foo,/bar/baz");
     Assert.assertEquals(
         Arrays.asList(Paths.get("/foo"), Paths.get("/bar/baz")),

jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/BuildDockerMojo.java

@@ -26,6 +26,7 @@
 import com.google.cloud.tools.jib.plugins.common.IncompatibleBaseImageJavaVersionException;
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
 import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
@@ -146,6 +147,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
           "<container><appRoot> is not an absolute Unix-style path: " + ex.getInvalidPathValue(),
           ex);
 
+    } catch (InvalidContainerizingModeException ex) {
+      throw new MojoExecutionException(
+          "invalid value for <containerizingMode>: " + ex.getInvalidContainerizingMode(), ex);
+
     } catch (InvalidWorkingDirectoryException ex) {
       throw new MojoExecutionException(
           "<container><workingDirectory> is not an absolute Unix-style path: "

jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/BuildImageMojo.java

@@ -25,6 +25,7 @@
 import com.google.cloud.tools.jib.plugins.common.IncompatibleBaseImageJavaVersionException;
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
 import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
@@ -140,6 +141,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
           "<container><appRoot> is not an absolute Unix-style path: " + ex.getInvalidPathValue(),
           ex);
 
+    } catch (InvalidContainerizingModeException ex) {
+      throw new MojoExecutionException(
+          "invalid value for <containerizingMode>: " + ex.getInvalidContainerizingMode(), ex);
+
     } catch (InvalidWorkingDirectoryException ex) {
       throw new MojoExecutionException(
           "<container><workingDirectory> is not an absolute Unix-style path: "

jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/BuildTarMojo.java

@@ -23,6 +23,7 @@
 import com.google.cloud.tools.jib.plugins.common.IncompatibleBaseImageJavaVersionException;
 import com.google.cloud.tools.jib.plugins.common.InvalidAppRootException;
 import com.google.cloud.tools.jib.plugins.common.InvalidContainerVolumeException;
+import com.google.cloud.tools.jib.plugins.common.InvalidContainerizingModeException;
 import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
 import com.google.cloud.tools.jib.plugins.common.JibBuildRunner;
 import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
@@ -118,6 +119,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
           "<container><appRoot> is not an absolute Unix-style path: " + ex.getInvalidPathValue(),
           ex);
 
+    } catch (InvalidContainerizingModeException ex) {
+      throw new MojoExecutionException(
+          "invalid value for <containerizingMode>: " + ex.getInvalidContainerizingMode(), ex);
+
     } catch (InvalidWorkingDirectoryException ex) {
       throw new MojoExecutionException(
           "<container><workingDirectory> is not an absolute Unix-style path: "