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
Martin Hořeňovský 10fb93cce8
Add new reporter event called for each test case enter/exit
This means that e.g. for `TEST_CASE` with two sibling `SECTION`s
the event will fire twice, because the `TEST_CASE` will be entered
twice.

Closes #2107 (the event mentioned there already exists, but this
is its counterpart that we also want to provide to users)
2021-09-14 13:19:45 +02:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Always install the used compiler in Github Actions 2021-05-28 11:30:06 +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 Update release notes with new fixes, improvements and breaking changes 2021-09-07 22:00:57 +02:00
examples Fix typos in the code base (#2206) 2021-04-07 20:43:50 +02: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 Add new reporter event called for each test case enter/exit 2021-09-14 13:19:45 +02:00
tests Add new reporter event called for each test case enter/exit 2021-09-14 13:19:45 +02:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools Fix updateVersionPlaceholder when the placeholder starts the line 2021-05-09 18:05:27 +02: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 Don't include CTest in non-development builds. 2021-05-29 16:24:44 +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 Add GitHub Actions badges to README 2021-08-07 21:18:00 +02: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

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.

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.

How to use it

This documentation comprises these three parts:

More