Chapter 7. Creating custom rules

Procedure

1. Create a file containing the basic syntax for YAML rules as follows:

   - category: mandatory
     description:
      <DESCRIPTION TITLE>
      <DESCRIPTION TEXT>
     effort: <EFFORT>
     labels:
     - konveyor.io/source=<SOURCE_TECH>
     - konveyor.io/target=<TARGET_TECH>
     links:
    - url: <HYPERLINK>
      title: <HYPERLINK_TITLE>
     message: <MESSAGE>
     tag:
     - <TAG1>
     - <TAG2>
     ruleID: <RULE_ID>
     when:
      <CONDITIONS>

   Copy to Clipboard Toggle word wrap

1. Create a YAML file for the rule. In the following example, the rule is created in your $HOME directory.

1. Create jboss-web.xml and pom.xml files in a directory:

   mkdir /home/<USER>/data/
   touch /home/<USER>/data/jboss-web.xml
   touch /home/<USER>/data/pom.xml

   Copy to Clipboard Toggle word wrap

2. In the jboss-web.xml file you created, paste the following content:

   <!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 4.2//EN" "http://www.jboss.org/j2ee/dtd/jboss-web_4_2.dtd">
   <jboss-web>
       <class-loading java2ClassLoadingCompliance="false">
           <loader-repository>
               seam.jboss.org:loader=@projectName@
               <loader-repository-config>java2ParentDelegation=false</loader-repository-config>
           </loader-repository>
       </class-loading>
   </jboss-web>

   Copy to Clipboard Toggle word wrap

3. In the pom.xml file you created, paste the following content:

   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   
     <groupId>test</groupId>
     <artifactId>test</artifactId>
     <version>1.1.0-SNAPSHOT</version>
   
     <properties>
   	<maven.compiler.source>1.7</maven.compiler.source>
   	<maven.compiler.target>1.7</maven.compiler.target>
     </properties>
   
     <dependencies>
     </dependencies>
   </project>

   Copy to Clipboard Toggle word wrap

4. In the rule.yaml file you created, paste the following contents:

   - ruleID: <UNIQUE_RULE_ID>
     description: <DESCRIPTION>
     when:
       <CONDITION(S)>
     message: <MESSAGE>
     labels: <LABELS>
     effort: <EFFORT>
     links:
     - <LINKS>

   Copy to Clipboard Toggle word wrap

   where:

   ruleID

   Unique ID for your rule. For example, jboss5-web-class-loading.

   description

   Text description of the rule.

   when

   Complete the when block specifying one or more conditions:

   1. Use the builtin provider’s XML capability because this rule checks for a match in an XML file.

      when:
        builtin.xml:
          xpath: /jboss-web/class-loading

      Copy to Clipboard Toggle word wrap

   message

   Helpful message explaining the migration issue. The message is generated in the report when the rule matches. For example:

1. Point the CLI to the rule file you created :

   –rules /home/<USER>/rules.yaml

   Copy to Clipboard Toggle word wrap

2. To test the rule, point the input to the test data you created and pass the rule using the rules option in MTA CLI:

   mta-cli analyze --input /home/<USER>/data/ --output /home/<USER>/output/ --rules /home/<USER>/rules.yaml

   Copy to Clipboard Toggle word wrap

3. Review the report to be sure that it provides the expected results.

   Once the analysis is complete, the command outputs the path to the HTML report:

   INFO[0066] Static report created. Access it at this URL:  URL="file:/home/<USER>/output/static-report/index.html"

   Copy to Clipboard Toggle word wrap

   Open /home/<USER_NAME>/output/static-report/index.html in a web browser.

4. Navigate to the Issues tab in the left menu.

5. Verify that the rule is executed:

   1. In the Issues table, type JBoss XML in the search bar.
   2. Verify that the issue with the title Find class loading element in JBoss XML file is present in the table.
6. Click the jboss-web.xml link to open the affected file.

Procedure

1. Create a go-rule-001.yml file in a directory.

