Override common rules to be more Azure specific

[agoncal]

There are some common rules that are worth using for our Azure targets:

• Migrating Windows specific code to Linux
• Containerize code

But we might want the messages displayed to the user to be more Azure specific. For example, the rule that check the Windows path vs Linux path:

<rule id="os-specific-00001">
    <perform>
        <hint title="Windows file system path" effort="1" category-id="mandatory">
            <message>This file system path is Microsoft Windows platform dependent. It needs to be replaced with a Linux-style path.</message>
        </hint>
    </perform>
</rule>

If we want to be more specific on our message, we can use the rule overriding mecanism in WindUp.

These overriding rules will not be contributed back to WindUp. For that, we should keep them separate. Maybe a new rules-override-azure directory that mimics the other common rules structure:

├── rules
│   ├── rules-archived
│   ├── rules-generated
│   ├── rules-reviewed
│   │   ├── azure
│   │   ├── camel3
│   │   ├── core.windup.categories.xml
│   │   ├── droolsjbpm
│   │   ├── eap6
│   │   ├── eap7
│   │   ├── eap8
│   │   ├── eapxp
│   │   ├── filemappings
│   │   └── ...
└───── rules-override-azure
        ├── azure
        ├── camel3
        ├── core.windup.categories.xml
        ├── droolsjbpm
        ├── eap6
        ├── eap7
        ├── eap8
        ├── eapxp
        ├── filemappings
        └── ...

Common Rules that could be Overridden:

• openjdk7/oraclejdk7/oracle2openjdk.rhamt.xml: Migration from OracleJDK to OpenJDK
• openjdk11/openjdk8/java-removals.windup.xml: API removals between OpenJDK 8 and 11
• openjdk11/openjdk8/removed-javaee-modules.windup.xml: Respect to modules removed between OpenJDK 8 and 11
• openjdk17/openjdk11/applet-api-deprecation.windup.xml: applet-api deprecation between OpenJDK 11 to 17
• openjdk17/openjdk11/lombok.windup.xml: Lombok incompatibility between OpenJDK 11 to 17
• openjdk17/openjdk11/removed-classes.windup.xml: After being deprecated in OpenJDK 11, the pack200, unpack200 and corresponding java.util.jar.Pack200* classes were removed in OpenJDK 14
• openjdk17/openjdk11/removed-packages.windup.xml: Packages removed between OpenJDK 11 to 17
• openjdk17/openjdk11/security-manager-deprecation.windup.xml: Security Manager classes and methods deprecated between OpenJDK 11 to 17
• cloud-readiness/embedded-cache-libraries.windup.xml: Detects embedded cache libraries, which may be problematic when migrating an application to a cloud environment
• cloud-readiness/java-rmi.windup.xml: detects the Java Remote Method Invocation (RMI), which may be problematic when migrating an application to a cloud environment
• cloud-readiness/java-rpc.windup.xml: detects the Java Remote Procedure Call (RPC), which is problematic when migrating an application to a cloud environment
• cloud-readiness/jca.windup.xml: detects the Java Connector Architecture (JCA), which may be problematic when migrating an application to a cloud environment
• cloud-readiness/jni-native-code.windup.xml: detects Java Native Interface (JNI) and Java Native Access (JNA) code, which may be problematic when migrating an application to a cloud environment
• cloud-readiness/local-storage.windup.xml: detects local storage usage, which is problematic when migrating an application to a cloud environment
• cloud-readiness/logging.windup.xml: detects logging configurations that may be problematic when migrating an application to a cloud environment
• cloud-readiness/mail.windup.xml: detects the Java Mail API, which may be problematic when migrating an application to a cloud environment
• cloud-readiness/session.windup.xml: detects data storage in HTTP session objects, which may be problematic when migrating an application to a cloud environment
• cloud-readiness/socket-communication.windup.xml: detects the use of socket communication by the client or server, which may be problematic when migrating an application to a cloud environment
• os/windows/os-specific.windup.xml: ruleset for Windows operating system specific rules while migrating to Linux operating system

In technology-usage there are many rulesets that could partially be overriden:

• 3rd-party.windup.xml: Tomcat
• clustering.windup.xml: detecting usage of clustering technologies
• configuration-management.windup.xml: configuration-management related technologies
• connect.windup.groovy: See https://github.com/Azure/windup-rulesets/issues/4
• database.windup.groovy: See https://github.com/Azure/windup-rulesets/issues/2
• ejb.windup.xml: provides analysis of EJB libraries
• embedded-framework.windup.xml: provides analysis of embedded frameworks
• integration.windup.xml: Istio
• javase.windup.xml: Threads
• logging-technology-usage.windup.xml: logging items that were found during the analysis
• markup-technology-usage.windup.xml: Markup (HTML, CSS, JS) items that were found during the analysis
• observability.windup.xml: observability related technologies
• security.windup.xml: Java security libraries
• web.windup.xml: JNLP

[agoncal]

Looks like we cannot override an issue with different target (see https://issues.redhat.com/browse/WINDUP-3814 that @KaiqianYang created)

[agoncal]

@mrizzi also mentioned "The condition for overriding is that both ruleset and rule IDs must match."

[agoncal]

Trying something different: https://github.com/Azure/windup-rulesets/pull/47

[agoncal]

This has been fixed with https://github.com/windup/windup-rulesets/pull/987

[brunoborges]

I am moving this to Post-MVP, so that we focus on the rules we still need to close down. If we are done, we can go back and start discussing these, as the list is not small. Might as well break down into separate issues later.