neptards
/
doctest
forked from mirror/doctest
Code Issues Pull Requests Releases Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dev
fix-672
master
u3-2.4.9
1.0.0
1.1.0
1.1.1
1.1.2
1.1.3
1.1.4
1.2.0
1.2.1
1.2.2
1.2.3
1.2.4
1.2.5
1.2.6
1.2.7
1.2.8
1.2.9
2.0.0
2.0.1
2.1.0
2.2.0
2.2.1
2.2.2
2.2.3
2.3.0
2.3.1
2.3.2
2.3.3
2.3.4
2.3.5
2.3.6
2.3.7
2.3.8
2.4.0
2.4.1
2.4.2
2.4.3
2.4.4
2.4.5
2.4.6
2.4.7
v2.4.8
v2.4.9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'u3-2.4.9'
${ noResults }
doctest/doc/markdown/configuration.md

19 KiB
Raw Permalink Blame History

Configuration

doctest is designed to "just work" as much as possible. It also allows configuring how it is built with a set of identifiers.

The identifiers should be defined before the inclusion of the framework header.

Defining something globally means for every source file of the binary (executable / shared object).

For most people the only configuration needed is telling doctest which source file should host all the implementation code:

DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
#include "doctest.h"

This should be defined only in the source file where the library is implemented. It also creates a main() entry point.

DOCTEST_CONFIG_IMPLEMENT

If the client wants to supply the main() function (either to set an option with some value from the code or to integrate the framework into their existing project codebase) this identifier should be used.

This should be defined only in the source file where the library is implemented.

DOCTEST_CONFIG_DISABLE

One of the most important configuration options - everything testing-related is removed from the binary - including most of the framework implementation and every test case written anywhere! This is one of the most unique features of doctest.

This should be defined globally.

DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL

This will affect the public interface of doctest - all necessary forward declarations for writing tests will be turned into imported symbols. That way the test runner doesn't have to be implemented in the binary (executable / shared object) and can be reused from another binary where it is built and exported.

To export the test runner from a binary simply use DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL together with DOCTEST_CONFIG_IMPLEMENT (or DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN but then the other binaries will have to link to the executable) in whatever source file the test runner gets implemented into. Note that this identifier should not be defined in the other source files of the binary which exports the doctest test runner - or there will be linker conflicts - having the same symbols as both imported and exported within the same binary.

Checkout the example - it shows how to have the test runner implemented in a dll (and there are even tests in a plugin which is dynamically loaded).

This should be defined globally in binaries that import the symbols.

This should be defined only in the source file where the library is implemented for binaries that export the test runner.

DOCTEST_CONFIG_NO_SHORT_MACRO_NAMES

This will remove all macros from doctest that don't have the DOCTEST_ prefix - like CHECK, TEST_CASE and SUBCASE. Then only the full macro names will be available - DOCTEST_CHECK, DOCTEST_TEST_CASE and DOCTEST_SUBCASE. The user is free to make their own short versions of these macros - example.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING

By default char* is being treated as a pointer. With this option comparing char* pointers will switch to using strcmp() for comparisons and when stringified the string will be printed instead of the pointer value.

This should be defined globally.

DOCTEST_CONFIG_REQUIRE_STRINGIFICATION_FOR_ALL_USED_TYPES

By default if stringification is not available for a type, it is simply printed as {?}. By enabling this flag, whenever a type is used in an assert that does not provide stringification, the compilation is stopped.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_DOUBLE_STRINGIFY

If you define your own toString functions that return something, that's different from doctest::String, but still stringifiable, you can enable this flag to stringify the result of internal stringification calls again.

You can also define DOCTEST_STRINGIFY yourself to override doctest's stringification behavior.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_SUPER_FAST_ASSERTS

This config option makes the assert macros (except for those dealing with exceptions) compile much faster! (31-91% - depending on the type - normal or binary)

Each assert is turned into a single function call - the only downside of this is: if an assert fails and a debugger is attached - when it breaks it will be in an internal function - the user will have to go 1 level up in the callstack to see the actual assert.

It also implies DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS (so exceptions thrown during the evaluation of an assert are not caught by the assert itself but by the testing framework - meaning that the test case is immediately aborted).

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_USE_STD_HEADERS

The library by default provides a forward declaration of std::ostream in order to support the operator<< stringification mechanism (also std::tuple<> and std::nullptr_t). This is forbidden by the standard (even though it works everywhere on all tested compilers). However if the user wishes to be 100% standards compliant - then this configuration option can be used to force the inclusion of the relevant standard headers.

Also it is possible that some STL implementation of a compiler with niche usage defines them differently - then there will be compilation errors in STL headers and using this option should fix the problem.

This should be defined globally.

DOCTEST_CONFIG_VOID_CAST_EXPRESSIONS

This affects the asserts dealing with exceptions - the expression is cast to void to avoid problems such as when functions with the [[nodiscard]] attribute are used but their result isn't checked.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_NO_COMPARISON_WARNING_SUPPRESSION

By default the library suppresses warnings about comparing signed and unsigned types, etc.

  • g++/clang -Wsign-conversion
  • g++/clang -Wsign-compare
  • msvc C4389 'operator' : signed/unsigned mismatch
  • msvc C4018 'expression' : signed/unsigned mismatch

You can checkout this issue to better understand why I suppress these warnings by default.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_OPTIONS_PREFIX

