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ý 081a1e9aba
ColourGuard is no longer constructed engaged
Forcing it to be engaged explicitly, either via `op<<`, or by
`ColourGuard::engage`, fixes an issue with multiple `ColourGuard`s
being constructed in a single expression. Because the construction
of the `ColourGuard` instances can happen in arbitrary order,
colours would be applied in arbitrary order too. However, a chain
of `op<<`s has strict call orders, fixing this issue.
2022-03-24 16:02:54 +01:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
CMake Fix name of with-main library. 2022-03-04 00:40:55 +01:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs Add eventpp and accessorpp to Catch2 users 2022-03-13 16:56:07 +01:00
examples Examples: remove references to catch_default_main 2022-02-20 13:10:42 +01:00
extras Bump version to v3.0.0 preview 4 2022-01-03 23:16:39 +01:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src ColourGuard is no longer constructed engaged 2022-03-24 16:02:54 +01:00
tests Rename isStdout => isConsole and add doccomment 2022-03-24 16:02:51 +01:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +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 Ignoring VSCode settings dir 2022-01-15 15:45:56 +01:00
appveyor.yml Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
BUILD.bazel Fix borken Bazel build 2022-03-16 14:01:18 +01:00
CMakeLists.txt Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
CMakePresets.json Add basic CMake presets 2022-02-22 15:47:11 +01: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 proper support for lib suffix in conan 2022-02-05 20:53:43 +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 Fix borken Bazel build 2022-03-16 14:01:18 +01: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