# C言語のgcovを使ったカバレッジ計測

## 1. 目次

1.1 はじめに

1.2 カバレッジ計測とは

1.3 gcovとは

1.4 gcovのインストールと設定

1.5 サンプルプログラムの作成

1.6 gcovを使ったカバレッジ計測の手順

1.7 gcovの出力を理解する

1.8 導入時の注意点とベストプラクティス

1.9 他のカバレッジツールとの比較

1.10 まとめ

## 1.1 はじめに

プログラムの品質を評価する際に重要な指標の一つがコードカバレッジです。コードカバレッジはソフトウェアのテストで実行されたコードの割合を示し、テストの網羅性を評価するために使用されます。本記事では、C言語プログラムのコードカバレッジ計測に使用されるツールであるgcovを紹介し、その使い方や他のツールとの比較を行います。

## 1.2 カバレッジ計測とは

コードカバレッジとは、テストを実行した際に実際に実行されたソースコードの比率を示します。これにより、どれだけのコードがテストされているかを定量的に把握することができます。以下のような種類があります：

- **ステートメントカバレッジ**: 実行された命令行の割合。

- **ブランチカバレッジ**: 条件式の各分岐が実行された割合。

- **条件カバレッジ**: 各条件のすべての結果が実行されたかを示します。

## 1.3 gcovとは

gcovはGNUプロジェクトの一部で、GCCコンパイラと連携してコードカバレッジを計測するためのツールです。gcovは特にCおよびC++で動作し、テストがカバーしたコードの部分と未テストの部分を容易に識別できるようにします。

### 1.3.1 gcovの特長

- **オープンソースであること**: 無料で使用可能。

- **統合がシンプル**: GCCと一緒に使用するための設定が簡単。

- **詳細なカバレッジレポート**: 関数ごとの詳細なカバレッジ情報を提供。

## 1.4 gcovのインストールと設定

### 1.4.1 インストール

gcovは、GCCの一部として提供されているため、通常GCCがインストールされていれば利用可能です。もしインストールされていない場合は、以下のコマンドでインストールします：

```bash

sudo apt-get update

sudo apt-get install gcc

```

### 1.4.2 設定

gcovを使用するためには、ソースコードファイルをコンパイルする際に特定のオプションを付加する必要があります：

```bash

gcc -fprofile-arcs -ftest-coverage -o my_program my_program.c

```

- `-fprofile-arcs`: 実行プロファイルデータの収集を有効にします。

- `-ftest-coverage`: テストカバレッジ情報を記録するためのコードを挿入します。

## 1.5 サンプルプログラムの作成

簡単なプログラムを作成し、そのカバレッジを計測してみましょう。以下は、対象となるC言語のサンプルプログラムです：

```c

#include <stdio.h>

void greet(int hour) {

    if (hour < 12) {

        printf("Good morning!\n");

    } else if (hour < 18) {

        printf("Good afternoon!\n");

    } else {

        printf("Good evening!\n");

    }

}

int main() {

    for (int i = 0; i < 3; i++) {

        greet(i * 8);

    }

    return 0;

}

```

このプログラムは時間帯に応じた挨拶を表示します。三つの代表的な時間帯に対して挨拶を出力するループがあります。

## 1.6 gcovを使ったカバレッジ計測の手順

### 1.6.1 コンパイルと実行

最初に、次のようにコンパイルと実行を行います：

```bash

gcc -fprofile-arcs -ftest-coverage -o greet greet.c

./greet

```

### 1.6.2 gcovの実行

プログラムの実行後、`gcov`コマンドを使ってカバレッジデータを生成します：

```bash

gcov greet.c

```

実行すると、以下のようなファイルが生成されます：

- `greet.gcda`

- `greet.gcno`

- `greet.c.gcov`

### 1.6.3 生成されたファイルの役割

- **`greet.gcda`**: 実行時に生成されるデータファイルで、カバレッジ情報を含む。

- **`greet.gcno`**: コンパイル時に生成されるファイルで、gcovがカバレッジ情報を付加するためのメタデータを持つ。

- **`greet.c.gcov`**: カバレッジ情報を視覚化したテキストファイル。

## 1.7 gcovの出力を理解する

生成された`greet.c.gcov`ファイルは次のような出力を持つかもしれません：

```

        -:    0:Source:greet.c

        -:    0:Graph:greet.gcno

        -:    0:Data:greet.gcda

        -:    0:Runs:1

        -:    0:Programs:1

        1:    1:#include <stdio.h>

        1:    2:

        1:    3:void greet(int hour) {

        3:    4:    if (hour < 12) {

        1:    5:        printf("Good morning!\n");

        -:    6:    } else if (hour < 18) {

        1:    7:        printf("Good afternoon!\n");

        -:    8:    } else {

        1:    9:        printf("Good evening!\n");

        -:   10:    }

        -:   11:}

        1:   12:

        1:   13:int main() {

        1:   14:    for (int i = 0; i < 3; i++) {

        3:   15:        greet(i * 8);

        -:   16:    }

        1:   17:    return 0;

        -:   18:}

```

数字が表示されている行が実行されたことを示し、「-」は実行されなかった行を示します。

## 1.8 導入時の注意点とベストプラクティス

gcovを用いる際には以下の点に注意する必要があります：

- **最適化の無効化**: カバレッジ情報の精度を保つために、最適化オプション（`-O2`や`-O3`など）は使用を控える。

- **正しい計測ターゲットの選択**: ライブラリやデバイスドライバなど、実際にテスト可能なコードをターゲットに設定する。

- **コンパイルと実行の環境一致**: カバレッジを測定する実行とビルド環境は一致していることが望ましい。

## 1.9 他のカバレッジツールとの比較

C言語では、gcov以外にもいくつかのカバレッジツールが利用可能です：

### 1.9.1 lcov

lcovはgcovの拡張で、HTMLフォーマットでリポートを生成します。これにより、視覚的にわかりやすいインターフェースでカバレッジデータを確認できます。

### 1.9.2 gprof

プロファイルデータ収集と性能解析に強みを持つgprofは、カバレッジデータ計測の補完的な役割を果たします。

### 1.9.3 比較

以下に、gcovと他のツールを比較するテーブルを示します：

| ツール  | 主要機能                    | 特徴                      |

|--------|----------------------------|-------------------------|

| gcov   | コードカバレッジ計測          | 軽量でGCCに標準搭載       |

| lcov   | HTMLレポート生成            | インタラクティブな可視化   |

| gprof  | プロファイルデータと性能解析   | 詳細なパフォーマンス分析   |

## 1.10 まとめ

gcovは、C言語でプログラムを開発する際に、コードカバレッジを効果的に測定するためのツールとして非常に有用です。簡単な設定と実行方法を知っているだけで、テストの網羅性を評価し、未テストの部分を特定することができます。他のツールとも比較しながら、プロジェクトに最適なツールを選択することが成功への鍵となります。gcovを使いこなし、より堅牢なプログラム開発を目指しましょう。

C言語のgcovを使ったカバレッジ計測

1. 目次

続きを読むには単価診断を受けてください（30秒）