lightweight single header C++ library for embedding tests within your codebase - like documentation
#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
implementation.cpp ends up first in the unity file, however I assume that should already be the case because of the CMake file: add_library(implementation SHARED implementation.cpp implementation_2.cpp) - implementation.cpp is listed first... i don't know why that's not the case in your setup... perhaps you've reordered the .cpp files?)
Hello everyone, I got some issues to compile with i686-w64-mingw32-g++ a shared library (.dll) project.
Here is what I get when I compile :
x86_64-w64-mingw32-g++ -shared -std=gnu++0x -fPIC -Wl,--allow-shlib-undefined,-soname,libgs1user.2.dll sources.cpp -static-libgcc -static-libstdc++ -o libgs1user.2.0.0.dll
...
/usr/bin/x86_64-w64-mingw32-ld: /tmp/cchQKq4R.o:gs1user.cpp:(.text+0x126b): undefined reference to __imp__ZN7doctest6detail9TestSuitemlEPKc'
/usr/bin/x86_64-w64-mingw32-ld: /tmp/cchQKq4R.o:gs1user.cpp:(.text+0x1277): undefined reference toimpZN7doctest6detail12setTestSuiteERKNS0_9TestSuiteE'
/usr/bin/x86_64-w64-mingw32-ld: /tmp/ccfCh4GW.o:c_dsfid.cpp:(.text+0x24): undefined reference to `doctest::String::String(char const*)'
...
Everything is fine with g++ for Linux compilation
Can anyone help me ?
Okay, I found the fix... :
- just forgot to add "doctest/parts/doctest.cpp" to the compiler
- placed "#define DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL" before "#include "../libraries/doctest/doctest.h""
Just put the problem writed here help me to find what's was wrong.
By the way cross-compiling to Windows using mingw32 works using the lib header "mingw-std-threads/mingw.mutex.h" and replaced <mutex> by :
'#if defined(_WIN64) || defined(_WIN32)
' #include "../mingw-std-threads/mingw.mutex.h"
'#else
' #include <mutex>
'#endif
in doctest.hpp and doctest.cpp
Hi all, thanks Viktor for doctest! I just started using it (I like the cargo test experience), but I found that perhaps the https://github.com/onqtam/doctest/blob/master/doc/markdown/build-systems.md#cmake example is not in sync. If the single file inside your own repository intro is correct, the minimal snipped should be without find_packages and without doctest in target_link_libraries, something like:
add_executable(test test.cpp <other-sources>)
target_compile_features(test PRIVATE cxx_std_17)
target_link_libraries(test <other-libs>)May I propose a PR to update the docs?
target_compile_features(test PRIVATE cxx_std_17) line is also unnecessary... C++11 is required and I assume that's the default by now for most compilers
I've tried a simple clone, and it fails the same, because of some Finddoctest.cmake missing. In case of a simple clone a minimal snippet:
include_directories(doctest/doctest)
add_subdirectory(doctest)Should go, with target_link_libraries(test doctest). I just leave it here for the posterity ;)
Hi. I have a project like below, I can control A, and I'm trying to use doctest in it.
project
|
+-- A
+-- B
+-- SO
+-- EXESO expects A and B to provide static libraries, and SO will combine them to create a final shared lib, say libOUTPUT.so.
Then EXE will link to libOUTPUT.so.
I can by default define DOCTEST_CONFIG_DISABLE, then everything builds OK.
But I do want to remove this macro, and builds the entire project as well, though doctest is not used by SO or EXE at all.
In this case (doctest enabled), A itself has executable targets and builds without problem. But EXE linking to SO has problem:
XXX.so: undefined reference to `doctest::detail::ResultBuilder::react() const'
XXX.so: undefined reference to `doctest::detail::TestCase::operator*(char const*)'
XXX.so: undefined reference to `doctest::detail::setTestSuite(doctest::detail::TestSuite const&)'
XXX.so: undefined reference to `doctest::String::~String()'
XXX.so: undefined reference to `doctest::detail::regTest(doctest::detail::TestCase const&)'
XXX.so: undefined reference to `doctest::detail::TestSuite::operator*(char const*)'
XXX.so: undefined reference to `doctest::detail::ResultBuilder::translateException()'
XXX.so: undefined reference to `doctest::detail::ResultBuilder::ResultBuilder(doctest::assertType::Enum, char const*, int, char const*, char const*, char const*)'
XXX.so: undefined reference to `doctest_detail_test_suite_ns::getCurrentTestSuite()'
XXX.so: undefined reference to `doctest::detail::ResultBuilder::log()'
XXX.so: undefined reference to `doctest::detail::TestCase::TestCase(void (*)(), char const*, unsigned int, doctest::detail::TestSuite const&, char const*, int)'
collect2: error: ld returned 1 exit statusA, I do inlcude a dummy source, to be included in the static library:#define DOCTEST_CONFIG_IMPLEMENT
#include "doctest.h"The symbol ResultBuilder::ResultBuilder does exist in static lib from A:
$ nm -gC libA.a | grep -i ResultBuilder::ResultBuilder
0000000000003d6a T doctest::detail::ResultBuilder::ResultBuilder(doctest::assertType::Enum, char const*, int, char const*, char const*, char const*)
0000000000003d6a T doctest::detail::ResultBuilder::ResultBuilder(doctest::assertType::Enum, char const*, int, char const*, char const*, char const*)But in the SO, the symbol is undefined:
$ nm -gC libOUTPUT.so | grep doctest
U doctest_detail_test_suite_ns::getCurrentTestSuite()
U doctest::detail::setTestSuite(doctest::detail::TestSuite const&)
U doctest::detail::ResultBuilder::translateException()
U doctest::detail::ResultBuilder::log()
U doctest::detail::ResultBuilder::ResultBuilder(doctest::assertType::Enum, char const*, int, char const*, char const*, char const*)
U doctest::detail::regTest(doctest::detail::TestCase const&)
U doctest::detail::TestCase::TestCase(void (*)(), char const*, unsigned int, doctest::detail::TestSuite const&, char const*, int)
U doctest::detail::TestCase::operator*(char const*)
U doctest::detail::TestSuite::operator*(char const*)
U doctest::String::~String()
U doctest::detail::ResultBuilder::react() constexecutable_dll_and_plugin, it seems that it just uses the macro DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL. I tried this but not working.exe_with_static_libs, this example introduced some tricky CMake utility, initially I tried to use this to register test cases in depedent libraries, but not working either. But now I'm using object libraries inside my component now.
SO component to enable "whole-archive" linking, then my current source tree can build with doctest enabled in my component.But I'm not sure if this is the root cause. Or there is indeed something I can do inside my component "A" to solve this linking issue.
./myexe -tc TEST_CASE_NAME --my-options
@onqtam Hi Viktor, I was trying to use the "integration with the output window of Visual Studio 2019 for failing tests" with a CMake project. I RMB-click the root CMakeLists.txt and then press "Run Tests" from the drop-down menu. The tests run and output is shown in console. Failing tests are shown with a file and its linenumber in "Show output from: CMake":
Excerpt from output:
[...]
[doctest] doctest version is "2.4.6"
[doctest] run with "--help" for options
===============================================================================
..\..\..\tests\collatz_test.cpp(9):
TEST SUITE: collatz
TEST CASE: Test unique by name to doctest
..\..\..\tests\collatz_test.cpp(11): ERROR: CHECK( 42 == 41 ) is NOT correct!
values: CHECK( 42 == 41 )
===============================================================================
[...]However, double-clicking on collatz_test.cpp(11): just prints "The system cannot find the file specified." in Visual Studio's status bar.
Could this be an issue with the "integration with the output window of Visual Studio 2019 for failing tests"-feature used with relative path ..\..\..\tests\collatz_test.cpp instead of an absolute path? Is it possible to somehow build my doctest-binary so that it outputs absolute paths?
2 replies
On Mac OS, I've defined -DDOCTEST_CONFIG_DISABLE and -DDOCTEST_CONFIG_USE_STD_HEADERS.
For a very simple TEST_CASE:
TEST_CASE("UT.util.chrono.getSystemTimeMillis")
{
auto millis = getSystemTimeMillis();
auto sys_time = static_cast<int64_t>(tn::simple_time::system_time() * 1000);
CHECK_LT(std::abs(millis - sys_time), 2);
}There are warnings:
warning: unused variable 'millis' [-Wunused-variable]
auto millis = getSystemTimeMillis();
^
warning: unused variable 'sys_time' [-Wunused-variable]
auto sys_time = static_cast<int64_t>(tn::simple_time::system_time() * 1000);I have two questions:
- Although
DOCTEST_CONFIG_DISABLEis defined, the code is still compiled into the object file? - Any good practice to fix such warnings when the disable macro is defined?
DOCTEST_CONFIG_DISABLE is defined all test cases are turned into uninstantiated templates - that means that the code must continue to parse, but it won't end up in the final object file (as it is never instantiated as a template). All asserts are also turned into a no-op so that it gets parsed faster. However that does indeed result in such warnings for unused variables and I'd suggest suppressing those warnings when doctest is disabled (you can use DOCTEST_CLANG_SUPPRESS_WARNING("-Wunused-variable"))
