CTestCoverageの達人になる！ CTEST_COVERAGE_EXTRA_FLAGSでテストカバレッジ計測を詳細に制御する方法

CMakeにおけるCTEST_COVERAGE_EXTRA_FLAGS変数の詳細解説

設定方法

CTEST_COVERAGE_EXTRA_FLAGS は、CMakeLists.txtファイル内で以下の方法で設定できます。

set(CTEST_COVERAGE_EXTRA_FLAGS "-g -O0")

上記例では、テスト対象プログラムに -g と -O0 オプションを付与しています。

• -g オプションは、デバッグ情報を生成します。これは、テストカバレッジ計測ツールがテスト対象プログラムのコード行とカバレッジ率を正確に関連付けるために必要です。
• -O0 オプションは、最適化を無効にします。これは、テストカバレッジ計測ツールがテスト対象プログラムのすべてのコード行が実行されるようにするために必要です。

使用可能なオプションフラグ

CTEST_COVERAGE_EXTRA_FLAGS で使用可能なオプションフラグは、テストカバレッジ計測ツールによって異なります。以下は、一般的なオプションフラグの例です。

• GCC:
  • -fprofile-arcs : 各基本ブロックが実行された回数を出力します。
  • -ftest-coverage : テストカバレッジ計測機能を有効にします。
• Lcov:
  • -c : コードカバレッジ計測を有効にします。
  • -d : テスト対象プログラムのソースコードディレクトリを指定します。

補足

• CTEST_COVERAGE_EXTRA_FLAGS は、テストカバレッジ計測を行う場合にのみ設定する必要があります。
• テスト対象プログラムに渡されるオプションフラグは、テストカバレッジ計測ツールだけでなく、コンパイラやリンカなどの他のツールによっても使用される可能性があります。そのため、CTEST_COVERAGE_EXTRA_FLAGS で設定するオプションフラグは、これらのツールと互換性があることを確認する必要があります。
• テストカバレッジ計測を行う際には、テスト対象プログラムのすべてのコード行が実行されるようにテストケースを設計する必要があります。

CMakeにおけるCTEST_COVERAGE_EXTRA_FLAGS変数のサンプルコード

GCCとGcovを使用したサンプルコード

set(CMAKE_C_COMPILER gcc)
set(CMAKE_CXX_COMPILER g++)

set(CTEST_COVERAGE_EXTRA_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")

add_executable(my_program main.c)

add_test(NAME my_program_test
  COMMAND ./my_program)

ctest_coverage(my_program_test)

• -g オプションは、デバッグ情報を生成します。
• -O0 オプションは、最適化を無効にします。

ClangとLCOVを使用したサンプルコード

set(CMAKE_C_COMPILER clang)
set(CMAKE_CXX_COMPILER clang++)

set(CTEST_COVERAGE_EXTRA_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")

add_executable(my_program main.c)

add_test(NAME my_program_test
  COMMAND ./my_program)

ctest_coverage(my_program_test)

# LCOVを使用してテストカバレッジレポートを生成する
lcov --directory . --capture --output-file coverage.info
genhtml coverage.info --output-directory coverage

このコードは、ClangとLCOVを使用してテストカバレッジ計測を行う例です。

複数のテスト対象プログラム

set(CMAKE_C_COMPILER gcc)
set(CMAKE_CXX_COMPILER g++)

set(CTEST_COVERAGE_EXTRA_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")

add_executable(my_program1 main1.c)
add_executable(my_program2 main2.c)

add_test(NAME my_program1_test
  COMMAND ./my_program1)

add_test(NAME my_program2_test
  COMMAND ./my_program2)

ctest_coverage(my_program1_test)
ctest_coverage(my_program2_test)

このコードは、複数のテスト対象プログラムに対してテストカバレッジ計測を行う例です。

CTEST_COVERAGE_EXTRA_FLAGS 以外のテストカバレッジ計測方法

テストカバレッジ計測ツール

• Gcov: GCC のテストカバレッジ計測ツールです。
• Lcov: Gcov の出力データを処理して、HTML 形式のレポートを生成するツールです。
• Coveralls: テストカバレッジ計測結果をオンラインで共有できるサービスです。

これらのツールは、CMake とは別にインストールする必要があります。

CMake GUI を使用してテストカバレッジ計測を行うこともできます。

1. CMake GUI でプロジェクトを開きます。
2. ツールバーの Coverage ボタンをクリックします。
3. Coverage Options ダイアログで、テストカバレッジ計測ツールを選択します。
4. OK ボタンをクリックします。

CMake GUI は、テストカバレッジ計測結果を HTML 形式で表示することができます。

その他の方法

• CMakeLists.txt ファイルで直接オプションフラグを設定する
• テスト対象プログラムを直接変更する

これらの方法は、CTEST_COVERAGE_EXTRA_FLAGS よりも高度な知識が必要となります。