support multiple cloud manager environments with optional cloudManager.target assignment

Author: stefanseifert

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

@@ -40,9 +40,7 @@
 abstract class AbstractCloudManagerMojo extends AbstractMojo {
 
   /**
-   * 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
-   * environments.
+   * Selected environments to generate.
    */
   @Parameter(property = "conga.environments")
   private String[] environments;
@@ -77,7 +75,7 @@ protected File getTargetDir() {
    * @return Environment directory
    * @throws MojoExecutionException if no or multiple directories found
    */
-  protected File getEnvironmentDir() throws MojoExecutionException {
+  protected List<File> getEnvironmentDir() throws MojoExecutionException {
     List<File> directories = null;
     Set<String> selectedEnvironments = toSet(this.environments);
     if (configurationDir.exists() && configurationDir.isDirectory()) {
@@ -92,11 +90,7 @@ protected File getEnvironmentDir() throws MojoExecutionException {
     if (directories == null || directories.isEmpty()) {
       throw new MojoExecutionException("No matching environment directory found in " + getCanonicalPath(configurationDir));
     }
-    if (directories.size() > 1) {
-      throw new MojoExecutionException("Multiple environments found in " + getCanonicalPath(configurationDir)
-          + " - please specify a single environment via the 'environments' parameter.");
-    }
-    return directories.get(0);
+    return directories;
   }
 
   /**

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.Set;
 
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
@@ -71,23 +72,31 @@ public final class CloudManagerAllPackageMojo extends AbstractCloudManagerMojo {
   @Parameter(property = "conga.cloudManager.allPackage.skip", defaultValue = "false")
   private boolean skip;
 
+  private static final String CLOUDMANAGER_TARGET_NONE = "none";
+
   @Override
   public void execute() throws MojoExecutionException, MojoFailureException {
     if (skip) {
       return;
     }
 
-    File environmentDir = getEnvironmentDir();
-    List<File> nodeDirs = getNodeDirs(environmentDir);
-    ModelParser modelParser = new ModelParser();
-    for (File nodeDir : nodeDirs) {
-      buildAllPackage(nodeDir, modelParser);
+    List<File> environmentDirs = getEnvironmentDir();
+    for (File environmentDir : environmentDirs) {
+      List<File> nodeDirs = getNodeDirs(environmentDir);
+      ModelParser modelParser = new ModelParser();
+      for (File nodeDir : nodeDirs) {
+        Set<String> cloudManagerTarget = modelParser.getCloudManagerTarget(nodeDir);
+        if (!cloudManagerTarget.contains(CLOUDMANAGER_TARGET_NONE)) {
+          buildAllPackage(environmentDir, nodeDir, cloudManagerTarget, modelParser);
+        }
+      }
     }
   }
 
-  private void buildAllPackage(File nodeDir, ModelParser modelParser) throws MojoFailureException {
+  private void buildAllPackage(File environmentDir, File nodeDir, Set<String> cloudManagerTarget,
+      ModelParser modelParser) throws MojoExecutionException {
     String groupName = this.group;
-    String packageName = nodeDir.getName() + "-" + this.name;
+    String packageName = environmentDir.getName() + "." + nodeDir.getName() + "." + this.name;
 
     List<ContentPackageFile> contentPackages = modelParser.getContentPackagesForNode(nodeDir);
     File targetFile = new File(getTargetDir(), packageName + ".zip");
@@ -98,15 +107,15 @@ private void buildAllPackage(File nodeDir, ModelParser modelParser) throws MojoF
         .logger(getLog());
 
     try {
-      if (builder.build(contentPackages)) {
+      if (builder.build(contentPackages, cloudManagerTarget)) {
         getLog().info("Generated " + getCanonicalPath(targetFile));
       }
       else {
         getLog().debug("Skipped " + getCanonicalPath(targetFile) + " - no valid package.");
       }
     }
     catch (IOException ex) {
-      throw new MojoFailureException("Unable to generate " + getCanonicalPath(targetFile), ex);
+      throw new MojoExecutionException("Unable to generate " + getCanonicalPath(targetFile), ex);
     }
   }
 

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

@@ -65,18 +65,27 @@ public void execute() throws MojoExecutionException, MojoFailureException {
       return;
     }
 
-    File environmentDir = getEnvironmentDir();
-    List<File> nodeDirs = getNodeDirs(environmentDir);
-    ModelParser modelParser = new ModelParser();
-    for (File nodeDir : nodeDirs) {
-      if (modelParser.hasRole(nodeDir, ROLE_AEM_DISPATCHER_CLOUD)) {
-        buildDispatcherConfig(nodeDir);
+    int dispatcherNodeCount = 0;
+    List<File> environmentDirs = getEnvironmentDir();
+    for (File environmentDir : environmentDirs) {
+      List<File> nodeDirs = getNodeDirs(environmentDir);
+      ModelParser modelParser = new ModelParser();
+      for (File nodeDir : nodeDirs) {
+        if (modelParser.hasRole(nodeDir, ROLE_AEM_DISPATCHER_CLOUD)) {
+          buildDispatcherConfig(environmentDir, nodeDir);
+          dispatcherNodeCount++;
+        }
       }
     }
+
+    if (dispatcherNodeCount > 1) {
+      throw new MojoFailureException("More than one node with role '" + ROLE_AEM_DISPATCHER_CLOUD + "' found - "
+          + "AEM Cloud service supports only a single dispatcher configuration.");
+    }
   }
 
-  private void buildDispatcherConfig(File nodeDir) throws MojoFailureException {
-    File targetFile = new File(getTargetDir(), nodeDir.getName() + ".dispatcher-config.zip");
+  private void buildDispatcherConfig(File environmentDir, File nodeDir) throws MojoExecutionException {
+    File targetFile = new File(getTargetDir(), environmentDir.getName() + "." + nodeDir.getName() + ".dispatcher-config.zip");
 
     try {
       String basePath = toZipDirectoryPath(nodeDir);
@@ -86,7 +95,7 @@ private void buildDispatcherConfig(File nodeDir) throws MojoFailureException {
       zipArchiver.createArchive();
     }
     catch (ArchiverException | IOException ex) {
-      throw new MojoFailureException("Unable to build file " + targetFile.getPath() + ": " + ex.getMessage(), ex);
+      throw new MojoExecutionException("Unable to build file " + targetFile.getPath() + ": " + ex.getMessage(), ex);
     }
   }
 

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

@@ -32,6 +32,7 @@
 import java.util.Enumeration;
 import java.util.List;
 import java.util.Properties;
+import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
@@ -63,6 +64,8 @@ public final class AllPackageBuilder {
   private boolean autoDependenciesSeparateMutable;
   private Log log;
 
+  private static final String RUNMODE_DEFAULT = "$default$";
+
   /**
    * @param targetFile Target file
    * @param groupName Group name
@@ -112,10 +115,20 @@ 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
    * @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) throws IOException {
+  public boolean build(List<ContentPackageFile> contentPackages, Set<String> cloudManagerTarget) throws IOException {
+
+    // collect list of cloud manager environment run modes
+    List<String> environmentRunmodes = new ArrayList<>();
+    if (cloudManagerTarget.isEmpty()) {
+      environmentRunmodes.add(RUNMODE_DEFAULT);
+    }
+    else {
+      environmentRunmodes.addAll(cloudManagerTarget);
+    }
 
     // generate warnings for each invalid content packages that is skipped
     contentPackages.stream()
@@ -142,27 +155,29 @@ public boolean build(List<ContentPackageFile> contentPackages) throws IOExceptio
 
     // build content package
     // 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);
-        }
-        else {
-          // add package file directly
-          contentPackage.addFile(path, pkg.getFile());
+      for (String environmentRunmode : environmentRunmodes) {
+        List<ContentPackageFile> previousPackages = new ArrayList<>();
+        for (ContentPackageFile pkg : validContentPackages) {
+          String path = buildPackagePath(pkg, rootPath, environmentRunmode);
+
+          // 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);
+          }
+          else {
+            // add package file directly
+            contentPackage.addFile(path, pkg.getFile());
+          }
+          previousPackages.add(pkg);
         }
-        previousPackages.add(pkg);
       }
     }
 
@@ -201,15 +216,18 @@ private static String buildRootPath(String groupName, String packageName) {
    * @param rootPath Root path
    * @return Package path
    */
-  private static String buildPackagePath(ContentPackageFile pkg, String rootPath) {
-    String runModeSuffix = "";
+  private static String buildPackagePath(ContentPackageFile pkg, String rootPath, String environmentRunmode) {
+    StringBuilder runModeSuffix = new StringBuilder();
     if (RunModeUtil.isOnlyAuthor(pkg)) {
-      runModeSuffix = "." + RUNMODE_AUTHOR;
+      runModeSuffix.append(".").append(RUNMODE_AUTHOR);
     }
     else if (RunModeUtil.isOnlyPublish(pkg)) {
-      runModeSuffix = "." + RUNMODE_PUBLISH;
+      runModeSuffix.append(".").append(RUNMODE_PUBLISH);
+    }
+    if (!StringUtils.equals(environmentRunmode, RUNMODE_DEFAULT)) {
+      runModeSuffix.append(".").append(environmentRunmode);
     }
-    return rootPath + "/" + pkg.getPackageType() + "/install" + runModeSuffix + "/" + pkg.getFile().getName();
+    return rootPath + "/" + pkg.getPackageType() + "/install" + runModeSuffix.toString() + "/" + pkg.getFile().getName();
   }
 
   /**

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

@@ -28,13 +28,16 @@
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.util.ArrayList;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import org.apache.commons.lang3.CharEncoding;
 import org.apache.commons.lang3.StringUtils;
 import org.yaml.snakeyaml.Yaml;
 
+import io.wcm.devops.conga.model.util.MapExpander;
 import io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackagePropertiesPostProcessor;
 
 /**
@@ -66,6 +69,54 @@ public List<ContentPackageFile> getContentPackagesForNode(File nodeDir) {
     return collectPackages(data, nodeDir);
   }
 
+  /**
+   * Checks if the node has the given node role assigned.
+   * @param nodeDir Node directory
+   * @param roleName Node role name
+   * @return true if role is assigned
+   */
+  @SuppressWarnings("unchecked")
+  public boolean hasRole(File nodeDir, String roleName) {
+    Map<String, Object> data = getModelData(nodeDir);
+    List<Map<String, Object>> roles = (List<Map<String, Object>>)data.get("roles");
+    for (Map<String, Object> role : roles) {
+      if (StringUtils.equals((String)role.get("role"), roleName)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  /**
+   * Collects all assigned "cloudManager.target" values (lists or single values) to any role from the node.
+   * @param nodeDir Node directory
+   * @return List of cloud manager environment names or "none"
+   */
+  @SuppressWarnings("unchecked")
+  public Set<String> getCloudManagerTarget(File nodeDir) {
+    Set<String> targets = new LinkedHashSet<>();
+    Map<String, Object> data = getModelData(nodeDir);
+    List<Map<String, Object>> roles = (List<Map<String, Object>>)data.get("roles");
+    for (Map<String, Object> role : roles) {
+      Map<String, Object> config = (Map<String, Object>)role.get("config");
+      if (config != null) {
+        Object targetValue = MapExpander.getDeep(config, "cloudManager.target");
+        if (targetValue != null) {
+          if (targetValue instanceof String) {
+            targets.add((String)targetValue);
+          }
+          else if (targetValue instanceof List) {
+            targets.addAll((List<String>)targetValue);
+          }
+          else {
+            throw new RuntimeException("Invalid cloudManager.target value: " + targetValue);
+          }
+        }
+      }
+    }
+    return targets;
+  }
+
   private Map<String, Object> getModelData(File nodeDir) {
     File modelFile = new File(nodeDir, MODEL_FILE);
     if (!modelFile.exists() || !modelFile.isFile()) {
@@ -113,22 +164,4 @@ private ContentPackageFile toContentPackageFile(Map<String, Object> fileData,
     return new ContentPackageFile(file, fileData, roleData);
   }
 
-  /**
-   * Checks if the node has the given node role assigned.
-   * @param nodeDir Node directory
-   * @param roleName Node role name
-   * @return true if role is assigned
-   */
-  @SuppressWarnings("unchecked")
-  public boolean hasRole(File nodeDir, String roleName) {
-    Map<String, Object> data = getModelData(nodeDir);
-    List<Map<String, Object>> roles = (List<Map<String, Object>>)data.get("roles");
-    for (Map<String, Object> role : roles) {
-      if (StringUtils.equals((String)role.get("role"), roleName)) {
-        return true;
-      }
-    }
-    return false;
-  }
-
 }