This page describes how to enable and configure Atlassian's Clover add-on for a job in Bamboo.

Bamboo を Clover と統合すると、次のことが可能になります。

  • 各ビルド結果のコード カバレッジの詳細 (つまり、テストでカバーされたコードの割合) を表示する
  • ジョブの一定期間におけるコード カバレッジの傾向を表示する
  • ジョブのコード カバレッジの要約を表示する

 

このページの内容

関連ページ


アトラシアンのブログ:

Clover アドオンを有効にする

  1. Navigate to the desired job, as described on Configuring jobs.
  2. [Actions (アクション)] > [Configure Job (ジョブを設定)] の順に選択します。
  3. [Miscellaneous (その他)] タブをクリックします。

  4. [Use Clover to collect Code Coverage for this build (Clover を使用してこのビルドのコード カバレッジを収集する)] を選択して、次の設定を指定します。

 

設定説明
このビルドに Clover を自動的に統合するYou will need to provide a Clover license (evaluation licenses are available), unless this has been configured globally in the Administration panel (Administration > Plugins > Clover Plugin).
Generate a Clover Historical Report (Clover 履歴レポートを生成する)現在のカバレッジ結果を以前の Clover コード カバレッジ レポートと比較して表示します。
Generate a JSON report (JSON レポートを生成する)アプリまたは外部レポート ビューに組み込める形式で Clover 結果を提供します。
Use plan-defined Clover license key (プランに定義された Clover ライセンス キーを使用する)該当する特定のプランに対してグローバル Clover ライセンスをオーバーライドします。
Clover is already integrated into this build (Clover はこのビルドに統合済み)

Use this option when you already have Clover-for-Ant, Clover-for-Maven or other Clover integration configured to generate a report.

Clover XML Location (Clover XML の場所)

Bamboo における Clover の XML レポート ファイルの参照場所を指定します。プランのルート ディレクトリを基準とした相対ファイル パスを指定してください (例: /home/bamboouser/bamboo-home/xml-data/build-dir/MY_PLAN/)。絶対パスは指定しないでください。

 target/site/clover/clover.xml

スクリーンショット: ジョブに対して Clover を有効にするための設定

 

As Clover integration (automatic and manual) produces instrumented classes, we recommend to ensure that your job does not install them to production (for instance: 'mvn deploy' to public repository, 'scp' to an application server running on production, etc ...). Having instrumented code in such location is usually not desired.

Common practices to ensure proper separation of instrumented and non-instrumented classes are:

  • create a dedicated plan or job with Clover integration enabled
  • enable automatic Clover integration for jobs running tests only (e.g. "mvn verify")
  • use different location of local artifact cache if you need to install artifacts (e.g. ~/.m2/repository-clover and "mvn install")
  • use different URL for uploading artifacts if necessary (e.g. a separate repository for "mvn deploy")

 

Clover の自動統合

自動統合は、Ant、Maven 2.x、Maven 3.x、および Grails タスクと連携します。

  1. Clover コード カバレッジ設定で、[Use Clover to collect Code Coverage for this build (Clover を使用してこのビルドのコード カバレッジを収集する)] を選択します。
  2. [Automatically integrate Clover into this build (このビルドに Clover を自動的に統合する)] を選択します。
  3. Clover のグローバル ライセンス キーを入力するか ([Administration (管理)] > [Plugins (プラグイン)] > [Clover Plugin (Clover プラグイン)] に移動)、[Use plan-defined Clover license key (プランに定義された Clover ライセンス キーを使用する)] を有効にして、表示されるテキスト フィールドにキーを貼り付けます。

さらに、次のことが可能です。

 Clover の自動統合を有効にすると、Bamboo で最初に次のことが行われます。

  • 「Clover Report (System) (Clover レポート (システム))」という名前のアーティファクトを作成します。これは、ジョブの [Artifacts (アーティファクト)] タブに表示されます。

そして、各ビルドの実行時に次のことが行われます。

  • Extract the Clover licence (either the global or plan license key) into a temporary file and pass it to:
    • Ant タスク (-Dclover.license.path=/<bamboo-home>/xml-data/build-dir/<your-job>/.clover/clover.license として)
    • Maven タスク (-Dmaven.clover.licenseLocation=/<bamboo-home>/xml-data/build-dir/<your-job>/.clover/clover.license として)
  • 以下を追加してタスクを強化します。
    • Ant ターゲット
    • Maven ゴール ("clover2:setup verify clover2:aggregate clover2:clover" など)
  • Clover XML レポートと HTML レポートを生成します (既定)。
  • プラン要約の統計とグラフを生成します。

 

Clover の手動統合

