aem-contentpackage-properties post processor: Allow to override package type with contentPackage.packageType option (useful for 3rdparty packages that have no package type defined).

Author: stefanseifert

changes.xml

@@ -43,6 +43,9 @@
         aem-contentpackage-osgiconfig post processor: Include only generated *.config files in AEM content package, no other .content files (exception the package is empty otherwise).
         Automatically set 'packageType' for packages created by this post processor.
       </action>
+      <action type="update" dev="sseifert">
+        aem-contentpackage-properties post processor: Allow to override package type with contentPackage.packageType option (useful for 3rdparty packages that have no package type defined).
+      </action>
     </release>
 
     <release version="1.10.0" date="2020-01-30">

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePropertiesPostProcessor.java

@@ -19,10 +19,14 @@
  */
 package io.wcm.devops.conga.plugins.aem.postprocessor;
 
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_PACKAGE_TYPE;
+import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_PACKAGE_TYPE;
+
 import java.io.IOException;
 import java.util.List;
 import java.util.Map;
 
+import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 
 import com.google.common.collect.ImmutableList;
@@ -33,6 +37,7 @@
 import io.wcm.devops.conga.generator.spi.context.FileContext;
 import io.wcm.devops.conga.generator.spi.context.PostProcessorContext;
 import io.wcm.devops.conga.generator.util.FileUtil;
+import io.wcm.devops.conga.plugins.aem.util.ContentPackageUtil;
 import io.wcm.tooling.commons.packmgr.util.ContentPackageProperties;
 
 /**
@@ -82,6 +87,14 @@ public List<FileContext> apply(FileContext fileContext, PostProcessorContext con
     try {
       Map<String, Object> properties = ContentPackageProperties.get(fileContext.getFile());
       if (!properties.isEmpty()) {
+
+        // allow to redefine the packageType content package property via post processor options
+        // this is useful when 3rdparty packages do not define a package type
+        String packageType = ContentPackageUtil.getOptionalProp(context.getOptions(), PROPERTY_PACKAGE_PACKAGE_TYPE);
+        if (StringUtils.isNotBlank(packageType)) {
+          properties.put(NAME_PACKAGE_TYPE, packageType);
+        }
+
         fileContext.getModelOptions().put(MODEL_OPTIONS_PROPERTY, properties);
         logger.info("Extracted properties from AEM content package.");
       }

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java

@@ -287,7 +287,7 @@ else if (value != null) {
    * @param key Key
    * @return Option value or null
    */
-  private static String getOptionalProp(Map<String, Object> options, String key) {
+  public static String getOptionalProp(Map<String, Object> options, String key) {
     Object value = MapExpander.getDeep(options, key);
     if (value instanceof String) {
       return (String)value;

conga-aem-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePropertiesPostProcessorTest.java

@@ -30,58 +30,77 @@
 import org.junit.jupiter.api.Test;
 import org.slf4j.LoggerFactory;
 
+import com.google.common.collect.ImmutableMap;
+
 import io.wcm.devops.conga.generator.spi.PostProcessorPlugin;
 import io.wcm.devops.conga.generator.spi.context.FileContext;
 import io.wcm.devops.conga.generator.spi.context.PluginContextOptions;
 import io.wcm.devops.conga.generator.spi.context.PostProcessorContext;
 import io.wcm.devops.conga.generator.util.PluginManagerImpl;
 import io.wcm.devops.conga.plugins.sling.postprocessor.ProvisioningOsgiConfigPostProcessor;
 
-public class ContentPackagePropertiesPostProcessorTest {
+class ContentPackagePropertiesPostProcessorTest {
 
   private PostProcessorPlugin underTest;
 
   @BeforeEach
-  public void setUp() {
+  void setUp() {
     underTest = new PluginManagerImpl().get(ContentPackagePropertiesPostProcessor.NAME, PostProcessorPlugin.class);
   }
 
   @SuppressWarnings("unchecked")
   @Test
-  public void testContentPackage() throws Exception {
+  void testContentPackage() throws Exception {
 
     FileContext fileContext = new FileContext()
         .file(new File("src/test/resources/package/example.zip"));
 
     // post-process
-    applyPlugin(fileContext);
+    applyPlugin(fileContext, ImmutableMap.of());
 
     // validate
     Map<String, Object> props = (Map<String, Object>)fileContext.getModelOptions().get(ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY);
     assertEquals("mapping-sample", props.get("name"));
     assertEquals(false, props.get("requiresRoot"));
     assertEquals(2, props.get("packageFormatVersion"));
+    assertNull(props.get("packageType"));
+  }
+
+  @SuppressWarnings("unchecked")
+  @Test
+  void testContentPackageOverridePackageType() throws Exception {
+
+    FileContext fileContext = new FileContext()
+        .file(new File("src/test/resources/package/example.zip"));
+
+    // post-process
+    applyPlugin(fileContext, ImmutableMap.of("contentPackage", ImmutableMap.of("packageType", "mytype")));
+
+    // validate
+    Map<String, Object> props = (Map<String, Object>)fileContext.getModelOptions().get(ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY);
+    assertEquals("mytype", props.get("packageType"));
   }
 
   @Test
-  public void testNonContentPackage() throws Exception {
+  void testNonContentPackage() throws Exception {
 
     FileContext fileContext = new FileContext()
         .file(new File("src/test/resources/package/no-content-package.zip"));
 
     // post-process
-    applyPlugin(fileContext);
+    applyPlugin(fileContext, ImmutableMap.of());
 
     // validate
     assertNull(fileContext.getModelOptions().get(ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY));
   }
 
-  private void applyPlugin(FileContext fileContext) {
+  private void applyPlugin(FileContext fileContext, Map<String, Object> options) {
     PluginContextOptions pluginContextOptions = new PluginContextOptions()
         .pluginManager(new PluginManagerImpl())
         .logger(LoggerFactory.getLogger(ProvisioningOsgiConfigPostProcessor.class));
     PostProcessorContext context = new PostProcessorContext()
-        .pluginContextOptions(pluginContextOptions);
+        .pluginContextOptions(pluginContextOptions)
+        .options(options);
 
     assertTrue(underTest.accepts(fileContext, context));
     underTest.apply(fileContext, context);