OOTB Service-Based rewrite rules should be exported (#86)

* Allow for extending OOTB Service-based Rules * Need to downgrade invoker plugin due to incompatibility issues. * Make rules available in OSGi manifest
adobe · Nov 23, 2021 · 27b352b · 27b352b
1 parent 0f7785a
commit 27b352b
Show file tree

Hide file tree

Showing 18 changed files with 95 additions and 23 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -11,6 +11,8 @@ updates:
         versions: ["1.x"]
       - dependency-name: "org.osgi.service.log"
         versions: ["1.x"]
+      - dependency-name: "maven-invoker"
+        versions: ["2.x"]
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

diff --git a/.github/workflows/javadocs.yaml b/.github/workflows/javadocs.yaml
@@ -27,7 +27,7 @@ jobs:
           cache: maven
 
       - name: Build JavaDocs
-        run: mvn -U clean install -Pgenerate-site-javadoc
+        run: mvn -U clean verify -Pgenerate-site-javadoc,aemCloudService
 
       - name: Commit JavaDocs
         run: |

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -57,7 +57,7 @@ jobs:
           cache: maven
 
       - name: Maven Verify
-        run: mvn -U clean install
+        run: mvn -U clean verify
 
       - name: Generate Release Changelog
         id: generate-release-changelog
@@ -123,7 +123,7 @@ jobs:
           cache: maven
 
       - name: Maven Verify
-        run: mvn clean install -P${{ matrix.profile }}
+        run: mvn clean verify -P${{ matrix.profile }}
 
       - name: Upload Release Artifacts
         id: upload-release-artifacts

diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -25,7 +25,7 @@ jobs:
           cache: maven
 
       - name: Build & Test with Maven
-        run: mvn -U clean install -P${{ matrix.profile }}
+        run: mvn -U clean verify -P${{ matrix.profile }}
 
       - name: Upload CodeCov
         uses: codecov/codecov-action@v2.1.0

diff --git a/all/pom.xml b/all/pom.xml
@@ -65,6 +65,10 @@
             </plugin>
         </plugins>
     </build>
+<!--expose rule for extension-->
+<!--release-->
+<!--video-->
+<!--documentation links and release-->
 
     <!-- ====================================================================== -->
     <!-- P R O F I L E S                                                        -->
@@ -107,6 +111,20 @@
                             </embeddeds>
                         </configuration>
                     </plugin>
+                    <plugin>
+                        <groupId>com.adobe.aem</groupId>
+                        <artifactId>aemanalyser-maven-plugin</artifactId>
+                        <extensions>true</extensions>
+                        <executions>
+                            <execution>
+                                <id>analyse-project</id>
+                                <phase>verify</phase>
+                                <goals>
+                                    <goal>project-analyse</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
                 </plugins>
             </build>
             <dependencies>

diff --git a/...t/impl/rule/ColumnControlRewriteRule.java → ...ponent/rule/ColumnControlRewriteRule.java b/...t/impl/rule/ColumnControlRewriteRule.java → ...ponent/rule/ColumnControlRewriteRule.java
@@ -1,4 +1,4 @@
-package com.adobe.aem.modernize.component.impl.rule;
+package com.adobe.aem.modernize.component.rule;
 
 /*-
  * #%L
@@ -48,7 +48,6 @@
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ResourceResolverFactory;
-import org.apache.sling.commons.osgi.PropertiesUtil;
 
 import com.adobe.aem.modernize.RewriteException;
 import com.adobe.aem.modernize.component.ComponentRewriteRule;
@@ -65,7 +64,6 @@
 import org.osgi.service.metatype.annotations.AttributeDefinition;
 import org.osgi.service.metatype.annotations.Designate;
 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
-import org.osgi.service.metatype.annotations.Option;
 import org.osgi.util.converter.Converters;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

diff --git a/core/src/main/java/com/adobe/aem/modernize/component/rule/package-info.java b/core/src/main/java/com/adobe/aem/modernize/component/rule/package-info.java
@@ -0,0 +1,23 @@
+@org.osgi.annotation.versioning.Version("2.0.0")
+package com.adobe.aem.modernize.component.rule;
+
+/*-
+ * #%L
+ * AEM Modernize Tools - Core
+ * %%
+ * Copyright (C) 2019 - 2021 Adobe Inc.
+ * %%
+ * 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%
+ */
+
diff --git a/.../structure/impl/rule/PageRewriteRule.java → ...rnize/structure/rule/PageRewriteRule.java b/.../structure/impl/rule/PageRewriteRule.java → ...rnize/structure/rule/PageRewriteRule.java
@@ -1,4 +1,4 @@
-package com.adobe.aem.modernize.structure.impl.rule;
+package com.adobe.aem.modernize.structure.rule;
 
 /*-
  * #%L

diff --git a/core/src/main/java/com/adobe/aem/modernize/structure/rule/package-info.java b/core/src/main/java/com/adobe/aem/modernize/structure/rule/package-info.java
@@ -0,0 +1,23 @@
+@org.osgi.annotation.versioning.Version("2.0.0")
+package com.adobe.aem.modernize.structure.rule;
+
+/*-
+ * #%L
+ * AEM Modernize Tools - Core
+ * %%
+ * Copyright (C) 2019 - 2021 Adobe Inc.
+ * %%
+ * 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%
+ */
+
diff --git a/...pl/rule/ColumnControlRewriteRuleTest.java → ...nt/rule/ColumnControlRewriteRuleTest.java b/...pl/rule/ColumnControlRewriteRuleTest.java → ...nt/rule/ColumnControlRewriteRuleTest.java
@@ -1,4 +1,4 @@
-package com.adobe.aem.modernize.component.impl.rule;
+package com.adobe.aem.modernize.component.rule;
 
 /*-
  * #%L
@@ -44,7 +44,7 @@
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
-import static com.adobe.aem.modernize.component.impl.rule.ColumnControlRewriteRule.*;
+import static com.adobe.aem.modernize.component.rule.ColumnControlRewriteRule.*;
 import static org.junit.jupiter.api.Assertions.*;
 
 @ExtendWith(SlingContextExtension.class)

diff --git a/...pl/rule/ColumnControlTreeRewriteTest.java → ...nt/rule/ColumnControlTreeRewriteTest.java b/...pl/rule/ColumnControlTreeRewriteTest.java → ...nt/rule/ColumnControlTreeRewriteTest.java
@@ -1,4 +1,4 @@
-package com.adobe.aem.modernize.component.impl.rule;
+package com.adobe.aem.modernize.component.rule;
 
 /*-
  * #%L

diff --git a/...ule/ParsysComponentNodeBasedRuleTest.java → ...ule/ParsysComponentNodeBasedRuleTest.java b/...ule/ParsysComponentNodeBasedRuleTest.java → ...ule/ParsysComponentNodeBasedRuleTest.java
@@ -1,4 +1,4 @@
-package com.adobe.aem.modernize.component.impl.rule;
+package com.adobe.aem.modernize.component.rule;
 
 /*-
  * #%L

diff --git a/core/src/test/java/com/adobe/aem/modernize/job/FullConversionJobExecutorTest.java b/core/src/test/java/com/adobe/aem/modernize/job/FullConversionJobExecutorTest.java
@@ -47,7 +47,7 @@
 import com.adobe.aem.modernize.structure.StructureRewriteRule;
 import com.adobe.aem.modernize.structure.StructureRewriteRuleService;
 import com.adobe.aem.modernize.structure.impl.StructureRewriteRuleServiceImpl;
-import com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule;
+import com.adobe.aem.modernize.structure.rule.PageRewriteRule;
 import com.day.cq.wcm.api.NameConstants;
 import com.day.cq.wcm.api.Page;
 import com.day.cq.wcm.api.PageManager;

diff --git a/core/src/test/java/com/adobe/aem/modernize/servlet/rule/ListTemplateRulesServletTest.java b/core/src/test/java/com/adobe/aem/modernize/servlet/rule/ListTemplateRulesServletTest.java
@@ -36,7 +36,7 @@
 import com.adobe.aem.modernize.MockRule;
 import com.adobe.aem.modernize.rule.RewriteRule;
 import com.adobe.aem.modernize.structure.StructureRewriteRuleService;
-import com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule;
+import com.adobe.aem.modernize.structure.rule.PageRewriteRule;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.wcm.testing.mock.aem.junit5.AemContext;

diff --git a/...ucture/impl/rule/PageRewriteRuleTest.java → ...e/structure/rule/PageRewriteRuleTest.java b/...ucture/impl/rule/PageRewriteRuleTest.java → ...e/structure/rule/PageRewriteRuleTest.java
@@ -1,4 +1,4 @@
-package com.adobe.aem.modernize.structure.impl.rule;
+package com.adobe.aem.modernize.structure.rule;
 
 /*-
  * #%L
@@ -42,7 +42,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
-import static com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule.*;
+import static com.adobe.aem.modernize.structure.rule.PageRewriteRule.*;
 import static org.junit.jupiter.api.Assertions.*;
 
 @ExtendWith(AemContextExtension.class)

diff --git a/core/src/test/resources/job/full-job-data.json b/core/src/test/resources/job/full-job-data.json
@@ -15,7 +15,7 @@
       "/var/aem-modernize/rules/policy/extraLargeTitle"
     ],
     "templateRules": [
-      "com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule"
+      "com.adobe.aem.modernize.structure.rule.PageRewriteRule"
     ],
     "buckets": {
       "bucket0": {
@@ -42,7 +42,7 @@
       "/var/aem-modernize/rules/policy/extraLargeTitle"
     ],
     "templateRules": [
-      "com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule"
+      "com.adobe.aem.modernize.structure.rule.PageRewriteRule"
     ],
     "buckets": {
       "bucket0": {

diff --git a/core/src/test/resources/job/structure-job-data.json b/core/src/test/resources/job/structure-job-data.json
@@ -9,8 +9,8 @@
     "sourceRoot": "/content/test",
     "targetRoot": "/content/newpath/with/extra/tokens",
     "templateRules": [
-      "com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule.first-page",
-      "com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule.second-page"
+      "com.adobe.aem.modernize.structure.rule.PageRewriteRule.first-page",
+      "com.adobe.aem.modernize.structure.rule.PageRewriteRule.second-page"
     ],
     "buckets": {
       "bucket0": {
@@ -31,8 +31,8 @@
     "componentRules": [],
     "policyRules": [],
     "templateRules": [
-      "com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule.first-page",
-      "com.adobe.aem.modernize.structure.impl.rule.PageRewriteRule.second-page"
+      "com.adobe.aem.modernize.structure.rule.PageRewriteRule.first-page",
+      "com.adobe.aem.modernize.structure.rule.PageRewriteRule.second-page"
     ],
     "buckets": {
       "bucket0": {

diff --git a/pom.xml b/pom.xml
@@ -96,6 +96,7 @@
         <vault.user>admin</vault.user>
         <vault.password>admin</vault.password>
 
+        <aemanalyser.version>1.2.2</aemanalyser.version>
         <bnd.version>6.0.0</bnd.version>
         <slf4j.version>1.7.32</slf4j.version>
         <jmockit.version>1.49</jmockit.version>
@@ -210,7 +211,7 @@
                         <dependency>
                             <groupId>org.apache.maven.shared</groupId>
                             <artifactId>maven-invoker</artifactId>
-                            <version>3.1.0</version>
+                            <version>2.2</version> <!-- Freeze until 3.0.0 of Maven Release Plugin is GA -->
                         </dependency>
                         <dependency>
                             <groupId>org.apache.maven.release</groupId>
@@ -355,6 +356,13 @@ Bundle-DocURL:
                         </dependency>
                     </dependencies>
                 </plugin>
+                <!-- AEM Analyser Plugin -->
+                <plugin>
+                    <groupId>com.adobe.aem</groupId>
+                    <artifactId>aemanalyser-maven-plugin</artifactId>
+                    <version>${aemanalyser.version}</version>
+                    <extensions>true</extensions>
+                </plugin>
                 <!-- Content Package Plugin -->
                 <plugin>
                     <groupId>com.day.jcr.vault</groupId>