EAP to Azure AppService - Look for datasource drivers in config files

rules-reviewed/azure/eap/eap-to-azure-appservice-datasource-driver.windup.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<ruleset id="eap-to-azure-appservice-datasource-driver"
+         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">
+    <metadata>
+        <description>
+            External resources such as data sources are injected via Java Naming and Directory Interface (JNDI). Some such resources may require migration or reconfiguration.
+        </description>
+        <dependencies>
+            <addon id="org.jboss.windup.rules,windup-rules-xml,3.0.0.Final" />
+        </dependencies>
+        <sourceTechnology id="eap" versionRange="[7,8)" />
+        <targetTechnology id="azure-appservice"/>
+        <targetTechnology id="azure-aks"/>
+        <tag>password</tag>
+        <tag>security</tag>
+    </metadata>
+    <rules>
+        <rule id="eap-to-azure-appservice-datasource-driver-01000">
+            <when>
+                <or>
+                    <xmlfile matches="/datasources/datasource/connection-url[contains(text(),'jdbc:db2')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/drivers/driver/xa-datasource-class[contains(text(),'db2')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/datasource/connection-url[contains(text(),'jdbc:mysql')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/drivers/driver/xa-datasource-class[contains(text(),'mysql')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/datasource/connection-url[contains(text(),'jdbc:oracle')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/drivers/driver/xa-datasource-class[contains(text(),'oracle')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/datasource/connection-url[contains(text(),'jdbc:postgres')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/drivers/driver/xa-datasource-class[contains(text(),'postgres')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/datasource/connection-url[contains(text(),'jdbc:microsoft:sqlserver')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/drivers/driver/xa-datasource-class[contains(text(),'sqlserver')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/datasource/connection-url[contains(text(),'jdbc:sybase')]" in="{*}-ds.xml"/>
+                    <xmlfile matches="/datasources/drivers/driver/xa-datasource-class[contains(text(),'sybase')]" in="{*}-ds.xml"/>
+                </or>
+            </when>
+            <perform>
+                <hint title="Datasource driver found in configuration file" category-id="potential" effort="3">
+                    <message>
+                        <![CDATA[
+                        A datasource driver was found in a configuration file.
+
+                        There are three core steps when registering a data source with JBoss EAP in Azure App Service: uploading the JDBC driver, adding the JDBC driver as a module, and registering the module.
+
+                        App Service is a stateless hosting service, so the configuration commands for adding and registering the data source module must be scripted and applied as the container starts.
+
+                        For more information, see Datasource Management in the JBoss EAP documentation.                        
+                        ]]>
+                    </message>
+                    <link title="Migrate JBoss EAP applications to JBoss EAP on Azure App Service - Datasources" href="https://docs.microsoft.com/en-us/azure/developer/java/migration/migrate-jboss-eap-to-jboss-eap-on-azure-app-service#datasources"/>
+                    <link title="Migrate JBoss EAP applications to JBoss EAP on Azure App Service - Set up data sources" href="https://docs.microsoft.com/en-us/azure/developer/java/migration/migrate-jboss-eap-to-jboss-eap-on-azure-app-service#set-up-data-sources"/>
+                    <link title="Datasource Management" href="https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.4/html/configuration_guide/datasource_management" />
+                </hint>
+            </perform>
+        </rule>
+    </rules>
+</ruleset>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/db2-ds.xml

@@ -0,0 +1,24 @@
+<datasources>
+    <datasource jndi-name="java:/DB2DS" pool-name="DB2DS">
+      <connection-url>jdbc:db2:ibmdb2db</connection-url>
+      <driver>ibmdb2</driver>
+      <pool>
+        <min-pool-size>0</min-pool-size>
+        <max-pool-size>50</max-pool-size>
+      </pool>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security> 
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker"></valid-connection-checker>
+        <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker"></stale-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter"></exception-sorter>
+      </validation>
+    </datasource>
+    <drivers>
+      <driver name="ibmdb2" module="com.ibm">
+        <xa-datasource-class>com.ibm.db2.jdbc.DB2XADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/db2-xa-ds.xml

