Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 4.6 KB

logging.md

File metadata and controls

87 lines (55 loc) · 4.6 KB
Raw

Logging macros

Additional messages can be logged during a test case (safely even in concurrent threads).

INFO()

The INFO() macro allows heterogenous sequences of values to be streamed using the insertion operator (<<) in the same way that std::ostream, std::cout, etc support it.

INFO("The number is " << i);

This message will be relevant to all asserts after it in the current scope or in scopes nested in the current one and will be printed later only if an assert fails.

Note that there is no initial << - instead the insertion sequence is placed in parentheses.

The message is NOT constructed right away - instead it gets lazily stringified only when needed. This means that rvalues (temporaries) cannot be passed to the INFO() macro. All literals are treated as rvalue references by the standard - except for C string literals ("like this one"). That means that even normal integer literals cannot be used directly - they need to be stored in a variable/constant before being passed to INFO(). If C++14 is used (or Visual Studio 2017+) doctest provides the TO_LVALUE() macro to help in this regard - it turns any literal or constexpr value to an lvalue and can be used like this:

constexpr int foo() { return 42; }
TEST_CASE("playing with literals and constexpr values") {
    INFO(TO_LVALUE(6) << " and this is a C string literal " << TO_LVALUE(foo()));
    CHECK(false);
}

TO_LVALUE() can also help in contexts where you might want to avoid a static constexpr member to be ODR-used - see DOCTEST_CONFIG_ASSERTION_PARAMETERS_BY_VALUE.

Some notes:

  • the lazy stringification means the values will be stringified when an assert fails and not at the point of capture - so the value might have changed
  • if the library is built with C++11 rvalue reference support (see DOCTEST_CONFIG_WITH_RVALUE_REFERENCES) then deleted overloads are provided to prohibit rvalues from being captured in an INFO() call - since the lazy stringification actually caches pointers to the objects. For C++98 temporaries will again not work but there will be horrible compilation errors
  • the DOCTEST_CONFIG_NUM_CAPTURES_ON_STACK config identifier can be used to control how much stack space is used to avoid heap allocations for the streaming macros
  • stream manipulators (from <iomanip>) can be used but need to be created as local variables and used as lvalues
  • refer to the stringification page for information on how to teach doctest to stringify your types

The lazy stringification and the stack usage means that in the common case when no asserts fail the code runs super fast. This makes it suitable even in loops - perhaps to log the iteration.

There is also the CAPTURE() macro which is a convenience wrapper of INFO():

CAPTURE(some_variable)

This will handle the stringification of the variable name for you (actually it works with any expression, not just variables).

This would log something like:

  some_variable := 42

Messages which can optionally fail test cases

There are a few other macros for logging information:

  • MESSAGE(message)
  • FAIL_CHECK(message)
  • FAIL(message)

FAIL() is like a REQUIRE assert - fails the test case and exits it. FAIL_CHECK() acts like a CHECK assert - fails the test case but continues with the execution. MESSAGE() just prints a message.

In all these macros the messages are again composed using the << streaming operator - like this:

FAIL("This is not supposed to happen! some var: " << var);

Also there is no lazy stringification here - strings are always constructed and printed and thus there are no limitations to the values being logged - temporaries and rvalues are accepted - unlike with the INFO() macro.

There are also a few more intended for use by third party libraries such as mocking frameworks:

  • ADD_MESSAGE_AT(file, line, message)
  • ADD_FAIL_CHECK_AT(file, line, message)
  • ADD_FAIL_AT(file, line, message)

They can be useful when integrating asserts from a different framework with doctest.

  • Check out the example which shows how all of these are used.

Home