Ant スクリプトからのコード・カバレッジの使用可能化

ビルドしているコードが、指定したコード・カバレッジの許容基準を満たしているかを確認するため、Ant スクリプトからコード・カバレッジを使用可能にすることができます。これを行うには以下の手順が必要です。

• コード・カバレッジを使用可能にする Ant スクリプトを構成する
• Ant スクリプトを実行する
• コード・カバレッジ統計を生成する
• コード・カバレッジ・レポートを生成する
• コード・カバレッジを使用不可にする

ワークベンチにコード・カバレッジの結果を表示することもできます。

コード・カバレッジを使用可能にするための Ant スクリプトの構成

コード・カバレッジを使用可能にする Ant スクリプトを構成するため、以下を CLASSPATH 環境変数に追加します。
<install_dir>/plugins/com.ibm.rational.llc.engine_1.0.0.<version_number>
また、ビルド・ファイルに新規タスクを定義します。例:

<taskdef name="instrument" classname="com.ibm.rational.llc.engine.instrumentation.anttask.InstrumentationTask" classpath="${install_dir}/plugins/com.ibm.rational.llc.engine_1.0.0.<version_number>"/>

インスツルメンテーション・タスクのフォーマットは次のとおりです。

<instrument buildPath="" baseLineFile="" saveBackups="" outputDir=""/>

場所:

buildPath:

コード・カバレッジ・データを収集するファイルを指定します。ビルド・パスは、クラス・ファイル名、JAR ファイル名、またはディレクトリー名のいずれかを参照します。Ant で使用される他のパス参照と同様に定義することができます。

baseLineFile:

ベースライン・ファイルを格納するパスを指定します。このベースライン・ファイルに対して、装備するコードを比較し、コード・カバレッジ統計を生成します。これは、レポート生成 Ant タスクへの入力データとなります。

saveBackups:

オリジナル・クラスや JAR ファイルを *.bak へと名前変更するかどうかを指定します。saveBackups に true を設定すると、バックアップ・ファイルを生成します。saveBackups に false を設定すると、オリジナル・ファイルを上書きする (つまりオリジナル・ファイルを失う) ことになります。
注: saveBackups オプションで、デフォルト値は false です。

outputDir:

装備するファイルを格納するロケーションを指定します。デフォルトでは、装備するファイルは、装備しているファイルと同じロケーションに格納されます。

例 1

以下の例では、bin/ にあるすべてのファイルのコード・カバレッジ・データを収集し、ベースライン・ファイルを blfile.coveragedata に格納します。これらのファイルに対してバックアップは生成されません。また、装備するファイルは、coverageData_files に格納されます。

<instrument saveBackups="false" baseLineFile="blfile.coveragedata" buildPath="bin/" outputDir="coverageData_files"/>

例 2

以下の例では、build.Dir として参照される bin/ にあるすべてのファイルのコード・カバレッジ・データを収集し、ベースライン・ファイルを blfile.coveragedata に格納します。これらのファイルのバックアップが、それぞれ生成されます。

<path id="build.Dir"> <pathelement location="bin"/> </path>
<instrument saveBackups="true" baseLineFile="blfile.coveragedata" buildPathRef="build.Dir" />

例 3

以下の例では、bin/ にあるすべてのファイルのコード・カバレッジ・データを収集し、ベースライン・ファイルを blfile.coveragedata に格納します。これらのファイルのバックアップが、それぞれ生成されます。

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <pathelement location="bin"/> </buildPath> </instrument>

例 4

以下の例では、ディレクトリー名に Test を含むディレクトリーにあるファイルを除き、bin/ にある com をディレクトリー名に含むすべてのサブディレクトリーのコード・カバレッジ・データを使用可能にします。コード・カバレッジの分析が行われるファイルに対して、それぞれバックアップが生成され、ベースライン・ファイルを blfile.coveragedataに格納します。

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <fileset dir="bin"> <exclude name="**/*Test*"/> <include name="**/*com*/*"> </fileset> </buildPath> </instrument>

例 5

以下の例では、ディレクトリー名に Test を含む bin のサブディレクトリーにあるファイルを除いて、bin/ と bin2/ のすべてファイルのコード・カバレッジ・データを使用可能にします。コード・カバレッジの分析が行われるファイルに対して、それぞれバックアップが生成され、ベースライン・ファイルを blfile.coveragedataに格納します。

<instrument saveBackups="true" baseLineFile="blfile.coveragedata"> <buildPath> <fileset dir="bin"> <exclude name="**/*Test*"/> </fileset> </buildPath> <buildPath> <pathelement location="bin2"/> </buildPath> </instrument>

