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ý be060cde44
Update README.md
* Add usage examples to the introduction
* Mention that v3 has been released
2022-10-17 21:47:22 +02:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Downgrade MacOS version in GHA 2022-10-15 13:06:50 +02:00
CMake improve -ffile-prefix-map detection (#2517) 2022-10-04 15:55:50 +02:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs 3.1.1 2022-10-17 19:57:58 +02:00
examples Raise the minimum CMake version to 3.10 (#2523) 2022-09-16 17:56:00 +02:00
extras 3.1.1 2022-10-17 19:57:58 +02:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src 3.1.1 2022-10-17 19:57:58 +02:00
tests meson cleanups with muon (#2539) 2022-10-03 17:23:38 +02:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools meson cleanups with muon (#2539) 2022-10-03 17:23:38 +02:00
.bazelrc Make Bazel work with CATCH_CONFIG_SHARED_LIBRARY 2022-09-27 22:06:12 +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 support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
appveyor.yml Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
BUILD.bazel Make Bazel work with CATCH_CONFIG_SHARED_LIBRARY 2022-09-27 22:06:12 +02:00
CMakeLists.txt 3.1.1 2022-10-17 19:57:58 +02: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 Add lib/cmake/Catch2 to conan builddirs in package recipe so extras/*.cmake files are packaged 2022-06-15 10:50:24 +02: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
meson.build 3.1.1 2022-10-17 19:57:58 +02:00
README.md Update README.md 2022-10-17 21:47:22 +02:00
SECURITY.md Add SECURITY.md 2021-11-26 00:10:01 +01:00
WORKSPACE.bazel Bazel build: Update of skylib 2022-09-27 22:06:12 +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 is 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. Test names do not have to be valid identifiers, assertions look like normal C++ boolean expressions, and sections provide a nice and local way to share set-up and tear-down code in tests.

Example unit test

#include <catch2/catch_test_macros.hpp>

#include <cstdint>

uint32_t factorial( uint32_t number ) {
    return number <= 1 ? number : factorial(number-1) * number;
}

TEST_CASE( "Factorials are computed", "[factorial]" ) {
    REQUIRE( factorial( 1) == 1 );
    REQUIRE( factorial( 2) == 2 );
    REQUIRE( factorial( 3) == 6 );
    REQUIRE( factorial(10) == 3'628'800 );
}

Example microbenchmark

#include <catch2/benchmark/catch_benchmark.hpp>

#include <cstdint>

uint64_t fibonacci(uint64_t number) {
    return number < 2 ? 1 : fibonacci(number - 1) + fibonacci(number - 2);
}

TEST_CASE("Benchmark Fibonacci", "[!benchmark]") {
    REQUIRE(Fibonacci(5) == 5);

    REQUIRE(Fibonacci(20) == 6'765);
    BENCHMARK("Fibonacci 20") {
        return Fibonacci(20);
    };

    REQUIRE(Fibonacci(25) == 75'025);
    BENCHMARK("Fibonacci 25") {
        return Fibonacci(25);
    };
}

Catch2 v3 has been released!

You are on the devel branch, where the v3 version is being developed. v3 brings a bunch of significant changes, the big one being that Catch2 is no longer a single-header library. Catch2 now behaves as a normal library, with multiple headers and separately compiled implementation.

The documentation is slowly being updated to take these changes into account, but this work is currently still ongoing.

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.

For the previous major version of Catch2 look into the v2.x branch here on GitHub.

How to use it

This documentation comprises these three parts:

More