A modern, C++-native, test framework for unit-tests, TDD and BDD - using C++14, C++17 and later (C++11 support is in v2.x branch, and C++03 on the Catch1.x branch)
Go to file
Alan Jowett 98a6c69e1e Switch from AddVectoredExceptionHandler to SetUnhandledExceptionFilter
This avoids issues with Catch2's handler firing too early, on
structured exceptions that would be handled later. This issue
meant that the old attempts at structured exception handling
were incompatible with Windows's ASan, because it throws
continuable `C0000005` exception, which it then handles.

With the new handling, Catch2 is only notified if nothing else,
including the debugger, has handled the exception.

Signed-off-by: Alan Jowett <alanjo@microsoft.com>

Closes #2332
Closes #2286
Closes #898
2022-01-03 22:50:32 +01:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Add myself to FUNDING 2021-10-11 10:44:29 +02:00
CMake pkgconfig: Add missing entries 2021-09-11 19:02:21 +02:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs Redo reporter CLI and reporter-specific docs 2022-01-03 20:38:13 +01:00
examples Refactor implementation of case-insensitivity in tags 2021-12-28 00:20:55 +01:00
extras Use make_unique instead of unique_ptr(new T) 2021-06-01 00:17:22 +02:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src Switch from AddVectoredExceptionHandler to SetUnhandledExceptionFilter 2022-01-03 22:50:32 +01:00
tests Switch from AddVectoredExceptionHandler to SetUnhandledExceptionFilter 2022-01-03 22:50:32 +01:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools Add support for multiple parallel reporters 2022-01-01 14:02:23 +01:00
.clang-format Clang-format configuration added. 2020-07-22 21:43:30 +02:00
.gitattributes Update gitattributes 2018-07-23 10:15:52 +02:00
.gitignore Add a script - buildAndTest.sh 2020-10-28 11:38:06 +01:00
appveyor.yml Add Linux and Windows CI builds with surrogate TUs 2021-02-19 23:23:00 +01:00
BUILD.bazel Add Bazel support for the v3 branch 2020-05-26 14:49:49 +02:00
CMakeLists.txt Stop declaring compiled Catch2 artifacts as arch independent 2021-10-25 14:46:54 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-08-17 07:45:12 +01:00
codecov.yml Sweep out two leftover references to master 2020-10-23 23:02:44 +02:00
conanfile.py Add support for Components 2020-11-02 15:37:35 +01:00
Doxyfile Simple Doxygen file 2020-11-26 18:43:31 +01:00
LICENSE.txt Renamed licence file, license should now be detected by github 2017-03-20 08:59:25 +01:00
mdsnippets.json Add infrastructure for embedding code samples in docs. 2020-10-28 11:38:06 +01:00
README.md Reorganize the main readme 2021-11-16 23:46:22 +01:00
SECURITY.md Add SECURITY.md 2021-11-26 00:10:01 +01:00
WORKSPACE Add Bazel support for the v3 branch 2020-05-26 14:49:49 +02:00

Catch2 logo

Github Releases Linux build status Linux build status MacOS build status Build Status Code Coverage Try online Join the chat in Discord: https://discord.gg/4CWS9zD

What's the Catch2?

Catch2 is mainly a unit testing framework for C++, but it also provides basic micro-benchmarking features, and simple BDD macros.

Catch2's main advantage is that using it is both simple and natural. Tests autoregister themselves and do not have to be named with valid identifiers, assertions look like normal C++ code, and sections provide a nice way to share set-up and tear-down code in tests.

Catch2 v3 is being developed!

You are on the devel branch, where the next major version, v3, of Catch2 is being developed. As it is a significant rework, you will find that parts of this documentation are likely still stuck on v2.

For stable (and documentation-matching) version of Catch2, go to the v2.x branch.

For migrating from the v2 releases to v3, you should look at our documentation. It provides a simple guidelines on getting started, and collects most common migration problems.

How to use it

This documentation comprises these three parts:

More