GoogleTest 実行結果の着色ルール

1 概要

GoogleTest は、テスト実行結果の視認性を高めるため、ターミナル出力に ANSI カラーコードを使用します。このドキュメントでは、出力行の見出し部 (角括弧で囲まれた部分) に適用される色を説明します。

2 色の定義

GoogleTest の内部では、以下の 4 つの色が定義されています。

3 見出し行と着色の対応

テスト実行中に表示される見出し行と、それぞれに適用される色を以下に示します。

3.1 テスト実行フェーズ

3.2 テスト結果

3.3 その他の情報出力

4 出力例

以下は、典型的なテスト実行結果の出力例です。

[==========] Running 3 tests from 2 test suites.      <- 緑
[----------] Global test environment set-up.          <- 緑
[----------] 2 tests from FooTest                     <- 緑
[ RUN      ] FooTest.DoesAbc                          <- 緑
[       OK ] FooTest.DoesAbc (0 ms)                   <- 緑
[ RUN      ] FooTest.HasXyzProperty                   <- 緑
[  FAILED  ] FooTest.HasXyzProperty (1 ms)            <- 赤
[----------] 2 tests from FooTest (1 ms total)        <- 緑
[----------] 1 test from BarTest                      <- 緑
[ RUN      ] BarTest.SkippedOnCondition               <- 緑
[ SKIPPED  ] BarTest.SkippedOnCondition (0 ms)        <- 黄
[----------] 1 test from BarTest (0 ms total)         <- 緑
[----------] Global test environment tear-down        <- 緑
[==========] 3 tests from 2 test suites ran. (2 ms)   <- 緑
[  PASSED  ] 1 test.                                  <- 緑
[ SKIPPED  ] 1 test, listed below:                    <- 黄
[ SKIPPED  ] BarTest.SkippedOnCondition               <- 黄
[  FAILED  ] 1 test, listed below:                    <- 赤
[  FAILED  ] FooTest.HasXyzProperty                   <- 赤

 1 FAILED TEST

5 色出力の制御

色の有効・無効は、以下の方法で制御できます。

5.1 コマンドラインオプション

./test_binary --gtest_color=yes   # 常に色を使用
./test_binary --gtest_color=no    # 色を使用しない
./test_binary --gtest_color=auto  # 自動判定 (デフォルト)

5.2 環境変数

export GTEST_COLOR=1    # 色を有効化
export GTEST_COLOR=0    # 色を無効化

5.3 auto モードの判定条件

--gtest_color=auto (デフォルト) の場合、以下の条件をすべて満たすときに色が有効になります。

• 出力先がターミナル (TTY) である
• UNIX 系 OS の場合、環境変数 TERM が xterm または xterm-color に設定されている
• Windows の場合、コンソールがカラー出力をサポートしている

6 ソースコード上の実装

着色は gtest.cc 内の PrettyUnitTestResultPrinter クラスで実装されています。主要なメソッドを以下に示します。

7 着色フィルターの使用

Windows 環境などでエスケープシーケンスなしの出力に色を付けるフィルタースクリプトについて説明します。

test.exe | python add_gtest_color.py

このフィルターは、見出し部 (角括弧で囲まれた部分) のみに色を付け、本文はそのまま出力します。

8 フィルターの可逆性について

8.1 結論

テキストベースのフィルターは、元の GoogleTest の着色と ほぼ完全に可逆 です。ただし、以下の制約があります。

8.2 可逆である部分

標準的なテスト実行で出力されるすべての見出しは、テキストパターンから一意に色を復元できます。

8.3 可逆性の技術的根拠

元の GoogleTest ソースコード (gtest.cc) では、PrettyUnitTestResultPrinter クラスが以下のように着色を行っています。

// OnTestStart - テスト開始時
ColoredPrintf(GTestColor::kGreen, "[ RUN      ]");

// OnTestEnd - テスト終了時
if (result.Skipped()) {
  ColoredPrintf(GTestColor::kYellow, "[ SKIPPED  ]");
} else if (result.Passed()) {
  ColoredPrintf(GTestColor::kGreen, "[       OK ]");
} else {
  ColoredPrintf(GTestColor::kRed, "[  FAILED  ]");
}

この実装から、見出し文字列と色は 1 対 1 で対応しており、テキストから色を一意に復元できます。

8.4 可逆でない可能性がある部分

以下のケースでは、フィルターが対応できない可能性があります。

1. カスタム TestEventListener の出力: ユーザーが独自の Listener を実装し、標準と異なる見出しを使用した場合

2. 将来の GoogleTest バージョン: 新しい見出しが追加された場合は、フィルターの更新が必要

3. サードパーティツールの出力: GoogleTest 互換のフォーマットでも、微妙に異なるスペーシングを使用している場合

8.5 検証方法

フィルターの正確性を確認するには、以下のコマンドで元の出力と比較できます。

./test.exe --gtest_color=yes > colored.txt

./test.exe --gtest_color=no | python add_gtest_color.py > filtered.txt

diff colored.txt filtered.txt

9 参考リンク

• GoogleTest Advanced Topics - Colored Terminal Output
• GoogleTest ソースコード (gtest.cc)
• GTEST_SKIP によるテストスキップ機能 (PR #1544)