Catch2 README

The project's README from github.com/catchorg/Catch2. As one markdown file: README.md.

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/catch_test_macros.hpp>
#include <catch2/benchmark/catch_benchmark.hpp>

#include <cstdint>

uint64_t fibonacci(uint64_t number) {
    return number < 2 ? number : 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);
    };
}

Note that benchmarks are not run by default, so you need to run it explicitly with the [!benchmark] tag.

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

Catch2 (catchorg/Catch2)

Searching Database…

21.5K ·GitHub
What is this?Catch2 is a unit testing framework for C++ that also provides basic micro-benchmarking features and simple BDD macros.
So it is a library I build into my own test executable, not a standalone tool?Yes — you write tests in C++ and build them against Catch2 like any other library. It ships as headers plus a separately compiled implementation that you link into your test executable.
How do I write and run my first test?Start with the getting-started tutorial in the documentation; a full reference section covers the details. The docs come in three parts: why the framework exists, the tutorial, and the reference.
Which C++ standard does it need, and does it pull in other libraries?v3 targets C++14 and later (C++17 works too) and is C++-native with no external dependencies. Stuck on C++11? Use the v2.x branch; C++03 lives on the Catch1.x branch.
What is different about v3 compared to v2?The big change is that v3 is no longer a single-header library — builds that just dropped in one header must now compile and link a normal library. The documentation has a migration guide collecting the most common problems.
Do real projects actually use Catch2?Yes — the README links a list of open-source projects and commercial companies using it, and the repository has been on GitHub since 2010.
What makes tests easier to write in Catch2 than in other C++ test frameworks?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.
How do I run the micro-benchmarks?Catch2 includes basic micro-benchmarking, but benchmarks are not run by default — you have to run them explicitly with the [!benchmark] tag.
Why yet another C++ test framework?The documentation literally opens with that question and argues the case before the tutorial. In short, the author wanted a framework where writing tests feels simple and natural.
What are similar projects?mocha, ava, testify, googletest, jasmine, cppinsights, coost, pest
Creator
catchorg
Size
33 MB
Stars
21.5K
Age
15y
Commits · 90 Days