Support packaging OSGi bundles in "all" content package file and local installation (#10)

Also generate "all" content packgage for environment if configured explicitly, even if it is configure to cloudManager.target=node.

Author: stefanseifert

changes.xml

@@ -27,6 +27,12 @@
       <action type="add" dev="sseifert">
         conga-aem-maven-plugin: Add new parameter packageTypeValidation which controls how to handle packages with invalid or without package types.
       </action>
+      <action type="add" dev="sseifert">
+        conga-aem-maven-plugin: Support to include OSGi bundles referenced in CONGA definitions to be directly included in "all" content package, or deployed to a local AEM instance.
+      </action>
+      <action type="update" dev="sseifert">
+        conga-aem-maven-plugin: Generate "all" content packgage for environment if configured explicitly, even if it is configure to cloudManager.target=node. 
+      </action>
       <action type="update" dev="sseifert">
         Content Package Validator: Update to filevault-package-maven-plugin 1.3.0.
       </action>

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

@@ -93,6 +93,16 @@ protected List<File> getEnvironmentDir() throws MojoExecutionException {
     return directories;
   }
 
+  /**
+   * Checks if the given environment was configured explicitly in plugin configuration.
+   * @param environment Environment name
+   * @return true if configured explicitly
+   */
+  protected boolean isEnvironmentConfiguredExplicitely(String environment) {
+    Set<String> selectedEnvironments = toSet(this.environments);
+    return selectedEnvironments.contains(environment);
+  }
+
   /**
    * Get matching node directories from environment.
    * @param environmentDir Environment directory

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

@@ -40,6 +40,8 @@
  */
 abstract class AbstractContentPackageMojo extends AbstractMojo {
 
+  private static final String CONSOLE_URL = "/system/console";
+
   /**
    * <p>
    * The URL of the HTTP service API of the CRX package manager.
@@ -245,4 +247,16 @@ private String buildBundleStatusUrl() throws MojoExecutionException {
     return baseUrl + "/system/console/bundles/.json";
   }
 
+  protected String buildConsoleUrl() {
+    return VendorInstallerFactory.getBaseUrl(this.serviceURL) + CONSOLE_URL;
+  }
+
+  protected String getConsoleUser() {
+    return this.consoleUserId;
+  }
+
+  protected String getConsolePassword() {
+    return this.consolePassword;
+  }
+
 }

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

@@ -36,7 +36,7 @@
 import org.apache.maven.project.MavenProjectHelper;
 
 import io.wcm.devops.conga.plugins.aem.maven.allpackage.AllPackageBuilder;
-import io.wcm.devops.conga.plugins.aem.maven.model.ContentPackageFile;
+import io.wcm.devops.conga.plugins.aem.maven.model.InstallableFile;
 import io.wcm.devops.conga.plugins.aem.maven.model.ModelParser;
 
 /**
@@ -180,12 +180,12 @@ public void execute() throws MojoExecutionException, MojoFailureException {
    * Build an "all" package for each environment and node.
    */
   private void buildAllPackagesPerEnvironmentNode() throws MojoExecutionException, MojoFailureException {
-    visitEnvironmentsNodes((environmentDir, nodeDir, cloudManagerTarget, contentPackages) -> {
+    visitEnvironmentsNodes((environmentDir, nodeDir, cloudManagerTarget, files) -> {
       String packageName = environmentDir.getName() + "." + nodeDir.getName() + "." + this.name;
       AllPackageBuilder builder = createBuilder(packageName);
 
       try {
-        builder.add(contentPackages, cloudManagerTarget);
+        builder.add(files, cloudManagerTarget);
       }
       catch (IllegalArgumentException ex) {
         throw new MojoFailureException(ex.getMessage(), ex);
@@ -202,9 +202,9 @@ private void buildSingleAllPackage() throws MojoExecutionException, MojoFailureE
     String packageName = this.name;
     AllPackageBuilder builder = createBuilder(packageName);
 
-    visitEnvironmentsNodes((environmentDir, nodeDir, cloudManagerTarget, contentPackages) -> {
+    visitEnvironmentsNodes((environmentDir, nodeDir, cloudManagerTarget, files) -> {
       try {
-        builder.add(contentPackages, cloudManagerTarget);
+        builder.add(files, cloudManagerTarget);
       }
       catch (IllegalArgumentException ex) {
         throw new MojoFailureException(ex.getMessage(), ex);
@@ -249,23 +249,37 @@ private void buildAllPackage(AllPackageBuilder builder) throws MojoExecutionExce
   }
 
   private void visitEnvironmentsNodes(EnvironmentNodeVisitor visitor) throws MojoExecutionException, MojoFailureException {
-    ModelParser modelParser = new ModelParser();
     List<File> environmentDirs = getEnvironmentDir();
     for (File environmentDir : environmentDirs) {
       List<File> nodeDirs = getNodeDirs(environmentDir);
       for (File nodeDir : nodeDirs) {
-        Set<String> cloudManagerTarget = modelParser.getCloudManagerTarget(nodeDir);
-        if (!cloudManagerTarget.contains(CLOUDMANAGER_TARGET_NONE)) {
-          List<? extends ContentPackageFile> contentPackages = modelParser.getContentPackagesForNode(nodeDir);
-          visitor.visit(environmentDir, nodeDir, cloudManagerTarget, contentPackages);
+        ModelParser modelParser = new ModelParser(nodeDir);
+        Set<String> cloudManagerTarget = modelParser.getCloudManagerTarget();
+
+        boolean validNodeForAllPackage = false;
+        if (cloudManagerTarget.contains(CLOUDMANAGER_TARGET_NONE)) {
+          if (isEnvironmentConfiguredExplicitely(environmentDir.getName())) {
+            // cloud manager target is set to "none" - but environment is configured explicitly, so include it
+            validNodeForAllPackage = true;
+            cloudManagerTarget.remove(CLOUDMANAGER_TARGET_NONE);
+          }
+        }
+        else {
+          // cloud manager target is not set to "none" - include node
+          validNodeForAllPackage = true;
+        }
+
+        if (validNodeForAllPackage) {
+          List<InstallableFile> files = modelParser.getInstallableFilesForNode();
+          visitor.visit(environmentDir, nodeDir, cloudManagerTarget, files);
         }
       }
     }
   }
 
   interface EnvironmentNodeVisitor {
     void visit(File environmentDir, File nodeDir, Set<String> cloudManagerTarget,
-        List<? extends ContentPackageFile> contentPackages) throws MojoExecutionException, MojoFailureException;
+        List<InstallableFile> files) throws MojoExecutionException, MojoFailureException;
   }
 
 }

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

@@ -69,9 +69,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
     List<File> environmentDirs = getEnvironmentDir();
     for (File environmentDir : environmentDirs) {
       List<File> nodeDirs = getNodeDirs(environmentDir);
-      ModelParser modelParser = new ModelParser();
       for (File nodeDir : nodeDirs) {
-        if (modelParser.hasRole(nodeDir, ROLE_AEM_DISPATCHER_CLOUD)) {
+        ModelParser modelParser = new ModelParser(nodeDir);
+        if (modelParser.hasRole(ROLE_AEM_DISPATCHER_CLOUD)) {
           buildDispatcherConfig(environmentDir, nodeDir);
           dispatcherNodeCount++;
         }

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

@@ -23,20 +23,34 @@
 
 import java.io.File;
 import java.util.List;
-import java.util.stream.Collectors;
 
+import org.apache.maven.execution.MavenSession;
+import org.apache.maven.model.Plugin;
+import org.apache.maven.plugin.BuildPluginManager;
+import org.apache.maven.plugin.MavenPluginManager;
+import org.apache.maven.plugin.MojoExecution;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.apache.maven.plugin.descriptor.PluginDescriptor;
+import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+import org.codehaus.plexus.configuration.PlexusConfigurationException;
+import org.codehaus.plexus.util.xml.Xpp3Dom;
 
+import io.wcm.devops.conga.plugins.aem.maven.model.BundleFile;
+import io.wcm.devops.conga.plugins.aem.maven.model.InstallableFile;
 import io.wcm.devops.conga.plugins.aem.maven.model.ModelContentPackageFile;
 import io.wcm.devops.conga.plugins.aem.maven.model.ModelParser;
 import io.wcm.tooling.commons.packmgr.install.PackageFile;
 import io.wcm.tooling.commons.packmgr.install.PackageInstaller;
 
 /**
- * Installs all AEM content packages to AEM which are referenced in a model.yaml generated by CONGA for a node.
+ * Installs all AEM content packages and OSGi bundles to AEM which are referenced in a model.yaml
+ * generated by CONGA for a node.
  */
 @Mojo(name = "package-install", threadSafe = true, requiresProject = false)
 public final class InstallPackagesMojo extends AbstractContentPackageMojo {
@@ -82,6 +96,21 @@ public final class InstallPackagesMojo extends AbstractContentPackageMojo {
   @Parameter(property = "vault.replicatePackage")
   private boolean replicate;
 
+  /**
+   * Version of Sling plugin
+   */
+  @Parameter(property = "sling.plugin.version", required = true, defaultValue = "2.4.2")
+  private String slingPluginVersion;
+
+  @Parameter(defaultValue = "${project}", readonly = true)
+  private MavenProject project;
+  @Parameter(defaultValue = "${session}", readonly = true)
+  private MavenSession session;
+  @Component(role = MavenPluginManager.class)
+  private MavenPluginManager pluginManager;
+  @Component(role = BuildPluginManager.class)
+  private BuildPluginManager buildPluginManager;
+
   @Override
   public void execute() throws MojoExecutionException, MojoFailureException {
     if (isSkip()) {
@@ -95,10 +124,8 @@ public void execute() throws MojoExecutionException, MojoFailureException {
     getLog().info("Get AEM content packages from " + getCanonicalPath(nodeDirectory));
 
     // collect files to install
-    ModelParser modelParser = new ModelParser();
-    List<PackageFile> items = modelParser.getContentPackagesForNode(nodeDirectory).stream()
-        .map(this::toPackageFile)
-        .collect(Collectors.toList());
+    ModelParser modelParser = new ModelParser(nodeDirectory);
+    List<InstallableFile> items = modelParser.getInstallableFilesForNode();
 
     // ensure any file exist
     if (items.isEmpty()) {
@@ -109,33 +136,52 @@ public void execute() throws MojoExecutionException, MojoFailureException {
     // install files
     PackageInstaller installer = new PackageInstaller(getPackageManagerProperties());
     installer.setReplicate(this.replicate);
-    installer.installFiles(items);
+
+    for (InstallableFile item : items) {
+      if (item instanceof ModelContentPackageFile) {
+        PackageFile packageFile = toPackageFile((ModelContentPackageFile)item);
+        installer.installFile(packageFile);
+      }
+      else if (item instanceof BundleFile) {
+        BundleFile bundleFile = (BundleFile)item;
+        if (bundleFile.getInstall() == null || bundleFile.getInstall()) {
+          installBundleViaSlingPlugin(bundleFile.getFile());
+        }
+      }
+      else {
+        getLog().warn("Unsupported file: " + getCanonicalPath(item.getFile()));
+      }
+    }
   }
 
   private PackageFile toPackageFile(ModelContentPackageFile item) {
     PackageFile output = new PackageFile();
 
     output.setFile(item.getFile());
-    if (item.getInstall() != null) {
-      output.setInstall(item.getInstall());
+    Boolean installParam = item.getInstall();
+    if (installParam != null) {
+      output.setInstall(installParam);
     }
     else {
       output.setInstall(this.install);
     }
-    if (item.getForce() != null) {
-      output.setForce(item.getForce());
+    Boolean forcePAram = item.getForce();
+    if (forcePAram != null) {
+      output.setForce(forcePAram);
     }
     else {
       output.setForce(this.force);
     }
-    if (item.getRecursive() != null) {
-      output.setRecursive(item.getRecursive());
+    Boolean recursiveParam = item.getRecursive();
+    if (recursiveParam != null) {
+      output.setRecursive(recursiveParam);
     }
     else {
       output.setRecursive(this.recursive);
     }
-    if (item.getDelayAfterInstallSec() != null) {
-      output.setDelayAfterInstallSec(item.getDelayAfterInstallSec());
+    Integer delayAfterInstallSecParam = item.getDelayAfterInstallSec();
+    if (delayAfterInstallSecParam != null) {
+      output.setDelayAfterInstallSec(delayAfterInstallSecParam);
     }
     else if (this.delayAfterInstallSec != null) {
       output.setDelayAfterInstallSec(this.delayAfterInstallSec);
@@ -148,4 +194,46 @@ else if (this.delayAfterInstallSec != null) {
     return output;
   }
 
+  /**
+   * Executes the sling-maven-plugin directly from the current project to install OSGi bundles.
+   */
+  private void installBundleViaSlingPlugin(File file) throws MojoExecutionException {
+    Plugin plugin = new Plugin();
+    plugin.setGroupId("org.apache.sling");
+    plugin.setArtifactId("sling-maven-plugin");
+    plugin.setVersion(this.slingPluginVersion);
+
+    try {
+      PluginDescriptor pluginDescriptor = pluginManager.getPluginDescriptor(plugin,
+          project.getRemotePluginRepositories(), session.getRepositorySession());
+      MojoDescriptor mojoDescriptor = pluginDescriptor.getMojo("install-file");
+      MojoExecution mojoExecution = new MojoExecution(pluginDescriptor.getMojo("install-file"));
+
+      Xpp3Dom config = convertConfiguration(mojoDescriptor.getMojoConfiguration());
+      config.getChild("slingUrl").setValue(buildConsoleUrl());
+      config.getChild("user").setValue(this.getConsoleUser());
+      config.getChild("password").setValue(this.getConsolePassword());
+      config.getChild("mountByFS").setValue("false");
+      config.getChild("bundleFileName").setValue(file.getAbsolutePath());
+      mojoExecution.setConfiguration(config);
+
+      buildPluginManager.executeMojo(session, mojoExecution);
+    }
+    catch (Exception ex) {
+      throw new MojoExecutionException("Faild to execute plugin: " + plugin, ex);
+    }
+  }
+
+  private Xpp3Dom convertConfiguration(PlexusConfiguration plexusConfig) throws PlexusConfigurationException {
+    Xpp3Dom config = new Xpp3Dom(plexusConfig.getName());
+    config.setValue(plexusConfig.getValue());
+    for (String attribute : plexusConfig.getAttributeNames()) {
+      config.setAttribute(attribute, plexusConfig.getAttribute(attribute));
+    }
+    for (PlexusConfiguration child : plexusConfig.getChildren()) {
+      config.addChild(convertConfiguration(child));
+    }
+    return config;
+  }
+
 }