Clover の手動統合は、Clover の呼び出しが可能なあらゆる種類のタスク (Ant、Maven 2.x、Maven 3.x、Command、Grails) と連携します。 

  1. Clover コード カバレッジ設定で、[Use Clover to collect Code Coverage for this build (Clover を使用してこのビルドのコード カバレッジを収集する)] を選択します。
  2. [Clover is already integrated into this build (Clover はこのビルドに統合済み)] を選択します。
  3. 参照場所を指定します。  Clover によって生成された XML レポート ファイルはここで Bamboo によって参照されます。

  4. [Artifacts (アーティファクト)] タブで、[Create Definition (定義を作成)] をクリックし、次のようにフォームに入力します。

    名前"Clover Report" から始める必要があります。
    場所HTML レポートのディレクトリを指す必要があります (例: target/site/clover)。
    コピー パターン**/*.* を使用します。

  5. ビルド スクリプトで Clover を設定して、XML と HTML の両方のレポートが生成されるようにします。

    <clover-report initstring="target/clover/database/clover.db">			
    <current outfile="target/site/clover/clover.xml" />
    <current outfile="target/site/clover">
        <format type="html"/>
    </current>
</clover-report>
    <plugin>
    <groupId>com.atlassian.maven.plugins</groupId>
    <artifactId>maven-clover2-plugin</artifactId>
    <configuration>
        <generateHtml>true</generateHtml>
        <generateXml>true</generateXml>
    </configuration>
</plugin>

  6. ビルド スクリプトで Clover ライセンスを設定するか、ジョブ設定の適切なタスク パラメーターとして Clover ライセンスを渡します。

    1. Clover ライセンス キーをファイル (/opt/bamboo/clover.license など) に保存します。
    2. 次の方法で、ライセンス キーの場所をビルド タスクに渡します。
      • ビルド スクリプトで場所を定義する
      • 計画設定の Ant/Maven タスクの Java プロパティとして渡す
    <plugin>
    <groupId>com.atlassian.maven.plugins</groupId>
    <artifactId>maven-clover2-plugin</artifactId>
    <configuration>
        <licenseLocation>/opt/bamboo/clover.license</licenseLocation>
    </configuration>
</plugin>
    <project>
  <property name="clover.license.path" location="/opt/bamboo/clover.license"/>
  <!-- ... -->
</project>
    clean with.clover test clover.report -Dclover.license.path=/opt/bamboo/clover.license
    mvn clean clover2:setup verify clover2:aggregate clover2:clover -Dmaven.clover.licenseLocation=/opt/bamboo/clover.license

     

     

ビルドのたびに、Bamboo は Clover XML ファイルを解析して、計画要約の統計とチャートを生成します。計画要約ページとジョブ要約ページに [Clover] タブが表示されます。 

Clover の結果を参照する

Clover HTML report and Clover statistics for a job: see Viewing the Clover code-coverage for a plan. 

Clover code coverage summary for a plan: see Viewing the Clover code-coverage for a build.

Clover code coverage statistics across multiple plans: see Generating reports across multiple plans.

Clover が動作するマシンを制限する

Clover がライセンスされているマシンの数よりも多くのリモート エージェントがある場合は、次の機能を使用して Clover が動作するマシンを制限できます。
  1. Clover でビルドを実行する EC2 イメージごとに、イメージの設定に「clover=true」などの機能を追加します。
    これを行うには、[管理] > [Elastic Bamboo] > [設定] に移動します。エラスティック イメージを選択して、[Add Capability (機能を追加)] をクリックします。
  2. 「clover=true」などの一致要件を各ジョブの設定に追加します。
    これを行うには、[アクション] > [プランを構成] > [ジョブ] の順に移動します。Clover を実行するジョブを選択して、[要件] をクリックし、次に [Add Extra Requirement (要件を追加)] をクリックします。

トラブルシューティング

自動または手動の Clover 統合と生成されたプロセス

通常は、自動 Clover 統合を使用するか、maven-clover2-plugin に依存関係を手動で追加するだけで十分です。

ただし、ビルドが別の JVM プロセスを生成する場合 (例: フォークされた JVM で実行されるユニット テスト、その場でインスタンス化されたコンテナーでのテスト、別のサーバーにデプロイされたコードの呼び出しテスト)、その生成されたプロセスの依存関係を Clover JAR に手動で追加する必要があります。

See NoClassDefFoundError com_atlassian_clover/CoverageRecorder KB article.

自動 Clover 統合とサブディレクトリでの構築

In case you perform a build in a subdirectory (for instance, in the Maven Task configuration you have the "Working sub directory" field set) and you have automatic Clover integration, you may need to correct the Location in the "Clover Report (System)" artifact. Otherwise, an HTML report may be empty as automatic Clover integration uses the default path (for instance, the "target/site/clover" in case of integration with Maven). This bug has been fixed in Bamboo 5.7.

自動 Clover 統合とマルチモジュール Maven プロジェクト

If you have a multi-module Maven project with dependencies between modules and use Automatic Clover integration, it can happen that an instrumented JAR of the dependent artifact will be taken for test execution in a build phase where Clover was not enabled yet. See BAM-13208 for more details. In such case, we recommend the following: