Over time, some limitations of Catch2 emerged. Some of these are due to implementation details that cannot be easily changed, some of these are due to lack of development resources on our part, and some of these are due to plain old 3rd party bugs.
If you are using SECTIONs inside loops, you have to create them with
different name per loop's iteration. The recommended way to do so is to
incorporate the loop's counter into section's name, like so:
TEST_CASE( "Looped section" ) {
for (char i = '0'; i < '5'; ++i) {
SECTION(std::string("Looped section ") + i) {
SUCCEED( "Everything is OK" );
}
}
}or with a DYNAMIC_SECTION macro (that was made for exactly this purpose):
TEST_CASE( "Looped section" ) {
for (char i = '0'; i < '5'; ++i) {
DYNAMIC_SECTION( "Looped section " << i) {
SUCCEED( "Everything is OK" );
}
}
}If the last section in a test fails, it might be run again. This is because
Catch2 discovers SECTIONs dynamically, as they are about to run, and
if the last section in test case is aborted during execution (e.g. via
the REQUIRE family of macros), Catch2 does not know that there are no
more sections in that test case and must run the test case again.
Compiling Catch2 with MinGW can be exceedingly slow, especially during
the linking step. As far as we can tell, this is caused by deficiencies
in its default linker. If you can tell MinGW to instead use lld, via
-fuse-ld=lld, the link time should drop down to reasonable length
again.
This section outlines some missing features, what is their status and their possible workarounds.
Catch2's assertion macros are not thread safe. This does not mean that you cannot use threads inside Catch's test, but that only single thread can interact with Catch's assertions and other macros.
This means that this is ok
std::vector<std::thread> threads;
std::atomic<int> cnt{ 0 };
for (int i = 0; i < 4; ++i) {
threads.emplace_back([&]() {
++cnt; ++cnt; ++cnt; ++cnt;
});
}
for (auto& t : threads) { t.join(); }
REQUIRE(cnt == 16);because only one thread passes the REQUIRE macro and this is not
std::vector<std::thread> threads;
std::atomic<int> cnt{ 0 };
for (int i = 0; i < 4; ++i) {
threads.emplace_back([&]() {
++cnt; ++cnt; ++cnt; ++cnt;
CHECK(cnt == 16);
});
}
for (auto& t : threads) { t.join(); }
REQUIRE(cnt == 16);Because C++11 provides the necessary tools to do this, we are planning to remove this limitation in the future.
Catch does not support running tests in isolated (forked) processes. While this might in the future, the fact that Windows does not support forking and only allows full-on process creation and the desire to keep code as similar as possible across platforms, mean that this is likely to take significant development time, that is not currently available.
Catch's test execution is strictly serial. If you find yourself with a test suite that takes too long to run and you want to make it parallel, there are 2 feasible solutions
- You can split your tests into multiple binaries and then run these binaries in parallel.
- You can have Catch list contained test cases and then run the same test binary multiple times in parallel, passing each instance list of test cases it should run.
Both of these solutions have their problems, but should let you wring parallelism out of your test suite.
This section outlines known bugs in 3rd party components (this means compilers, standard libraries, standard runtimes).
There is a known bug in Visual Studio 2017 (VC 15), that causes compilation error when preprocessor attempts to stringize a raw string literal (# preprocessor is applied to it). This snippet is sufficient to trigger the compilation error:
#define CATCH_CONFIG_MAIN
#include "catch.hpp"
TEST_CASE("test") {
CHECK(std::string(R"("\)") == "\"\\");
}Catch provides a workaround, it is possible to disable stringification of original expressions by defining CATCH_CONFIG_DISABLE_STRINGIFICATION:
#define CATCH_CONFIG_FAST_COMPILE
#define CATCH_CONFIG_DISABLE_STRINGIFICATION
#include "catch.hpp"
TEST_CASE("test") {
CHECK(std::string(R"("\)") == "\"\\");
}Do note that this changes the output somewhat
catchwork\test1.cpp(6):
PASSED:
CHECK( Disabled by CATCH_CONFIG_DISABLE_STRINGIFICATION )
with expansion:
""\" == ""\"
VS 2015 has a known bug, where declval<T> can cause compilation error
if T has alignment requirements that it cannot meet.
A workaround is to explicitly specialize Catch::is_range for given
type (this avoids code path that uses declval<T> in a SFINAE context).
VS 2015 has a known bug where __LINE__ macro can be improperly expanded under certain circumstances, while compiling multi-file project in Debug mode.
A workaround is to compile the binary in Release mode.
Some versions of libc++ and libstdc++ (or their runtimes) have a bug with std::uncaught_exception() getting stuck returning true after rethrow, even if there are no active exceptions. One such case is this snippet, which skipped the sections "a" and "b", when compiled against libcxxrt from master
#define CATCH_CONFIG_MAIN
#include <catch.hpp>
TEST_CASE("a") {
CHECK_THROWS(throw 3);
}
TEST_CASE("b") {
int i = 0;
SECTION("a") { i = 1; }
SECTION("b") { i = 2; }
CHECK(i > 0);
}If you are seeing a problem like this, i.e. a weird test paths that trigger only under Clang with libc++, or only under very specific version of libstdc++, it is very likely you are seeing this. The only known workaround is to use a fixed version of your standard library.
This is a bug in libstdc++-4.8, where all matching methods from <regex> return false. Since Matches uses <regex> internally, if the underlying implementation does not work, it doesn't work either.
Workaround: Use newer version of libstdc++.
Running a Catch2 binary compiled against libstdc++ with _GLIBCXX_DEBUG
macro defined with --order rand will cause a debug check to trigger and
abort the run due to self-assignment.
This is a known bug inside libstdc++
Workaround: Don't use --order rand when compiling against debug-enabled
libstdc++.