Doctest support

Adding Doctest to your project

1. Download the latest version of doctest.h and copy it into your project tree.

   The minimum supported version is 2.3.0.

2. Include the header in your test files:

   #include "doctest.h"

3. In only one header file, precede #include with #define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN.

   See these instructions if you need to supply your own main.

Doctest run/debug configuration

1. Open the Run | Edit Configurations dialog. Under the Doctest node, you will see the configurations created automatically for the detected targets.

   

2. To create a new Doctest configuration, click and select Doctest from the list of templates.

3. Specify the configuration settings:

   • Set the configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

   • Suite/Test

     Test

     Select this option to run a particular test or suite.

     In the Suite field, specify the suite name. Start typing, and auto-completion will suggest the available suits:

     

     In the Test field, select the desired test. Leave this field to run the entire suite.

     

     Select this option to specify a single test or define a set of tests:

     • [#*filename.cpp] to run all tests in filename.cpp,

     • [suite_name] to run a suite with the corresponding name,

     • [suite_name][test_name] or [suite_name][test_name][subtest_name] to run a particular test from a given suite,

     • use []([][]) to refer to an anonymous suite, but make sure to add a test name.

     You can specify several patterns in a comma-separated list, for example:

     

     Alternatively, you can leave the Suite and Test fields empty, and provide the Doctest's command line flags via Program arguments instead.

   • In the Target field, select the desired target from the list.

4. Save the configuration, and it's ready for Run or Debug.

note

Instead of editing a single configuration, you can modify the Doctest template itself. In this case, the settings you specify will apply as defaults to all new configurations of this type.