Add httpdCloudManagerConditional and withAllCloudManagerConditional handlebars helper to build envrionment-conditional configuration for AEM cloud service.

Author: stefanseifert

changes.xml

@@ -25,7 +25,7 @@
 
     <release version="1.12.0" date="not released">
       <action type="add" dev="sseifert">
-        Add aemTenantsCloudManagerConditional handlebar helper to build conditional sling mapping definitions for AEM cloud service with a sling dispatcher configuration.
+        Add httpdCloudManagerConditional and withAllCloudManagerConditional handlebars helper to build envrionment-conditional configuration for AEM cloud service..
       </action>
       <action type="add" dev="sseifert">
         conga-aem-maven-plugin: Add new parameter autoDependenciesMode which replaces/supercedes autoDependencies and autoDependenciesSeparateMutable flags.

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AbstractCloudManagerConditionalHelper.java

@@ -0,0 +1,134 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2020 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.handlebars.helper;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.github.jknack.handlebars.Context;
+import com.github.jknack.handlebars.Options;
+import com.github.jknack.handlebars.Options.Buffer;
+import com.google.common.collect.ImmutableMap;
+
+import io.wcm.devops.conga.generator.spi.handlebars.HelperPlugin;
+import io.wcm.devops.conga.generator.spi.handlebars.context.HelperContext;
+import io.wcm.devops.conga.model.util.MapMerger;
+
+/**
+ * Checks if there is a conditional statement 'httpd.cloudManagerConditional' in the current context.
+ * If yes iterates over all environments and renders the body for each with a merged model.
+ * If no the body is rendered once with the default model.
+ */
+abstract class AbstractCloudManagerConditionalHelper implements HelperPlugin<Object> {
+
+  static final String HTTPD_KEY = "httpd";
+  static final String CLOUD_MANAGER_CONDITIONAL_KEY = "cloudManagerConditional";
+  static final String TARGET_ENVIRONMENT_KEY = "targetEnvironment";
+
+  @Override
+  @SuppressWarnings("unchecked")
+  public final Object apply(Object context, Options options, HelperContext pluginContext) throws IOException {
+    Buffer buffer = options.buffer();
+
+    Context currentContext = options.context;
+    if (context != null) {
+      currentContext = Context.copy(options.context, context);
+    }
+
+    // get tenants from context
+    Object cloudManagerConditional = currentContext.get(HTTPD_KEY + "." + CLOUD_MANAGER_CONDITIONAL_KEY);
+
+    if (!(cloudManagerConditional instanceof List)) {
+      // no conditional statement - just render the body
+      buffer.append(options.fn(currentContext));
+    }
+    else {
+      // render body for each environment in conditional block with a merged context
+      List<CloudManagerConditional> items = getCloudManagerConditional((List<Map<String, Object>>)cloudManagerConditional);
+      for (CloudManagerConditional item : items) {
+
+        // config inside httpd.cloudManagerConditional is considered to be prefixed with "httpd.", so wrap it around here for merging
+        Map<String, Object> httpdWrapper = ImmutableMap.of(HTTPD_KEY, item.getConfig());
+        Map<String, Object> mergedModel = MapMerger.merge(httpdWrapper, (Map<String, Object>)currentContext.model());
+
+        // remove cloudManagerConditional after merging the models
+        Map<String, Object> mergedHttpd = (Map<String, Object>)mergedModel.get(HTTPD_KEY);
+        if (mergedHttpd != null) {
+          mergedHttpd.remove(CLOUD_MANAGER_CONDITIONAL_KEY);
+        }
+
+        Context mergedContext = Context.copy(currentContext, mergedModel);
+        CharSequence bodyContent = options.fn(mergedContext);
+
+        if (StringUtils.isNotBlank(bodyContent)) {
+          renderBodyContent(buffer, bodyContent, item.getTargetEnvironment());
+        }
+      }
+    }
+
+    return buffer;
+  }
+
+  protected abstract void renderBodyContent(Buffer buffer, CharSequence bodyContent,
+      String targetEnvironment) throws IOException;
+
+  private List<CloudManagerConditional> getCloudManagerConditional(List<Map<String, Object>> configs) {
+    return configs.stream()
+        .map(config -> new CloudManagerConditional(config))
+        .filter(item -> item.getTargetEnvironment() != null)
+        .collect(Collectors.toList());
+  }
+
+  /**
+   * Cloud manager conditional result per tenant and target environment.
+   */
+  private static class CloudManagerConditional {
+
+    private final Map<String, Object> config;
+    private final String targetEnvironment;
+
+    CloudManagerConditional(Map<String, Object> config) {
+      this.config = new HashMap<>(config);
+      Object value = this.config.get(AbstractCloudManagerConditionalHelper.TARGET_ENVIRONMENT_KEY);
+      if (value instanceof String) {
+        this.targetEnvironment = (String)value;
+      }
+      else {
+        this.targetEnvironment = null;
+      }
+      this.config.remove(AbstractCloudManagerConditionalHelper.TARGET_ENVIRONMENT_KEY);
+    }
+
+    public String getTargetEnvironment() {
+      return targetEnvironment;
+    }
+
+    public Map<String, Object> getConfig() {
+      return config;
+    }
+
+  }
+
+}

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AemTenantsCloudManagerConditionalHelper.java

@@ -0,0 +1,54 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2020 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.handlebars.helper;
+
+import java.io.IOException;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.github.jknack.handlebars.Options.Buffer;
+
+/**
+ * Checks if there is a conditional statement 'httpd.cloudManagerConditional' in the current context.
+ * If yes iterates over all environments and renders the body for each with a merged model,
+ * each enclosed in an IfDefine statement.
+ * If no the body is rendered once with the default model.
+ */
+public final class HttpdCloudManagerConditionalHelper extends AbstractCloudManagerConditionalHelper {
+
+  /**
+   * Plugin/Helper name
+   */
+  public static final String NAME = "httpdCloudManagerConditional";
+
+  @Override
+  public String getName() {
+    return NAME;
+  }
+
+  @Override
+  protected void renderBodyContent(Buffer buffer, CharSequence bodyContent,
+      String targetEnvironment) throws IOException {
+    buffer.append("<IfDefine ENVIRONMENT_").append(StringUtils.upperCase(targetEnvironment)).append(">");
+    buffer.append(bodyContent);
+    buffer.append("</IfDefine>\n");
+  }
+
+}