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ý e92b9c07c3 Add an experimental new way of capturing stdout/stderr
Unlike the relatively non-invasive old way of capturing stdout/stderr,
this new way is also able to capture output from C's stdlib functions
such as `printf`. This is done by redirecting stdout and stderr file
descriptors to a file, and then reading this file back.

This approach has two sizeable drawbacks:
1) Performance, obviously. Previously an installed capture made the
program run faster (as long as it was then discarded), because a call
to `std::cout` did not result in text output to the console. This new
capture method in fact forces disk IO. While it is likely that any
modern OS will keep this file in memory-cache and might never actually
issue the IO to the backing storage, it is still a possibility and
calls to the file system are not free.

2) Nonportability. While POSIX is usually assumed portable, and this
implementation relies only on a very common parts of it, it is no
longer standard C++ (or just plain C) and thus might not be available
on some obscure platforms. Different C libs might also implement the
relevant functions in a less-than-useful ways (e.g. MS's `tmpfile`
generates a temp file inside system folder, so it will not work
without elevated privileges and thus is useless).

These two drawbacks mean that, at least for now, the new capture is
opt-in. To opt-in, `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` needs to be
defined in the implementation file.

Closes #1243
2018-04-29 22:25:49 +02:00
.github Added "How to test changes in PR" section to documentation 2017-06-22 18:56:10 +02:00
CMake Add codecov.io coverage tracking 2017-11-27 20:13:47 +01:00
artwork Tweaked logo 2017-11-07 11:41:49 +00:00
contrib Catch ``catch_discover_tests`` 2018-01-11 21:17:12 +01:00
docs Add an experimental new way of capturing stdout/stderr 2018-04-29 22:25:49 +02:00
examples Namespace Catch CMake options 2018-01-18 23:20:26 +01:00
include Add an experimental new way of capturing stdout/stderr 2018-04-29 22:25:49 +02:00
misc Fixup various spelling errors (#1208) 2018-03-07 10:08:35 +01:00
projects Support for parenthesizing types with commas. 2018-04-20 15:11:09 +02:00
scripts Minor fixes to python scripts by pycodestyle 2018-04-27 18:57:18 +02:00
single_include v2.2.2 2018-04-06 12:11:22 +02:00
test_package v2.2.2 2018-04-06 12:11:22 +02:00
third_party Bring in Clara v1.1.4 2018-03-09 10:37:56 +01:00
.gitattributes Keep .py files with LF endings so they can be executed from bash 2018-02-09 16:49:35 +01:00
.gitignore Exclude benchmark dir 2018-01-05 14:39:59 +00:00
.travis.yml Fix potential for false negative CI results on coverage collection 2018-04-01 14:36:55 +02:00
CMakeLists.txt Add an experimental new way of capturing stdout/stderr 2018-04-29 22:25:49 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-08-17 07:45:12 +01:00
LICENSE.txt Renamed licence file, license should now be detected by github 2017-03-20 08:59:25 +01:00
README.md v2.2.2 2018-04-06 12:11:22 +02:00
appveyor.yml Disable PIP's version check on AppVeyor 2018-03-22 15:19:09 +01:00
catch.pc.in Small fix to generate pc with include path 2018-04-02 21:38:17 +02:00
codecov.yml Set patch coverage check to target 80% 2018-02-09 20:09:55 +01:00
conanfile.py v2.2.2 2018-04-06 12:11:22 +02:00

README.md

catch logo

Github Releases Build Status Build status codecov Try online

The latest version of the single header can be downloaded directly using this link

Catch2 is released!

If you've been using an earlier version of Catch, please see the Breaking Changes section of the release notes before moving to Catch2. You might also like to read this blog post for more details.

What's the Catch?

Catch2 stands for C++ Automated Test Cases in a Header and is a multi-paradigm test framework for C++. which also supports Objective-C (and maybe C). It is primarily distributed as a single header file, although certain extensions may require additional headers.

How to use it

This documentation comprises these three parts:

More