Add glob support for extra file permissions

jib-gradle-plugin/CHANGELOG.md

@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- Glob pattern support for `jib.extraDirectories.permissions`. ([#1200](https://github.com/GoogleContainerTools/jib/issues/1200))
+
 ### Changed
 
 - `jib.container.creationTime` now accepts more timezone formats:`+HHmm`. This allows for easier configuration of creationTime by external systems. ([#2320](https://github.com/GoogleContainerTools/jib/issues/2320))

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

@@ -16,7 +16,6 @@
 
 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;
@@ -162,7 +161,7 @@ public List<Path> getExtraDirectories() {
   }
 
   @Override
-  public Map<AbsoluteUnixPath, FilePermissions> getExtraDirectoryPermissions() {
+  public Map<String, FilePermissions> getExtraDirectoryPermissions() {
     return TaskCommon.convertPermissionsMap(jibExtension.getExtraDirectories().getPermissions());
   }
 

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

@@ -19,12 +19,11 @@
 import com.google.api.client.http.HttpTransport;
 import com.google.cloud.tools.jib.ProjectInfo;
 import com.google.cloud.tools.jib.api.LogEvent;
-import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
 import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
 import com.google.cloud.tools.jib.plugins.common.ProjectProperties;
 import com.google.cloud.tools.jib.plugins.common.UpdateChecker;
 import com.google.common.util.concurrent.Futures;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.ExecutorService;
@@ -114,19 +113,17 @@ static void disableHttpLogging() {
   }
 
   /**
-   * Validates and converts a {@code String->String} file-path-to-file-permissions map to an
-   * equivalent {@code AbsoluteUnixPath->FilePermission} map.
+   * Converts a {@code String->String} file-path-to-file-permissions map to an equivalent {@code
+   * String->FilePermission} map.
    *
    * @param stringMap the map to convert (example entry: {@code "/path/on/container" -> "755"})
    * @return the converted map
    */
-  static Map<AbsoluteUnixPath, FilePermissions> convertPermissionsMap(
-      Map<String, String> stringMap) {
-    Map<AbsoluteUnixPath, FilePermissions> permissionsMap = new HashMap<>();
+  static Map<String, FilePermissions> convertPermissionsMap(Map<String, String> stringMap) {
+    // Order is important, so use a LinkedHashMap
+    Map<String, FilePermissions> permissionsMap = new LinkedHashMap<>();
     for (Map.Entry<String, String> entry : stringMap.entrySet()) {
-      AbsoluteUnixPath key = AbsoluteUnixPath.get(entry.getKey());
-      FilePermissions value = FilePermissions.fromOctalString(entry.getValue());
-      permissionsMap.put(key, value);
+      permissionsMap.put(entry.getKey(), FilePermissions.fromOctalString(entry.getValue()));
     }
     return permissionsMap;
   }

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

@@ -286,9 +286,9 @@ public void testIsWarProject() {
   public void testConvertPermissionsMap() {
     Assert.assertEquals(
         ImmutableMap.of(
-            AbsoluteUnixPath.get("/test/folder/file1"),
+            "/test/folder/file1",
             FilePermissions.fromOctalString("123"),
-            AbsoluteUnixPath.get("/test/file2"),
+            "/test/file2",
             FilePermissions.fromOctalString("456")),
         TaskCommon.convertPermissionsMap(
             ImmutableMap.of("/test/folder/file1", "123", "/test/file2", "456")));

jib-maven-plugin/CHANGELOG.md

@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- Glob pattern support for `<extraDirectories><permissions>`. ([#1200](https://github.com/GoogleContainerTools/jib/issues/1200))
+
 ### Changed
 
 - `<container><creationTime>` now accepts more timezone formats:`+HHmm`. This allows for easier configuration of creationTime by external systems. ([#2320](https://github.com/GoogleContainerTools/jib/issues/2320))

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

@@ -16,7 +16,6 @@
 
 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;
@@ -167,7 +166,7 @@ public List<Path> getExtraDirectories() {
   }
 
   @Override
-  public Map<AbsoluteUnixPath, FilePermissions> getExtraDirectoryPermissions() {
+  public Map<String, FilePermissions> getExtraDirectoryPermissions() {
     return MojoCommon.convertPermissionsList(jibPluginConfiguration.getExtraDirectoryPermissions());
   }
 

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

@@ -18,7 +18,6 @@
 
 import com.google.cloud.tools.jib.ProjectInfo;
 import com.google.cloud.tools.jib.api.LogEvent;
-import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
 import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
 import com.google.cloud.tools.jib.maven.JibPluginConfiguration.PermissionConfiguration;
 import com.google.cloud.tools.jib.plugins.common.ProjectProperties;
@@ -30,7 +29,7 @@
 import com.google.common.util.concurrent.Futures;
 import java.nio.file.Path;
 import java.util.Collections;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -100,24 +99,23 @@ static List<Path> getExtraDirectories(JibPluginConfiguration jibPluginConfigurat
   }
 
   /**
-   * Validates and converts a list of {@link PermissionConfiguration} to an equivalent {@code
-   * AbsoluteUnixPath->FilePermission} map.
+   * Converts a list of {@link PermissionConfiguration} to an equivalent {@code
+   * String->FilePermission} map.
    *
    * @param permissionList the list to convert
    * @return the resulting map
    */
-  @VisibleForTesting
-  static Map<AbsoluteUnixPath, FilePermissions> convertPermissionsList(
+  static Map<String, FilePermissions> convertPermissionsList(
       List<PermissionConfiguration> permissionList) {
-    Map<AbsoluteUnixPath, FilePermissions> permissionsMap = new HashMap<>();
+    // Order is important, so use a LinkedHashMap
+    Map<String, FilePermissions> permissionsMap = new LinkedHashMap<>();
     for (PermissionConfiguration permission : permissionList) {
       if (!permission.getFile().isPresent() || !permission.getMode().isPresent()) {
         throw new IllegalArgumentException(
             "Incomplete <permission> configuration; requires <file> and <mode> fields to be set");
       }
-      AbsoluteUnixPath key = AbsoluteUnixPath.get(permission.getFile().get());
-      FilePermissions value = FilePermissions.fromOctalString(permission.getMode().get());
-      permissionsMap.put(key, value);
+      permissionsMap.put(
+          permission.getFile().get(), FilePermissions.fromOctalString(permission.getMode().get()));
     }
     return permissionsMap;
   }

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

@@ -25,9 +25,13 @@
 import com.google.cloud.tools.jib.api.buildplan.RelativeUnixPath;
 import com.google.cloud.tools.jib.filesystem.DirectoryWalker;
 import java.io.IOException;
+import java.nio.file.FileSystems;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.nio.file.Paths;
 import java.time.Instant;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.function.BiFunction;
 import java.util.function.Predicate;
@@ -46,22 +50,41 @@ public class JavaContainerBuilderHelper {
    */
   public static FileEntriesLayer extraDirectoryLayerConfiguration(
       Path extraDirectory,
-      Map<AbsoluteUnixPath, FilePermissions> extraDirectoryPermissions,
+      Map<String, FilePermissions> extraDirectoryPermissions,
       BiFunction<Path, AbsoluteUnixPath, Instant> modificationTimeProvider)
       throws IOException {
     FileEntriesLayer.Builder builder =
         FileEntriesLayer.builder().setName(LayerType.EXTRA_FILES.getName());
+    Map<PathMatcher, FilePermissions> pathMatchers = new LinkedHashMap<>();
+    for (Map.Entry<String, FilePermissions> entry : extraDirectoryPermissions.entrySet()) {
+      pathMatchers.put(
+          FileSystems.getDefault().getPathMatcher("glob:" + entry.getKey()), entry.getValue());
+    }
+
     new DirectoryWalker(extraDirectory)
         .filterRoot()
         .walk(
             localPath -> {
               AbsoluteUnixPath pathOnContainer =
                   AbsoluteUnixPath.get("/").resolve(extraDirectory.relativize(localPath));
               Instant modificationTime = modificationTimeProvider.apply(localPath, pathOnContainer);
-              FilePermissions permissions = extraDirectoryPermissions.get(pathOnContainer);
+              FilePermissions permissions =
+                  extraDirectoryPermissions.get(pathOnContainer.toString());
               if (permissions == null) {
+                // Check for matching globs
+                Path containerPath = Paths.get(pathOnContainer.toString());
+                for (Map.Entry<PathMatcher, FilePermissions> entry : pathMatchers.entrySet()) {
+                  if (entry.getKey().matches(containerPath)) {
+                    builder.addEntry(
+                        localPath, pathOnContainer, entry.getValue(), modificationTime);
+                    return;
+                  }
+                }
+
+                // Add with default permissions
                 builder.addEntry(localPath, pathOnContainer, modificationTime);
               } else {
+                // Add with explicit permissions
                 builder.addEntry(localPath, pathOnContainer, permissions, modificationTime);
               }
             });

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

@@ -16,7 +16,6 @@
 
 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;
@@ -81,7 +80,7 @@ public interface RawConfiguration {
 
   List<Path> getExtraDirectories();
 
-  Map<AbsoluteUnixPath, FilePermissions> getExtraDirectoryPermissions();
+  Map<String, FilePermissions> getExtraDirectoryPermissions();
 
   Optional<Path> getDockerExecutable();
 

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

@@ -27,9 +27,11 @@
 import com.google.cloud.tools.jib.api.buildplan.AbsoluteUnixPath;
 import com.google.cloud.tools.jib.api.buildplan.FileEntriesLayer;
 import com.google.cloud.tools.jib.api.buildplan.FileEntry;
+import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
 import com.google.cloud.tools.jib.configuration.BuildContext;
 import com.google.cloud.tools.jib.filesystem.FileOperations;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.io.Resources;
 import com.google.common.util.concurrent.MoreExecutors;
 import java.io.IOException;
@@ -41,6 +43,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import org.junit.Assert;
@@ -97,6 +100,76 @@ public void testExtraDirectoryLayerConfiguration() throws URISyntaxException, IO
         layerConfiguration.getEntries());
   }
 
+  @Test
+  public void testExtraDirectoryLayerConfiguration_globPermissions()
+      throws URISyntaxException, IOException {
+    Path extraFilesDirectory = Paths.get(Resources.getResource("core/layer").toURI());
+    Map<String, FilePermissions> permissionsMap =
+        ImmutableMap.of(
+            "/a",
+            FilePermissions.fromOctalString("123"),
+            "/a/*",
+            FilePermissions.fromOctalString("456"),
+            "**/bar",
+            FilePermissions.fromOctalString("765"));
+    FileEntriesLayer fileEntriesLayer =
+        JavaContainerBuilderHelper.extraDirectoryLayerConfiguration(
+            extraFilesDirectory, permissionsMap, (ignored1, ignored2) -> Instant.EPOCH);
+    assertExtractionPathsUnordered(
+        Arrays.asList("/a", "/a/b", "/a/b/bar", "/c", "/c/cat", "/foo"),
+        fileEntriesLayer.getEntries());
+
+    Map<AbsoluteUnixPath, FilePermissions> expectedPermissions =
+        ImmutableMap.<AbsoluteUnixPath, FilePermissions>builder()
+            .put(AbsoluteUnixPath.get("/a"), FilePermissions.fromOctalString("123"))
+            .put(AbsoluteUnixPath.get("/a/b"), FilePermissions.fromOctalString("456"))
+            .put(AbsoluteUnixPath.get("/a/b/bar"), FilePermissions.fromOctalString("765"))
+            .put(AbsoluteUnixPath.get("/c"), FilePermissions.DEFAULT_FOLDER_PERMISSIONS)
+            .put(AbsoluteUnixPath.get("/c/cat"), FilePermissions.DEFAULT_FILE_PERMISSIONS)
+            .put(AbsoluteUnixPath.get("/foo"), FilePermissions.DEFAULT_FILE_PERMISSIONS)
+            .build();
+    for (FileEntry entry : fileEntriesLayer.getEntries()) {
+      Assert.assertEquals(
+          expectedPermissions.get(entry.getExtractionPath()), entry.getPermissions());
+    }
+  }
+
+  @Test
+  public void testExtraDirectoryLayerConfiguration_overlappingPermissions()
+      throws URISyntaxException, IOException {
+    Path extraFilesDirectory = Paths.get(Resources.getResource("core/layer").toURI());
+    Map<String, FilePermissions> permissionsMap =
+        ImmutableMap.of(
+            "/a**",
+            FilePermissions.fromOctalString("123"),
+            // Should be ignored, since first match takes priority
+            "/a/b**",
+            FilePermissions.fromOctalString("000"),
+            // Should override first match since explicit path is used instead of glob
+            "/a/b/bar",
+            FilePermissions.fromOctalString("765"));
+    FileEntriesLayer fileEntriesLayer =
+        JavaContainerBuilderHelper.extraDirectoryLayerConfiguration(
+            extraFilesDirectory, permissionsMap, (ignored1, ignored2) -> Instant.EPOCH);
+    assertExtractionPathsUnordered(
+        Arrays.asList("/a", "/a/b", "/a/b/bar", "/c", "/c/cat", "/foo"),
+        fileEntriesLayer.getEntries());
+
+    Map<AbsoluteUnixPath, FilePermissions> expectedPermissions =
+        ImmutableMap.<AbsoluteUnixPath, FilePermissions>builder()
+            .put(AbsoluteUnixPath.get("/a"), FilePermissions.fromOctalString("123"))
+            .put(AbsoluteUnixPath.get("/a/b"), FilePermissions.fromOctalString("123"))
+            .put(AbsoluteUnixPath.get("/a/b/bar"), FilePermissions.fromOctalString("765"))
+            .put(AbsoluteUnixPath.get("/c"), FilePermissions.DEFAULT_FOLDER_PERMISSIONS)
+            .put(AbsoluteUnixPath.get("/c/cat"), FilePermissions.DEFAULT_FILE_PERMISSIONS)
+            .put(AbsoluteUnixPath.get("/foo"), FilePermissions.DEFAULT_FILE_PERMISSIONS)
+            .build();
+    for (FileEntry entry : fileEntriesLayer.getEntries()) {
+      Assert.assertEquals(
+          expectedPermissions.get(entry.getExtractionPath()), entry.getPermissions());
+    }
+  }
+
   @Test
   public void testFromExplodedWar()
       throws URISyntaxException, IOException, InvalidImageReferenceException,

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

@@ -166,8 +166,7 @@ public void testPluginConfigurationProcessor_extraDirectory()
     Path extraDirectory = Paths.get(Resources.getResource("core/layer").toURI());
     Mockito.when(rawConfiguration.getExtraDirectories()).thenReturn(Arrays.asList(extraDirectory));
     Mockito.when(rawConfiguration.getExtraDirectoryPermissions())
-        .thenReturn(
-            ImmutableMap.of(AbsoluteUnixPath.get("/foo"), FilePermissions.fromOctalString("123")));
+        .thenReturn(ImmutableMap.of("/foo", FilePermissions.fromOctalString("123")));
 
     BuildContext buildContext = getBuildContext(processCommonConfiguration());
     List<FileEntry> extraFiles =