Ant スクリプトの実行

一度、コード・カバレッジを使用可能にするため Ant スクリプトを構成したら、コマンド行またはワークベンチから Ant スクリプトを実行することができます。

コマンド行からの実行

コマンド行から Ant スクリプトを実行するために、以下のことを行ってください。

1. JAVA_HOME 環境変数に JDK がインストールされているディレクトリーを設定します。
2. CLASSPATH 環境変数が probekit.jar ファイルの絶対パスとファイル名を含んでいるか確認してください。probekit.jar ファイルは、製品インストールのプラグイン・フォルダーでバージョン番号が高く、タイム・スタンプが最新な org.eclipse.hyades.probekit サブフォルダーに配置されます。
3. CLASSPATH 環境変数が、JAVA_HOME (JAVA_HOME/bin/java のような Java インストールのパスが有効である) を含んでいるか確認してください。
4. PATH 環境変数が、プラットフォームに適した org.eclipse.hyades.probekit サブフォルダーへの絶対パスを含んでいるか確認してください。例:
   • Windows の場合:
     <install_dir>¥plugins¥org.eclipse.hyades.probekit_<version>¥os¥win32¥x86
   • Linux の場合:
     <install_dir>/plugins/org.eclipse.hyades.probekit_<version>/os/linux/x86
5. LLC_PLUGIN をプラグイン・フォルダーへのパスとして設定します。
   set LLC_PLUGIN=<install_dir>¥plugins

例

ant -lib=<install_dir>¥plugins¥org.eclipse.hyades.probekit_<version>¥probekit.jar myTarget

ワークベンチからの実行

ワークベンチから Ant スクリプトを実行するために、以下のことを行ってください。

• ビルド・ファイルを選択する
• 右クリックして、「実行」>「Ant ビルド...」を選択する
• 「クラスパス」タブを選択する
• 「ユーザー・エントリー」を選択する
• 「外部 JAR の追加...」をクリックする
• バージョン番号が高く、タイム・スタンプが最新な org.eclipse.hyades.probekit プラグイン・サブフォルダーから CLASSPATH へ <install_dir>¥plugins¥org.eclipse.hyades.probekit_<version>¥probekit.jar を追加する
• 「ターゲット」タブを選択する
• 希望のターゲットにチェック・マークを付ける
• 「環境」タブを選択する
• 「新規...」をクリックする
• 「新規環境変数」ダイアログから、「名前」フィールドに LLC_Plugin を入力し、「値」フィールドに LLC_PLUGIN のパスを入力する (例えば、<install_dir>¥plugins)
• 「OK」をクリックする
• 「新規...」をクリックする
• 「新規環境変数」ダイアログから、「名前」フィールドに PATH を入力し、「値」フィールドに <install_dir>¥plugins¥org.eclipse.hyades.probekit_<version>¥os¥win32¥x86 を入力する
• 「OK」をクリックする
• 「実行」をクリックする

コード・カバレッジ統計の生成

クラスパスに以下が含まれているか確認してください。
<install_dir>¥plugins¥com.ibm.rational.llc.engine_1.0.0.<version_number>

コマンド行から、またはコードの上のディレクトリーからコード・カバレッジ統計を生成するために、以下を実行してください。

java -Dcoverage.out.file=C:¥coverage_report¥coverage_data.coveragedata com.ibm.rational.llc.example

注: Java を製品インストールのものと一致させて設定する必要があります。

コード・カバレッジ・レポートの生成

Ant を使用してレポートを生成するために、以下のことを行ってください。
BIRT Runtime Report Engine をダウンロードし、コンテンツを unzip します。 以下の環境変数を設定します。

• CLASSPATH - org.eclipse.equinox.common_<version_number>.jar を指定する
• LLC_COMMON_PLUGIN - com.ibm.rational.llc.common_1.0.0.<version_number> を指定する
• LLC_REPORT_PLUGIN - com.ibm.rational.llc.report.birt_1.0.0.<version_number> を指定する
• BIRT_HOME - BIRT ランタイムから ReportEngine ディレクトリーを指定する

コード・カバレッジ・レポートのタスクのフォーマットは次のとおりです。

<code-coverage-report outputDir="" coverageDataFile="" baseLineFiles=""> <filters> <filter type="" value=""/> </filters> <configurations> <configuration name="" value=""/> </configurations> </code-coverage-report>

場所:

outputDir:

レポートの結果を格納するロケーションを指定します。

coverageDataFile:

レポートを生成するカバレッジ・データ・ファイルを 1 つ以上指定します。Ant で使用される他のパス参照と同様に定義することができます。

baseLineFiles:

