CLI ガイド

このガイドは、Java アプリケーションやその他のコンポーネントを移行するために、Migration Toolkit for Applications (MTA) を使用するエンジニア、コンサルタント、およびその他のユーザーを対象としています。CLI のインストールおよび実行方法、生成されたレポートを確認し、追加機能を活用する方法を説明します。

Migration Toolkit for Applications とは

Migration Toolkit for Applications (MTA) は、拡張およびカスタマイズ可能なルールベースのツールで、Java アプリケーションの移行を容易にします。

MTA は、プロジェクトソースディレクトリーやアプリケーションアーカイブを含むアプリケーションアーティファクトを検査し、変更を必要とするエリアを強調表示する HTML レポートを作成します。MTA を使用して、以前のバージョンの Red Hat JBoss Enterprise Application Platform から、または Oracle® WebLogic Server や IBM® WebSphere® Application Server などの他のコンテナーから Java アプリケーションを移行できます。

Migration Toolkit for Applications で移行を単純化する方法

Migration Toolkit for Applications は一般的なリソースを探し、アプリケーションを移行する際のテクノロジーと既知の問題点を明らかにします。この目的は、アプリケーションが使用するテクノロジーの概要を提供し、組織がエンタープライズアプリケーションを Java EE および Red Hat JBoss Enterprise Application Platform に推定、文書化、移行するために使用できる詳細なレポートを提供することです。

詳細情報

Migration Toolkit for Applications の機能、サポートされている設定、システム要件、および使用可能なツールの詳細については、スタートガイド を参照してください。

CLI は、Migration Toolkit for Applications のコマンドラインツールです。これにより、ユーザーはアプリケーションに対する移行およびモダナイゼーションの作業を評価および優先順位付けできます。他のツールのオーバーヘッドなしに分析を強調表示する多数のレポートが提供されます。CLI にはさまざまなカスタマイズオプションが含まれており、MTA 分析オプションを細かく調整したり、外部の自動化ツールと統合したりできます。

CLI をインストールする前に、次の前提条件を満たしていることを確認してください。

解凍したディレクトリーは、このガイドでは RHAMT_HOME と呼ばれます。

アプリケーションに対して MTA を実行するには、次の手順を使用します。

MTA GitHub リポジトリーにあるソースコードディレクトリーとアーカイブを使用するコマンドの例については、以下の MTA コマンドの例 を参照してください。

MTA コマンドの例

アプリケーションアーカイブでの MTA の実行

次のコマンドは、JBoss EAP 5 から JBoss EAP 7 に移行するための サンプル EAR アーカイブ jee-example-app-1.0.0.ear の com.acme パッケージおよび org.apache パッケージを解析します。

$ RHAMT_HOME/bin/rhamt-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/report-output/ --source eap:5 --target eap:7 --packages com.acme org.apache

ソースコードでの MTA の実行

次のコマンドは、JBoss EAP 6 に移行するための seam-booking-5.2 サンプルソースコードの org.jboss.seam パッケージを分析します。

$ RHAMT_HOME/bin/rhamt-cli --sourceMode --input /path/to/seam-booking-5.2/ --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam

cloud-readiness ルールの実行

次のコマンドは、JBoss EAP 7 に移行するためのサンプル EAR アーカイブ jee-example-app-1.0.0.ear の com.acme パッケージおよび org.apache パッケージを解析します。また、cloud-readiness についても評価します。

$ RHAMT_HOME/bin/rhamt-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/report-output/ --target eap:7 --target cloud-readiness --packages com.acme org.apache

MTA プロパティーを上書きする

デフォルトの Fernflower デコンパイラーを上書きするには、コマンドラインで -Dwindup.decompiler 引数を渡します。たとえば、Procyon デコンパイル機能を使用する場合は、以下の構文を使用します。

$ RHAMT_HOME/bin/rhamt-cli -Dwindup.decompiler=procyon --input INPUT_ARCHIVE_OR_DIRECTORY --output OUTPUT_REPORT_DIRECTORY --target TARGET_TECHNOLOGY --packages PACKAGE_1 PACKAGE_2

MTA CLI bash 補完

MTA CLI は、Linux システムの bash 補完を有効にするオプションを提供し、コマンドを入力した時に Tab キーを押して MTA コマンドライン引数 を自動化できます。たとえば、bash 補完を 有効 にすると、以下のように利用可能な引数のリストが表示されます。

$ RHAMT_HOME/bin/rhamt-cli [TAB]

bash 補完を有効にする

現在のシェルで bash 補完を有効にするには、以下のコマンドを実行します。プロンプトが返されたら、CLI の実行 の手順に従います。

$ source RHAMT_HOME/bash-completion/rhamt-cli

永続的な bash 補完を有効にする