Defining this as a string will change the prefix of the command line options to use the given prefix instead of the default dt- prefix. This can be useful for integrating the testing framework into a client codebase, where a command option prefix like selftest- might be more clear to users.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_NO_UNPREFIXED_OPTIONS

This will disable the short versions of the command line options and only the versions with --dt- prefix will be parsed by doctest - this is possible for easy interoperability with client command line option handling when the testing framework is integrated within a client codebase - so there are no clashes and so that the user can exclude everything starting with --dt- from their option parsing.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS

This will remove all try / catch sections from:

so exceptions thrown while evaluating the expression in an assert will terminate the current test case.

This can be used for some mild compile time savings but for greater impact look into DOCTEST_CONFIG_SUPER_FAST_ASSERTS.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_NO_EXCEPTIONS

This will remove everything that uses exceptions from the framework - it is also auto detectable if exceptions are disabled for compilers (like with -fno-exceptions for GCC/Clang).

What gets changed:

  • asserts that evaluate the expression in a try / catch section no longer evaluate in such a context
  • REQUIRE macros are gone (undefined)
  • exception macros are gone (undefined)
  • the abort-after option won't be fully working because an exception is used to terminate test cases

The REQUIRE family of asserts uses exceptions to terminate the current test case when they fail. An exception is used instead of a simple return; because asserts can be used not only in a test case but also in functions called by a test case.

Also some of the logging macros which act like a REQUIRE assert (terminating the test case) - like FAIL() - start to work differently - like a FAIL_CHECK().

DOCTEST_CONFIG_NO_EXCEPTIONS implies DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS

If you wish to use asserts that deal with exceptions and only sometimes build without exceptions - check the DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS config option.

This should be defined globally.

DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS

When building with no exceptions (see DOCTEST_CONFIG_NO_EXCEPTIONS) REQUIRE asserts and the ones about dealing with exceptions are gone.

If however you want your code to use these assertions and only sometimes build without exceptions - then using this config will be of help. The effects of using it are the following:

  • REQUIRE asserts are not gone - but they act like CHECK asserts - when one of them fails the whole test case will be marked as failed but will not be exited immediately
  • the asserts for dealing with exceptions are turned into a no-op (instead of being totally undefined)

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_ASSERTION_PARAMETERS_BY_VALUE

This option forces all doctest asserts to copy by value the expressions they are given instead of binding them to const references. This might be useful to avoid ODR-usage of static constants (which might lead to linker errors with g++/clang):

template<typename T> struct type_traits { static const bool value = false; };

// unless DOCTEST_CONFIG_ASSERTION_PARAMETERS_BY_VALUE is defined the following assertion
// will lead to a linker error if type_traits<int>::value isn't defined in a translation unit
CHECK(type_traits<int>::value == false);

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_COLORS_NONE

This will remove support for colors in the console output of the framework.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_COLORS_WINDOWS

This will force the support for colors in the console output to use the Windows APIs and headers.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_COLORS_ANSI

This will force the support for colors in the console output to use ANSI escape codes.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_WINDOWS_SEH

This will enable SEH handling on Windows. Currently enabled only when compiled with MSVC, because some versions of MinGW do not have the necessary Win32 API support. The user may choose to enable this explicitly - it is known to work with the MinGW-w64 project.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_NO_WINDOWS_SEH

This can be used to disable DOCTEST_CONFIG_WINDOWS_SEH when it is auto-selected by the library.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_POSIX_SIGNALS

This will enable the use of signals under UNIX for handling crashes. On by default.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_NO_POSIX_SIGNALS

This can be used to disable DOCTEST_CONFIG_POSIX_SIGNALS when it is auto-selected by the library.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS

This can be used to include the <type_traits> C++11 header. That in turn will enable the ability for the Approx helper to be used with strong typedefs of double - check this or this issue for more details on that.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_NO_MULTITHREADING

This can be used to disable all multithreading support.

Speeds up single threaded applications.

Includes DOCTEST_CONFIG_NO_MULTI_LANE_ATOMICS.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_NO_MULTI_LANE_ATOMICS

This can be used to disable multi lane atomics. Multi lane atomics can speed up highly parallel use of assert statements, but have a small overhead for single threaded applications.

This should be defined only in the source file where the library is implemented (it's relevant only there).

DOCTEST_CONFIG_ASSERTS_RETURN_VALUES

Makes all assertion macros return a boolean value, reporting whether the assertion succeeded. This can be used, for example, to have nullptr checks that don't terminate the test case on failure.

Example:

if (CHECK(somePtr != nullptr))
    CHECK(somePtr->someMethod() == 42);

This has a slight negative impact on performance as well as disabling some functionality inside assertions (e.g. co_return).

When DOCTEST_CONFIG_DISABLE is defined, all macros return false by default.

This can be defined both globally and in specific source files only.

DOCTEST_CONFIG_EVALUATE_ASSERTS_EVEN_WHEN_DISABLED

When DOCTEST_CONFIG_ASSERTS_RETURN_VALUES and DOCTEST_CONFIG_DISABLE are defined, this macro will cause conditions from assertions to evaluate properly (instead of returning false), although all overhead and functionality from doctest is removed. This is useful when assertions are used in production code within if statements so that the condition continues to be evaluated.

Since all THROWS_WITH assertions depend on doctest functionality which is not available when DOCTEST_CONFIG_DISABLE is defined (stringification), they will still unconditionally return false.

This can be defined both globally and in specific source files only.

Home