add switch to use separate dependency chains for mutable and immutable packages

Author: stefanseifert

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

@@ -59,6 +59,12 @@ public final class CloudManagerAllPackageMojo extends AbstractCloudManagerMojo {
   @Parameter(property = "conga.cloudManager.allPackage.autoDependencies", defaultValue = "true")
   private boolean autoDependencies;
 
+  /**
+   * Use separate dependency chains for mutable and immutable packages.
+   */
+  @Parameter(property = "conga.cloudManager.allPackage.autoDependenciesSeparateMutable", defaultValue = "false")
+  private boolean autoDependenciesSeparateMutable;
+
   /**
    * Set this to "true" to skip installing packages to CRX although configured in the POM.
    */
@@ -88,6 +94,7 @@ private void buildAllPackage(File nodeDir, ModelParser modelParser) throws MojoF
 
     AllPackageBuilder builder = new AllPackageBuilder(targetFile, groupName, packageName)
         .autoDependencies(this.autoDependencies)
+        .autoDependenciesSeparateMutable(this.autoDependenciesSeparateMutable)
         .logger(getLog());
 
     try {

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

@@ -28,6 +28,7 @@
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
 import java.util.Properties;
@@ -59,6 +60,7 @@ public final class AllPackageBuilder {
   private final String groupName;
   private final String packageName;
   private boolean autoDependencies;
+  private boolean autoDependenciesSeparateMutable;
   private Log log;
 
   /**
@@ -82,6 +84,15 @@ public AllPackageBuilder autoDependencies(boolean value) {
     return this;
   }
 
+  /**
+   * @param value Use separate dependency chains for mutable and immutable packages.
+   * @return this
+   */
+  public AllPackageBuilder autoDependenciesSeparateMutable(boolean value) {
+    this.autoDependenciesSeparateMutable = value;
+    return this;
+  }
+
   /**
    * @param value Maven logger
    * @return this
@@ -130,10 +141,19 @@ public boolean build(List<ContentPackageFile> contentPackages) throws IOExceptio
     builder.filter(new PackageFilter(rootPath));
 
     // build content package
-    ContentPackageFile previousPkg = null;
+    // if auto dependencies is active: build separate "dependency chains" between mutable and immutable packages
+    List<ContentPackageFile> previousPackages = new ArrayList<>();
     try (ContentPackage contentPackage = builder.build(targetFile)) {
       for (ContentPackageFile pkg : validContentPackages) {
         String path = buildPackagePath(pkg, rootPath);
+
+        // get last previous package
+        // if autoDependenciesSeparateMutable active only that of the same mutability type
+        ContentPackageFile previousPkg = previousPackages.stream()
+            .filter(item -> !autoDependenciesSeparateMutable || mutableMatches(item, pkg))
+            .reduce((first, second) -> second)
+            .orElse(null);
+
         if (autoDependencies && previousPkg != null) {
           // wire previous package in package dependency
           addFileWithDependency(contentPackage, path, pkg, previousPkg);
@@ -142,7 +162,7 @@ public boolean build(List<ContentPackageFile> contentPackages) throws IOExceptio
           // add package file directly
           contentPackage.addFile(path, pkg.getFile());
         }
-        previousPkg = pkg;
+        previousPackages.add(pkg);
       }
     }
 
@@ -154,6 +174,17 @@ private static boolean isValid(ContentPackageFile pkg) {
     return pkg.getPackageType() != null;
   }
 
+  private static boolean isMutable(ContentPackageFile pkg) {
+    return StringUtils.equals("content", pkg.getPackageType());
+  }
+
+  private static boolean mutableMatches(ContentPackageFile pkg1, ContentPackageFile pkg2) {
+    if (pkg1 == null || pkg2 == null) {
+      return false;
+    }
+    return isMutable(pkg1) == isMutable(pkg2);
+  }
+
   /**
    * Build root path to be used for embedded package.
    * @param groupName Group name

tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderTest.java

@@ -86,8 +86,7 @@ void testBuild() throws Exception {
     File contentInstallDir = new File(contentDir, "install.author");
     assertFiles(contentInstallDir, "aem-cms-author-replicationagents.zip", "wcm-io-samples-sample-content-1.3.1-SNAPSHOT.zip");
     assertDependencies(contentInstallDir, "aem-cms-author-replicationagents.zip");
-    assertDependencies(contentInstallDir, "wcm-io-samples-sample-content-1.3.1-SNAPSHOT.zip",
-        "wcm-io-samples:wcm-io-samples-complete:1.3.1-SNAPSHOT");
+    assertDependencies(contentInstallDir, "wcm-io-samples-sample-content-1.3.1-SNAPSHOT.zip");
 
     File containerDir = new File(appsDir, "container");
     assertFiles(containerDir, "install.author");
@@ -142,6 +141,50 @@ void testBuildWithAutoDependencies() throws Exception {
         "wcm-io-samples:wcm-io-samples-aem-cms-config:1.3.1-SNAPSHOT");
   }
 
+  @Test
+  void testBuildWithAutoDependenciesSeparateMutable() throws Exception {
+    List<ContentPackageFile> contentPackages = new ModelParser().getContentPackagesForNode(nodeDir);
+    File targetFile = new File(targetDir, "all.zip");
+
+    AllPackageBuilder builder = new AllPackageBuilder(targetFile, "test-group", "test-pkg")
+        .autoDependencies(true)
+        .autoDependenciesSeparateMutable(true);
+    assertTrue(builder.build(contentPackages));
+
+    ZipUtil.unpack(targetFile, targetUnpackDir);
+
+    File appsDir = new File(targetUnpackDir, "jcr_root/apps/test-group-test-pkg-packages");
+    assertFiles(appsDir, "application", "content", "container");
+
+    File applicationDir = new File(appsDir, "application");
+    assertFiles(applicationDir, "install.author");
+
+    File applicationInstallDir = new File(applicationDir, "install.author");
+    assertFiles(applicationInstallDir, "aem-cms-system-config.zip");
+    assertDependencies(applicationInstallDir, "aem-cms-system-config.zip",
+        "day/cq60/product:cq-ui-wcm-editor-content:1.1.224",
+        "adobe/cq/product:cq-remotedam-client-ui-components:1.1.6");
+
+    File contentDir = new File(appsDir, "content");
+    assertFiles(contentDir, "install.author");
+
+    File contentInstallDir = new File(contentDir, "install.author");
+    assertFiles(contentInstallDir, "aem-cms-author-replicationagents.zip", "wcm-io-samples-sample-content-1.3.1-SNAPSHOT.zip");
+    assertDependencies(contentInstallDir, "aem-cms-author-replicationagents.zip");
+    assertDependencies(contentInstallDir, "wcm-io-samples-sample-content-1.3.1-SNAPSHOT.zip",
+        "wcm-io-samples:aem-cms-author-replicationagents:1.3.1-SNAPSHOT");
+
+    File containerDir = new File(appsDir, "container");
+    assertFiles(containerDir, "install.author");
+
+    File containerInstallDir = new File(containerDir, "install.author");
+    assertFiles(containerInstallDir, "wcm-io-samples-aem-cms-config.zip", "wcm-io-samples-complete-1.3.1-SNAPSHOT.zip");
+    assertDependencies(containerInstallDir, "wcm-io-samples-aem-cms-config.zip",
+        "wcm-io-samples:aem-cms-system-config:1.3.1-SNAPSHOT");
+    assertDependencies(containerInstallDir, "wcm-io-samples-complete-1.3.1-SNAPSHOT.zip",
+        "wcm-io-samples:wcm-io-samples-aem-cms-config:1.3.1-SNAPSHOT");
+  }
+
   private void assertFiles(File dir, String... fileNames) {
     assertTrue(dir.exists(), "file exists: " + dir.getPath());
     assertTrue(dir.isDirectory(), "is directory: " + dir.getPath());