Add API for reporting failures

[rollbear]

It would be marvellous if there was a supported way to report failures from 3rd party tools. As mentioned, you can throw exceptions, but that is not always a good idea (during stack rollback, for example.) There is also the option to just use REQUIRE_FALSE(message), but it does not give as nice messages and attributes file/line to the function that does the reporting.

In a proof of concept reporter for trompeloeil mocking framework I successfully used:

struct initializer {
  initializer() {
    trompeloeil::set_reporter([](trompeloeil::severity s,
                                 char const *file,
                                 unsigned long line,
                                 std::string const& msg)
                              {
                                doctest::detail::logAssert(false,
                                                           msg.c_str(),
                                                           false,
                                                           s == trompeloeil::severity::fatal
                                                           ? "unexpected call"
                                                           : "unfulfilled expectation",
                                                           "trompeloeil violation",
                                                           file,
                                                           line);
                                if (s == trompeloeil::severity::fatal)
                                  throw std::runtime_error("fatal error in trompeloeil expectation");

                              });
  }
} initializer_obj;

This works fine, but relying on undocumented internal functions is never a good idea.

[onqtam]

Just to let you know - There will be a better way of doing this in the future :) (I also saw this - cool!)

[rollbear]

Looking forward to it.

[onqtam]

This is implemented in the dev branch. doctest version 1.2 is expected to ship in the near month and then this issue will be closed.

Use like this:

ADD_FAIL_AT("asd.cpp", 45, "some string" << some_variable << "more stuff");

Alternatively there is ADD_FAIL_CHECK_AT which will fail the test case but will not stop its execution - and will act as a CHECK assert.

[rollbear]

Cool! Tried it, and am ready to update the documentation for Trompeloeil as soon as 1.2 is out.