conga-aem-maven-plugin: Auto-generate package dependencies for 'all-package' goal

Author: stefanseifert

tooling/conga-aem-maven-plugin/pom.xml

@@ -104,6 +104,23 @@
       <scope>compile</scope>
     </dependency>
 
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.xmlunit</groupId>
+      <artifactId>xmlunit-core</artifactId>
+      <version>2.6.3</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.xmlunit</groupId>
+      <artifactId>xmlunit-legacy</artifactId>
+      <version>2.6.3</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.zeroturnaround</groupId>
       <artifactId>zt-zip</artifactId>

tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/AllPackageMojo.java

@@ -60,6 +60,12 @@ public final class AllPackageMojo extends AbstractMojo {
   @Parameter(property = "conga.allPackage.group", required = true)
   private String group;
 
+  /**
+   * Automatically generate dependencies between content packages based on file order in CONGA configuration.
+   */
+  @Parameter(property = "conga.allPackage.autoDependencies", defaultValue = "true")
+  private boolean autoDependencies;
+
   /**
    * Selected environments to generate. It's only allowed to define a single environment for this mojo,
    * but to be compatible with the other CONGA plugins it's uses the same semantic for defining multiple
@@ -158,8 +164,12 @@ private void buildAllPackage(File nodeDir, ModelParser modelParser) throws MojoF
 
     List<ContentPackageFile> contentPackages = modelParser.getContentPackagesForNode(nodeDir);
     File targetFile = new File(target, packageName + ".zip");
+
+    AllPackageBuilder builder = new AllPackageBuilder(targetFile, groupName, packageName)
+        .autoDependencies(this.autoDependencies);
+
     try {
-      if (AllPackageBuilder.build(targetFile, contentPackages, groupName, packageName)) {
+      if (builder.build(contentPackages)) {
         getLog().info("Generated " + getCanonicalPath(targetFile));
       }
       else {

tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilder.java

@@ -21,11 +21,26 @@
 
 import static io.wcm.devops.conga.plugins.aem.maven.allpackage.RunModeUtil.RUNMODE_AUTHOR;
 import static io.wcm.devops.conga.plugins.aem.maven.allpackage.RunModeUtil.RUNMODE_PUBLISH;
+import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_DEPENDENCIES;
 
 import java.io.File;
+import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.InputStream;
+import java.util.Enumeration;
 import java.util.List;
+import java.util.Properties;
 import java.util.stream.Collectors;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+import java.util.zip.ZipOutputStream;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.jackrabbit.vault.packaging.Dependency;
+import org.apache.jackrabbit.vault.packaging.DependencyUtil;
+import org.apache.jackrabbit.vault.packaging.VersionRange;
 
 import io.wcm.devops.conga.plugins.aem.maven.model.ContentPackageFile;
 import io.wcm.tooling.commons.contentpackagebuilder.ContentPackage;
@@ -37,21 +52,39 @@
  */
 public final class AllPackageBuilder {
 
-  private AllPackageBuilder() {
-    // static methods only
-  }
+  private final File targetFile;
+  private final String groupName;
+  private final String packageName;
+  private boolean autoDependencies;
 
   /**
-   * Build "all" content package.
    * @param targetFile Target file
-   * @param contentPackages Content packages (invalid will be filtered out)
    * @param groupName Group name
    * @param packageName Package name
+   */
+  public AllPackageBuilder(File targetFile, String groupName, String packageName) {
+    this.targetFile = targetFile;
+    this.groupName = groupName;
+    this.packageName = packageName;
+  }
+
+  /**
+   * @param value Automatically generate dependencies between content packages based on file order in CONGA
+   *          configuration.
+   * @return this
+   */
+  public AllPackageBuilder autoDependencies(boolean value) {
+    this.autoDependencies = value;
+    return this;
+  }
+
+  /**
+   * Build "all" content package.
+   * @param contentPackages Content packages (invalid will be filtered out)
    * @return true if "all" package was generated, false if not valid package was found.
+   * @throws IOException I/O exception
    */
-  public static boolean build(File targetFile,
-      List<ContentPackageFile> contentPackages,
-      String groupName, String packageName) throws IOException {
+  public boolean build(List<ContentPackageFile> contentPackages) throws IOException {
 
     // collect AEM content packages for this node
     List<ContentPackageFile> validContentPackages = contentPackages.stream()
@@ -72,12 +105,22 @@ public static boolean build(File targetFile,
     builder.filter(new PackageFilter(rootPath));
 
     // build content package
+    ContentPackageFile previousPkg = null;
     try (ContentPackage contentPackage = builder.build(targetFile)) {
       for (ContentPackageFile pkg : validContentPackages) {
         String path = buildPackagePath(pkg, rootPath);
-        contentPackage.addFile(path, pkg.getFile());
+        if (autoDependencies && previousPkg != null) {
+          // wire previous package in package dependency
+          addFileWithDependency(contentPackage, path, pkg, previousPkg);
+        }
+        else {
+          // add package file directly
+          contentPackage.addFile(path, pkg.getFile());
+        }
+        previousPkg = pkg;
       }
     }
+
     return true;
   }
 
@@ -113,4 +156,84 @@ else if (RunModeUtil.isOnlyPublish(pkg)) {
     return rootPath + "/" + pkg.getPackageType() + "/install" + runModeSuffix + "/" + pkg.getFile().getName();
   }
 
+  /**
+   * Rewrite content package ZIP file while adding to "all" package:
+   * Add dependency to previous package in CONGA configuration file oder.
+   * @param contentPackage Target content page
+   * @param path Path in target content package
+   * @param pkg Package to add
+   * @param previousPkg Previous package to get dependency information from
+   * @throws IOException I/O error
+   */
+  private static void addFileWithDependency(ContentPackage contentPackage, String path,
+      ContentPackageFile pkg, ContentPackageFile previousPkg) throws IOException {
+
+    // create temp zip file to create rewritten copy of package
+    File tempFile = File.createTempFile("pkg", ".zip");
+
+    // open original content package
+    try (ZipFile zipFileIn = new ZipFile(pkg.getFile())) {
+
+      // 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();
+        while (zipInEntries.hasMoreElements()) {
+          ZipEntry zipInEntry = zipInEntries.nextElement();
+          ZipEntry zipOutEntry = new ZipEntry(zipInEntry.getName());
+          if (!zipInEntry.isDirectory()) {
+            zipOut.putNextEntry(zipOutEntry);
+            if (StringUtils.equals(zipInEntry.getName(), "META-INF/vault/properties.xml")) {
+              // if entry is properties.xml, update dependency information
+              try (InputStream is = zipFileIn.getInputStream(zipInEntry)) {
+                Properties props = new Properties();
+                props.loadFromXML(is);
+                updateDependencies(props, previousPkg);
+                props.storeToXML(zipOut, null);
+              }
+            }
+            else {
+              // otherwise transfer the binary data 1:1
+              try (InputStream is = zipFileIn.getInputStream(zipInEntry)) {
+                IOUtils.copy(is, zipOut);
+              }
+            }
+            zipOut.closeEntry();
+          }
+        }
+      }
+
+      // add temp zip file to "all" content package
+      contentPackage.addFile(path, tempFile);
+    }
+    finally {
+      FileUtils.deleteQuietly(tempFile);
+    }
+  }
+
+  /**
+   * Add dependency information to dependencies string in properties (if it does not exist already).
+   * @param props Properties
+   * @param dependencyFile Dependency package
+   */
+  private static void updateDependencies(Properties props, ContentPackageFile dependencyFile) {
+    String[] existingDepsStrings = StringUtils.split(props.getProperty(NAME_DEPENDENCIES), ",");
+    Dependency[] existingDeps = null;
+    if (existingDepsStrings != null && existingDepsStrings.length > 0) {
+      existingDeps = Dependency.fromString(existingDepsStrings);
+    }
+
+    Dependency newDependency = new Dependency(dependencyFile.getGroup(), dependencyFile.getName(),
+        VersionRange.fromString(dependencyFile.getVersion()));
+    Dependency[] deps;
+    if (existingDeps != null) {
+      deps = DependencyUtil.add(existingDeps, newDependency);
+    }
+    else {
+      deps = new Dependency[] { newDependency };
+    }
+
+    props.put(NAME_DEPENDENCIES, Dependency.toString(deps));
+  }
+
 }

tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/model/ContentPackageFile.java

@@ -19,7 +19,10 @@
  */
 package io.wcm.devops.conga.plugins.aem.maven.model;
 
+import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_GROUP;
+import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_NAME;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_PACKAGE_TYPE;
+import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_VERSION;
 
 import java.io.File;
 import java.util.Collections;
@@ -41,9 +44,14 @@ public final class ContentPackageFile {
   private final Integer delayAfterInstallSec;
   private final Integer httpSocketTimeoutSec;
 
+  private final String name;
+  private final String group;
+  private final String version;
   private final String packageType;
+
   private final List<String> variants;
 
+  @SuppressWarnings("unchecked")
   ContentPackageFile(File file, Map<String, Object> fileData, Map<String, Object> roleData) {
     this.file = file;
 
@@ -53,18 +61,17 @@ public final class ContentPackageFile {
     this.delayAfterInstallSec = (Integer)fileData.get("delayAfterInstallSec");
     this.httpSocketTimeoutSec = (Integer)fileData.get("httpSocketTimeoutSec");
 
-    this.packageType = getPackageType(fileData);
-    this.variants = getVariants(roleData);
-  }
-
-  @SuppressWarnings("unchecked")
-  private static String getPackageType(Map<String, Object> fileData) {
     Map<String, Object> contentPackageProperties = (Map<String, Object>)fileData.get(
         ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY);
-    if (contentPackageProperties != null) {
-      return (String)contentPackageProperties.get(NAME_PACKAGE_TYPE);
+    if (contentPackageProperties == null) {
+      throw new IllegalArgumentException(ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY + " missing.");
     }
-    return null;
+    this.name = (String)contentPackageProperties.get(NAME_NAME);
+    this.group = (String)contentPackageProperties.get(NAME_GROUP);
+    this.version = (String)contentPackageProperties.get(NAME_VERSION);
+    this.packageType = (String)contentPackageProperties.get(NAME_PACKAGE_TYPE);
+
+    this.variants = getVariants(roleData);
   }
 
   @SuppressWarnings("unchecked")
@@ -102,6 +109,18 @@ public Integer getHttpSocketTimeoutSec() {
     return this.httpSocketTimeoutSec;
   }
 
+  public String getName() {
+    return this.name;
+  }
+
+  public String getGroup() {
+    return this.group;
+  }
+
+  public String getVersion() {
+    return this.version;
+  }
+
   public String getPackageType() {
     return this.packageType;
   }