conga-aem-maven-plugin: Check package manager installstatus.jsp before/after installation of content packages (#11)

Author: stefanseifert

changes.xml

@@ -28,6 +28,9 @@
         conga-aem-maven-plugin: Add parameter "runModeOptimization" to "cloudmanager-all-package" goal, set by default to OFF.
         When set to ELIMINATE_DUPLICATES, only one content package is built per environment, including author and publish runmodes, eliminating duplicates between those two modes as much as possible.
       </action>
+      <action type="add" dev="sseifert">
+        conga-aem-maven-plugin: Check package manager installstatus.jsp before and after installation of content package to make sure packager manager is also completed with installing embedded packages.
+      </action>
     </release>
 
     <release version="2.17.0" date="2022-05-11">

parent/pom.xml

@@ -75,7 +75,7 @@
       <dependency>
         <groupId>io.wcm.tooling.commons</groupId>
         <artifactId>io.wcm.tooling.commons.crx-packmgr-helper</artifactId>
-        <version>2.0.4</version>
+        <version>2.1.0-SNAPSHOT</version>
       </dependency>
 
       <dependency>

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

@@ -34,6 +34,7 @@
 
 import io.wcm.tooling.commons.packmgr.PackageManagerProperties;
 import io.wcm.tooling.commons.packmgr.install.VendorInstallerFactory;
+import io.wcm.tooling.commons.packmgr.install.VendorInstallerFactory.Service;
 
 /**
  * Common functionality for all mojos.
@@ -120,14 +121,14 @@ abstract class AbstractContentPackageMojo extends AbstractMojo {
    * before it is tried to upload and install a new package and after each upload.
    * </p>
    * <p>
-   * If not all packages are installed the upload is delayed up to 10 minutes, every 5 seconds the
-   * activation status is checked anew.
+   * If not all bundles are activated the upload is delayed up to {@link #bundleStatusWaitLimit} seconds,
+   * every 5 seconds the activation status is checked anew.
    * </p>
    * <p>
    * Expected is an URL like: http://localhost:4502/system/console/bundles/.json
    * </p>
    * <p>
-   * If the URL is not set it is derived from serviceURL. Set to "-" to explicitly disable the status check.
+   * If the URL is not set it is derived from serviceURL. If set to "-" the status check is disabled.
    * </p>
    */
   @Parameter(property = "vault.bundleStatusURL", required = false)
@@ -140,6 +141,33 @@ abstract class AbstractContentPackageMojo extends AbstractMojo {
   @Parameter(property = "vault.bundleStatusWaitLimit", defaultValue = "360")
   private int bundleStatusWaitLimit;
 
+  /**
+   * <p>
+   * Package Manager install status JSON URL. If an URL is configured the installation status of packages and
+   * embedded packages is checked before it is tried to upload and install a new package and after each upload.
+   * </p>
+   * <p>
+   * If not all packages are installed the upload is delayed up to {@link #packageManagerInstallStatusWaitLimit}
+   * seconds, every 5 seconds the installation status is checked anew.
+   * </p>
+   * <p>
+   * Expected is an URL like: http://localhost:4502/crx/packmgr/installstatus.jsp
+   * </p>
+   * <p>
+   * If the URL is not set it is derived from serviceURL. If set to "-" the status check is disabled.
+   * </p>
+   */
+  @Parameter(property = "vault.packageManagerInstallStatusURL", required = false)
+  private String packageManagerInstallStatusURL;
+
+  /**
+   * Number of seconds to wait as maximum for a positive package manager install status check.
+   * If this limit is reached and the package manager status is still not positive the install of the package proceeds
+   * anyway.
+   */
+  @Parameter(property = "vault.packageManagerInstallStatusWaitLimit", defaultValue = "360")
+  private int packageManagerInstallStatusWaitLimit;
+
   /**
    * Patterns for symbolic names of bundles that are expected to be not present in bundle list.
    * If any of these bundles are found in the bundle list, this system is assumed as not ready for installing further
@@ -211,6 +239,8 @@ protected PackageManagerProperties getPackageManagerProperties() throws MojoExec
     props.setBundleStatusWaitLimitSec(this.bundleStatusWaitLimit);
     props.setBundleStatusBlacklistBundleNames(ImmutableList.copyOf(this.bundleStatusBlacklistBundleNames));
     props.setBundleStatusWhitelistBundleNames(ImmutableList.copyOf(this.bundleStatusWhitelistBundleNames));
+    props.setPackageManagerInstallStatusURL(buildPackageManagerInstallStatusUrl());
+    props.setPackageManagerInstallStatusWaitLimitSec(this.packageManagerInstallStatusWaitLimit);
     props.setRelaxedSSLCheck(this.relaxedSSLCheck);
     props.setHttpConnectTimeoutSec(this.httpConnectTimeoutSec);
     props.setHttpSocketTimeoutSec(this.httpSocketTimeout);
@@ -230,7 +260,7 @@ private String buildPackageManagerUrl() throws MojoExecutionException {
         serviceUrl = VendorInstallerFactory.getBaseUrl(serviceUrl) + COMPOSUM_URL;
         break;
       default:
-        throw new MojoExecutionException("Unsupporte service URL: " + serviceUrl);
+        throw new MojoExecutionException("Unsupported service URL: " + serviceUrl);
     }
     return serviceUrl;
   }
@@ -247,6 +277,19 @@ private String buildBundleStatusUrl() throws MojoExecutionException {
     return baseUrl + "/system/console/bundles/.json";
   }
 
+  private String buildPackageManagerInstallStatusUrl() throws MojoExecutionException {
+    if (StringUtils.equals(this.packageManagerInstallStatusURL, "-")
+        || VendorInstallerFactory.identify(this.serviceURL) != Service.CRX) {
+      return null;
+    }
+    if (this.packageManagerInstallStatusURL != null) {
+      return this.packageManagerInstallStatusURL;
+    }
+    // if not set use hostname from serviceURL and add default path to bundle status
+    String baseUrl = VendorInstallerFactory.getBaseUrl(buildPackageManagerUrl());
+    return baseUrl + "/crx/packmgr/installstatus.jsp";
+  }
+
   protected String buildConsoleUrl() {
     return VendorInstallerFactory.getBaseUrl(this.serviceURL) + CONSOLE_URL;
   }