ensure only allowed packageTypes are included in cloud manager "all" package

Author: stefanseifert

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

@@ -47,6 +47,8 @@
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.plugin.logging.SystemStreamLog;
 
+import com.google.common.collect.ImmutableSet;
+
 import io.wcm.devops.conga.plugins.aem.maven.model.ContentPackageFile;
 import io.wcm.tooling.commons.contentpackagebuilder.ContentPackage;
 import io.wcm.tooling.commons.contentpackagebuilder.ContentPackageBuilder;
@@ -65,6 +67,7 @@ public final class AllPackageBuilder {
   private Log log;
 
   private static final String RUNMODE_DEFAULT = "$default$";
+  private static final Set<String> ALLOWED_PACKAGE_TYPES = ImmutableSet.of("application", "container", "content");
 
   /**
    * @param targetFile Target file
@@ -132,12 +135,24 @@ public boolean build(List<ContentPackageFile> contentPackages, Set<String> cloud
 
     // generate warnings for each invalid content packages that is skipped
     contentPackages.stream()
-        .filter(pkg -> !isValid(pkg))
+        .filter(pkg -> !hasPackageType(pkg))
         .forEach(pkg -> getLog().warn("Skipping content package without package type: " + getCanonicalPath(pkg.getFile())));
 
+    // fail build if content packages with non-allowed package types exist
+    List<ContentPackageFile> invalidPackageTypeContentPackages = contentPackages.stream()
+        .filter(AllPackageBuilder::hasPackageType)
+        .filter(pkg -> !isValidPackageType(pkg))
+        .collect(Collectors.toList());
+    if (!invalidPackageTypeContentPackages.isEmpty()) {
+      throw new IOException("Content packages found with unsupported package types: " +
+          invalidPackageTypeContentPackages.stream()
+              .map(pkg -> pkg.getName() + " -> " + pkg.getPackageType())
+              .collect(Collectors.joining(", ")));
+    }
+
     // collect AEM content packages for this node
     List<ContentPackageFile> validContentPackages = contentPackages.stream()
-        .filter(pkg -> isValid(pkg))
+        .filter(AllPackageBuilder::hasPackageType)
         .collect(Collectors.toList());
     if (validContentPackages.isEmpty()) {
       return false;
@@ -184,11 +199,16 @@ public boolean build(List<ContentPackageFile> contentPackages, Set<String> cloud
     return true;
   }
 
-  private static boolean isValid(ContentPackageFile pkg) {
-    // accept only content packages with package type
+  private static boolean hasPackageType(ContentPackageFile pkg) {
+    // accept only content packages with a package type set
     return pkg.getPackageType() != null;
   }
 
+  private static boolean isValidPackageType(ContentPackageFile pkg) {
+    // check if the package type is an allowed package type
+    return ALLOWED_PACKAGE_TYPES.contains(pkg.getPackageType());
+  }
+
   private static boolean isMutable(ContentPackageFile pkg) {
     return StringUtils.equals("content", pkg.getPackageType());
   }

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

@@ -0,0 +1,67 @@
+/*
+ * #%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.maven.allpackage;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+
+import org.apache.commons.io.FileUtils;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+
+import com.google.common.collect.ImmutableSet;
+
+import io.wcm.devops.conga.plugins.aem.maven.model.ContentPackageFile;
+import io.wcm.devops.conga.plugins.aem.maven.model.ModelParser;
+
+class AllPackageBuilderMixedPackageTypeTest {
+
+  private File nodeDir;
+  private File targetDir;
+  private File targetUnpackDir;
+
+  @BeforeEach
+  void setUp(TestInfo testInfo) throws IOException {
+    nodeDir = new File("src/test/resources/node-mixed-package");
+    targetDir = new File("target/test-" + getClass().getSimpleName() + "_" + testInfo.getDisplayName());
+    targetUnpackDir = new File(targetDir, "unpack");
+    FileUtils.deleteDirectory(targetDir);
+    targetDir.mkdirs();
+    targetUnpackDir.mkdirs();
+  }
+
+  @Test
+  void testBuild() 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");
+
+    // should fail to to "mixed" packageType
+    assertThrows(IOException.class, () -> {
+      builder.build(contentPackages, ImmutableSet.of());
+    });
+  }
+
+}

tooling/conga-aem-maven-plugin/src/test/resources/node-mixed-package/model.yaml

@@ -0,0 +1,28 @@
+roles:
+- role: aem-cms
+  variant: aem-author
+  variants: [aem-author]
+  files:
+  - path: packages/aem-cms-system-config.zip
+    postProcessors: [aem-contentpackage-osgiconfig, aem-contentpackage-properties]
+    aemContentPackageProperties:
+      allowIndexDefinitions: false
+      created: '2020-04-07T10:36:38.606+02:00'
+      createdBy: admin
+      description: |-
+        This file is AUTO-GENERATED by CONGA. Please do not change it manually.
+
+        Version 1.3.1-SNAPSHOT
+        Environment: development
+        Role: aem-cms
+        Variant: aem-author
+        Template: aem-cms-system-config.provisioning.hbs
+
+        Dependencies:
+        io.wcm.devops.conga.definitions/io.wcm.devops.conga.definitions.aem/1.6.2
+      group: wcm-io-samples
+      name: aem-cms-system-config
+      packageType: mixed
+      requiresRoot: false
+      version: 1.3.1-SNAPSHOT
+    force: true