Catch2#
A modern, C++-native, test framework for unit-tests, TDD and BDD - using C++14, C++17 and later.
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:
Tutorial - getting started
Reference section - all the details
More#
Issues and bugs can be raised on the Issue tracker on GitHub
For discussion or questions please use our Discord
See who else is using Catch2 in Open Source Software or commercially.
Contents#
- Developer’s API
- Assertion Macros
- Authoring benchmarks
- Tooling integration (CI, test runners and so on)
- CMake integration
- Command line
- Commercial users of Catch2
- Comparing floating point numbers with Catch2
- Compile-time configuration
- Contributing to Catch2
- Deprecations and incoming changes
- Event Listeners
- Frequently Asked Questions (FAQ)
- Data Generators
- Known limitations
- List of examples
- Logging macros
- Matchers
- Migrating from v2 to v3
- Open Source projects using Catch2
- Other macros
- Supplying main() yourself
- Release notes
- How to release
- Reporter events
- Reporters
- Explicitly skipping, passing, and failing tests at runtime
- Test cases and sections
- Test fixtures
- String conversions
- Tutorial
- Best practices and other tips on using Catch2
- Why do we need yet another C++ test framework?