このセクションの内容

はじめに

C/C++test のマルチメトリクス カバレッジ解析機能は、スタンドアロンアプリケーションやライブラリを C/C++test の外で実行した際のコード カバレッジをモニターできます。

C/C++testには、以下のコンポーネントからなるスタンドアロンのカバレッジ パッケージが付属しています。

• <INSTALL_DIR>/cpptestcc - ビルド プロセスに統合し、カバレッジデータを収集できるようアプリケーションをインストゥルメントするカバレッジツールです。
  
• <INSTALL_DIR>/engine/coverage/runtime - インストゥルメントされたアプリケーションに統合する必要があるカバレッジランタイム ライブラリです。

1. cpptestcc ツールをビルドに統合し、アプリケーションをインストゥルメントする。
2. インストゥルメントされたコードを実行し、raw カバレッジ データを収集する。
3. ビルトイン テスト コンフィギュレーションを使用して raw カバレッジ データを C/C++test にインポートし、C/C++test でカバレッジを確認する。

cpptestccのクイックスタート

1. コンパイル コマンドを変更し、-- を区切り文字としたコンパイラコマンドの接頭辞としてcpptestcc実行モジュールを含めます。 例:
   

   元のコンパイル コマンド ライン

   cc -I app/includes -D defines -c source.cpp

   変更後のコンパイル コマンド ライン
   

   cpptestcc -compiler gcc_9-64 -line-coverage -- cc -I app/includes -D defines -c source.cpp

   cpptestcc ツールを利用するには、少なくとも以下のパラメーターがコマンドラインに設定されている必要があります。

   - コンパイラ識別子-compiler <COMPILER_ID>

   - カバレッジメトリクス (例: -decision-coverage)

   その他のオプションについては、「cpptestcc コマンド ライン リファレンス」を参照してください。


2. リンカー コマンドを変更し、C/C++test に付属のビルド済みカバレッジランタイム ライブラリへのパスを指定して、アプリケーションにこのライブラリを追加します。例:
   

   元のコンパイル コマンド ライン
   

   lxx -L app/lib app/source.o somelib.lib -o app.exe

   変更後のコンパイル コマンド ライン
   

   lxx -L app/lib app/source.o somelib.lib [INSTALL_DIR]/engine/coverage/runtime/lib/cpptest.lib -o app.exe

   重要

   カバレッジ ランタイムのライブラリが共有 (動的ロード) ライブラリとしてリンクされる場合、インストゥルメントされたアプリケーションの開始時にカバレッジ ツールのライブラリを確実にロードできるようにする必要があります。通常は、 <INSTALL_DIR>/engine/coverage/runtime/bin を PATH 環境変数に追加するか (Windows の場合)、または <INSTALL_DIR>/engine/coverage/runtime/lib  を LD_LIBRARY_PATH 環境変数に追加する必要があります (Linux の場合)。

   C/C++test には、Window および Linux のネイティブ アプリケーション用にビルド済みのカバレッジ ランタイム ライブラリが付属しています。クロスプラットフォームおよび組み込みテストの場合は、  <INSTALL_DIR>/engine/coverage/runtime/bin のソースからランタイム ライブラリをビルドする必要があります。 詳細は「カバレッジ ランタイム ライブラリ」を参照してください。
   

3. アプリケーションをビルドします。コードをインストゥルメントする際、cpptestccは .cpptest/cpptestcc フォルダーを作成します。ここには、重要なカバレッジ関連データ (「カバレッジ マップ」) が保存されます。デフォルトでは、フォルダーは現在のコンパイルの作業ディレクトリに作成されます。-workspace <path> オプションを使用してデフォルトの場所を変更できます。詳細は「cpptestcc コマンド ライン リファレンス」を参照してください。 
   
4. アプリケーションを実行します。cpptest_results.clogファイルにカバレッジ データ (「カバレッジ ログ」) が保存されます。
   
5. C/C++test がインストールされた IDE で、アプリケーションのすべてのソース ファイルを含む新規プロジェクトを作成します。
   ファイルおよびすべてのパスに変更がないことを確認します。
   
6. プロジェクトを選択し、IDE のメニューで [Parasoft] > [テスト コンフィギュレーション] > [Utilities] > [Load Application Coverage] をクリックしてカバレッジ データをインポートします (詳細は「カバレッジ データのインポート」を参照)。
   
7. カバレッジ情報を参照します (「カバレッジ情報の参照」を参照)。

