このセクションの内容
概要
Jtest を起動するには、Jtest のインストール ディレクトリにある jtestcli.exe
を実行します。通常は、サポートされているビルド システム (Maven、Antおよび Gradle) の専用プラグインから jtestcli.exe を起動しますが、コマンドラインから手動で実行することもできます。
jtestcli.exe
は、ビルド システム プラグインが自動的に生成する jtest.data.json
データ ファイルを処理します。コマンド ラインから jtestcli.exe
を実行する場合、-data
オプションを使用して、解析に使用する .json
データ ファイルを指定します。
ビルド システム プラグインの使用
通常、jtestcli.exe
は Maven、Ant または Gradle 専用のプラグインから起動されます。プラグインの設定やトラブルシューティングなどの詳細については、「ビルド システムとの統合」を参照してください。
プラグインからの実行時に jtestcli.exe に渡される引数を表示するには、環境変数 $XTEST_ITX=714 を追加します。
コマンド ラインからの jtestcli
の使用
Jtest を起動するには、コマンドラインから jtestcli.exe
を実行します。少なくともテスト コンフィギュレーションおよび解析対象コードのデータ ファイルの場所を指定する必要があります。詳細については「テスト コンフィギュレーションの設定」および「テスト データの場所の指定」を参照してください。
コマンドは次のようになります。
jtestcli.exe -settings settings.properties -config "builtin://Recommended Rules" -data demo.data.json -report report
テスト データの場所の指定
-data
スイッチを使用して、ビルドシステム プラグインによって生成される *.json
データファイルのディレクトリを指定します。自動生成された *.json
データ ファイルは、ワークスペースと同じ情報を Jtest 固有のフォーマットで表します。
-data file
ビルド システム プラグインは、data 引数を自動的に追加し、生成された値をインクルードします。そのため、これをプラグインの構成に追加する必要はありません。
プロパティ パターンの設定
.properties ファイルで jtest.data
オプションを使ってデータ ファイルへのパスを指定できます。
jtest.data=[path to file]
データ ファイルのフォーマット
データ ファイル (jtest.data.json
) は、Jtest のビルド システム プラグインによって自動生成され、フォーマットされた json オブジェクトのストリームです。データ ファイルは、テスト対象プロジェクトに関してワークスペースと同じ情報を提供します。ファイル内の各オブジェクトが 1 つのプロジェクトを記述します。現行の Jtest は、classpath_project 共通オブジェクト型をサポートします。サンプルについては 「テストスコープの設定」を参照してください。
データ ファイル オブジェクトのサンプル
{ "type": "classpath_project", "name": "project_name", "location" "/absolute/path/to/project", "compilations": [ { "sourcepath": [ "/absolute/path/to/srcdir1" ], "resourcepath": [ "/absolute/path/to/resources" ], "classpath": [ "/absolute/path/to/classdir1", "/absolute/path/to/buildfile.jar" ], "bootpath": [ "absolute/path/to/java/ajavalib.jar" ], "encoding": "project_encoding_name", "sourcelevel" "project_source_level" },{ ... } ] } { ... }
詳細な進捗情報の表示
詳細な進捗情報を表示するには、-showdetails
スイッチを使用します。
-showdetails
または、console.verbosity
オプションに high
を指定します。
console.verbosity.level=high
Ant および Maven のパターン
Ant または Maven を使用している場合、次のパターンを使用します。
<showdetails>true</showdetails>
Jtest データの場所の指定
解析を実行するには、解析中に Jtest が実行固有のデータを保存する .jtest ディレクトリへの書き込み権限が必要です。デフォルトでは、ディレクトリは現在の作業ディレクトリまたはビルド システムの出力ディレクトリ (Maven のターゲット ディレクトリなど) に保存されます。-workspace
コマンドライン オプションを使って、.jtest ディレクトリのカスタムの場所へのパスを指定できます。例:
-workspace /home/qa/jtestdata_project1