# Doctest

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

[Doctest (英語)](https://github.com/onqtam/doctest) は、自己登録テストを備えた単一ヘッダーフレームワークです。 [ドキュメント(英語)](https://github.com/onqtam/doctest/blob/master/README.md)に記載されているように、Doctest は Catch の後に設計されており、Catch のコードの一部を共有しています ( [doctest と Catch の違い(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/faq.md#how-is-doctest-different-from-catch)を参照)。

Doctest は [モッキングをサポートしていません(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/faq.md#is-mocking-supported)が、 [trompeloeil(英語)](https://github.com/rollbear/trompeloeil)、 [googlemock(英語)](https://github.com/google/googletest/tree/master/googlemock)、または [FakeIt(英語)](https://github.com/eranpeer/FakeIt) などのサードパーティのモッキングライブラリと統合できます。

## Doctest の基本

Doctest に詳しくない場合は、以下で主な概念の説明を参照してください。

### サンプルテスト

Doctest で書かれた簡単なテストは次のようになります:

```CPLUSPLUS
// provides main(); this line is required in only one .cpp file
#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#include "doctest.h"

//function to be tested
int fact(int n) {
    return n <= 1 ? n : fact(n - 1) * n;
}

TEST_CASE("testing the factorial function") {
    CHECK(fact(0) == 1); // should fail
    CHECK(fact(1) == 1);
    CHECK(fact(2) == 2);
    CHECK(fact(3) == 6);
    CHECK(fact(10) == 3628800);
}

```

上記の例では、  階乗関数のテスト は自由形式のテスト名であり、一意である必要はありません。  `CHECK`  は、Doctest の [アサーションマクロ(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/assertions.md)の 1 つです。

### テストケース、サブテスト、スイート

Doctest は、共通のセットアップとティアダウンを共有するネストされたテストを作成するためのサブケースのメカニズムを提供します（ただし、クラスベースのフィクスチャも [サポートされています(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/testcases.md#test-fixtures)）。

```CPLUSPLUS
TEST_CASE("vectors can be sized and resized") {
    std::vector<int> v(5);

    REQUIRE(v.size() == 5);
    REQUIRE(v.capacity() >= 5);

    SUBCASE("adding to the vector increases its size") {
        v.push_back(1);

        CHECK(v.size() == 6);
        CHECK(v.capacity() >= 6);
    }
    SUBCASE("reserving increases just the capacity") {
        v.reserve(6);

        CHECK(v.size() == 5);
        CHECK(v.capacity() >= 6);
    }
}

```

上記のコードでは、  `TEST_CASE()`  は各  `SUBCASE()`  の最初から実行されます。 2 つの  `REQUIRE`  ステートメントは、  `size`  が 5 であり、  `capacity`  が各サブケースのエントリで少なくとも 5 であることを保証します。  `CHECK()`  -s の 1 つが失敗した場合、テストは失敗しましたが、実行は続行されます。  `TEST_CASE()`  を実行するたびに、Doctest は 1 つのサブケースを実行し、他のサブケースをスキップします。 次回は、2 番目が実行されます。

Catch のセクションと同様に、サブケースをネストして、チェック操作のシーケンスを作成できます。 各リーフサブケース（内部にネストされたサブケースのないサブケース）は 1 回実行されます。 親サブケースが失敗すると、子サブケースが実行されなくなります。

`TEST_SUITE()`  または  `TEST_SUITE_BEGIN()`  /  `TEST_SUITE_END()`  マクロを使用して、テストケースをスイートにグループ化できます。

```CPLUSPLUS
TEST_CASE("") {} // not part of any test suite

TEST_SUITE("math") {
    TEST_CASE("") {} // part of the math test suite
    TEST_CASE("") {} // part of the math test suite
}

TEST_SUITE_BEGIN("utils");

TEST_CASE("") {} // part of the utils test suite

TEST_SUITE_END();

TEST_CASE("") {} // not part of any test suite

```

Doctest は [BDD スタイルの構文(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/testcases.md#bdd-style-test-cases)もサポートしています。

## CLion での Doctest の操作

Procedure: Doctest をプロジェクトに追加する

1. `doctest.h`  の最新バージョンを [ダウンロード(英語)](https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h)して、プロジェクトツリーにコピーします。

サポートされている最小バージョンは 2.3.0 です。

2. テストファイルにヘッダーを含めます。

```CPLUSPLUS
#include "doctest.h"
```

3. 1 つのヘッダーファイルのみで、  `#include`  の前に  `#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN`  を付けます。

独自の  `main`  を提供する必要がある場合は、 [これらの手順(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/main.md)を参照してください。

Procedure: 自動的に作成された Doctest 構成を実行 / デバッグする

CLion detects the Doctest tests in your project and creates a run/debug configuration for them.

1. You can use this configuration right away to run or debug all the Doctest tests in your project:

![自動的に作成された Doctest 構成](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_autocreated_config.png)

Procedure: 新しい Doctest 実行 / デバッグ構成を追加する

1. 実行 | 実行構成の編集​   に進みます。

2. ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg) をクリックし、テンプレートのリストから   Doctest   を選択します。

![Doctest 構成の追加](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_config_templateslist.png)

3. ![doctest 構成設定](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_config_overview.png)

* 命名方法名 フィールドに構成名を設定してください。 この名前は、利用可能な実行 / デバッグ構成のリストに表示されます。

* スイート / テスト: 特定のテストまたはスイートを実行するには、このオプションを選択します。 スイート フィールドで、スイート名を指定します。 入力を開始すると、自動補完が利用可能なスイートを提案します。 ![スイート名の自動補完](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_config_suite_completion.png) テスト フィールドで、目的のテストを選択します。 スイート全体を実行するには、このフィールドを残します。 ![スイートからのテストの選択](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_config_testselection.png) テスト: このオプションを選択して、単一のテストを指定するか、一連のテストを定義します。 * `filename.cpp` ですべてのテストを実行する `[#*filename.cpp]` * `[suite_name]` は、対応する名前でスイートを実行します。 * `[suite_name][test_name]` または `[suite_name][test_name][subtest_name]` は、特定のスイートから特定のテストを実行します。 * `[]` （ `[][]` ）を使用して匿名スイートを参照しますが、必ずテスト名を追加してください。 カンマ区切りのリストで複数のパターンを指定できます。例: ![Doctest 構成のパターン](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_config_pattern.png) または、 スイート フィールドと テスト フィールドを空のままにして、代わりに プログラム引数 を介して Doctest の [コマンドラインフラグ(英語)](https://github.com/onqtam/doctest/blob/master/doc/markdown/commandline.md)を指定することもできます。

* ターゲット​ フィールドで、リストから目的のターゲットを選択します。

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

4. 構成を保存するには、   変更を適用   をクリックします。

5. スイッチャーで新しく作成した構成を選択し、 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.run.svg) を実行または ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.debug.svg) でデバッグします。

![Doctest 構成の実行 / ダバッグ](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_config_switcher.png)

Procedure: テストを実行

* The quickest way to run or debug test in CLion is by using the gutter icons:

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

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

> **Tip:**
> 詳細は [テストの実行、デバッグ、終了](performing-tests.html)を参照してください。

* When you run a test/suite/fixture using gutter icons, CLion creates a [temporary](run-debug-configuration.html) Doctest configuration, which is greyed out in the list of configurations. 一時構成を保存するには、  `実行構成の編集`  ダイアログでそれを選択し、 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.save.svg) をクリックします。

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

Procedure: テスト結果を調べる

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

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

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

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

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

![テストランナーウィンドウ](https://resources.jetbrains.com/help/img/idea/2026.3/cl_doctest_testrunner.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)

