CMakeのCTEST_CUSTOM_WARNING_EXCEPTION変数を使って警告メッセージを無視する方法

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

変数の役割

CTEST_CUSTOM_WARNING_EXCEPTIONは、正規表現のリストとして設定されます。テストの実行中に、CTestは各警告メッセージをこのリストと照合します。メッセージがリスト内のいずれかの正規表現に一致した場合、その警告は出力されません。

設定方法

CTEST_CUSTOM_WARNING_EXCEPTIONは以下の方法で設定できます。

• CMakeLists.txtファイル

set(CTEST_CUSTOM_WARNING_EXCEPTION
  "some_warning_message_pattern"
  "another_warning_message_pattern"
)

• ctestコマンドラインオプション

ctest -D CTEST_CUSTOM_WARNING_EXCEPTION="some_warning_message_pattern"

正規表現の書式

CTEST_CUSTOM_WARNING_EXCEPTIONで使用される正規表現は、Perl互換の正規表現です。詳細は、PCRE: [無効な URL を削除しました]。

使用例

以下は、CTEST_CUSTOM_WARNING_EXCEPTIONを使用して特定の警告メッセージを無視する例です。

set(CTEST_CUSTOM_WARNING_EXCEPTION
  "^.*warning.*$"
)

この設定により、テストの実行中に"warning"という文字列を含むすべての警告メッセージが無視されます。

注意点

• CTEST_CUSTOM_WARNING_EXCEPTIONは、テストスイート全体に適用されます。特定のテストケースでのみ警告メッセージを無視したい場合は、ctest_testコマンドのWARNING_EXCEPTIONオプションを使用する必要があります。
• 正規表現のパターンに誤りがあると、テスト結果が誤って解釈される可能性があります。

補足

• CTEST_CUSTOM_WARNING_EXCEPTIONは、CTest 2.8以降で使用可能です。
• CTest 3.15以降では、ctest_testコマンドのWARNING_EXCEPTION_PATTERNSオプションを使用して、テストケースごとに異なる警告メッセージを無視することができます。

CTEST_CUSTOM_WARNING_EXCEPTIONは、テストの実行中に不要な警告メッセージを抑制し、テスト結果の読みやすさを向上させるために役立ちます。設定方法は簡単で、正規表現を使用して特定の警告メッセージを無視することができます。

CTEST_CUSTOM_WARNING_EXCEPTIONサンプルコード

特定の警告メッセージを無視する

set(CTEST_CUSTOM_WARNING_EXCEPTION
  "^.*warning.*$"
)

複数の警告メッセージを無視する

set(CTEST_CUSTOM_WARNING_EXCEPTION
  "^.*warning.*$"
  "^.*deprecated.*$"
)

この設定により、テストの実行中に"warning"または"deprecated"という文字列を含むすべての警告メッセージが無視されます。

特定のファイルからの警告メッセージを無視する

set(CTEST_CUSTOM_WARNING_EXCEPTION
  "^.*my_file.cpp.*warning.*$"
)

この設定により、テストの実行中にmy_file.cppファイルからのみ"warning"という文字列を含む警告メッセージが無視されます。

正規表現を使用して複雑なパターンを無視する

set(CTEST_CUSTOM_WARNING_EXCEPTION
  "^.*(function_name|class_name).*warning.*$"
)

この設定により、テストの実行中にfunction_nameまたはclass_nameを含む関数またはクラスからのみ"warning"という文字列を含む警告メッセージが無視されます。

CTEST_CUSTOM_WARNING_EXCEPTION以外の方法

テストケースのコードを変更する

警告メッセージの原因となるコードを修正することで、警告メッセージ自体をなくすことができます。これが最も根本的な解決策ですが、コードの変更が難しい場合もあります。

コンパイラオプションを使用して、特定の警告メッセージを出力しないように設定することができます。例えば、GCCでは-Wno-warning-messageオプションを使用できます。

g++ -Wall -Wno-warning-message -o my_program my_program.cpp

この方法の利点は、特定の警告メッセージのみを抑制できることです。ただし、使用しているコンパイラによってオプションが異なるため、注意が必要です。

テストスイートの構成を変更する

CTestには、警告メッセージの出力レベルを設定するオプションがあります。ctest_configureコマンドのWARNING_LEVELオプションを使用して、以下のレベルを設定することができます。

• 0: すべての警告メッセージを出力する
• 1: 致命的な警告メッセージのみを出力する
• 2: 致命的な警告メッセージとエラーメッセージを出力する

ctest_configure -D WARNING_LEVEL=1

この方法の利点は、テストスイート全体にわたって警告メッセージの出力レベルを統一できることです。ただし、特定の警告メッセージのみを抑制することはできません。

CTEST_CUSTOM_WARNING_EXCEPTION以外にも、テスト実行中に警告メッセージを抑制する方法はいくつかあります。状況に応じて適切な方法を選択してください。