カバレッジ データのインポート

Load Application Coverage テスト コンフィギュレーションは、.cpptest/cpptestcc フォルダーと cpptest_results.clog ファイルの両方がデフォルトの場所にあると仮定します。場所をカスタマイズするには、テスト コンフィギュレーションの実行の詳細オプション ([実行] > [全般] > [実行の詳細]) で以下のように設定します。
- Coverage map files root location - デフォルト: ${project_loc}/.cpptest/cpptestcc
- Coverage log files - デフォルト: ${project_loc}/*.clog

デフォルトでは、Load Application Coverage テスト コンフィギュレーションは、すべてのサポート対象カバレッジ メトリクスの情報をロードしようとします。サポート対象カバレッジ メトリクスのリストをカスタマイズするには、 [実行] > [全般] > [実行の詳細] > [インストゥルメント モード] > [インストゥルメント機能]> [C/C++ コード カバレッジ メトリクス] に移動し、レポートしたいメトリクスを選択します。

コンパイル コマンドラインで cpptestcc ツールに対して有効に指定したメトリクスと一貫性を保つよう推奨します。

MSBuild プロジェクトのアプリケーション カバレッジの収集

C/C++test には、カバレッジ解析を統合するよう MSBuild プロジェクトをすばやく再設定するスクリプトが付属しています。このスクリプトは、Visual Studio および CMake で生成された MSBuild プロジェクトの両方をサポートします。スクリプトはターゲットの .vcxproj ファイルのバックアップを作成し、要求された Parasoft 機能をすべてのビルド ターゲットで使用できるようにプロジェクトを変更します。

C/C++test には、インクルードされたツールを実行するための Python スクリプトが付属しています。スクリプトは次の場所にあります。

<CPPTEST_INSTALL_DIR>/engine/bin/cpptestpy.exe

<CPPTEST_INSTALL_DIR>/integration/msbuild/msbuild_cpptest.py

MSBuild プロジェクトのカバレッジを取得するには、次の操作を行います。

1. 環境変数をセットアップします。

= の後にダブル クオーテーションを使用しないようにしてください。使用すると、文字列が誤って解釈されます。 

1. 1. CPPTEST_INSTALL_DIR 変数をセットアップします。

      set CPPTEST_HOME=<CPPTEST_INSTALL_DIR>

   2. PATH 変数をセットアップします。

      set PATH=%PATH%;%CPPTEST_HOME\engine\coverage\runtime\bin

2. (CMake のみ) CMake を使用して MSBuild ファイルを生成します。 

   cd <PROJECT_DIR>
   mkdir build
   cd build
   cmake ..

3. 統合スクリプトを実行します。 

   <cpptestpy.exe> <msbuild_cpptest.py> -c -f project.vcxproj

4. MSBuild を使用してプロジェクトをビルドします。

   msbuild -t:Rebuild project.sln

5.  カバレッジを収集するには、ビルド ディレクトリに移動してプロジェクトを実行します。

   cd x64\Debug
   project.exe

   現在の作業ディレクトリにカバレッジ情報を含む .clog ファイルが作成されます。
   デフ ォルトのファイル名は cpptest_results.clog です。

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

   cpptestcli.exe \
   -solution Sensor.sln \
   -config "builtin://Load Application Coverage"

cpptestcc コマンド ライン リファレンス

次のコマンドを実行すると、利用可能なオプションがコンソールに表示されます: cpptestcc -help

以下のオプションがあります。

<project root> + external_libs + src + include

<project root> <sourcefiles>.cpp <headerfiles>.hpp

カバレッジ ランタイム ライブラリ

カバレッジ ランタイム ライブラリは、アプリケーション実行時にカバレッジ情報を出力するためにソース コード インストゥルメンテーションによって使用されるヘルパー関数およびサービスのコレクションです。インストゥルメントされたアプリケーションは、ライブラリなしではリンクできません。ランタイム ライブラリを最終的なテスト可能なバイナリにリンクする方法は、テスト対象プロジェクトのタイプに応じて複数あります。

インストゥルメントされたコードに基本的なサービスを提供するほか、ライブラリはコード カバレッジ ソリューションを特定の開発環境向けに調整するためにも使用されます。たとえば、テスト対象の組み込みデバイスと開発ホストの間でカバレッジ結果を送受信するために非標準的なトランスポートをサポートする場合などです。

ビルド済みのバージョンとカスタマイズされたビルド

C/C++test にはランタイム ライブラリのビルド済みのバージョンが付属しています。これらのバージョンは、C/C++test がインストールされているのと同じプラットフォームでの使用に適しています。多くの場合、ネイティブで開発されたアプリケーションは、ランタイム ライブラリのビルド済みのバージョンを使用してコード カバレッジを収集できます。

クロスプラットフォームのアプリケーションを開発するユーザーは、適切なクロス コンパイラおよび場合によってはリンカーを使用してカバレッジ ランタイム ライブラリのカスタム ビルドを用意する必要があります。C/C++test にはコード カバレッジ ランタイム ライブラリのソース コードが付属しています。

カバレッジ ランタイム ライブラリのカスタム ビルドの準備に必要なプロセスは、通常は、カバレッジ ランタイム ライブラリのソース コードをコンパイルすることだけです。状況によっては、一部のソース コードをインストールしてコード カバレッジを特定の開発プラットフォーム向けに変更する必要がある場合もあります。このプロセスについては、後のセクションで説明します。

ビルド済みランタイム ライブラリの使用

C/C++test には以下のバイナリ ファイルが含まれています。

Windows (x86 および x86-64) 

あらかじめ用意されていない形式のランタイム ライブラリを使用する必要がある場合、特定の開発環境の要件に合わせたカバレッジ ランタイム ライブラリのカスタム ビルドを用意します。詳細については、「ランタイム ライブラリのカスタマイズ」を参照してください。

リンカー コマンド ラインとの統合

カバレッジ ランタイム ライブラリをテスト対象アプリケーションと統合するリンク プロセスでは、通常はリンカー コマンド ラインの変更が必要であり、場合によっては実行環境の変更も必要です。このセクションでは、C/C++test に付属しているビルド済みのバージョンを使用する場合にリンク プロセスを変更する方法を説明します。

Windows Cygwin GNU GCC コンパイラ用の静的ライブラリの場合

1. ビルド スクリプト内のリンカー コマンド ラインを特定します。
2. ビルド スクリプトを変更し、リンカー コマンド ラインの任意の場所にカバレッジ ランタイム ライブラリを指定します。できればすべてのオブジェクト ファイルの後に指定します。

Microsoft Visual C++ コンパイラ用の動的リンク ライブラリの場合

1. ビルド スクリプト内のリンカー コマンド ラインを特定します。

2. ビルド スクリプトを変更し、リンカー コマンド ラインの任意の場所にカバレッジ ランタイム ライブラリを指定します。できればすべてのオブジェクト ファイルの後に指定します。例:

   $(LXX) $(PRODUCT_OBJ) $(OFLAG_EXE)$(PROJ_EXECUTABLE) $(LXXFLAGS) $(SYSLIB) $(EXECUTABLE_LIB_LXX_OPTS) <INSTALL_DIR>/engine/coverage/runtime/lib/cpptest.lib

3. PATH 環境変数に lib ディレクトリへのパスが追加され、テスト対象プログラム起動時にライブラリを発見できるようになっていることを確認します。cpptest.dll(またはcpptest64.dll) ファイルを実行モジュールと同じディレクトリ、またはテスト対象アプリケーションの起動時に動的リンク ライブラリを検索するその他の場所にコピーすることを検討するとよいでしょう。

GNU GCC コンパイラ用共有ライブラリの場合

1. ビルド スクリプト内のリンカー コマンド ラインを特定します。

2. ビルド スクリプトを変更し、リンカー コマンド ラインの任意の場所にカバレッジ ランタイム ライブラリを指定します。できればすべてのオブジェクト ファイルの後に指定します。例:

   $(LXX) $(PRODUCT_OBJ) $(OFLAG_EXE)$(PROJ_EXECUTABLE) $(LXXFLAGS) $(SYSLIB) $(EXECUTABLE_LIB_LXX_OPTS) -L <INSTALL_DIR>/engine/coverage/runtime/lib -lcpptest

   -L および -lcpptest オプションが追加されていることに注意してください。

3. テスト対象実行モジュールが共有ライブラリへのパスを見つけられるよう、LD_LIBRARY_PATH 環境変数に lib ディレクトリへのパスが追加されていることを確認します。

ランタイム ライブラリのカスタマイズ

以下の条件に当てはまる場合、ランタイム ライブラリをカスタマイズする必要がある可能性があります。

• 別の形式のバイナリ ファイルが必要である。
• 結果を転送するためにデフォルト以外の通信チャネルを有効にする
• 結果を転送するために通信チャネルのカスタム 実装をインストールする
• デフォルトではサポートされないマルチスレッド アプリケーションのサポートを有効にする
• マルチスレッド アプリケーションをサポートするためのカスタム実装をインストールする
• 複数のインストルメントされたバイナリが 1 つのログ ファイルに書き込んでいる

ライブラリのソース コードの構造

C/C++test に付属しているランタイム ライブラリのソース コードは、[INSTALL_DIR]/engine/coverage/runtime ディレクトリにあります。次の表は、使用方法の説明です。 

通信チャネルサポートの切り替え

ランタイム ライブラリはさまざまな通信チャネル経由でのデータ収集をサポートしています。使用される通信チャネルは開発環境に依存します。多くの場合、結果を 1 つまたは複数のファイルに格納するのが適切ですが、TCP/IP ソケットまたは RS232 による転送が必要な場合もあります。cpptest.c ライブラリ ソース ファイルをコンパイルするときに専用のマクロに値を設定することで、特定の通信チャネルを有効にできます。値を設定するには、コンパイル コマンド ラインに -D<MACRO> を追加します。次の表は、通信チャネル制御マクロの一覧です。  

提供されている Makefile でカバレッジ ランタイム ライブラリをビルドする場合、[INSTALL_DIR]/engine/coverage/runtime/channel ディレクトリにある make 設定ファイルを使用できます。

カスタム通信チャネルのサポートをインストール

お使いの開発環境に合う通信チャネルの実装がない場合、カスタム実装を使用できます。次の手順は、ランタイム ライブラリをカスタマイズして通信チャネルのカスタム実装を使用する方法を説明しています。 

1. [INSTALL_DIR]/engine/coverage/runtime/src/cpptest.c をコピーし、編集用に開きます。

2. セクション 1.13 "Custom Communication Implementation" の場所を探します。
   カスタム通信の実装セクションには、4 つの異なるメソッドのための空のテンプレートがあります。

   関数	説明
   void cpptestInitializeStream(void)	この関数は通信チャネルの初期化を行います。たとえば、ソケットの作成および接続や、UART デバイスの初期化などを行います。
   void cpptestFinalizeStream(void)	この関数は、通信チャネルの後処理を行います。たとえば、TCP/IP ソケットのクローズなどを行います。
   int cpptestSendData(const char *data, unsigned size)	この関数は、データ バッファーからのサイズ バイトを送信します。
   void cpptestFlushData(void)	この関数は、データをフラッシュします。フラッシュの意味は、トランスポートタイプによって異なります。一部の実装では、あまり意味がない可能性もあります。その場合、関数は空のままにしておきます。

3. お使いの環境の要件に合わせてこれらのメソッドを実装します。
4. コンパイル コマンド ラインに次のマクロ定義を付加して cpptest.c をコンパイルします。
   "-DCPPTEST_CUSTOM_COMMUNICATION"
5. 生成されたオブジェクトファイルでは不十分な場合、要求に合わせてさらにファイルを処理できます (共有ライブラリを作成するなど)。

マルチスレッド API サポートの切り替え

ランタイム ライブラリはマルチスレッド アプリケーションをサポートします。POSIX、Windows、および VxWorks API がサポートされます。cpptest.c をコンパイルする際にコマンド ラインに -D<MACRO> を追加することで特定のマルチスレッド API のサポートを有効化できます。次の表は、マルチスレッド API サポート制御マクロの一覧です。

カスタム スレッド API サポートのインストール

サポート対象外のマルチスレッド API を使用するマルチスレッド アプリケーションと共に C/C++test のカバレッジ エンジンを使用する場合、お使いのマルチスレッド API と共に動作するようランタイム ライブラリをカスタマイズできます。それには、次の手順を行う必要があります。

1. [INSTALL_DIR]/engine/coverage/runtime/src/cpptest.c をコピーし、編集用に開きます。

2. セクション 2.5 "Custom Communication Implementation" の場所を探します。
   カスタム通信の実装セクションには、4 つの異なるメソッドのための空のテンプレートがあります。

   関数	説明
   static int cpptestLock(void)	この関数は、カバレッジ ツール ランタイム ライブラリ内の処理が同期されることを保証します。あるスレッドがランタイム ライブラリ サービスへのアクセスをロックした場合、その間はアトミックな処理が行われ、他のスレッドがランタイム ライブラリ サービスを使用できないことを意味します。ロックが解放されると、他のスレッドがランタイム ライブラリ サービスを使用できるようになります。
   static int cpptestUnlock(void)	ランタイム ライブラリ サービスを解放します。

3. お使いの環境の要件に合わせてこれらのメソッドを実装します。

4. コンパイル コマンド ラインに次のマクロ定義を付加して cpptest.c をコンパイルします。
   "-DCPPTEST_CUSTOM_THREADS"

5. 生成されたオブジェクト ファイルが十分ではない場合、ニーズに合わせてさらにファイルを編集できます (たとえば共有ライブラリを作成するなど)。

複数のインストルメントされたバイナリが 1 つのログ ファイルに書き込んでいる

1 つのカバレッジ ログ ファイル (.clof) が並行して実行される複数のインストゥルメントされたバイナリによって使用される場合、ランタイム ライブラリで複数プロセスのサポートを有効にする必要があります。

複数プロセスのサポートを有効にするには、コンパイル コマンド ラインに次のマクロを追加して cpptest.c をコンパイルします。
"-DCPPTEST_MULTI_PROCESSES_LOG=1"

ランタイム ライブラリのビルド

C/C++test にはランライム ライブラリのビルド プロセスを簡略化するシンプルな Makefile (「ライブラリのソース コードの構造」を参照) が付属しています。しかし、ソース コードがすでにビルド プロセス用に最適化されているため、多くの場合、付属の make ファイルは必要ありません。唯一の必須の手順は、メイン cpptest.c ソース ファイルをコンパイルすることです。生成されたオブジェクト ファイルをさらに処理する必要があるかどうかは、個々の開発環境や、ランタイム ライブラリを共有ライブラリとして提供するかなどの要件によります。

付属の Makefile を使用したランタイム ライブラリのビルド

1. <INSTALL_DIR>/engine/coverage/runtime をローカル ディレクトリにコピーします。

2. コンパイル フラグを変更する必要がある場合 (たとえばクロスコンパイラやランタイム ライブラリの再設定を強制する定義を追加するなど)、ターゲット サブディレクトリに新しく make 設定ファイルを用意します。作業を簡単にするため、既存のターゲット設定ファイルをコピーし、ニーズに合わせて内容を変更できます。

3. 次のコマンド ラインを呼び出すと、単一のオブジェクト cpptest.<OBJ_EXT> を含むサブディレクトリ build が作成されます。それを使用してインストゥルメントされたアプリケーションとリンクできます。

   make TARGET_CFG=<target config file name> CHANNEL_FILE=<channel config file name>

   コマンドは次のようになります。

   make TARGET_CFG=gcc-static.mk CHANNEL_FILE=channel/unix-socket.mk

   チャネル タイプを指定することもできます。

   make TARGET_CFG=gcc-static.mk CHANNEL_TYPE=unix-socket

4. カバレッジ ランタイム ライブラリを共有ライブラリ、動的リンク ライブラリ、またはその他のバイナリ形式でリンクする必要がある場合、目的に合わせて Makefile をカスタマイズするか、カスタム ビルドをセットアップする必要があります。

ランタイム ライブラリのユーザー ビルド

カバレッジ ランタイム ライブラリのユーザー ビルドをセットアップするには、次の操作を行います。

1. <INSTALL_DIR>/engine/coverage/runtime/src/cpptest.c から任意の場所に cpptest.c ファイルをコピーします。

2. 「Customizing the Runtime Library」の説明に従って、任意のカスタマイズを行います。
3. 任意のビルド システムをセットアップします (例: IAR Embedded Workbench プロジェクトまたはその他のソース コード ビルダー)。

4. コンパイル フラグを変更し、コンパイラ インクルード フラグ (通常は -I) に次の値を含めます。-I <INSTALL_DIR>/engine/coverage/runtime/include

5. 必要な設定があれば追加します (よくあるのは -D) 。例:
   -DCPPTEST_FILE_COMMUNICATION -DCPPTEST_NO_THREADS
6. ビルダーを実行します (たとえば、IDE でビルド コマンドを選択します)。
7. 結果として作成されたオブジェクト ファイルの場所を確認し、インストゥルメントされたアプリケーションとリンクします。

コード カバレッジのトラブルシューティング

cpptestcc -disable-auto-recovery-mode [...]

cpptestcc -coverage-data-variants [...]