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
2020-11-02 15:37:35 +01:00
.conan Sweep out two leftover references to master 2020-10-23 23:02:44 +02:00
.github Update FUNDING file (-Patreon, +PayPal) 2020-07-24 22:35:17 +02:00
CMake Sweep out Wshadow 2020-09-06 13:11:42 +02:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs Picked release notes for v2.13.3 2020-11-02 14:42:24 +01:00
examples Split EventListener base from streaming_base.hpp 2020-08-29 19:09:54 +02:00
extras Consider CMP0110 add_test() policy 2020-11-02 14:42:22 +01:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src Fix potential infinite loops in generators combined with section filter 2020-10-23 21:21:15 +02:00
tests Tighten the test for matching filenames-as-tags 2020-10-23 23:02:09 +02:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools Bump OpenCppCoverage to 0.9.9.0 2020-10-29 13:39:35 +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
.travis.yml Provide 1 .hpp + 1 .cpp distribution of Catch2 2020-09-09 13:02:50 +02:00
appveyor.yml Bump OpenCppCoverage to 0.9.9.0 2020-10-29 13:39:35 +01:00
BUILD.bazel Add Bazel support for the v3 branch 2020-05-26 14:49:49 +02:00
CMakeLists.txt Enable IPO for CMake versions that support it 2020-11-01 09:36:42 +00: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 Inject conan_basic_setup to properly set MD/MT flags 2020-11-02 15:37:35 +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 Link to the migration docs from main readme and docs/readme 2020-10-31 09:08:58 +01:00
WORKSPACE Add Bazel support for the v3 branch 2020-05-26 14:49:49 +02:00

Catch2 logo

Github Releases 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