# Boost.Test

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

[Boost 単体テストフレームワーク (Boost.Test)(英語)](https://www.boost.org/doc/libs/1_71_0/libs/test/doc/html/index.html) は、 [Boost(英語)](https://www.boost.org/) ライブラリの一部です。 これは、幅広いアサーションマクロ、XML 出力、その他の機能を備えた、完全に機能的でスケーラブルなフレームワークです。 Boost.Test 自体にはモック機能がありませんが、 [gmock(英語)](https://github.com/google/googlemock) などのスタンドアロンのモックフレームワークと組み合わせることができます。

## Boost.Test の基本

Boost.Test に詳しくない場合は、その主な概念の説明を以下に示します。

### チェッカーズ

ほとんどの Boost.Test チェッカーでは、重大度を設定できます。

* チェックが失敗した場合、 WARN は警告メッセージを生成しますが、エラーカウンタは増加せず、テストケースは続行されます。

* チェックが失敗した場合、 CHECK はエラーを報告してエラーカウンタを増やしますが、テストケースは続行されます。

* REQUIRE は、テストケースの実行を中止する必要がある場合に致命的なエラーを報告するために使用されます（たとえば、後で使用するオブジェクトが正常に作成されたかどうかを確認するため）。

この方法で、Boost チェッカーは通常、  `BOOST_[level]_[checkname]`  フォーマットのマクロで、引数を 1 つまたは複数取ります。 基本的なマクロは  `BOOST_WARN` 、  `BOOST_CHECK` 、および  `BOOST_REQUIRE`  です。 チェックする式に対して引数を一つ取ります。例えば：

```CPLUSPLUS
BOOST_WARN(sizeof(int) == sizeof(long));
BOOST_CHECK( i == 1 );
BOOST_REQUIRE( j > 5 );
            
```

他のチェッカーの例をいくつか以下に示します。

|  一般比較  |      `BOOST_[level]_EQUAL`  、  `BOOST_[level]_NE`  、  `BOOST_[level]_GT`        失敗した場合、これらのマクロは  テストに失敗した というメッセージを表示するだけでなく、期待値と実際の値も表示します。       ```CPLUSPLUS int i = 2; int j = 1; BOOST_CHECK( i == j ); // reports the fact of failure only: "check i == j failed" BOOST_CHECK_EQUAL( i, j ); // reports "check i == j failed [2 != 1]"                          ```    |
|  浮動小数点比較  |   `BOOST_[level]_CLOSE`  /  `BOOST_[level]_CLOSE_FRACTION`  /  `BOOST_[level]_SMALL`   |
|  例外チェック  |   `BOOST_[level]_THROW`  /  `BOOST_[level]_NO_THROW`  /  `BOOST_[level]_EXCEPTION`   |

### スイート

`BOOST_AUTO_TEST_SUITE(suite_name)`  マクロと  `BOOST_AUTO_TEST_SUITE_END()`  マクロのペアを使用して、Boost テストを [スイート(英語)](https://www.boost.org/doc/libs/1_71_0/libs/test/doc/html/boost_test/tests_organization/test_tree/test_suite.html)に編成できます。 単純なテストスイートは次のようになります。

```CPLUSPLUS
#define BOOST_TEST_MODULE Suite_example
#include <boost/test/unit_test.hpp>

BOOST_AUTO_TEST_SUITE(TwoTwoFour_suite)
BOOST_AUTO_TEST_CASE(testPlus) {
    BOOST_CHECK_EQUAL(2+2, 4);
}
BOOST_AUTO_TEST_CASE(testMult) {
    BOOST_CHECK_EQUAL(2*2, 4);
}
BOOST_AUTO_TEST_SUITE_END()
            
```

### フィクスチャ

Boost を使用してフィクスチャを作成するには、フィクスチャクラス宣言の後に作成された [通常の BOOST_AUTO_TEST_CASE マクロ(英語)](https://www.boost.org/doc/libs/1_71_0/libs/test/doc/html/boost_test/tests_organization/fixtures.html)または特別な  `BOOST_FIXTURE_TEST_CASE`  マクロのいずれかを使用できます。

```CPLUSPLUS
struct SampleF {
    SampleF() : i(1) { }
    ~SampleF() { }
    int i;
};
    
BOOST_FIXTURE_TEST_CASE(SampleF_test, SampleF) {
    // accessing i from SampleF directly
    BOOST_CHECK_EQUAL(i, 1);
    BOOST_CHECK_EQUAL(i, 2);
    BOOST_CHECK_EQUAL(i, 3);
}
            
```

## Boost.Test をプロジェクトに追加する

フレームワークには、ヘッダーのみ、静的ライブラリ、共有ライブラリの 3 つの [使用方法から(英語)](https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/boost_test/usage_variants.html)選択できます。 最適なオプションを選択するときは、ヘッダーのみとして使用される Boost.Test がかなりのコンパイル時間を必要とする可能性があることに注意してください。

さらに、 [共有ライブラリバリアント(英語)](https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/boost_test/usage_variants.html#boost_test.usage_variants.shared_lib)に焦点を当てます。

Procedure:

1. 次の [手順(英語)](https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/boost_test/adv_scenarios/build_utf.html)に従って、Boost Testing フレームワークをインストールしてビルドします。

CLion は Boost.Test バージョン 1.55 以降をサポートしています。

2. プロジェクトルートに Boost テスト用のフォルダーを作成します。 例:  `Boost_tests`  と呼びましょう。

3. `CMakeLists.txt`  ファイルを   Boost_tests   フォルダー内に作成します。プロジェクトツリーで右クリックして  `新規 | CMakeLists.txt`  を選択してください。

次の行をカスタマイズして、スクリプトに追加します。

```CMAKE
set (Boost_USE_STATIC_LIBS OFF)
find_package (Boost REQUIRED COMPONENTS unit_test_framework)
include_directories (${Boost_INCLUDE_DIRS})

# 'Boost_Tests_run' is the target name
# 'test1.cpp test2.cpp' are source files with tests
add_executable (Boost_Tests_run test1.cpp test2.cpp)
target_link_libraries (Boost_Tests_run ${Boost_LIBRARIES})
                
```

[boost_with_libs](#live-templates-boost) の  ライブテンプレート を使用し、テンプレートコードを調整して上記のスニペットを模倣することもできます。

4. ルート    `CMakeLists.txt`  スクリプトで、  `add_subdirectory(Boost_tests)`  コマンドを最後に追加し、プロジェクトを再ロードします。

5. テストを含むソースファイルに、次の行を追加します。

```CPLUSPLUS
#define BOOST_TEST_DYN_LINK
#define BOOST_TEST_MAIN // in only one cpp file
#include <boost/test/unit_test.hpp>

```

> **Note:**
> テストを含む  `.cpp`  ファイルが複数ある場合、  `#define BOOST_TEST_MAIN`  はそのうちの 1 つにのみ配置する必要があります。

> **Tip:**
> [クイック CMake チュートリアル](https://resources.jetbrains.com/stardust/clion/2019.2/quick-cmake-tutorial.html#boost)と、   単体テストチュートリアル   に記載されている [例](unit-testing-tutorial.html#adding-framework)を参照してください

## Boost.Test のライブテンプレート

Boost.Test で CMake スクリプトを編集する時間を節約するのに役立つ 2 つの定義済みの [ライブテンプレート](using-live-templates.html)があります:  boost  と  boost_with_libs  です。 それらの説明と設定は  `設定 | エディター | ライブテンプレート | CMake`  にあります。

テンプレートを挿入するには、 `Ctrl+J` (Windows), `⌘ J` (macOS), `⌘ J` (IntelliJ IDEA Classic (macOS)), `⌘ J` (macOS System Shortcuts), `Ctrl+J` (XWin), `Ctrl+J` (GNOME), `Ctrl+J` (KDE), `Ctrl+J` (Emacs), `Ctrl+J` (Sublime Text), `Ctrl+J` (Sublime Text (macOS)), `⌘ J` (Xcode), `Ctrl+K, X` (Visual Studio), `⌘ E, L` (Visual Studio (macOS)), `Ctrl+J` (ReSharper), `⌘ J` (ReSharper (macOS)), `Ctrl+J` (QtCreator), `Ctrl+J` (QtCreator (macOS)), `Ctrl+J` (NetBeans), `Ctrl+Alt+Shift+J` (Eclipse), `Ctrl+J` (Eclipse (macOS)) を押すか、  `CMakeLists.txt`  の状態で  `コード | ライブテンプレートの挿入`  を呼び出します。 リストからオプションを選択します。例えば：

![Boost ライブテンプレート](https://resources.jetbrains.com/help/img/idea/2026.3/cl_cmake_boosttemplate.png)

または、略語の入力を開始し、 `Tab` (Windows), `⇥` (macOS), `⇥` (IntelliJ IDEA Classic (macOS)), `⇥` (macOS System Shortcuts), `Tab` (XWin), `Tab` (GNOME), `Tab` (KDE), `Tab` (Emacs), `Tab` (Sublime Text), `⇥` (Sublime Text (macOS)), `⇥` (Xcode), `Tab` (Visual Studio), `⇥` (Visual Studio (macOS)), `Tab` (ReSharper), `⇥` (ReSharper (macOS)), `Tab` (QtCreator), `⇥` (QtCreator (macOS)), `Tab` (NetBeans), `Tab` (Eclipse), `⇥` (Eclipse (macOS)) を押してスタブコードを挿入することもできます。

## Boost.Test の実行 / デバッグ構成

Boost.Test はテストプログラムに  `main()`  エントリを提供し、通常のアプリケーションとして実行できますが、専用の Boost.Test 実行 / デバッグ構成を使用することをお勧めします。 これにはテスト関連の設定が含まれており、テストを通常のプログラムとして実行する場合は使用できない組み込みの [テストランナー](#test-runner)の利点を活用できます。

Procedure:

1. Boost.Test 構成を作成するには、メインメニューの   実行 | 実行構成の編集​   に移動し、 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg) をクリックして、テンプレートのリストから   Boost.Test   を選択します。

2. 構成に含めるテストまたはスイートを指定するか、テスト名をフィルタリングするためのパターンを提供します。 フィールドに自動補完機能が用意されているため、すぐに記入できます。

![構成フィールドの補完](https://resources.jetbrains.com/help/img/idea/2026.3/cl_boosttest_config_completion.png)

ワイルドカードを設定してテストパターンを指定します。例えば：

![テストのパターン](https://resources.jetbrains.com/help/img/idea/2026.3/cl_googletest_config_pattern.png)

3. 構成設定の他のフィールドでは、環境変数とコマンドライン引数を設定できます。

Boost.Test バージョン 1.62 以前では、    テストフレームワークが予期せず終了しました    メッセージを受け取った場合、   プログラム引数   に次の文字列を設定します。

```SHELL
--log_format=HRF --log_level=all

```

4. 構成を保存すると、   実行   ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.execute.svg) または   デバッグ   ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.startDebugger.svg) の準備ができました。

> **Note:**
> 単一の構成を編集する代わりに、   Boost.Test テンプレート自体を変更する   できます。 この場合、指定した設定は、このタイプのすべての新しい構成にデフォルトとして適用されます。

## テストの実行

CLion では、テスト実行/デバッグセッションを開始する方法が [いくつか](performing-tests.html)あります。そのひとつが、特別なガターアイコンを使う方法です。 これらのアイコンは、単一テストまたはスイート／フィクスチャ全体をすばやく実行またはデバッグするのに役立ちます：

![テスト用のガターアイコン](https://resources.jetbrains.com/help/img/idea/2026.3/cl_boosttest_guttericons.png)

ガターアイコンは、テスト結果（すでに入手可能な場合）も表示します：成功 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.runConfigurations.testState.green2.svg) または失敗 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.runConfigurations.testState.red2.svg)。

ガターアイコンを使用してテスト/スイート/フィクスチャを実行すると、CLion は [一時的な](run-debug-configuration.html) Boost.Test 構成を作成しますが、構成のリストではグレー表示されます。 一時的な設定を保存するには、  `実行構成の編集`  ダイアログでそれを選択して ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.save.svg) を押します。

![一時的なテスト構成の保存](https://resources.jetbrains.com/help/img/idea/2026.3/cl_boosttest_tempconfig.png)

## 結果を探る

テストを実行すると、CLion は組み込みの [テストランナーウィンドウ](viewing-and-exploring-test-results.html)に結果とプロセスを表示します。 テストツリーには、実行中のすべてのテストが 1 つずつ表示されます。 テストランナーウィンドウには次のものが含まれます。

* これまでに実行されたテストの割合を示す プログレスバー 、

* 実行中のすべてのテストとそのステータスおよび期間の ツリービュー 、

* テストの 出力 ストリーム

* ツールバー には、失敗した ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.runConfigurations.testState.red2.svg) テストを再実行する、 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.export.svg) をエクスポートする、 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.vcs.history.svg) で自動的に保存された以前の結果を開く、特定のテストを簡単に見つけるために ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.objectBrowser.sorted.svg) のアルファベット順に並べ替える、または ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.runConfigurations.sortbyDuration.svg) の期間で並べ替えて、どのテストが他のものより長く実行されたかを理解するためのオプションがあります。

> **Tip:**
> CLion テストランナーは Boost.Test の [デコレータ](https://www.boost.org/doc/libs/1_60_0/libs/test/doc/html/boost_test/tests_organization/decorators.html)（例えば  `boost::unit_test::disabled()/enabled()` ）もサポートしています。

![テストランナー](https://resources.jetbrains.com/help/img/idea/2026.3/cl_boosttest_runner.png)

## See also

### オンラインドキュメント

[単体テストのチュートリアル](unit-testing-tutorial.html) [クイック CMake チュートリアル](quick-cmake-tutorial.html)

### プロシージャ

[Run/Debug/Terminate Tests](performing-tests.html) [Explore Test Results](viewing-and-exploring-test-results.html)

