Minor refactoring to prepare for extra directory targets (#2436)

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

@@ -16,12 +16,14 @@
 
 package com.google.cloud.tools.jib.gradle;
 
+import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
 import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
 import com.google.cloud.tools.jib.api.buildplan.ImageFormat;
 import com.google.cloud.tools.jib.plugins.common.AuthProperty;
 import com.google.cloud.tools.jib.plugins.common.RawConfiguration;
 import java.nio.file.Path;
 import java.util.Collections;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -157,8 +159,12 @@ public String getCreationTime() {
   }
 
   @Override
-  public List<Path> getExtraDirectories() {
-    return jibExtension.getExtraDirectories().getPaths();
+  public Map<Path, AbsoluteUnixPath> getExtraDirectories() {
+    Map<Path, AbsoluteUnixPath> directoryMap = new LinkedHashMap<>();
+    for (Path path : jibExtension.getExtraDirectories().getPaths()) {
+      directoryMap.put(path, AbsoluteUnixPath.get("/"));
+    }
+    return directoryMap;
   }
 
   @Override

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

@@ -16,11 +16,13 @@
 
 package com.google.cloud.tools.jib.maven;
 
+import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
 import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
 import com.google.cloud.tools.jib.api.buildplan.ImageFormat;
 import com.google.cloud.tools.jib.plugins.common.AuthProperty;
 import com.google.cloud.tools.jib.plugins.common.RawConfiguration;
 import java.nio.file.Path;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -161,8 +163,12 @@ public String getCreationTime() {
   }
 
   @Override
-  public List<Path> getExtraDirectories() {
-    return MojoCommon.getExtraDirectories(jibPluginConfiguration);
+  public Map<Path, AbsoluteUnixPath> getExtraDirectories() {
+    Map<Path, AbsoluteUnixPath> directoryMap = new LinkedHashMap<>();
+    for (Path path : MojoCommon.getExtraDirectories(jibPluginConfiguration)) {
+      directoryMap.put(path, AbsoluteUnixPath.get("/"));
+    }
+    return directoryMap;
   }
 
   @Override

jib-plugins-common/src/main/java/com/google/cloud/tools/jib/plugins/common/JavaContainerBuilderHelper.java

@@ -42,14 +42,16 @@ public class JavaContainerBuilderHelper {
   /**
    * Returns a {@link FileEntriesLayer} for adding the extra directory to the container.
    *
-   * @param extraDirectory the source extra directory path
+   * @param sourceDirectory the source extra directory path
+   * @param targetDirectory the root directory on the container to place the files in
    * @param extraDirectoryPermissions map from path on container to file permissions
    * @param modificationTimeProvider file modification time provider
    * @return a {@link FileEntriesLayer} for adding the extra directory to the container
    * @throws IOException if walking the extra directory fails
    */
   public static FileEntriesLayer extraDirectoryLayerConfiguration(
-      Path extraDirectory,
+      Path sourceDirectory,
+      AbsoluteUnixPath targetDirectory,
       Map<String, FilePermissions> extraDirectoryPermissions,
       BiFunction<Path, AbsoluteUnixPath, Instant> modificationTimeProvider)
       throws IOException {
@@ -61,12 +63,12 @@ public static FileEntriesLayer extraDirectoryLayerConfiguration(
           FileSystems.getDefault().getPathMatcher("glob:" + entry.getKey()), entry.getValue());
     }
 
-    new DirectoryWalker(extraDirectory)
+    new DirectoryWalker(sourceDirectory)
         .filterRoot()
         .walk(
             localPath -> {
               AbsoluteUnixPath pathOnContainer =
-                  AbsoluteUnixPath.get("/").resolve(extraDirectory.relativize(localPath));
+                  targetDirectory.resolve(sourceDirectory.relativize(localPath));
               Instant modificationTime = modificationTimeProvider.apply(localPath, pathOnContainer);
               FilePermissions permissions =
                   extraDirectoryPermissions.get(pathOnContainer.toString());

jib-plugins-common/src/main/java/com/google/cloud/tools/jib/plugins/common/PluginConfigurationProcessor.java

@@ -52,6 +52,7 @@
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.BiFunction;
@@ -396,11 +397,15 @@ static JibContainerBuilder processCommonConfiguration(
         getCreationTime(rawConfiguration.getCreationTime(), projectProperties));
 
     // Adds all the extra files.
-    for (Path directory : rawConfiguration.getExtraDirectories()) {
-      if (Files.exists(directory)) {
+    for (Map.Entry<Path, AbsoluteUnixPath> entry :
+        rawConfiguration.getExtraDirectories().entrySet()) {
+      Path sourceDirectory = entry.getKey();
+      AbsoluteUnixPath targetDirectory = entry.getValue();
+      if (Files.exists(sourceDirectory)) {
         jibContainerBuilder.addFileEntriesLayer(
             JavaContainerBuilderHelper.extraDirectoryLayerConfiguration(
-                directory,
+                sourceDirectory,
+                targetDirectory,
                 rawConfiguration.getExtraDirectoryPermissions(),
                 modificationTimeProvider));
       }

jib-plugins-common/src/main/java/com/google/cloud/tools/jib/plugins/common/RawConfiguration.java

@@ -16,6 +16,7 @@
 
 package com.google.cloud.tools.jib.plugins.common;
 
+import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
 import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
 import com.google.cloud.tools.jib.api.buildplan.ImageFormat;
 import java.nio.file.Path;
@@ -85,7 +86,7 @@ static interface ExtensionConfiguration {
 
   String getCreationTime();
 
-  List<Path> getExtraDirectories();
+  Map<Path, AbsoluteUnixPath> getExtraDirectories();
 
   Map<String, FilePermissions> getExtraDirectoryPermissions();
 

jib-plugins-common/src/test/java/com/google/cloud/tools/jib/plugins/common/JavaContainerBuilderHelperTest.java

@@ -88,7 +88,10 @@ public void testExtraDirectoryLayerConfiguration() throws URISyntaxException, IO
     Path extraFilesDirectory = Paths.get(Resources.getResource("core/layer").toURI());
     FileEntriesLayer layerConfiguration =
         JavaContainerBuilderHelper.extraDirectoryLayerConfiguration(
-            extraFilesDirectory, Collections.emptyMap(), (ignored1, ignored2) -> Instant.EPOCH);
+            extraFilesDirectory,
+            AbsoluteUnixPath.get("/"),
+            Collections.emptyMap(),
+            (ignored1, ignored2) -> Instant.EPOCH);
     assertSourcePathsUnordered(
         Arrays.asList(
             extraFilesDirectory.resolve("a"),
@@ -114,7 +117,10 @@ public void testExtraDirectoryLayerConfiguration_globPermissions()
             FilePermissions.fromOctalString("765"));
     FileEntriesLayer fileEntriesLayer =
         JavaContainerBuilderHelper.extraDirectoryLayerConfiguration(
-            extraFilesDirectory, permissionsMap, (ignored1, ignored2) -> Instant.EPOCH);
+            extraFilesDirectory,
+            AbsoluteUnixPath.get("/"),
+            permissionsMap,
+            (ignored1, ignored2) -> Instant.EPOCH);
     assertExtractionPathsUnordered(
         Arrays.asList("/a", "/a/b", "/a/b/bar", "/c", "/c/cat", "/foo"),
         fileEntriesLayer.getEntries());
@@ -150,7 +156,10 @@ public void testExtraDirectoryLayerConfiguration_overlappingPermissions()
             FilePermissions.fromOctalString("765"));
     FileEntriesLayer fileEntriesLayer =
         JavaContainerBuilderHelper.extraDirectoryLayerConfiguration(
-            extraFilesDirectory, permissionsMap, (ignored1, ignored2) -> Instant.EPOCH);
+            extraFilesDirectory,
+            AbsoluteUnixPath.get("/"),
+            permissionsMap,
+            (ignored1, ignored2) -> Instant.EPOCH);
     assertExtractionPathsUnordered(
         Arrays.asList("/a", "/a/b", "/a/b/bar", "/c", "/c/cat", "/foo"),
         fileEntriesLayer.getEntries());

jib-plugins-common/src/test/java/com/google/cloud/tools/jib/plugins/common/PluginConfigurationProcessorTest.java

@@ -111,8 +111,6 @@ public void setUp() throws IOException, InvalidImageReferenceException, Inferred
     Mockito.when(rawConfiguration.getAppRoot()).thenReturn("/app");
     Mockito.when(rawConfiguration.getFilesModificationTime()).thenReturn("EPOCH_PLUS_SECOND");
     Mockito.when(rawConfiguration.getCreationTime()).thenReturn("EPOCH");
-    Mockito.when(rawConfiguration.getExtraDirectories())
-        .thenReturn(Arrays.asList(Paths.get("nonexistent/path")));
     Mockito.when(rawConfiguration.getContainerizingMode()).thenReturn("exploded");
     Mockito.when(projectProperties.getToolName()).thenReturn("tool");
     Mockito.when(projectProperties.getToolVersion()).thenReturn("tool-version");
@@ -158,9 +156,10 @@ public void testPluginConfigurationProcessor_extraDirectory()
           InvalidContainerizingModeException, InvalidFilesModificationTimeException,
           InvalidCreationTimeException {
     Path extraDirectory = Paths.get(Resources.getResource("core/layer").toURI());
-    Mockito.when(rawConfiguration.getExtraDirectories()).thenReturn(Arrays.asList(extraDirectory));
+    Mockito.when(rawConfiguration.getExtraDirectories())
+        .thenReturn(ImmutableMap.of(extraDirectory, AbsoluteUnixPath.get("/target/dir")));
     Mockito.when(rawConfiguration.getExtraDirectoryPermissions())
-        .thenReturn(ImmutableMap.of("/foo", FilePermissions.fromOctalString("123")));
+        .thenReturn(ImmutableMap.of("/target/dir/foo", FilePermissions.fromOctalString("123")));
 
     BuildContext buildContext = getBuildContext(processCommonConfiguration());
     List<FileEntry> extraFiles =
@@ -182,13 +181,21 @@ public void testPluginConfigurationProcessor_extraDirectory()
             extraDirectory.resolve("foo")),
         extraFiles);
     assertExtractionPathsUnordered(
-        Arrays.asList("/a", "/a/b", "/a/b/bar", "/c", "/c/cat", "/foo"), extraFiles);
+        Arrays.asList(
+            "/target/dir/a",
+            "/target/dir/a/b",
+            "/target/dir/a/b/bar",
+            "/target/dir/c",
+            "/target/dir/c/cat",
+            "/target/dir/foo"),
+        extraFiles);
 
     Optional<FileEntry> fooEntry =
         extraFiles
             .stream()
             .filter(
-                layerEntry -> layerEntry.getExtractionPath().equals(AbsoluteUnixPath.get("/foo")))
+                layerEntry ->
+                    layerEntry.getExtractionPath().equals(AbsoluteUnixPath.get("/target/dir/foo")))
             .findFirst();
     Assert.assertTrue(fooEntry.isPresent());
     Assert.assertEquals("123", fooEntry.get().getPermissions().toOctalString());