lightweight single header C++ library for embedding tests within your codebase - like documentation
DOCTEST_CONFIG_IMPLEMENT is defined in a single place
DOCTEST_CONFIG_IMPLEMENT and then include doctest.h you get the interface + the implementation
DOCTEST_CONFIG_IMPLEMENT you pull the contents of that fictional .cpp along
The simple project have 2 dlls, dllA and dllB. I have a testrunner, which calls DOCTEST_CONFIG_IMPLEMENT. I have a testexecutable which calls doctest:Contest(). Each dlls calls DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL.
My question is, is this the best way to do it? Are there any other alternatives?
@syaifulnizamyahya This is the best way if you want to have a single test runner (a single place where DOCTEST_CONFIG_IMPLEMENT is defined) - that way all the tests from all .dlls will be registered in a single place. This way you could choose which dlls to load from the executable and thus choose which tests to have registered. You could also use the command line filtering functionality to choose tests from specific .cpp files or based on a pattern or test suite - you could use test suites for the different dlls.
A potential alternative might be to have a test runner in each dll but then you would need to have DOCTEST_CONFIG_IMPLEMENT in each dll and also create and use a doctest::Context object in the dllMain of each dll.
target_link_libraries(${LIBRARY_NAME}
doctest
)#define DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL
#define DOCTEST_CONFIG_IMPLEMENT
#define DOCTEST_CONFIG_NO_SHORT_MACRO_NAMES
#include "doctest.h"
DOCTEST_TEST_CASE("testrunner") {
DOCTEST_INFO("From testrunner\n");
}DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS or DOCTEST_CONFIG_NO_EXCEPTIONS or DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS or DOCTEST_CONFIG_SUPER_FAST_ASSERTS? What is the workflow that you guys use?
--no-breaks from the command line options: https://github.com/onqtam/doctest/blob/master/doc/markdown/commandline.mdYou could also set it by default in your
main() function with the ability to override it through the command line: https://github.com/onqtam/doctest/blob/master/doc/markdown/main.md (the option is used in the example as well - but as an override - move that above the call to applyCommandLine() and it will be a default instead of an override)
#define INFO ... which conflicts with the one from doctest? In that case you could use DOCTEST_CONFIG_NO_SHORT_MACRO_NAMES and perhaps a proxy header for including doctest like this: https://github.com/onqtam/doctest/blob/master/examples/all_features/doctest_proxy.h
Hey, I just started C++ programming and found DocTest. I was just wondering if my way of disabling tests is the correct one.
I followed the main.md and had no problems. When I tried #define DOCTEST_CONFIG_DISABLE the compiler couldn't find symbols like doctest::Context context etc (which wasn't surprising).
Is the correct way to put everything test related in a if(!DOCTEST_CONFIG_DISABLE) {...DocTest stuff here...} statement, so that the compiler ignores it?
DOCTEST_CONFIG_DISABLE for the entire project and it should continue to compile - including a custom main function which uses doctest::Context...
Context class is defined when DOCTEST_CONFIG_DISABLE is defined - the methods are empty stubs precisely so that users don't need to do anything extra
math.cpp:
#define DOCTEST_CONFIG_DISABLE
#include "doctest.h"
#include <iostream>
int add(int a, int b) {
return a+b;
}
TEST_CASE("testing add func") {
CHECK(add(0, 0) == 0);
CHECK(add(1, 0) == 1);
CHECK(add(1, 1) == 2);
CHECK(add(0, -1) == -1);
CHECK(add(-1, -1) == -2);
}
int main(int argc, char** argv) {
doctest::Context context;
context.setOption("abort-after", 5);
context.applyCommandLine(argc, argv);
context.setOption("no-breaks", true);
int res = context.run();
if(context.shouldExit())
return res;
std::cout << add(1, 2);
return res;
}using: g++ math.cpp -o math -std=c++2a
leads toUndefined symbols for architecture x86_64:
"doctest::Context::shouldExit()", referenced from:
_main in math-161803.o
"doctest::Context::applyCommandLine(int, char const* const*)", referenced from:
_main in math-161803.o
"doctest::Context::run()", referenced from:
_main in math-161803.o
"doctest::Context::setOption(char const*, int)", referenced from:
_main in math-161803.o
"doctest::Context::Context(int, char const* const*)", referenced from:
_main in math-161803.o
"doctest::Context::~Context()", referenced from:
_main in math-161803.o
ld: symbol(s) not found for architecture x86_64
clang: error: linker command failed with exit code 1 (use -v to see invocation)
If I use #define DOCTEST_CONFIG_IMPLEMENT everything seems to work as intended.
#define DOCTEST_CONFIG_IMPLEMENT must always be present in at least one .cpp file, and whether you have defined DOCTEST_CONFIG_DISABLE globally is a completely separate matter. Those stubs I pointed to require DOCTEST_CONFIG_IMPLEMENT.
DOCTEST_CONFIG_DISABLE in addition to DOCTEST_CONFIG_IMPLEMENT