aem-contentpackage post processor: Support "fileMatch" property to include a list of binary files matching the pattern into a content package.

stefanseifert · stefanseifert · commit 092008dd936b · 2020-07-07T19:35:06.000+02:00
diff --git a/changes.xml b/changes.xml
@@ -23,6 +23,12 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 https://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
+    <release version="1.12.2" date="not released">
+      <action type="update" dev="sseifert">
+        aem-contentpackage post processor: Support "fileMatch" property to include a list of binary files matching the pattern into a content package.
+      </action>
+    </release>
+
     <release version="1.12.0" date="2020-06-28">
       <action type="add" dev="sseifert">
         Add httpdCloudManagerConditional and withAllCloudManagerConditional handlebars helper to build envrionment-conditional configuration for AEM cloud service..
diff --git a/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePostProcessor.java b/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePostProcessor.java
@@ -97,7 +97,7 @@ public List<FileContext> apply(FileContext fileContext, PostProcessorContext con
         contentPackage.addContent(rootPath, content);
 
         // add additional binary files
-        for (ContentPackageBinaryFile binaryFile : ContentPackageUtil.getFiles(options)) {
+        for (ContentPackageBinaryFile binaryFile : ContentPackageUtil.getFiles(options, fileContext.getTargetDir())) {
           String path = binaryFile.getPath();
           try (InputStream is = binaryFile.getInputStream(context.getUrlFileManager(), fileContext.getTargetDir())) {
             contentPackage.addFile(path, is);
diff --git a/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java b/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java
@@ -34,11 +34,18 @@
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_THUMBNAIL_IMAGE;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_VERSION;
 
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 import org.apache.commons.lang3.BooleanUtils;
@@ -348,25 +355,70 @@ private static Map<String, Object> getOptionalPropMap(Map<String, Object> option
   /**
    * Get binary files to be added to package.
    * @param options Options
+   * @param targetDir Target directory
    * @return File list
    * @throws IOException I/O exception
    */
-  public static List<ContentPackageBinaryFile> getFiles(Map<String, Object> options) throws IOException {
+  public static List<ContentPackageBinaryFile> getFiles(Map<String, Object> options, File targetDir) throws IOException {
     List<ContentPackageBinaryFile> files = new ArrayList<>();
 
     List<Map<String, Object>> fileDefinitions = getOptionalPropMapList(options, PROPERTY_PACKAGE_FILES);
     if (fileDefinitions != null) {
       for (Map<String, Object> fileDefinition : fileDefinitions) {
         String file = getOptionalProp(fileDefinition, "file");
+        String fileMatch = getOptionalProp(fileDefinition, "fileMatch");
         String dir = getOptionalProp(fileDefinition, "dir");
         String url = getOptionalProp(fileDefinition, "url");
         String path = getMandatoryProp(fileDefinition, "path");
         boolean delete = BooleanUtils.toBoolean(getOptionalProp(fileDefinition, "delete"));
-        files.add(new ContentPackageBinaryFile(file, dir, url, path, delete));
+
+        if (fileMatch != null && file == null && url == null) {
+          // add multiple (local) files matching with given regex
+          files.addAll(getMatchingFiles(targetDir, fileMatch, dir, path, delete));
+        }
+        else {
+          // add single file
+          files.add(new ContentPackageBinaryFile(file, dir, url, path, delete));
+        }
       }
     }
 
     return files;
   }
 
+  private static List<ContentPackageBinaryFile> getMatchingFiles(File targetDir, String fileMatch,
+      String dir, String path, boolean delete) throws IOException {
+    File fileTargetDir = targetDir;
+    if (StringUtils.isNotEmpty(dir)) {
+      fileTargetDir = new File(targetDir, dir);
+    }
+    Path fileTargetPath = Paths.get(fileTargetDir.toURI());
+    String targetPathPrefix = normalizedAbsolutePath(fileTargetPath) + "/";
+    Pattern pattern = Pattern.compile(fileMatch);
+
+    // collect all files below the target dir
+    return Files.walk(Paths.get(fileTargetDir.toURI()))
+        .filter(Files::isRegularFile)
+        // strip off the target dir paths, keep only the relative path/file name
+        .map(ContentPackageUtil::normalizedAbsolutePath)
+        .map(file -> StringUtils.removeStart(file, targetPathPrefix))
+        // check if file matches with the regex, apply matching input groups to path
+        .map(file -> {
+          Matcher matcher = pattern.matcher(file);
+          if (matcher.matches()) {
+            String adaptedPath = matcher.replaceAll(path);
+            return new ContentPackageBinaryFile(file, dir, null, adaptedPath, delete);
+          }
+          else {
+            return null;
+          }
+        })
+        .filter(Objects::nonNull)
+        .collect(Collectors.toList());
+  }
+
+  private static String normalizedAbsolutePath(Path path) {
+    return StringUtils.replace(path.toAbsolutePath().toString(), "\\", "/");
+  }
+
 }
diff --git a/conga-aem-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePostProcessorTest.java b/conga-aem-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePostProcessorTest.java
@@ -88,7 +88,8 @@ public void testPostProcess() throws Exception {
         "my.custom.prop2", 123));
     options.put(PROPERTY_PACKAGE_FILES, ImmutableList.of(
         ImmutableMap.<String, Object>of("url", "classpath:/package/thumbnail.png", "path", "/content/image.png"),
-        ImmutableMap.<String, Object>of("file", "README.txt", "dir", "readme", "path", "/content/README.txt", "delete", true)));
+        ImmutableMap.<String, Object>of("file", "README.txt", "dir", "readme", "path", "/content/README.txt", "delete", true),
+        ImmutableMap.<String, Object>of("fileMatch", "file_(.*).txt", "dir", "files", "path", "/content/files/$1.txt", "delete", true)));
 
     // prepare JSON file
     File target = new File("target/" + ContentPackagePostProcessor.NAME + "-test");
@@ -98,12 +99,21 @@ public void testPostProcess() throws Exception {
     File contentPackageFile = new File(target, "test.json");
     FileUtils.copyFile(new File(getClass().getResource("/json/content.json").toURI()), contentPackageFile);
 
-    // pepare additionaly binary file
+    // prepare additional binary files
     File readmeFolder = new File(target, "readme");
     readmeFolder.mkdir();
     File readmeFile = new File(readmeFolder, "README.txt");
     FileUtils.write(readmeFile, "readme", StandardCharsets.UTF_8);
 
+    File filesFolder = new File(target, "files");
+    filesFolder.mkdir();
+    File file_1 = new File(filesFolder, "file_1.txt");
+    FileUtils.write(file_1, "file_1", StandardCharsets.UTF_8);
+    File file_2 = new File(filesFolder, "file_2.txt");
+    FileUtils.write(file_2, "file_2", StandardCharsets.UTF_8);
+    File file_3 = new File(filesFolder, "file_3.txt");
+    FileUtils.write(file_3, "file_3", StandardCharsets.UTF_8);
+
     // post-process
     FileContext fileContext = new FileContext()
         .file(contentPackageFile)
@@ -153,6 +163,18 @@ public void testPostProcess() throws Exception {
     byte[] readmeText = getDataFromZip(zipFile, "jcr_root/content/README.txt");
     assertNotNull(readmeText);
     assertFalse(readmeFile.exists());
+
+    byte[] file_1Text = getDataFromZip(zipFile, "jcr_root/content/files/1.txt");
+    assertNotNull(file_1Text);
+    assertFalse(file_1.exists());
+
+    byte[] file_2Text = getDataFromZip(zipFile, "jcr_root/content/files/2.txt");
+    assertNotNull(file_2Text);
+    assertFalse(file_2.exists());
+
+    byte[] file_3Text = getDataFromZip(zipFile, "jcr_root/content/files/3.txt");
+    assertNotNull(file_3Text);
+    assertFalse(file_3.exists());
   }
 
 }
diff --git a/src/site/markdown/extensions.md b/src/site/markdown/extensions.md
@@ -39,7 +39,7 @@ Both post processor plugins support a set of options that allow further configur
 | `contentPackage.filters`        | Contains list with filter definitions, optionally with include/exclude rules. If not defined a simple filter rule is derived from the `contentPackage.rootPath` property.
 | `contentPackage.acHandling`     | How to apply ACLs that are contained in the content package. Possible values: `ignore` (default), `overwrite`, `merge`, `merge_preserve`, `clear`.
 | `contentPackage.thumbnailImage` | URL to thumbnail PNG image to be used for the content package. URL file plugin prefixes can be used (e.g. `classpath:`).
-| `contentPackage.files`          | List of additional binary files to be included in content package. For each file you have to specify a `path` property (target path), and for the source an `url` property for an external file, or a `file` and `dir` property for a file that was generated by CONGA. If the file should be deleted after the inclusion you can additionally specify `delete: true`.
+| `contentPackage.files`          | List of additional binary files to be included in content package. For each file you have to specify a `path` property (target path), and for the source an `url` property for an external file, or a `file` and `dir` property for a file that was generated by CONGA. Instead of `file` your can also use `fileMath` to include multiple files matching this pattern. If the file should be deleted after the inclusion you can additionally specify `delete: true`.
 | `contentPackage.properties`     | Defines map with additional custom properties for package metadata.
 | `contentPackage.packageType`    | Defines the [packageType][jackrabbit-filevault-packagetype] for the content package. Uses for [FileVault validation][jackrabbit-filevault-validation] of the package.
 | `contentPackage.requiresRoot`   | Package requires root.
@@ -72,6 +72,37 @@ Example for defining package properties with a set of filters:
           pattern: /etc/map/http/AppMeasurementBridge
 ```
 
+Example for additionally adding binary files to the content package:
+
+```
+# Define a AEM content package with some JCR content
+- file: my-package.json
+  dir: packages
+  template: my-package.json.hbs
+  # Post-processors apply further actions after generation the file
+  postProcessors:
+  - aem-contentpackage
+  postProcessorOptions:
+    contentPackage:
+      name: my-package
+      rootPath: /content/files
+      files:
+      # Add a static file from the class paths (or other URLs)
+      - url:classpath:/my-resources/file1.txt
+        path: /content/files/file1.txt
+      # Add a file that was generated by CONGA (delete after inclusion in package)
+      - file: generated-file.txt
+        dir: generated-files
+        path: /content/files/generated-file.txt
+        delete: true
+      # Add a set file that were generated by CONGA (delete after inclusion in package)
+      - fileMatch: file_(.*)\.txt
+        dir: generated-files
+        path: /content/files/$1.txt
+        delete: true
+```
+
+
 
 ### Validating AEM Content Packages
 
