conga-aem-maven-plugin: Allow to defined custom package properties for 'cloudmanager-all-package' goal.

stefanseifert · stefanseifert · commit 4b5000660166 · 2020-04-25T09:33:40.000+02:00
diff --git a/changes.xml b/changes.xml
@@ -24,6 +24,9 @@
   <body>
 
     <release version="1.11.2" date="not released">
+      <action type="update" dev="sseifert">
+        conga-aem-maven-plugin: Allow to defined custom package properties for 'cloudmanager-all-package' goal.
+      </action>
       <action type="fix" dev="sseifert">
         Fail content package build when node or property names contains illegal characters (not following JCR standards).
       </action>
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
@@ -24,6 +24,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import org.apache.maven.plugin.MojoExecutionException;
@@ -66,6 +67,12 @@ public final class CloudManagerAllPackageMojo extends AbstractCloudManagerMojo {
   @Parameter(property = "conga.cloudManager.allPackage.autoDependenciesSeparateMutable", defaultValue = "false")
   private boolean autoDependenciesSeparateMutable;
 
+  /**
+   * Specifies additional properties to be set in the properties.xml file.
+   */
+  @Parameter
+  private Map<String, String> properties;
+
   /**
    * Set this to "true" to skip installing packages to CRX although configured in the POM.
    */
@@ -107,7 +114,7 @@ private void buildAllPackage(File environmentDir, File nodeDir, Set<String> clou
         .logger(getLog());
 
     try {
-      if (builder.build(contentPackages, cloudManagerTarget)) {
+      if (builder.build(contentPackages, cloudManagerTarget, properties)) {
         getLog().info("Generated " + getCanonicalPath(targetFile));
       }
       else {
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
@@ -31,6 +31,7 @@
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
+import java.util.Map;
 import java.util.Properties;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -119,10 +120,12 @@ private Log getLog() {
    * Build "all" content package.
    * @param contentPackages Content packages (invalid will be filtered out)
    * @param cloudManagerTarget Target environments/run modes the packages should be attached to
+   * @param properties Specifies additional properties to be set in the properties.xml file.
    * @return true if "all" package was generated, false if not valid package was found.
    * @throws IOException I/O exception
    */
-  public boolean build(List<ContentPackageFile> contentPackages, Set<String> cloudManagerTarget) throws IOException {
+  public boolean build(List<ContentPackageFile> contentPackages,
+      Set<String> cloudManagerTarget, Map<String, String> properties) throws IOException {
 
     // collect list of cloud manager environment run modes
     List<String> environmentRunmodes = new ArrayList<>();
@@ -168,6 +171,11 @@ public boolean build(List<ContentPackageFile> contentPackages, Set<String> cloud
     String rootPath = buildRootPath(groupName, packageName);
     builder.filter(new PackageFilter(rootPath));
 
+    // additional package properties
+    if (properties != null) {
+      properties.entrySet().forEach(entry -> builder.property(entry.getKey(), entry.getValue()));
+    }
+
     // build content package
     // if auto dependencies is active: build separate "dependency chains" between mutable and immutable packages
     try (ContentPackage contentPackage = builder.build(targetFile)) {
diff --git a/tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderMixedPackageTypeTest.java b/tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderMixedPackageTypeTest.java
@@ -60,7 +60,7 @@ void testBuild() throws Exception {
 
     // should fail to to "mixed" packageType
     assertThrows(IOException.class, () -> {
-      builder.build(contentPackages, ImmutableSet.of());
+      builder.build(contentPackages, ImmutableSet.of(), null);
     });
   }
 
diff --git a/tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderTest.java b/tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderTest.java
@@ -40,6 +40,7 @@
 import org.w3c.dom.Document;
 import org.zeroturnaround.zip.ZipUtil;
 
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 
 import io.wcm.devops.conga.plugins.aem.maven.model.ContentPackageFile;
@@ -54,7 +55,9 @@ class AllPackageBuilderTest {
   @BeforeEach
   void setUp(TestInfo testInfo) throws IOException {
     nodeDir = new File("src/test/resources/node");
-    targetDir = new File("target/test-" + getClass().getSimpleName() + "_" + testInfo.getDisplayName());
+    targetDir = new File("target/test-" + getClass().getSimpleName()
+        + (testInfo.getTestMethod().isPresent() ? "_" + testInfo.getTestMethod().get().getName() : ":")
+        + "_" + testInfo.getDisplayName());
     targetUnpackDir = new File(targetDir, "unpack");
     FileUtils.deleteDirectory(targetDir);
     targetDir.mkdirs();
@@ -76,7 +79,7 @@ void testBuild(Set<String> cloudManagerTarget, String[] expectedEnvironmentDirs)
     File targetFile = new File(targetDir, "all.zip");
 
     AllPackageBuilder builder = new AllPackageBuilder(targetFile, "test-group", "test-pkg");
-    assertTrue(builder.build(contentPackages, cloudManagerTarget));
+    assertTrue(builder.build(contentPackages, cloudManagerTarget, ImmutableMap.of("prop1", "value1")));
 
     ZipUtil.unpack(targetFile, targetUnpackDir);
 
@@ -123,7 +126,7 @@ void testBuildWithAutoDependencies(Set<String> cloudManagerTarget, String[] expe
 
     AllPackageBuilder builder = new AllPackageBuilder(targetFile, "test-group", "test-pkg")
         .autoDependencies(true);
-    assertTrue(builder.build(contentPackages, cloudManagerTarget));
+    assertTrue(builder.build(contentPackages, cloudManagerTarget, null));
 
     ZipUtil.unpack(targetFile, targetUnpackDir);
 
@@ -175,7 +178,7 @@ void testBuildWithAutoDependenciesSeparateMutable(Set<String> cloudManagerTarget
     AllPackageBuilder builder = new AllPackageBuilder(targetFile, "test-group", "test-pkg")
         .autoDependencies(true)
         .autoDependenciesSeparateMutable(true);
-    assertTrue(builder.build(contentPackages, cloudManagerTarget));
+    assertTrue(builder.build(contentPackages, cloudManagerTarget, null));
 
     ZipUtil.unpack(targetFile, targetUnpackDir);
 

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ void testBuild() throws Exception {`
`60`	`60`
`61`	`61`	`// should fail to to "mixed" packageType`
`62`	`62`	`assertThrows(IOException.class, () -> {`
`63`		`- builder.build(contentPackages, ImmutableSet.of());`
	`63`	`+ builder.build(contentPackages, ImmutableSet.of(), null);`
`64`	`64`	`});`
`65`	`65`	`}`
`66`	`66`