インスツルメンテーション・タスクの一部として生成されたベースライン・ファイルを1 つ以上指定します。Ant で使用される他のパス参照と同様に定義することができます。

filters:

オプション: レポートの結果をフィルターする場合に使用します。

filter:

タイプ: レポートに適用するフィルターのタイプ。

値: レポートに適用するフィルターの値。

使用可能なフィルター:

• 行カバレッジしきい値: 指定されたパーセントの値より低いデータを表示するように、行カバレッジ・レポートのしきい値を設定します。type=line_coverage_threshold, value=threshold value

構成:

オプション: さまざまな計算の構成を指定する場合に使用します。

構成:

名前: 構成名。

値: 構成の値。

使用可能な構成:

• デフォルト・コンストラクターのインクルード: デフォルト・コンストラクターがコード・カバレッジの計算から除外されるか、または組み込まれるかを構成します。デフォルトでは、デフォルト・コンストラクターは組み込まれています。クラスがコンストラクターを定義しない場合、コンパイラーは引数なしのデフォルト・コンストラクターを生成します。しかし、このコンストラクターは、実際のソース・ファイルには表示されません。プログラムの実行中、このクラスがインスタンス化されていない場合、非表示のデフォルト・コンストラクターは実行されず、そのため、カバレッジは期待される 100% と見なされません。次の構成で、この振る舞いを変更することができます。name=excludeDefaultConstructor, value=true or false

例 1

以下の例では、coverage-data/blfile.coveragedata をベースライン・ファイルとして使用し、coverage-data/coverage.coveragedata にレポートの生成を収集します。レポートは coverage-reports に格納され、line_coverage_threshold フィルターを 80 パーセントのしきい値で適用します。デフォルト・コンストラクターは、コード・カバレッジの計算から除外されます。

<code-coverage-report outputDir="coverage-reports/" coverageDataFile="coverage-data/coverage.coveragedata" baseLineFiles="coverage-data/blfile.coveragedata"> <filters> <filter type="line_coverage_threshold" value="80"/> </filters> <configurations> <configuration name="excludeDefaultConstructor" value="true"/> </configurations> </code-coverage-report>

例 2

以下の例では、blfile1.coveragedata と blfile2.coveragedataをベースライン・ファイルとして使用し、coverage1.coveragedata と coverage2.coveragedata の 2 つのカバレッジ・ファイルにレポートの生成を収集します。レポートは coverage-reports に格納されます。デフォルトで、デフォルト・コンストラクターが、コード・カバレッジの計算に組み込まれています。

<code-coverage-report outputDir="coverage-reports/" coverageDataFile="coverage-data/coverage1.coveragedata;coverage-data/coverage2.coveragedata" baseLineFiles="coverage-data/blfile1.coveragedata;coverage-data/blfile2.coveragedata"> </code-coverage-report>

ワークベンチにコード・カバレッジの結果を表示する

ワークベンチに Ant スクリプトのコード・カバレッジの結果を表示するには、次のようにします。

• カバレッジ結果ファイルをインポートします。
• 「ファイル」>「インポート...」を選択する
• 「コード・カバレッジ」>「コード・カバレッジのデータ・ファイル」を選択する
• 「次へ」をクリックする
• ファイル・システムのインポート・タイプを選択する
• 「次へ」をクリックする
• インポートするカバレッジ・データ・ファイルのロケーション (上記の例では、coverage_data.coveragedata)、インポートするファイルを格納するフォルダーの名前、およびカバレッジ・データ・ファイルと関連付けられるプロジェクトを入力する
• 「終了」をクリックする。コード・カバレッジがまだ使用可能に設定されていない場合、プロジェクトを再ビルドするためにプロンプトが表示されます。
• コード・カバレッジ・レポートを生成します。
• 「実行」>「コード・カバレッジ」>「レポートの生成...」を選択する
• 「名前」列の 1 つ以上の Java の起動を選択する
• Eclipse ベースまたは HTML ベースのレポートどちらかを選択する
• 「実行」をクリックする

注: 1 つ以上のカバレッジ・データ・ファイルを選択し、右クリックをして、「コード・カバレッジ」>「レポートの生成...」を選択することもできます。レポートの関連するプロジェクトおよびフォルダーのロケーションを指定し、「終了」をクリックしてください。

コード・カバレッジの使用不可化

Ant タスクを使用して装備されたクラスを使用不可にするには、プロジェクトを再コンパイルする、または saveBackups を使用可能に設定してある場合、.class ファイルを .class.bak ファイルと置き換えてください。

(C) Copyright IBM Corporation 2007, 2008. All Rights Reserved.