Add version suffix to release version packages (configurable) (#17)

Author: stefanseifert

tooling/conga-aem-maven-plugin/src/it/wcmio-archetype-aem65/config-definition/pom.xml

@@ -94,6 +94,28 @@
         </executions>
       </plugin>
 
+      <plugin>
+        <groupId>io.wcm.devops.conga.plugins</groupId>
+        <artifactId>conga-aem-maven-plugin</artifactId>
+        <executions>
+
+          <!-- Generate "all" packages including all packages from CONGA configuration for deployment via Adobe Cloud Manager -->
+          <execution>
+            <id>cloudmanager-all-package</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>cloudmanager-all-package</goal>
+            </goals>
+            <configuration>
+              <group>it</group>
+              <packageTypeValidation>WARN</packageTypeValidation>
+              <packageVersionMode>RELEASE_SUFFIX_VERSION</packageVersionMode>
+            </configuration>
+          </execution>
+
+        </executions>
+      </plugin>
+
       <!-- Do not generate eclipse project files -->
       <plugin>
         <groupId>io.wcm.devops.maven.plugins</groupId>

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

@@ -113,6 +113,16 @@ public final class CloudManagerAllPackageMojo extends AbstractCloudManagerMojo {
   @Parameter(property = "conga.cloudManager.allPackage.packageTypeValidation", defaultValue = "STRICT")
   private PackageTypeValidation packageTypeValidation;
 
+  /**
+   * How to handle versions of packages and sub-packages inside "all" package.
+   * <p>
+   * Possible options see
+   * <a href="apidocs/io/wcm/devops/conga/plugins/aem/maven/PackageVersionMode.html">PackageVersionMode</a>.
+   * </p>
+   */
+  @Parameter(property = "conga.cloudManager.allPackage.packageVersionMode", defaultValue = "DEFAULT")
+  private PackageVersionMode packageVersionMode;
+
   /**
    * Automatically generate dependencies between content packages based on file order in CONGA configuration.
    * @deprecated Please use autoDependenciesMode instead.
@@ -250,6 +260,7 @@ private AllPackageBuilder createBuilder(String packageName) {
         .autoDependenciesMode(this.autoDependenciesMode)
         .runModeOptimization(this.runModeOptimization)
         .packageTypeValidation(this.packageTypeValidation)
+        .packageVersionMode(this.packageVersionMode)
         .logger(getLog())
         .buildOutputTimestamp(new BuildOutputTimestamp(outputTimestamp));
   }

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

@@ -0,0 +1,47 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2022 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;
+
+/**
+ * How to handle versions of packages and sub-packages inside "all" package.
+ */
+public enum PackageVersionMode {
+
+  /**
+   * Keep original versions.
+   */
+  DEFAULT,
+
+  /**
+   * Suffix the version number of all packages with a release version with the version of the POM the Mojo runs in.
+   * Within the version suffix, dots are replaced with underlines to avoid convision with the main version number.
+   * This is useful when deploying to AMS with Cloud Manager.
+   * <p>
+   * Example:
+   * </p>
+   * <ul>
+   * <li>Original package version: 2.5.0</li>
+   * <li>POM version: 2022.1103.152749.0000000571</li>
+   * <li>Resulting package version: 2.5.0-2022_1103_152749_0000000571</li>
+   * </ul>
+   */
+  RELEASE_SUFFIX_VERSION
+
+}

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

@@ -29,6 +29,7 @@
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_DEPENDENCIES;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_NAME;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_PACKAGE_TYPE;
+import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_VERSION;
 
 import java.io.File;
 import java.io.FileOutputStream;
@@ -57,6 +58,7 @@
 import org.apache.jackrabbit.vault.packaging.DependencyUtil;
 import org.apache.jackrabbit.vault.packaging.PackageType;
 import org.apache.jackrabbit.vault.packaging.VersionRange;
+import org.apache.maven.artifact.ArtifactUtils;
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.plugin.logging.SystemStreamLog;
 import org.jetbrains.annotations.NotNull;
@@ -67,6 +69,7 @@
 import io.wcm.devops.conga.plugins.aem.maven.AutoDependenciesMode;
 import io.wcm.devops.conga.plugins.aem.maven.BuildOutputTimestamp;
 import io.wcm.devops.conga.plugins.aem.maven.PackageTypeValidation;
+import io.wcm.devops.conga.plugins.aem.maven.PackageVersionMode;
 import io.wcm.devops.conga.plugins.aem.maven.RunModeOptimization;
 import io.wcm.devops.conga.plugins.aem.maven.model.BundleFile;
 import io.wcm.devops.conga.plugins.aem.maven.model.ContentPackageFile;
@@ -105,6 +108,7 @@ public final class AllPackageBuilder {
   private AutoDependenciesMode autoDependenciesMode = AutoDependenciesMode.OFF;
   private RunModeOptimization runModeOptimization = RunModeOptimization.OFF;
   private PackageTypeValidation packageTypeValidation = PackageTypeValidation.STRICT;
+  private PackageVersionMode packageVersionMode = PackageVersionMode.DEFAULT;
   private Log log;
   private BuildOutputTimestamp buildOutputTimestamp;
 
@@ -113,6 +117,7 @@ public final class AllPackageBuilder {
       PackageType.APPLICATION.name().toLowerCase(),
       PackageType.CONTAINER.name().toLowerCase(),
       PackageType.CONTENT.name().toLowerCase());
+  private static final String VERSION_SUFFIX_SEPARATOR = "-";
 
   private final List<ContentPackageFileSet> contentPackageFileSets = new ArrayList<>();
   private final List<BundleFileSet> bundleFileSets = new ArrayList<>();
@@ -156,6 +161,15 @@ public AllPackageBuilder packageTypeValidation(PackageTypeValidation value) {
     return this;
   }
 
+  /**
+   * @param value How to handle versions of packages and sub-packages inside "all" package.
+   * @return this
+   */
+  public AllPackageBuilder packageVersionMode(PackageVersionMode value) {
+    this.packageVersionMode = value;
+    return this;
+  }
+
   /**
    * @param value Maven logger
    * @return this
@@ -457,8 +471,8 @@ private static String buildRootPath(String groupName, String packageName) {
 
   /**
    * Generate suffix for instance and environment run modes.
-   * @param file Content package
-   * @return Package path
+   * @param file File
+   * @return Suffix string
    */
   private static String buildRunModeSuffix(InstallableFile file, String environmentRunMode) {
     StringBuilder runModeSuffix = new StringBuilder();
@@ -474,6 +488,26 @@ else if (isOnlyPublish(file)) {
     return runModeSuffix.toString();
   }
 
+  /**
+   * Generate suffix for versions of content packages.
+   * @param pkg Content package
+   * @param ignoreSnapshot Do not build version suffix for SNAPSHOT versions
+   * @return Suffix string
+   */
+  private String buildVersionSuffix(ContentPackageFile pkg, boolean ignoreSnapshot) {
+    StringBuilder versionSuffix = new StringBuilder();
+
+    if (this.packageVersionMode == PackageVersionMode.RELEASE_SUFFIX_VERSION
+        && (!ArtifactUtils.isSnapshot(pkg.getVersion()) || !ignoreSnapshot)
+        && this.version != null) {
+      versionSuffix.append(VERSION_SUFFIX_SEPARATOR)
+          // replace dots with underlines in version suffix to avoid confusion with main version number
+          .append(StringUtils.replace(this.version, ".", "_"));
+    }
+
+    return versionSuffix.toString();
+  }
+
   /**
    * Build path to be used for embedded package.
    * @param pkg Package
@@ -492,7 +526,11 @@ private String buildPackagePath(ContentPackageFile pkg, String rootPath, String
 
     String versionSuffix = "";
     String packageVersion = pkg.getVersion();
-    if (packageVersion != null && pkg.getFile().getName().contains(packageVersion)) {
+    String packageVersionWithoutSuffix = packageVersion;
+    if (this.packageVersionMode == PackageVersionMode.RELEASE_SUFFIX_VERSION && this.version != null) {
+      packageVersionWithoutSuffix = StringUtils.removeEnd(packageVersion, buildVersionSuffix(pkg, false));
+    }
+    if (packageVersion != null && pkg.getFile().getName().contains(packageVersionWithoutSuffix)) {
       versionSuffix = "-" + packageVersion;
     }
     String fileName = pkg.getName() + versionSuffix
@@ -554,6 +592,7 @@ private List<TemporaryContentPackageFile> processContentPackage(ContentPackageFi
                 FileVaultProperties fileVaultProps = new FileVaultProperties(is);
                 Properties props = fileVaultProps.getProperties();
                 addSuffixToPackageName(props, pkg, environmentRunMode);
+                addSuffixToVersion(props, pkg);
 
                 // update package dependencies
                 ContentPackageFile dependencyFile = previousPkg;
@@ -562,7 +601,7 @@ private List<TemporaryContentPackageFile> processContentPackage(ContentPackageFi
                 }
                 updateDependencies(props, dependencyFile, environmentRunMode, allPackagesFromFileSets);
 
-                // if package type is missing package properties, put in the type defined in model
+                // if package type is missing in package properties, put in the type defined in model
                 String packageType = pkg.getPackageType();
                 if (props.get(NAME_PACKAGE_TYPE) == null && packageType != null) {
                   props.put(NAME_PACKAGE_TYPE, packageType);
@@ -583,7 +622,7 @@ else if (StringUtils.equals(FilenameUtils.getExtension(zipInEntry.getName()), "z
                 }
 
                 // check if contained ZIP file is really a content package
-                // then process it as well, remove if from the content package is was contained it
+                // then process it as well, remove if from the content package is was contained in
                 // and add it as "1st level package" to the all package
                 TemporaryContentPackageFile tempSubPackage = new TemporaryContentPackageFile(tempSubPackageFile, pkg.getVariants());
                 if (packageTypeValidation == PackageTypeValidation.STRICT && !isValidPackageType(tempSubPackage)) {
@@ -644,7 +683,7 @@ else if (in.getLastModifiedTime() != null) {
    * @param dependencyFile Dependency package
    * @param allPackagesFromFileSets Set with all packages from all file sets as dependency instances
    */
-  private static void updateDependencies(Properties props, ContentPackageFile dependencyFile, String environmentRunMode,
+  private void updateDependencies(Properties props, ContentPackageFile dependencyFile, String environmentRunMode,
       Set<Dependency> allPackagesFromFileSets) {
     String[] existingDepsStrings = StringUtils.split(props.getProperty(NAME_DEPENDENCIES), ",");
     Dependency[] existingDeps = null;
@@ -658,9 +697,10 @@ private static void updateDependencies(Properties props, ContentPackageFile depe
     Dependency[] deps;
     if (dependencyFile != null) {
       String runModeSuffix = buildRunModeSuffix(dependencyFile, environmentRunMode);
+      String dependencyVersion = dependencyFile.getVersion() + buildVersionSuffix(dependencyFile, true);
       Dependency newDependency = new Dependency(dependencyFile.getGroup(),
           dependencyFile.getName() + runModeSuffix,
-          VersionRange.fromString(dependencyFile.getVersion()));
+          VersionRange.fromString(dependencyVersion));
       deps = addDependency(existingDeps, newDependency);
     }
     else {
@@ -688,6 +728,15 @@ private static void addSuffixToPackageName(Properties props, ContentPackageFile
     props.put(NAME_NAME, packageName);
   }
 
+  private void addSuffixToVersion(Properties props, ContentPackageFile pkg) {
+    // package version
+    if (StringUtils.isEmpty(pkg.getVersion())) {
+      return;
+    }
+    String suffixedVersion = pkg.getVersion() + buildVersionSuffix(pkg, true);
+    props.put(NAME_VERSION, suffixedVersion);
+  }
+
   /**
    * Removes existing references to packages contained in the list of packages to manage by this builder because
    * they are added new (and probably with a different package name) during processing.