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
Catch2
Что это такое?Catch2 — это фреймворк для модульного тестирования на C++, который также предоставляет базовые возможности микробенчмарков и простые BDD-макросы.
То есть это библиотека, которую я собираю в свой тестовый исполняемый файл, а не отдельный инструмент?Да — вы пишете тесты на C++ и собираете их вместе с Catch2, как с любой другой библиотекой. Она поставляется в виде заголовочных файлов плюс отдельно компилируемой реализации, которую вы линкуете со своим тестовым исполняемым файлом.
Как написать и запустить свой первый тест?Начните с туториала по началу работы в документации; все подробности описаны в отдельном справочном разделе. Документация состоит из трёх частей: зачем нужен этот фреймворк, туториал и справочник.
Какая версия стандарта C++ нужна и подтягивает ли она другие библиотеки?v3 ориентируется на C++14 и новее (работает и C++17), это чистая C++-библиотека без внешних зависимостей. Застряли на C++11? Используйте ветку v2.x; для C++03 есть ветка Catch1.x.
Чем v3 отличается от v2?Главное изменение: v3 больше не библиотека из одного заголовочного файла — проекты, которые раньше просто подключали один заголовок, теперь должны компилировать и линковать обычную библиотеку. В документации есть руководство по миграции, где собраны самые частые проблемы.
Catch2 реально используют в настоящих проектах?Да — в README есть ссылка на список open-source проектов и коммерческих компаний, которые его используют, а репозиторий живёт на GitHub с 2010 года.
Почему тесты в Catch2 писать проще, чем в других C++ тестовых фреймворках?Имена тестов не обязаны быть корректными идентификаторами, проверки выглядят как обычные булевы выражения на C++, а секции дают удобный и локальный способ задавать в тестах общий код подготовки и очистки.
Как запустить микробенчмарки?В Catch2 есть базовое микробенчмаркирование, но по умолчанию бенчмарки не запускаются — их нужно запускать явно с помощью тега [!benchmark].
Зачем ещё один фреймворк для тестирования на C++?Документация буквально открывается этим вопросом и обосновывает его до туториала. Если коротко: автор хотел фреймворк, в котором написание тестов ощущается простым и естественным.
What are similar projects?mocha, ava, testify, googletest, jasmine, cppinsights, coost, pest
Which topics is it in?test-framework, cpp14, cpp17, tdd, unit-testing, no-dependencies, testing, cpp, c++, benchmark, developers, desktop
Creator
catchorg
Size
33 MB
Stars
21.5K
Updated
CommitOct 08Releasev3.16.1Oct 08
Age
15y
Commits · 90 Days