@@ -0,0 +1,30 @@
+<datasources>
+    <xa-datasource jndi-name="java:/DB2XADS" pool-name="DB2XADS">
+      <driver>ibmdb2</driver>
+      <xa-datasource-property name="DatabaseName">ibmdb2db</xa-datasource-property>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <xa-pool>
+        <is-same-rm-override>false</is-same-rm-override>
+      </xa-pool>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker"></valid-connection-checker>
+        <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker"></stale-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter"></exception-sorter>
+      </validation>
+      <recovery>
+        <recovery-plugin class-name="org.jboss.jca.core.recovery.ConfigurableRecoveryPlugin">
+          <config-property name="EnableIsValid">false</config-property>
+          <config-property name="IsValidOverride">false</config-property>
+          <config-property name="EnableClose">false</config-property>
+        </recovery-plugin>
+      </recovery>
+    </xa-datasource>
+    <drivers>
+      <driver name="ibmdb2" module="com.ibm">
+        <xa-datasource-class>com.ibm.db2.jcc.DB2XADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/mysql-ds.xml

@@ -0,0 +1,19 @@
+<datasources>
+  <datasource jndi-name="java:jboss/MySqlDS" pool-name="MySqlDS">
+    <connection-url>jdbc:mysql://mysql-localhost:3306/jbossdb</connection-url>
+    <driver>mysql</driver>
+    <security>
+      <user-name>admin</user-name>
+      <password>admin</password>
+    </security> 
+    <validation>
+      <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker"></valid-connection-checker>
+      <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter"></exception-sorter>
+    </validation>
+  </datasource>
+  <drivers>
+    <driver name="mysql" module="com.mysql">
+      <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class>
+    </driver>
+  </drivers>
+</datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/mysql-xa-ds.xml

@@ -0,0 +1,20 @@
+<datasources>
+    <xa-datasource jndi-name="java:jboss/MysqlXADS" pool-name="MysqlXADS">
+    <driver>mysql</driver>
+      <xa-datasource-property name="ServerName">localhost</xa-datasource-property>
+      <xa-datasource-property name="DatabaseName">mysqldb</xa-datasource-property>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker"></valid-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter"></exception-sorter>
+      </validation>
+    </xa-datasource>
+    <drivers>
+      <driver name="mysql" module="com.mysql">
+        <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/oracle-ds.xml

@@ -0,0 +1,20 @@
+<datasources>
+    <datasource jndi-name="java:/OracleDS" pool-name="OracleDS">
+      <connection-url>jdbc:oracle:thin:@localhost:1521:XE</connection-url>
+      <driver>oracle</driver>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security> 
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker"></valid-connection-checker>
+        <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker"></stale-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter"></exception-sorter>
+      </validation>
+    </datasource>
+    <drivers>
+      <driver name="oracle" module="com.oracle">
+        <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/oracle-xa-ds.xml

@@ -0,0 +1,24 @@
+<datasources>
+    <xa-datasource jndi-name="java:/XAOracleDS" pool-name="XAOracleDS">
+      <driver>oracle</driver>
+      <xa-datasource-property name="URL">jdbc:oracle:oci8:@tc</xa-datasource-property>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <xa-pool>
+        <is-same-rm-override>false</is-same-rm-override>
+        <no-tx-separate-pools />
+      </xa-pool>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker"></valid-connection-checker>
+        <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker"></stale-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter"></exception-sorter>
+      </validation>
+    </xa-datasource>
+    <drivers>
+      <driver name="oracle" module="com.oracle">
+        <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/postgresql-ds.xml

@@ -0,0 +1,11 @@
+<datasources>
+    <datasource jndi-name="java:jboss/datasources/postgresDS" pool-name="postgres-pool"
+        enabled="true" use-java-context="true">
+        <connection-url>jdbc:postgresql://db:5432/postgres</connection-url>
+        <driver>postgres</driver>
+        <security>
+            <user-name>application</user-name>
+            <password>s3cr3t</password>
+        </security>
+    </datasource>
+</datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/postgresql-xa-ds.xml

@@ -0,0 +1,23 @@
+<datasources>
+    <xa-datasource jndi-name="java:jboss/PostgresXADS" pool-name="PostgresXADS">
+      <driver>postgresql</driver>
+      <xa-datasource-property name="ServerName">localhost</xa-datasource-property>
+      <xa-datasource-property name="PortNumber">5432</xa-datasource-property>
+      <xa-datasource-property name="DatabaseName">postgresdb</xa-datasource-property>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker">
+        </valid-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter">
+        </exception-sorter>
+      </validation>
+    </xa-datasource>
+    <drivers>
+      <driver name="postgresql" module="org.postgresql">
+        <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/sqlserver-ds.xml

