2.3. 最初の YAML ルールを作成する
このセクションでは、最初の MTA YAML ベースのルールを作成してテストするプロセスを説明します。これは、すでに MTA がインストールされていることを前提としています。インストール手順は、CLI ガイド の CLI のインストールと実行 を参照してください。
この例では、アプリケーションが <class-loading> 要素を含む jboss-web.xml ファイルの定義を行うインスタンスを検出するルールを作成します。また、コードの移行方法を説明するドキュメントへのリンクを提供します。
2.3.1. ルールの YAML ファイルを作成する
- 最初のルール用の YAML ファイルを作成します。
$ mkdir /home/<USER>/rule.yaml
2.3.2. ルールをテストするためのデータの作成
ディレクトリーに、
jboss-web.xmlおよびpom.xmlファイルを作成します。mkdir /home/<USER>/data/ touch /home/<USER>/data/jboss-web.xml touch /home/<USER>/data/pom.xml
作成した
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>作成した
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>
2.3.3. ルールの作成
MTA YAML ベースのルールは、以下のルールパターンを使用します。
when(condition) perform(action)
手順
作成した
rule.yamlファイルに、次の内容を貼り付けます。- ruleID: <UNIQUE_RULE_ID> 1 description: <DESCRIPTION> 2 when: <CONDITION(S)> 3 message: <MESSAGE> 4 labels: <LABELS> 5 effort: <EFFORT> 6 links: - <LINKS> 7
- 1
- ルールの一意の ID。たとえば、
jboss5-web-class-loadingです。 - 2
- ルールの文字での説明。
- 3
- 1 つ以上の条件を指定して
whenブロックを完成させます。-
このルールは XML ファイル内の一致をチェックするため、
builtinプロバイダーの XML ケイパビリティーを使用します。 jboss-webの子であるclass-loading要素を照合するには、XPath 式jboss-web/web-loadingを XML クエリーとして使用します。この場合、必要な条件は 1 つだけです。when: builtin.xml: xpath: jboss-web/class-loading
-
このルールは XML ファイル内の一致をチェックするため、
- 4
- 移行の問題を説明する役立つメッセージ。ルールが一致すると、レポートにメッセージが生成されます。以下に例を示します。
message: The class-loading element is no longer valid in the jboss-web.xml file.
- 5
- ルールの文字列ラベルのリスト。
- 6
- この問題を解決するために予想されるストーリーポイントの数。
- 7
- 検出した移行問題に関するドキュメントを指す 1 つ以上のハイパーリンク。
links: - url: https://access.redhat.com/documentation/ja-JP/JBoss_Enterprise_Application_Platform/6.4/html-single/Migration_Guide/index.html#Create_or_Modify_Files_That_Control_Class_Loading_in_JBoss_Enterprise_Application_Platform_6 title: Create or Modify Files That Control Class Loading in JBoss EAP 6
以上でルールが完成しました。ルールは次のようになります。
- ruleID: jboss5-web-class-loading description: Find class loading element in JBoss XML file. when: builtin.xml: xpath: jboss-web/class-loading message: The class-loading element is no longer valid in the jboss-web.xml file. effort: 3 links: - url: https://access.redhat.com/documentation/ja-JP/JBoss_Enterprise_Application_Platform/6.4/html-single/Migration_Guide/index.html#Create_or_Modify_Files_That_Control_Class_Loading_in_JBoss_Enterprise_Application_Platform_6 title: Create or Modify Files That Control Class Loading in JBoss EAP 6
2.3.4. ルールのインストール
手順
CLI で、作成したルールファイルを指定します。
–rules /home/<USER>/rules.yaml
2.3.5. ルールのテスト
手順
ルールをテストするには、作成したテストデータを入力に指定し、MTA CLI のルールオプションを使用してルールを渡します。
mta-cli analyze --input /home/<USER>/data/ --output /home/<USER>/output/ --rules /home/<USER>/rules.yaml
2.3.6. レポートを確認する
レポートを確認して、予想される結果が表示されることを確認します。
手順
分析が完了すると、コマンドは 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を開きます。- 左側のメニューの Issues タブに移動します。
ルールが実行されていることを確認します。
-
Issues テーブルの検索バーに
JBoss XMLと入力します。 -
テーブルに、タイトルが
Find class loading element in JBoss XML fileの問題が存在することを確認します。
-
Issues テーブルの検索バーに
- jboss-web.xml リンクをクリックして、影響を受けたファイルを開きます。
