From deb131c05f8965be62455f84dce6101526131120 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 17 Jan 2024 12:33:55 +0100
Subject: [PATCH] jakarta faces to quarkus rules (#1056) (#1057)

Co-authored-by: Phil Cattanach <31246010+PhilipCattanach@users.noreply.github.com>
(cherry picked from commit e24bef0a6977e4efd6aeb689f12cae502a822c43)

Co-authored-by: Mark Brophy <36955467+m-brophy@users.noreply.github.com>
---
 .../jakarta-faces-to-quarkus.windup.xml       | 96 +++++++++++++++++++
 .../data/application-jakarta-api/pom.xml      | 12 +++
 .../jakarta-faces-to-quarkus.windup.test.xml  | 36 +++++++
 3 files changed, 144 insertions(+)
 create mode 100644 rules/rules-reviewed/quarkus/java-ee/jakarta-faces-to-quarkus.windup.xml
 create mode 100644 rules/rules-reviewed/quarkus/java-ee/tests/jakarta-faces-to-quarkus.windup.test.xml

diff --git a/rules/rules-reviewed/quarkus/java-ee/jakarta-faces-to-quarkus.windup.xml b/rules/rules-reviewed/quarkus/java-ee/jakarta-faces-to-quarkus.windup.xml
new file mode 100644
index 000000000..c2e8c4dc0
--- /dev/null
+++ b/rules/rules-reviewed/quarkus/java-ee/jakarta-faces-to-quarkus.windup.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0"?>
+<!DOCTYPE ruleset [
+    <!ENTITY build-tool-maven-link-title "Quarkus - Guide">
+    <!ENTITY build-tool-maven-link-href "https://quarkus.io/guides/maven-tooling#build-tool-maven">
+]>
+<ruleset xmlns="http://windup.jboss.org/schema/jboss-ruleset" id="jakarta-faces-to-quarkus"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
+    <metadata>
+        <description>
+            This ruleset gives hints to migrate JAX-RS applications to Quarkus extension
+        </description>
+        <dependencies>
+            <addon id="org.jboss.windup.rules,windup-rules-javaee,3.0.0.Final" />
+            <addon id="org.jboss.windup.rules,windup-rules-java,3.0.0.Final" />
+            <addon id="org.jboss.windup.rules,windup-rules-xml,3.0.0.Final" />
+        </dependencies>
+        <sourceTechnology id="java-ee" />
+        <targetTechnology id="quarkus" />
+    </metadata>
+    <rules>
+        <rule id="jakarta-faces-to-quarkus-00000">
+            <when>
+                <xmlfile in="pom.xml" matches="/m:project/m:dependencies/m:dependency[m:groupId/text() = 'jakarta.faces']">
+                    <namespace prefix="m" uri="http://maven.apache.org/POM/4.0.0" />
+                </xmlfile>
+            </when>
+            <perform>
+                <hint title="Replace Jakarta Faces Dependency with MyFaces" effort="1" category-id="mandatory">
+                    <message>
+                        <![CDATA[
+                        Faces Dependencies with groupId `jakarta.faces` should be replaced with 
+                        
+                        ```
+                        <!-- Quarkus MyFaces dependencies -->                      
+                        <dependency>
+                          <groupId>org.apache.myfaces.core.extensions.quarkus</groupId>
+                          <artifactId>myfaces-quarkus</artifactId>
+                          <version>4.0.1</version>
+                        </dependency>
+                        
+                        <!-- Quarkus Faces utilities and components extensions -->
+                        <dependency>
+                          <groupId>io.quarkiverse.primefaces</groupId>
+                          <artifactId>quarkus-primefaces</artifactId>
+                          <version>3.13.1</version>
+                        </dependency>
+                        <dependency>
+                          <groupId>io.quarkiverse.omnifaces</groupId>
+                          <artifactId>quarkus-omnifaces</artifactId>
+                          <version>4.2.0</version>
+                        </dependency>
+                        ```
+                        ]]>
+                    </message>
+                    <link title="Apache MyFaces: Getting Started on Quarkus" href="https://myfaces.apache.org/#/coregettingstarted?id=quarkus" />
+                </hint>
+            </perform>
+        </rule>
+        <rule id="jakarta-faces-to-quarkus-00010">
+            <when>
+                <filecontent filename="pom.xml" pattern="artifactId&gt;jakarta.faces&lt;" />
+            </when>
+            <perform>
+                <hint title="Replace Jakarta Faces Dependency with MyFaces" effort="1" category-id="mandatory">
+                    <message>
+                        <![CDATA[
+                        Faces Dependencies with artifactId `jakarta.faces` should be replaced with 
+                        
+                        ```
+                        <!-- Quarkus MyFaces dependencies -->                      
+                        <dependency>
+                          <groupId>org.apache.myfaces.core.extensions.quarkus</groupId>
+                          <artifactId>myfaces-quarkus</artifactId>
+                          <version>4.0.1</version>
+                        </dependency>
+                        
+                        <!-- Quarkus Faces utilities and components extensions -->
+                        <dependency>
+                          <groupId>io.quarkiverse.primefaces</groupId>
+                          <artifactId>quarkus-primefaces</artifactId>
+                          <version>3.13.1</version>
+                        </dependency>
+                        <dependency>
+                          <groupId>io.quarkiverse.omnifaces</groupId>
+                          <artifactId>quarkus-omnifaces</artifactId>
+                          <version>4.2.0</version>
+                        </dependency>
+                        ```
+                        ]]>
+                    </message>
+                    <link title="Apache MyFaces: Getting Started on Quarkus" href="https://myfaces.apache.org/#/coregettingstarted?id=quarkus" />
+                </hint>
+            </perform>
+        </rule>
+    </rules>
+</ruleset>
diff --git a/rules/rules-reviewed/quarkus/java-ee/tests/data/application-jakarta-api/pom.xml b/rules/rules-reviewed/quarkus/java-ee/tests/data/application-jakarta-api/pom.xml
index e5f3c1b74..91e1d91aa 100644
--- a/rules/rules-reviewed/quarkus/java-ee/tests/data/application-jakarta-api/pom.xml
+++ b/rules/rules-reviewed/quarkus/java-ee/tests/data/application-jakarta-api/pom.xml
@@ -49,5 +49,17 @@
             <version>9.0.0</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>jakarta.faces</groupId>
+            <artifactId>jakarta.faces-api</artifactId>
+            <version>4.0.1</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.glassfish</groupId>
+            <artifactId>jakarta.faces</artifactId>
+            <version>4.0.1</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 </project>
diff --git a/rules/rules-reviewed/quarkus/java-ee/tests/jakarta-faces-to-quarkus.windup.test.xml b/rules/rules-reviewed/quarkus/java-ee/tests/jakarta-faces-to-quarkus.windup.test.xml
new file mode 100644
index 000000000..bd5a16b36
--- /dev/null
+++ b/rules/rules-reviewed/quarkus/java-ee/tests/jakarta-faces-to-quarkus.windup.test.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<ruletest id="jakarta-faces-to-quarkus-tests"
+          xmlns="http://windup.jboss.org/schema/jboss-ruleset"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
+    <testDataPath>data/application-jakarta-api</testDataPath>
+    <rulePath>../jakarta-faces-to-quarkus.windup.xml</rulePath>
+    <ruleset>
+        <rules>
+            <rule id="jakarta-faces-to-quarkus-00000-test">
+                <when>
+                    <not>
+                        <iterable-filter size="1">
+                            <hint-exists message="Faces Dependencies with groupId `jakarta.faces` should be replaced with"/>
+                        </iterable-filter>
+                    </not>
+                </when>
+                <perform>
+                    <fail message="[jakarta-faces-to-quarkus-00000] MyFaces hint was not found!" />
+                </perform>
+            </rule>
+            <rule id="jakarta-faces-to-quarkus-00010-test">
+                <when>
+                    <not>
+                        <iterable-filter size="1">
+                            <hint-exists message="Faces Dependencies with artifactId `jakarta.faces` should be replaced with"/>
+                        </iterable-filter>
+                    </not>
+                </when>
+                <perform>
+                    <fail message="[jakarta-faces-to-quarkus-00010] MyFaces hint was not found!" />
+                </perform>
+            </rule>
+        </rules>
+    </ruleset>
+</ruletest>
\ No newline at end of file