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ý 9137e591fa
Cleanup and optimize stringifying of string-like types
More specifically, made the actual implementation of string-like
type handling take argument as `Catch::StringRef`, instead of
taking `std::string const&`.

This means that string-like types that are not `std::string` no
longer need to pay for an extra construction of `std::string`
(including the potential allocation), before they can be stringified.

The actual string stringification routine is now also better about
reserving sufficient space.
2021-05-18 23:15:22 +02:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Fix and improve GitHub Actions CI 2021-04-30 23:26:28 +02:00
CMake Make the static library build reproducible with supported compilers 2021-05-09 18:05:34 +02:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs Remove mention of `ANON_TEST_CASE` from documentation 2021-05-10 21:49:45 +02:00
examples Fix typos in the code base (#2206) 2021-04-07 20:43:50 +02:00
extras Add deprecation warning in ParseAndCatchTests 2021-05-09 18:05:25 +02:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src Cleanup and optimize stringifying of string-like types 2021-05-18 23:15:22 +02:00
tests Cleanup and optimize stringifying of string-like types 2021-05-18 23:15:22 +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
.travis.yml Remove conan to bintray packaging task from travis 2021-05-09 17:45:29 +02:00
BUILD.bazel Add Bazel support for the v3 branch 2020-05-26 14:49:49 +02:00
CMakeLists.txt Prepare to prevent Catch2 v3's tests from being run, and CTest targets from being added, if Catch2 is configured as a sub-project. (#2205) 2021-04-16 21:19:58 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-08-17 07:45:12 +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
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
appveyor.yml Add Linux and Windows CI builds with surrogate TUs 2021-02-19 23:23:00 +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
mdsnippets.json Add infrastructure for embedding code samples in docs. 2020-10-28 11:38:06 +01:00

README.md

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