Catch2 – catchorg

catchorg/Catch2

开发框架 / 工具库

21,422 Stars 3,499 Forks C++ BSL-1.0

Views · 浏览

项目简介

现代、原生的 C++ 测试框架，用于单元测试、TDD 和 BDD - 使用 C++14、C++17 及更高版本（C++11 支持在 v2.x 分支，C++03 在 Catch1.x 分支）

一键直达 GitHub Gitee 搜索访问主页

SECTION · 01

关键指标一览

Stars 数

21,422

Forks 数

3,499

Watchers 数

21,422

Issue 数

440

主要语言

C++

许可证

BSL-1.0

仓库所有者

catchorg

创建时间

2010.11.08

更新时间

2026.08.07

主题标签

bdd cpp cpp14 framework no-dependencies tdd test-framework testing

SECTION · 03

README 详细介绍

README 原文为英文,如需阅读完整中文内容,建议使用 浏览器翻译插件(如 Edge 浏览器自带翻译、Google 翻译扩展)进行整页翻译。

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](docs/migrate-v2-to-v3.md#top). 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](https://github.com/catchorg/Catch2/tree/v2.x).