はじめに

このセクションでは、C/C++test と Bazel ビルドを統合し、静的解析およびコード カバレッジの収集を行う方法を説明します。

前提条件

• C/C++test がインストールされていること
• Bazel version 4.0+
• Linux のみ

C/C++test を Bazel のローカル リポジトリとして追加する

C/C++test をインストールしただけの状態では、Bazel ローカル リポジトリとして動作しません。次の手順に従って、C/C++test を Bazel のローカル リポジトリとして追加します。

1. C/C++test インストール ディレクトリの integration/bazel ディレクトリにある WORKSPACE.bazel および BUILD.bazel ファイルをインストール ディレクトリの直下に移動します。
2. プロジェクトのルートにある Bazel WORKSPACE ファイルを開きます。

3. Bazel WORKSPACE ファイルに次の記述を追加します (C/C++test のインストール ディレクトリに合わせてパスを変更してください)。

   local_repository(name = "cpptest", path = "/opt/parasoft/cpptest")

BDF 生成ルールの登録

Bazel が BDF の生成を実行するには、テスト対象の cc_library または cc_binary がある BUILD ファイルにルールを追加する必要があります。たとえば、次の Bazel BUILD ファイルがあり、"hello-world" cc_binary ルールの BDF を生成するとします。

cc_library(
    name = "hello-greet",
    srcs = ["hello-greet.cc"],
    hdrs = ["hello-greet.h"],
)

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
    deps = [
        ":hello-greet",
    ],
)

次の手順に従って Bazel での BDF 生成を登録します。

1. C/C++test が提供する Bazel 統合コードをインクルードします。それには、プロジェクトの BUILD ファイルに次の記述を追加します。

   load("@cpptest//:integration/bazel/cpptest.bzl", "cpptest_generate_bdf")

2. BDF を構成するターゲットのリストを作成します。

   targets = [ "hello-world" ]

3. ターゲットの後に次のルール宣言を追加し、BDF 生成ルールにターゲットを登録します。

   cpptest_generate_bdf(
       name = "make_bdf",
       deps = targets,
   )

   これで、cpptest_generate_bdf ルールが BUILD ファイルに登録されました。

4. BUILD ファイルを保存します。

BDF ファイルの生成

1. BDF 生成ルールを実行するには、次のようなコマンドを入力します (この例では、gcc_10-64 コンパイラと上記の "hello-world" プロジェクトを使用しています)
   

   bazel run //:make_bdf --@cpptest//:compiler-config=gcc_10-64 --@cpptest//:project-name=hello-world

   使用しているコンパイラとプロジェクトに合わせて compiler-config および project-name 引数をカスタマイズします。
   プロジェクトのルートに BDF が生成されます。

2. 生成された BDF ファイルを使用した解析の実行

   cpptestcli -config "builtin://Recommended Rules" -module . -input hello-world.bdf -compiler gcc_10-64

コード カバレッジ ルールの登録

プロジェクトの BUILD ファイルでターゲット実行ファイルにコード カバレッジを追加するには、ファイルに新規ルールを追加する必要があります。 

1. BUILD ファイルの次の行を変更します。

   load("@cpptest//:integration/bazel/cpptest.bzl", "cpptest_generate_bdf")

   次のように変更します。

   load("@cpptest//:integration/bazel/cpptest.bzl", 
       "cpptest_generate_bdf",
       "cpptest_code_coverage_executable"
   )

2. ファイルに新規ルールを追加します。

   cpptest_code_coverage_executable(
       name = "code_cov", # This can be any name
       deps = targets, # Reuse the list of targets from BDF generation 
   )

コード カバレッジが有効な実行ファイルの生成

次の手順に従って、インストゥルメントされたバイナリを生成します。 

1. 行カバレッジを指定します。それには、Bazel の run コマンドに新しいオプションを追加します。オプションの指定によって、行カバレッジを有効にして実行ファイルをインストゥルメントするよう cpptestcc に指示します。

   bazel run //:code_cov --@cpptest//:compiler-config=gcc_10-64 --@cpptest//:line-coverage

   • 生成される実行ファイルは "<TARGET_NAME>.elf" という形式であり、通常のバイナリが生成されるのと同じレベルにある bazel-bin ディレクトリに配置されます。上の例では、"hello-world.elf" が生成されます。(注意: ファイル拡張子 ".elf" の使用は任意です)
   • Bazel との統合はインストゥルメントされたバイナリを実行しません。

2. インストゥルメントされたバイナリを実行します。

   ./bazel-bin/hello-world.elf

3. カバレッジ レポートを生成します。

   cpptestcli -config builtin://Coverage -module . -input cpptest_results.clog

C/C++test の設定オプション