[MASSEMBLY-791] overrideUmask option to ensure permissions in package…

…d archive match expected ones.

src/it/projects/bugs/massembly-791/expected-entries.txt

@@ -0,0 +1,6 @@
+40777 dir-a/
+100666 dir-a/a1.txt
+100666 dir-a/a2.txt
+40755 dir-b/
+100644 dir-b/b.txt
+40777 dir-c/

src/it/projects/bugs/massembly-791/pom.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.apache.maven.plugin.assembly.test</groupId>
+    <artifactId>it-project-parent</artifactId>
+    <version>1</version>
+  </parent>
+
+  <groupId>org.apache.maven.its</groupId>
+  <artifactId>massembly-791</artifactId>
+  <packaging>pom</packaging>
+  <version>1.0</version>
+
+  <properties>
+    <project.build.outputTimestamp>2023-06-07T10:18:31Z</project.build.outputTimestamp>
+  </properties>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>make-assembly</id>
+            <phase>package</phase>
+            <goals>
+              <goal>single</goal>
+            </goals>
+            <configuration>
+              <!-- Follow permissions defined in assembly descriptor -->
+              <overrideUmask>0</overrideUmask>
+              <descriptors>
+                <descriptor>src/assembly/src.xml</descriptor>
+              </descriptors>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

src/it/projects/bugs/massembly-791/src/assembly/src.xml

@@ -0,0 +1,56 @@
+<?xml version='1.0'?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
+  <id>src</id>
+  <formats>
+    <format>tar</format>
+  </formats>
+  <includeBaseDirectory>false</includeBaseDirectory>
+  <fileSets>
+    <fileSet>
+      <outputDirectory/>
+      <directory>src/main/resources</directory>
+      <includes>
+        <include>dir-a/</include>
+      </includes>
+      <fileMode>0666</fileMode>
+      <directoryMode>0777</directoryMode>
+    </fileSet>
+    <fileSet>
+      <outputDirectory/>
+      <directory>src/main/resources</directory>
+      <includes>
+        <include>dir-b/</include>
+      </includes>
+      <fileMode>0644</fileMode>
+      <directoryMode>0755</directoryMode>
+    </fileSet>
+    <fileSet>
+      <outputDirectory/>
+      <directory>src/main/resources</directory>
+      <includes>
+        <include>dir-c</include>
+      </includes>
+      <directoryMode>0777</directoryMode>
+    </fileSet>
+  </fileSets>
+</assembly>

src/it/projects/bugs/massembly-791/src/main/resources/dir-a/a1.txt

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

src/it/projects/bugs/massembly-791/src/main/resources/dir-a/a2.txt

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

src/it/projects/bugs/massembly-791/src/main/resources/dir-b/b.txt

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

src/it/projects/bugs/massembly-791/src/main/resources/dir-c/.gitignore

@@ -0,0 +1 @@
+# Workaround to keep empty directory under source control

src/it/projects/bugs/massembly-791/verify.groovy

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.apache.commons.compress.archivers.tar.TarArchiveEntry
+import org.apache.commons.compress.archivers.tar.TarFile
+
+List<String> expectedEntries = new File( basedir, "expected-entries.txt" ).readLines()
+
+File assembly = new File( new File( basedir, "target" ), "massembly-791-1.0-src.tar" )
+
+assert assembly.exists()
+
+List<String> effectiveEntries = new ArrayList<>()
+try ( TarFile tarFile = new TarFile( assembly ) ) {
+    for ( TarArchiveEntry entry : tarFile.getEntries() )
+    {
+        effectiveEntries.add( String.format( "%o %s", entry.getMode(), entry.getName() ) )
+    }
+}
+
+assert expectedEntries == effectiveEntries

src/main/java/org/apache/maven/plugins/assembly/AssemblerConfigurationSource.java

@@ -223,4 +223,12 @@ public interface AssemblerConfigurationSource {
      * @return Override group name.
      */
     String getOverrideGroupName();
+
+    /**
+     * @return mask which is applied to permissions of files/directories before they are put into the assembly.
+     * If {@code null} then the mask is not explicitly configured and remains implementation-specific.
+     */
+    default Integer getOverrideUmask() {
+        return null;
+    }
 }

src/main/java/org/apache/maven/plugins/assembly/archive/DefaultAssemblyArchiver.java

@@ -347,6 +347,10 @@ protected Archiver createArchiver(
         if (StringUtils.isNotBlank(configSource.getOverrideGroupName())) {
             archiver.setOverrideGroupName(StringUtils.trim(configSource.getOverrideGroupName()));
         }
+        final Integer overrideUmask = configSource.getOverrideUmask();
+        if (overrideUmask != null) {
+            archiver.setUmask(overrideUmask);
+        }
 
         return archiver;
     }

src/main/java/org/apache/maven/plugins/assembly/mojos/AbstractAssemblyMojo.java

@@ -430,6 +430,15 @@ public abstract class AbstractAssemblyMojo extends AbstractMojo implements Assem
     @Parameter
     private String overrideGroupName;
 
+    /**
+     * Override of mask which is applied to permissions of files/directories before they are put into assembly.
+     * If {@code null} then the mask is not explicitly configured and remains implementation-specific.
+     * If an invalid value is specified, such as a negative value, then the behaviour is implementation specific.
+     * That is, it depends on the underlying library which is used for building the assembly.
+     */
+    @Parameter
+    private Integer overrideUmask;
+
     public static FixedStringSearchInterpolator mainProjectInterpolator(MavenProject mainProject) {
         if (mainProject != null) {
             // 5
@@ -879,4 +888,9 @@ public Integer getOverrideGid() {
     public String getOverrideGroupName() {
         return this.overrideGroupName;
     }
+
+    @Override
+    public Integer getOverrideUmask() {
+        return this.overrideUmask;
+    }
 }