次のコマンドを使用すると、再起動後も bash 補完を維持できます。ただし、現在のシェルで bash 補完が必要な場合は、bash 補完を有効にする の手順に従う必要があります。

MTA ヘルプ

rhamt-cli コマンドで利用可能な引数の完全な一覧を表示するには、ターミナルを開き、RHAMT_HOME ディレクトリーに移動して、以下のコマンドを実行します。

$ RHAMT_HOME/bin/rhamt-cli --help

Migration Toolkit for Applications を実行すると、コマンドラインの --output 引数を使用して指定する OUTPUT_REPORT_DIRECTORY にレポートが生成されます。実行が完了すると、ターミナルに次のメッセージとレポートの場所が表示されます。

Report created: OUTPUT_REPORT_DIRECTORY/index.html
              Access it at this URL: file:///OUTPUT_REPORT_DIRECTORY/index.html

output ディレクトリーには、以下のファイルおよびサブディレクトリーが含まれます。

OUTPUT_REPORT_DIRECTORY/
├── index.html          // Landing page for the report
├── EXPORT_FILE.csv     // Optional export of data in CSV format
├── archives/           // Archives extracted from the application
├── mavenized/          // Optional Maven project structure
├── reports/            // Generated HTML reports
├── stats/              // Performance statistics

ブラウザーを使用して、レポート出力ディレクトリーにある index.html ファイルを開きます。MTA レポートの操作については、レポートを確認する を参照してください。

Technologies リンクをクリックして、レポートランディングページからこのレポートにアクセスします。

このレポートは、解析されたアプリケーションに使用されたテクノロジーを機能別にまとめたリストを提供します。これは、テクノロジーがどのように分散されているかを示し、通常は、多数のアプリケーションを分析してアプリケーションをグループ化し、パターンを特定した後にレビューされます。また、各アプリケーションのサイズ、ライブラリー数、およびストーリーポイントの合計も表示されます。

Markup などの任意のヘッダーをクリックすると、結果が降順に並べ替えられます。同じヘッダーを再度選択すると、結果が昇順になります。現在選択されているヘッダーは、並べ替えの方向を示す方向矢印の横に太字で示されます。

図3.11 複数のアプリケーションで使用されるテクノロジー

Dependencies Graph リンクをクリックして、レポートランディングページからこのレポートにアクセスします。

これには、WAR と JAR の一覧が含まれ、含まれる各ファイル間の関係をグラフ化します。グラフの各円は、アプリケーションで定義されている一意の依存関係を表します。ファイルを複数のアプリケーションに依存関係として組み込むと、それらはグラフにリンクされます。

以下の図では、2 つの異なるグループを確認できます。左側には、複数の JAR を依存関係として定義する単一の WAR が表示されます。右側には、複数の WAR で使用されるものと同じ依存関係があります。この 1 つは、選択された overlord-commons-auth-2.0.11.Final.jar です。

図3.12 複数のアプリケーション間の依存関係グラフ

依存関係グラフは、以下のいずれかを使用して調整できます。

Archives shared by multiple applications リンクをクリックして、レポートランディングページからこれらのレポートにアクセスします。このリンクは、適用可能な共有アーカイブがある場合にのみ利用できることに注意してください。

図3.13 複数のアプリケーションで共有されるアーカイブ

これにより、複数のアプリケーション間で共有されるすべてのアーカイブの詳細なレポートを表示できます。

Rule providers execution overview リンクをクリックして、レポートランディングページからこのレポートにアクセスします。

このレポートは、アプリケーションに対して MTA 移行コマンドを実行する際に実行するルールの一覧を提供します。

図3.14 ルールプロバイダー実行の概要

Migration Toolkit for Applications FreeMarker メソッド リンクをクリックして、レポートランディングページからこのレポートにアクセスします。

このレポートには、レポートの作成に使用されたすべての登録済み関数およびディレクティブがリストされます。これは、デバッグの目的で、または独自のカスタムレポートを作成する場合に役立ちます。

図3.15 Freemarker 機能およびディレクティブ

Send feedback リンクをクリックして、レポートランディングページからこのフィードバックフォームにアクセスします。

このフォームでは、製品を評価し、好きなものについて話し、改善のための提案を行うことができます。

図3.16 フィードバックフォームを送信

レポートを CSV ファイルにエクスポートするには、--exportCSV 引数を指定して MTA を実行します。CSV ファイルは、解析される各アプリケーションの、--output 引数で指定されたディレクトリーに作成されます。分析されたすべてのアプリケーションにわたるすべての発見された問題は、レポートのルートディレクトリーにある AllIssues.csv に含まれます。

アプリケーションレポートからのレポートへのアクセス

