conga-aem-maven-plugin: Make use of ${project.build.outputTimestamp} for reproducible builds for dispatcher configuration and processed packages in "all" package. (#15)

stefanseifert · web-flow · commit 5ded61ba5d4d · 2022-10-14T18:58:24.000+02:00
diff --git a/changes.xml b/changes.xml
@@ -23,6 +23,12 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 https://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
+    <release version="2.18.6" date="not released">
+      <action type="update" dev="sseifert">
+        conga-aem-maven-plugin: Make use of ${project.build.outputTimestamp} for reproducible builds for dispatcher configuration and processed packages in "all" package.
+      </action>
+    </release>
+
     <release version="2.18.4" date="2022-08-15">
       <action type="update" dev="sseifert">
         conga-aem-maven-plugin: Check bundle status before package manager install status as the latter may report errors if certain bundles are restarted.
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/BuildOutputTimestamp.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/BuildOutputTimestamp.java
@@ -0,0 +1,69 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2022 wcm.io
+ * %%
+ * Licensed 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.
+ * #L%
+ */
+package io.wcm.devops.conga.plugins.aem.maven;
+
+import java.nio.file.attribute.FileTime;
+import java.util.Date;
+
+import org.apache.maven.archiver.MavenArchiver;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Parse/convert ${project.build.outputTimestamp}.
+ */
+public class BuildOutputTimestamp {
+
+  private final Date date;
+
+  /**
+   * @param outputTimestamp Configured output timestamp
+   */
+  public BuildOutputTimestamp(@Nullable String outputTimestamp) {
+    MavenArchiver mavenArchiver = new MavenArchiver();
+    this.date = mavenArchiver.parseOutputTimestamp(outputTimestamp);
+  }
+
+  /**
+   * @return true if a valid timestamp is configured
+   */
+  public boolean isValid() {
+    return date != null;
+  }
+
+  /**
+   * @return Date or null if not a valid date
+   */
+  @Nullable
+  public Date toDate() {
+    return date;
+  }
+
+  /**
+   * @return FileTime or null if not a valid date
+   */
+  @Nullable
+  public FileTime toFileTime() {
+    if (date != null) {
+      return FileTime.fromMillis(date.toInstant().getEpochSecond());
+    }
+    return null;
+  }
+
+}
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/CloudManagerAllPackageMojo.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/CloudManagerAllPackageMojo.java
@@ -158,6 +158,9 @@ public final class CloudManagerAllPackageMojo extends AbstractCloudManagerMojo {
   @Parameter(property = "conga.cloudManager.allPackage.skip", defaultValue = "false")
   private boolean skip;
 
+  @Parameter(defaultValue = "${project.build.outputTimestamp}")
+  private String outputTimestamp;
+
   @Parameter(readonly = true, defaultValue = "${project}")
   private MavenProject project;
   @Component
@@ -264,7 +267,8 @@ private AllPackageBuilder createBuilder(String packageName) {
         .autoDependenciesMode(this.autoDependenciesMode)
         .runModeOptimization(this.runModeOptimization)
         .packageTypeValidation(this.packageTypeValidation)
-        .logger(getLog());
+        .logger(getLog())
+        .buildOutputTimestamp(new BuildOutputTimestamp(outputTimestamp));
   }
 
   private void buildAllPackage(AllPackageBuilder builder) throws MojoExecutionException {
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/CloudManagerDispatcherConfigMojo.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/CloudManagerDispatcherConfigMojo.java
@@ -59,6 +59,9 @@ public final class CloudManagerDispatcherConfigMojo extends AbstractCloudManager
   @Component(role = Archiver.class, hint = "zip")
   private ZipArchiver zipArchiver;
 
+  @Parameter(defaultValue = "${project.build.outputTimestamp}")
+  private String outputTimestamp;
+
   @Override
   public void execute() throws MojoExecutionException, MojoFailureException {
     if (skip) {
@@ -92,6 +95,11 @@ private void buildDispatcherConfig(File environmentDir, File nodeDir) throws Moj
       addZipDirectory(basePath, nodeDir, Collections.singleton(ModelParser.MODEL_FILE));
       zipArchiver.setDestFile(targetFile);
 
+      BuildOutputTimestamp buildOutputTimestamp = new BuildOutputTimestamp(outputTimestamp);
+      if (buildOutputTimestamp.isValid()) {
+        zipArchiver.configureReproducible(buildOutputTimestamp.toDate());
+      }
+
       zipArchiver.createArchive();
     }
     catch (ArchiverException | IOException ex) {
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilder.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilder.java
@@ -45,10 +45,10 @@
 import java.util.Properties;
 import java.util.Set;
 import java.util.stream.Collectors;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipFile;
-import java.util.zip.ZipOutputStream;
 
+import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
+import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
+import org.apache.commons.compress.archivers.zip.ZipFile;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.io.IOUtils;
@@ -65,6 +65,7 @@
 import com.google.common.collect.ImmutableSet;
 
 import io.wcm.devops.conga.plugins.aem.maven.AutoDependenciesMode;
+import io.wcm.devops.conga.plugins.aem.maven.BuildOutputTimestamp;
 import io.wcm.devops.conga.plugins.aem.maven.PackageTypeValidation;
 import io.wcm.devops.conga.plugins.aem.maven.RunModeOptimization;
 import io.wcm.devops.conga.plugins.aem.maven.model.BundleFile;
@@ -105,6 +106,7 @@ public final class AllPackageBuilder {
   private RunModeOptimization runModeOptimization = RunModeOptimization.OFF;
   private PackageTypeValidation packageTypeValidation = PackageTypeValidation.STRICT;
   private Log log;
+  private BuildOutputTimestamp buildOutputTimestamp;
 
   private static final String RUNMODE_DEFAULT = "$default$";
   private static final Set<String> ALLOWED_PACKAGE_TYPES = ImmutableSet.of(
@@ -172,6 +174,15 @@ public AllPackageBuilder version(String value) {
     return this;
   }
 
+  /**
+   * @param value Build output timestamp
+   * @return this
+   */
+  public AllPackageBuilder buildOutputTimestamp(BuildOutputTimestamp value) {
+    this.buildOutputTimestamp = value;
+    return this;
+  }
+
   private Log getLog() {
     if (this.log == null) {
       this.log = new SystemStreamLog();
@@ -530,18 +541,18 @@ private List<TemporaryContentPackageFile> processContentPackage(ContentPackageFi
 
       // iterate through entries and write them to the temp. zip file
       try (FileOutputStream fos = new FileOutputStream(tempFile);
-          ZipOutputStream zipOut = new ZipOutputStream(fos)) {
-        Enumeration<? extends ZipEntry> zipInEntries = zipFileIn.entries();
+          ZipArchiveOutputStream zipOut = new ZipArchiveOutputStream(fos)) {
+        Enumeration<? extends ZipArchiveEntry> zipInEntries = zipFileIn.getEntries();
         while (zipInEntries.hasMoreElements()) {
-          ZipEntry zipInEntry = zipInEntries.nextElement();
+          ZipArchiveEntry zipInEntry = zipInEntries.nextElement();
           if (!zipInEntry.isDirectory()) {
             try (InputStream is = zipFileIn.getInputStream(zipInEntry)) {
               boolean processedEntry = false;
 
               // if entry is properties.xml, update dependency information
               if (StringUtils.equals(zipInEntry.getName(), "META-INF/vault/properties.xml")) {
-                Properties props = new Properties();
-                props.loadFromXML(is);
+                FileVaultProperties fileVaultProps = new FileVaultProperties(is);
+                Properties props = fileVaultProps.getProperties();
                 addSuffixToPackageName(props, pkg, environmentRunMode);
 
                 // update package dependencies
@@ -557,9 +568,10 @@ private List<TemporaryContentPackageFile> processContentPackage(ContentPackageFi
                   props.put(NAME_PACKAGE_TYPE, packageType);
                 }
 
-                ZipEntry zipOutEntry = newZipEntry(zipInEntry);
-                zipOut.putNextEntry(zipOutEntry);
-                props.storeToXML(zipOut, null);
+                ZipArchiveEntry zipOutEntry = newZipEntry(zipInEntry);
+                zipOut.putArchiveEntry(zipOutEntry);
+                fileVaultProps.storeToXml(zipOut);
+                zipOut.closeArchiveEntry();
                 processedEntry = true;
               }
 
@@ -589,13 +601,13 @@ else if (StringUtils.equals(FilenameUtils.getExtension(zipInEntry.getName()), "z
 
               // otherwise transfer the binary data 1:1
               if (!processedEntry) {
-                ZipEntry zipOutEntry = newZipEntry(zipInEntry);
-                zipOut.putNextEntry(zipOutEntry);
+                ZipArchiveEntry zipOutEntry = newZipEntry(zipInEntry);
+                zipOut.putArchiveEntry(zipOutEntry);
                 IOUtils.copy(is, zipOut);
+                zipOut.closeArchiveEntry();
               }
             }
 
-            zipOut.closeEntry();
           }
         }
       }
@@ -615,12 +627,12 @@ else if (StringUtils.equals(FilenameUtils.getExtension(zipInEntry.getName()), "z
     return result;
   }
 
-  private static ZipEntry newZipEntry(ZipEntry in) {
-    ZipEntry out = new ZipEntry(in.getName());
-    if (in.getCreationTime() != null) {
-      out.setCreationTime(in.getCreationTime());
+  private ZipArchiveEntry newZipEntry(ZipArchiveEntry in) {
+    ZipArchiveEntry out = new ZipArchiveEntry(in.getName());
+    if (buildOutputTimestamp != null && buildOutputTimestamp.isValid()) {
+      out.setLastModifiedTime(buildOutputTimestamp.toFileTime());
     }
-    if (in.getLastModifiedTime() != null) {
+    else if (in.getLastModifiedTime() != null) {
       out.setLastModifiedTime(in.getLastModifiedTime());
     }
     return out;
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/FileVaultProperties.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/FileVaultProperties.java
@@ -0,0 +1,74 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2022 wcm.io
+ * %%
+ * Licensed 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.
+ * #L%
+ */
+package io.wcm.devops.conga.plugins.aem.maven.allpackage;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.nio.charset.StandardCharsets;
+import java.util.Properties;
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * Read and write properties.xml for FileVault package.
+ */
+class FileVaultProperties {
+
+  private final Properties props;
+
+  /**
+   * Read properties from input stream.
+   * @param is Input stream
+   * @throws IOException I/O exception
+   */
+  FileVaultProperties(InputStream is) throws IOException {
+    props = new Properties();
+    props.loadFromXML(is);
+  }
+
+  public Properties getProperties() {
+    return this.props;
+  }
+
+  /**
+   * Store properties content to output stream.
+   * Ensures consistent line endings are used on all operating systems.
+   * @param os Output stream
+   * @throws IOException I/O exception
+   */
+  public void storeToXml(OutputStream os) throws IOException {
+    // write properties XML to string
+    ByteArrayOutputStream bos = new ByteArrayOutputStream();
+    props.storeToXML(bos, null);
+    String xmlOutput = bos.toString(StandardCharsets.UTF_8.name());
+
+    // normalize line endings with unix line ending
+    xmlOutput = StringUtils.replace(xmlOutput, System.lineSeparator(), "\n");
+
+    // output normalized XML
+    OutputStreamWriter writer = new OutputStreamWriter(os, StandardCharsets.UTF_8);
+    writer.write(xmlOutput);
+    writer.flush();
+  }
+
+}
