ルール開発ガイド

手順

1. 以下のように、/home/<USER>/ ディレクトリーに YAML ルールの基本構文を含むファイルを作成します。

   - 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>

手順

1. --rules オプションを使用してディレクトリー全体を渡す場合は、ruleset.yaml ファイルのテンプレートを作成します。

   name: <RULESET_NAME> 

   1

   
   description: <RULESET_DESCRIPTION>
   labels: 

   2

   
     - key=val

   1

   名前は、指定されたルールセット内で一意である必要があります。

   2

   ルールセットのラベルは、そのルールセットに属するすべてのルールに継承されます。

手順

1. when 条件を作成します。

   YAML ルールの when 条件には、provider、and、or を指定できます。

   1. provider 条件を作成する

      プロバイダー条件は、特定の言語プロバイダーの検索クエリーを定義し、プロバイダーの特定のケイパビリティーを呼び出すために使用されます。

      条件の一般的な形式は <provider_name>.<capability> です。条件には、検索の詳細を指定するための内部フィールドもあります。provider 条件とその内部フィールドを作成する方法は、使用するプロバイダーと呼び出すケイパビリティーによって異なります。

      以下の表は、利用可能なプロバイダーとそのケイパビリティーを示しています。作成するルールの目的に合ったプロバイダーとケイパビリティーを選択してください。条件のこの部分には、条件のフィールドはまだ含まれていません。

      Expand

      プロバイダー	機能	説明
      java	referenced	詳細な検索の場合は、オプションのコード位置を指定して、アノテーションを含むパターンの参照を検索します。
      	dependency	アプリケーションに指定された依存関係があるか確認します。
      builtin	xml	XPath クエリーを使用して XML ファイルを検索します。
      	json	JSONPath クエリーを使用して JSON ファイルを検索します。
      	filecontent	RegEx パターンを使用して、通常のファイル内のコンテンツを検索します。
      	file	指定されたパターンに一致する名前を持つファイルを検索します。
      	hasTags	タグ付けルールを通じてアプリケーション用にタグが作成されているか確認します。
      Go	referenced	パターンの参照を検索します。
      	dependency	アプリケーションに指定された依存関係があるか確認します。

      Show more

      以下の例は、referenced ケイパビリティーを使用する java プロバイダー条件を示しています。

      例:

      when:
        java.referenced:

2. 適切なフィールドを provider 条件に追加します。

   以下の表は、利用可能なプロバイダー、そのケイパビリティー、フィールドをすべて示しています。選択したプロバイダーとケイパビリティーに属するフィールドを選択してください。一部のフィールドは必須であることに注意してください。

   Expand

   プロバイダー	機能	フィールド	必須 ?	説明
   java	referenced	pattern	はい	RegEx パターン
   		location	いいえ	ソースコードの場所。サポートされているすべての検索場所のリストは、以下を参照してください。
   		annotated	いいえ	アノテーションとその要素 (名前と値)
   	dependency	name	はい	依存関係の名前
   		nameregex	いいえ	名前と一致する RegEx
   		upperbound	いいえ	一致するバージョン番号の下限
   		lowerbound	いいえ	一致するバージョン番号の上限
   builtin	xml	xpath	はい	XPath クエリー
   		namespace	いいえ	クエリーの範囲を名前空間に絞るためのマップ
   		filepaths	いいえ	検索範囲を絞るためのオプションのファイルリスト
   	json	xpath	はい	XPath クエリー
   		filepaths	いいえ	検索範囲を絞るためのオプションのファイルリスト
   	filecontent	pattern	はい	コンテンツ内で一致する RegEx パターン
   		filePattern	いいえ	このパターンに一致する名前を持つファイル内のみを検索します。
   	file	pattern	はい	このパターンに一致する名前を持つファイルを検索します。
   	hasTags	文字列タグのインラインリストです。タグ形式の詳細は、ルールアクション の タグアクション を参照してください。
   Go	referenced	pattern	はい	RegEx パターン
   	dependency	name	はい	依存関係の名前
   		nameregex	いいえ	名前と一致する RegEx
   		upperbound	いいえ	一致するバージョン番号の下限
   		lowerbound	いいえ	一致するバージョン番号の上限

   Show more

   次の検索場所を使用して、java 検索の範囲を絞ることができます。

   • CONSTRUCTOR_CALL
   • TYPE
   • INHERITANCE
   • METHOD_CALL
   • ANNOTATION
   • IMPLEMENTS_TYPE
   • ENUM_CONSTANT
   • RETURN_TYPE
   • IMPORT

   • VARIABLE_DECLARATION

     以下の例は、パッケージの参照を検索するルールの when 条件を示しています。

     例:

     when:
       java.referenced:
         location: PACKAGE
         pattern: org.jboss*

3. AND または OR 条件を作成します。

   • and 条件は、その子条件が すべて 一致する場合に一致します。次のように、and 条件を作成します。

     when:
       and:
       - java.dependency:
           name: junit.junit
           upperbound: 4.12.2
           lowerbound: 4.4.0
       - java.referenced:
           location: IMPORT
           pattern: junit.junit

   • or 条件は、その子条件の いずれか が一致する場合に一致します。次のように、or 条件を作成します。

     when:
       or:
       - java.dependency:
           name: junit.junit
           upperbound: 4.12.2
           lowerbound: 4.4.0
       - java.referenced:
           location: IMPORT
           pattern: junit.junit

1. ディレクトリーに、jboss-web.xml および pom.xml ファイルを作成します。

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

2. 作成した jboss-web.xml ファイルに、次の内容を貼り付けます。

   <!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>

3. 作成した pom.xml ファイルに、次の内容を貼り付けます。

   <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>

手順

1. 分析が完了すると、コマンドは HTML レポートへのパスを出力します。

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

   Web ブラウザーで、/home/<USER_NAME>/output/static-report/index.html を開きます。

2. 左側のメニューの Issues タブに移動します。

3. ルールが実行されていることを確認します。

   1. Issues テーブルの検索バーに JBoss XML と入力します。
   2. テーブルに、タイトルが Find class loading element in JBoss XML file の問題が存在することを確認します。
4. jboss-web.xml リンクをクリックして、影響を受けたファイルを開きます。