CSV レポートをエクスポートすると、すべての CSV 問題を 問題レポート でダウンロードできます。これらの問題は、次の図に示すように、問題レポートの右上のセクションにある Download All Issues CSV ボタンを選択してダウンロードできます。

図4.1 CSV ダウンロードに関する問題レポート

詳細について、または問題を解決するには、スプレッドシートソフトウェアのヘルプを確認してください。

CSV 形式の出力ファイルには、以下のデータフィールドが含まれます。

MTA の実行時に --mavenize フラグを渡すことにより、提供されたアプリケーションの Maven プロジェクト構造を生成できます。

次の例では、jee-example-app-1.0.0.ear テストアプリケーションを使用して MTA を実行します。

$ RHAMT_HOME/bin/rhamt-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/output --target eap:6 --packages com.acme org.apache --mavenize

これにより、Maven プロジェクト構造が /path/to/output/mavenized ディレクトリーに生成されます。

--mavenizeGroupId オプションを使用して、POM ファイルに使用する <groupId> を指定することもできます。指定しないと、MTA はアプリケーションに適切な <groupId> の識別を試行するか、デフォルトで com.mycompany.mavenized になります。

/path/to/output/mavenized/APPLICATION_NAME/ ディレクトリーには、以下の項目が含まれます。

サンプルの jee-example-app-1.0.0.ear アプリケーションは、WAR と複数の JAR を含む EAR アーカイブです。これらのアーティファクトごとに個別のディレクトリーが作成されます。以下は、このアプリケーション用に作成された Maven プロジェクト構造です。

/path/to/output/mavenized/jee-example-app/
    jee-example-app-bom/pom.xml
    jee-example-app-ear/pom.xml
    jee-example-services2-jar/pom.xml
    jee-example-services-jar/pom.xml
    jee-example-web-war/pom.xml
    pom.xml

生成された各ファイルを確認し、プロジェクトに合わせてカスタマイズします。Maven POM ファイルの詳細は、Apache Maven ドキュメントの Introduction to the POM セクションを参照してください。

ルート POM ファイル

jee-example-app-1.0.0.ear アプリケーションのルート POM ファイルは /path/to/output/mavenized/jee-example-app/pom.xml にあります。このファイルは、すべてのプロジェクトモジュールのディレクトリーを特定します。

以下のモジュールは、サンプルの jee-example-app-1.0.0.ear アプリケーションのルート POM の一覧に記載されています。

<modules>
  <module>jee-example-app-bom</module>
  <module>jee-example-services2-jar</module>
  <module>jee-example-services-jar</module>
  <module>jee-example-web-war</module>
  <module>jee-example-app-ear</module>
</modules>

また、ルート POM は Red Hat JBoss Enterprise Application Platform Maven リポジトリー を使用してプロジェクトの依存関係をダウンロードするように設定されます。

BOM ファイル

BOM (Bill of Materials) ファイルは、-bom で終わるディレクトリーに生成されます。サンプルアプリケーション jee-example-app-1.0.0.ear の場合、BOM ファイルは /path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml にあります。この BOM の目的は、プロジェクトで使用されるサードパーティーの依存関係のバージョンを 1 か所で定義することです。BOM の使用に関する詳細は、Apache Maven ドキュメントの Introduction to the Dependency Mechanism セクションを参照してください。

以下の依存関係は、jee-example-app-1.0.0.ear アプリケーションの BOM に一覧表示されています。

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.6</version>
    </dependency>
    <dependency>
      <groupId>commons-lang</groupId>
      <artifactId>commons-lang</artifactId>
      <version>2.5</version>
    </dependency>
  </dependencies>
</dependencyManagement>

アプリケーション POM ファイル

Maven が可能なアプリケーションモジュールには、POM ファイルが含まれる個別のディレクトリーがあります。ディレクトリー名には、アーカイブタイプに応じてアーカイブの名前と、接尾辞 -jar、-war、または -ear で終わるものが含まれます。

各アプリケーション POM ファイルには、以下を含むモジュールの依存関係が一覧表示されます。

たとえば、jee-example-app-1.0.0.ear EAR (/path/to/output/mavenized/jee-example-app/jee-example-app-ear/pom.xml) の POM ファイルには、以下の依存関係の一覧が記載されます。

<dependencies>
  <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.6</version>
  </dependency>
  <dependency>
    <groupId>org.jboss.seam</groupId>
    <artifactId>jee-example-web-war</artifactId>
    <version>1.0</version>
    <type>war</type>
  </dependency>
  <dependency>
    <groupId>org.jboss.seam</groupId>
    <artifactId>jee-example-services-jar</artifactId>
    <version>1.0</version>
  </dependency>
  <dependency>
    <groupId>org.jboss.seam</groupId>
    <artifactId>jee-example-services2-jar</artifactId>
    <version>1.0</version>
  </dependency>
</dependencies>