ContentPackageOsgiConfigPostProcessor: Write OSGi configurations as .…

…cfg.json files instead of .config files (#85)
wcm-io-devops · Jan 9, 2024 · 5503772 · 5503772
1 parent 514e1ae
commit 5503772
Show file tree

Hide file tree

Showing 12 changed files with 33 additions and 42 deletions.
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="2.20.0" date="not released">
+      <action type="update" dev="sseifert" issue="85">
+        ContentPackageOsgiConfigPostProcessor: Write OSGi configurations as .cfg.json files instead of .config files.
+      </action>
+    </release>
+
     <release version="2.19.10" date="2023-12-18">
       <action type="fix" dev="sseifert">
         Update to latest io.wcm.tooling.commons.content-package-builder to fix potential problem with element ordering content packages generated from JSON files.

diff --git a/conga-aem-plugin/pom.xml b/conga-aem-plugin/pom.xml
@@ -25,13 +25,13 @@
   <parent>
     <groupId>io.wcm.devops.conga.plugins</groupId>
     <artifactId>io.wcm.devops.conga.plugins.aem.parent</artifactId>
-    <version>2.19.11-SNAPSHOT</version>
+    <version>2.20.0-SNAPSHOT</version>
     <relativePath>../parent/pom.xml</relativePath>
   </parent>
 
   <groupId>io.wcm.devops.conga.plugins</groupId>
   <artifactId>io.wcm.devops.conga.plugins.aem</artifactId>
-  <version>2.19.11-SNAPSHOT</version>
+  <version>2.20.0-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>CONGA AEM Plugin</name>

diff --git a/.../io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOsgiConfigPostProcessor.java b/.../io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOsgiConfigPostProcessor.java
@@ -151,7 +151,7 @@ public Void accept(String path, Dictionary<String, Object> properties) throws IO
         context.getLogger().info("  Include " + contentPath);
 
         // write configuration to temporary file
-        File tempFile = File.createTempFile(NAME, ".config");
+        File tempFile = File.createTempFile(NAME, ".cfg.json");
         try (OutputStream os = new FileOutputStream(tempFile)) {
           OsgiConfigUtil.write(os, properties);
         }

diff --git a/...wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOsgiConfigPostProcessorTest.java b/...wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOsgiConfigPostProcessorTest.java
@@ -34,14 +34,14 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.File;
-import java.io.IOException;
 import java.io.InputStream;
+import java.io.InputStreamReader;
 import java.nio.charset.StandardCharsets;
 import java.util.Dictionary;
 import java.util.Map;
 
 import org.apache.commons.io.FileUtils;
-import org.apache.felix.cm.file.ConfigurationHandler;
+import org.apache.felix.cm.json.io.Configurations;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.slf4j.LoggerFactory;
@@ -103,24 +103,9 @@ void testPostProcess() throws Exception {
     File zipFile = new File(target, "test.zip");
     assertTrue(zipFile.exists());
 
-    try (InputStream is = new ByteArrayInputStream(getDataFromZip(zipFile, "jcr_root/apps/test/config/my.pid.config"))) {
-
-      // check for initial comment line
-      is.mark(256);
-      final int firstChar = is.read();
-      if (firstChar == '#') {
-        int b;
-        while ((b = is.read()) != '\n') {
-          if (b == -1) {
-            throw new IOException("Unable to read configuration.");
-          }
-        }
-      }
-      else {
-        is.reset();
-      }
-
-      Dictionary<?, ?> config = ConfigurationHandler.read(is);
+    try (InputStream is = new ByteArrayInputStream(getDataFromZip(zipFile, "jcr_root/apps/test/config/my.pid.cfg.json"));
+        InputStreamReader reader = new InputStreamReader(is, StandardCharsets.UTF_8)) {
+      Dictionary<?, ?> config = Configurations.buildReader().build(reader).readConfiguration();
       assertEquals("value1", config.get("stringProperty"));
       assertArrayEquals(new String[] {
           "v1", "v2", "v3"
@@ -129,9 +114,9 @@ void testPostProcess() throws Exception {
       assertEquals(999999999999L, config.get("longProperty"));
     }
 
-    assertTrue(ZipUtil.containsEntry(zipFile, "jcr_root/apps/test/config/my.factory-my.pid.config"));
-    assertTrue(ZipUtil.containsEntry(zipFile, "jcr_root/apps/test/config.mode1/my.factory-my.pid2.config"));
-    assertTrue(ZipUtil.containsEntry(zipFile, "jcr_root/apps/test/config.mode2/my.pid2.config"));
+    assertTrue(ZipUtil.containsEntry(zipFile, "jcr_root/apps/test/config/my.factory-my.pid.cfg.json"));
+    assertTrue(ZipUtil.containsEntry(zipFile, "jcr_root/apps/test/config.mode1/my.factory-my.pid2.cfg.json"));
+    assertTrue(ZipUtil.containsEntry(zipFile, "jcr_root/apps/test/config.mode2/my.pid2.cfg.json"));
 
     Document filterXml = getXmlFromZip(zipFile, "META-INF/vault/filter.xml");
     assertXpathEvaluatesTo("/apps/test/config", "/workspaceFilter/filter[1]/@root", filterXml);

diff --git a/parent/pom.xml b/parent/pom.xml
@@ -31,7 +31,7 @@
 
   <groupId>io.wcm.devops.conga.plugins</groupId>
   <artifactId>io.wcm.devops.conga.plugins.aem.parent</artifactId>
-  <version>2.19.11-SNAPSHOT</version>
+  <version>2.20.0-SNAPSHOT</version>
   <packaging>pom</packaging>
 
   <name>CONGA AEM Plugin</name>
@@ -57,18 +57,18 @@
       <dependency>
         <groupId>io.wcm.devops.conga</groupId>
         <artifactId>io.wcm.devops.conga.generator</artifactId>
-        <version>1.16.4</version>
+        <version>1.16.5-SNAPSHOT</version>
       </dependency>
       <dependency>
         <groupId>io.wcm.devops.conga</groupId>
         <artifactId>conga-maven-plugin</artifactId>
-        <version>1.16.4</version>
+        <version>1.16.5-SNAPSHOT</version>
       </dependency>
 
       <dependency>
         <groupId>io.wcm.devops.conga.plugins</groupId>
         <artifactId>io.wcm.devops.conga.plugins.sling</artifactId>
-        <version>1.3.4</version>
+        <version>1.4.0-SNAPSHOT</version>
       </dependency>
 
       <dependency>

diff --git a/pom.xml b/pom.xml
@@ -23,13 +23,13 @@
   <parent>
     <groupId>io.wcm.devops.conga.plugins</groupId>
     <artifactId>io.wcm.devops.conga.plugins.aem.parent</artifactId>
-    <version>2.19.11-SNAPSHOT</version>
+    <version>2.20.0-SNAPSHOT</version>
     <relativePath>parent/pom.xml</relativePath>
   </parent>
 
   <groupId>io.wcm.devops.conga.plugins</groupId>
   <artifactId>io.wcm.devops.conga.plugins.aem.root</artifactId>
-  <version>2.19.11-SNAPSHOT</version>
+  <version>2.20.0-SNAPSHOT</version>
   <packaging>pom</packaging>
 
   <name>CONGA AEM Plugin</name>

diff --git a/tooling/conga-aem-crypto-cli/pom.xml b/tooling/conga-aem-crypto-cli/pom.xml
@@ -25,14 +25,14 @@
   <parent>
     <groupId>io.wcm.devops.conga.plugins</groupId>
     <artifactId>io.wcm.devops.conga.plugins.aem.parent</artifactId>
-    <version>2.19.11-SNAPSHOT</version>
+    <version>2.20.0-SNAPSHOT</version>
     <relativePath>../../parent/pom.xml</relativePath>
   </parent>
 
   <groupId>io.wcm.devops.conga.plugins</groupId>
   <artifactId>conga-aem-crypto-cli</artifactId>
   <packaging>jar</packaging>
-  <version>2.19.11-SNAPSHOT</version>
+  <version>2.20.0-SNAPSHOT</version>
 
   <name>CONGA AEM Crypto Command Line Interface</name>
   <description>Command line tool to generate Crypto keys for AEM.</description>
@@ -42,7 +42,7 @@
     <dependency>
       <groupId>io.wcm.devops.conga.plugins</groupId>
       <artifactId>io.wcm.devops.conga.plugins.aem</artifactId>
-      <version>2.19.11-SNAPSHOT</version>
+      <version>2.20.0-SNAPSHOT</version>
       <scope>compile</scope>
       <exclusions>
         <!-- Exclude all deps - only crypto util classes are used -->

diff --git a/tooling/conga-aem-maven-plugin/pom.xml b/tooling/conga-aem-maven-plugin/pom.xml
@@ -25,14 +25,14 @@
   <parent>
     <groupId>io.wcm.devops.conga.plugins</groupId>
     <artifactId>io.wcm.devops.conga.plugins.aem.parent</artifactId>
-    <version>2.19.11-SNAPSHOT</version>
+    <version>2.20.0-SNAPSHOT</version>
     <relativePath>../../parent/pom.xml</relativePath>
   </parent>
 
   <groupId>io.wcm.devops.conga.plugins</groupId>
   <artifactId>conga-aem-maven-plugin</artifactId>
   <packaging>maven-plugin</packaging>
-  <version>2.19.11-SNAPSHOT</version>
+  <version>2.20.0-SNAPSHOT</version>
 
   <name>CONGA AEM Maven Plugin</name>
   <description>wcm.io DevOps CONGA - CONfiguration GenerAtor Maven Plugin for AEM</description>
@@ -62,7 +62,7 @@
     <dependency>
       <groupId>io.wcm.devops.conga.plugins</groupId>
       <artifactId>io.wcm.devops.conga.plugins.aem</artifactId>
-      <version>2.19.11-SNAPSHOT</version>
+      <version>2.20.0-SNAPSHOT</version>
       <scope>compile</scope>
     </dependency>
     <dependency>

diff --git a/tooling/conga-aem-maven-plugin/src/it/example/pom.xml b/tooling/conga-aem-maven-plugin/src/it/example/pom.xml
@@ -74,7 +74,7 @@
       <plugin>
         <groupId>io.wcm.devops.conga</groupId>
         <artifactId>conga-maven-plugin</artifactId>
-        <version>1.16.4</version>
+        <version>1.16.5-SNAPSHOT</version>
         <extensions>true</extensions>
         <dependencies>
 

diff --git a/tooling/conga-aem-maven-plugin/src/it/mixed-no-package-type/pom.xml b/tooling/conga-aem-maven-plugin/src/it/mixed-no-package-type/pom.xml
@@ -67,7 +67,7 @@
       <plugin>
         <groupId>io.wcm.devops.conga</groupId>
         <artifactId>conga-maven-plugin</artifactId>
-        <version>1.16.4</version>
+        <version>1.16.5-SNAPSHOT</version>
         <extensions>true</extensions>
         <dependencies>
 

diff --git a/tooling/conga-aem-maven-plugin/src/it/wcmio-archetype-aem65/parent/pom.xml b/tooling/conga-aem-maven-plugin/src/it/wcmio-archetype-aem65/parent/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.wcm.maven</groupId>
     <artifactId>io.wcm.maven.aem-global-parent</artifactId>
-    <version>2.1.12</version>
+    <version>2.1.15-SNAPSHOT</version>
     <relativePath/>
   </parent>
 

diff --git a/tooling/conga-aem-maven-plugin/src/it/wcmio-archetype-cloud/parent/pom.xml b/tooling/conga-aem-maven-plugin/src/it/wcmio-archetype-cloud/parent/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.wcm.maven</groupId>
     <artifactId>io.wcm.maven.aem-global-parent</artifactId>
-    <version>2.1.12</version>
+    <version>2.1.15-SNAPSHOT</version>
     <relativePath/>
   </parent>