@@ -0,0 +1,18 @@
+<datasources>
+    <datasource jndi-name="java:/MSSQLDS" pool-name="MSSQLDS">
+      <connection-url>jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=MyDatabase</connection-url>
+      <driver>sqlserver</driver>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker"></valid-connection-checker>
+      </validation>
+    </datasource>
+    <drivers>
+      <driver name="sqlserver" module="com.microsoft">
+        <xa-datasource-class>com.microsoft.sqlserver.jdbc.SQLServerXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+</datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/sqlserver-xa-ds.xml

@@ -0,0 +1,23 @@
+<datasources>
+    <xa-datasource jndi-name="java:/MSSQLXADS" pool-name="MSSQLXADS">
+      <driver>sqlserver</driver>
+      <xa-datasource-property name="ServerName">localhost</xa-datasource-property>
+      <xa-datasource-property name="DatabaseName">mssqldb</xa-datasource-property>
+      <xa-datasource-property name="SelectMethod">cursor</xa-datasource-property>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <xa-pool>
+        <is-same-rm-override>false</is-same-rm-override>
+      </xa-pool>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker"></valid-connection-checker>
+      </validation>
+    </xa-datasource>
+    <drivers>
+      <driver name="sqlserver" module="com.microsoft">
+        <xa-datasource-class>com.microsoft.sqlserver.jdbc.SQLServerXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/sybase-ds.xml

@@ -0,0 +1,19 @@
+<datasources>
+    <datasource jndi-name="java:jboss/SybaseDB" pool-name="SybaseDB" enabled="true">
+      <connection-url>jdbc:sybase:Tds:localhost:5000/DATABASE?JCONNECT_VERSION=6</connection-url>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker"></valid-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter"></exception-sorter>
+      </validation>
+    </datasource>
+    <drivers>
+      <driver name="sybase" module="com.sybase">
+        <datasource-class>com.sybase.jdbc2.jdbc.SybDataSource</datasource-class>
+        <xa-datasource-class>com.sybase.jdbc3.jdbc.SybXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/data/eap-to-azure-appservice-datasource-driver/sybase-xa-ds.xml

@@ -0,0 +1,22 @@
+<datasources>
+    <xa-datasource jndi-name="java:jboss/SybaseXADS" pool-name="SybaseXADS" enabled="true">
+      <xa-datasource-property name="NetworkProtocol">Tds</xa-datasource-property>
+      <xa-datasource-property name="ServerName">myserver</xa-datasource-property>
+      <xa-datasource-property name="PortNumber">4100</xa-datasource-property>
+      <xa-datasource-property name="DatabaseName">mydatabase</xa-datasource-property>
+      <security>
+        <user-name>admin</user-name>
+        <password>admin</password>
+      </security>
+      <validation>
+        <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker"></valid-connection-checker>
+        <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter"></exception-sorter>
+      </validation>
+    </xa-datasource>
+    <drivers>
+      <driver name="sybase" module="com.sybase">
+        <datasource-class>com.sybase.jdbc2.jdbc.SybDataSource</datasource-class>
+        <xa-datasource-class>com.sybase.jdbc3.jdbc.SybXADataSource</xa-datasource-class>
+      </driver>
+    </drivers>
+  </datasources>

rules-reviewed/azure/eap/test/eap-to-azure-appservice-datasource-driver.windup.test.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<ruletest xmlns="http://windup.jboss.org/schema/jboss-ruleset"
+          id="eap-to-azure-appservice-datasource-driver-test" 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/eap-to-azure-appservice-datasource-driver</testDataPath>
+    <!-- By default sourceMode is True, so it will only consider .java files, not .jar binaries -->
+    <sourceMode>true</sourceMode>
+    <rulePath>../eap-to-azure-appservice-datasource-driver.windup.xml</rulePath>
+    <ruleset>
+        <rules>
+            <rule id="eap-to-azure-appservice-datasource-driver-001-test">
+                <when>
+                    <not>
+                        <iterable-filter size="17"> 
+                            <hint-exists message="A datasource driver was found in a configuration file*"/>
+                        </iterable-filter>
+                    </not>
+                </when>
+                <perform>
+                        <fail message="[eap-to-azure-appservice-datasource-driver-001-test] The assertion for the rule &quot;Datasource driver found in configuration file&quot; failed!" />
+                </perform>
+            </rule>
+        </rules>
+    </ruleset>
+</ruletest>