2. Copy the following rule in the yaml file:

   - message: golang apiextensions/v1/customresourcedefinitions found
     description: "golang apiextensions/v1/customresourcedefinitions found"
     ruleID: go-lang-ref-001
     effort: 1
     when:
       go.referenced:
         pattern: "v1beta1.CustomResourceDefinition"

   Copy to Clipboard Toggle word wrap
3. Create a test go file named example.go in your Home directory.

4. Paste the following code in the example.go file:

   package main
   
   import (
   	"fmt"
   
   	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
   )
   
   func main() {
   	fmt.Println(v1beta1.CustomResourceDefinition{})
   
   }

   Copy to Clipboard Toggle word wrap

5. Run the following command in the MTA CLI:

   $ ./mta-cli analyze -i _<path-to-Go-project>_ \
   -o _<path-to-report-directory>_ --run-local=false --rules \
   _<path-to-go-rule-001.yml>_

   Copy to Clipboard Toggle word wrap
   Note

   Add the --overwrite option if you want to use the same directory for the report when you run subsequent tests. MTA overwrites the current report with the result of the latest analysis that you run.

6. Open the static report at /home/<USER>/output/static-report/ in your browser.
7. Navigate to the issues to verify the golang apiextensions/v1/customresourcedefinitions found issue.

Procedure

1. Create the test-nodejs directory.

   $ mkdir -p ~/test-nodejs

   Copy to Clipboard Toggle word wrap

2. Save the following rule as nodejs-rule-001.yml in the test-nodejs directory:

   - ruleID: test-tsx-support-00000
     description: Found React import in .tsx file
     message: Found React import in .tsx file
     effort: 1
     when:
       nodejs.referenced:
        pattern: "React"

   Copy to Clipboard Toggle word wrap

3. Create the following test application in the Component.tsx file:

   import React from 'react';
    export const MyComponent: React.FC = () => <div>Hello</div>;

   Copy to Clipboard Toggle word wrap

4. Run the following command in the MTA CLI:

   $ ./mta-cli analyze -i ~/test-nodejs/ -o \
   ~/test-nodejs/report --run-local=false \
   --rules ~/test-nodejs/nodejs-rule-001.yml

   Copy to Clipboard Toggle word wrap
   Note

   Add the --overwrite option if you want to use the same directory for the report when you run subsequent tests. MTA overwrites the current report with the result of the latest analysis that you run.

5. Open the static report at ~/test-nodejs/report/static-report/index.html in your browser.
6. Click the <application_name> to open the Dashboard.
7. Review the incidents in the Issues tab.

Procedure

1. Create the directory test-python.

   $ mkdir -p ~/test-python

   Copy to Clipboard Toggle word wrap

2. Create a python-rule-001.yml file in the directory and add the following rule:

   - category: mandatory
     ruleID: python-rule-001
     effort: 1
     description: "Bad method"
     when:
       python.referenced:
         pattern: "bad_method"

   Copy to Clipboard Toggle word wrap

3. Create a python-rule-002.yml file in the directory and add the following rule:

     - category: mandatory
       ruleID: python-rule-002
       effort: 1
       message: "Found a python"
       when:
         python.referenced:
           pattern: "hello_world"

   Copy to Clipboard Toggle word wrap

4. Save the following Python code as file_b.py.

   import deprecated
   def hello_world():
             return "Hello, world!"
   @deprecated.deprecated("This method is bad!")
   def bad_method():
            return "I'm a bad method!"

   Copy to Clipboard Toggle word wrap

5. Save the following code as a second file, file_a.py.

   import file_b
   print(file_b.hello_world())
   print(file_b.bad_method())

   Copy to Clipboard Toggle word wrap

6. Run the following command in the MTA CLI:

   $ ./mta-cli analyze -i ~/test-python/ -o \
   ~/test-python/report --run-local=false \
   --rules ~/test-python/python-rule-001. \
   --rules ~/test-python/python-rule-002.yml

   Copy to Clipboard Toggle word wrap
   Note

   Add the --overwrite option if you want to use the same directory for the report when you run subsequent tests. MTA overwrites the current report with the result of the latest analysis that you run.

7. Open the static report at ~/test-python/report/static-report/index.html in your browser.
8. Click the <application_name> to open the Dashboard.
9. Review the incidents in the Issues tab.