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ý dcafc605f3
Only reseed the internal RNG when a test is first entered
This fixes multiple issues with random generators, with the most
important one being that multiple nested generators could return
values from the same sequence, due to internal implementation
details of `GENERATE`, and how they interact with test case
paths.

The cost of doing this is that given this simple `TEST_CASE`,
```cpp
TEST_CASE("foo") {
    auto i = GENERATE(take(10, random(0, 100));
    SECTION("A") {
        auto j = GENERATE(take(10, random(0, 100));
    }
    SECTION("B") {
        auto k = GENERATE(take(10, random(0, 100));
    }
}
```

`k` will have different values between running the test as
a whole, e.g. with `./tests "foo"`, and running only the "B"
section with `./tests "foo" -c "B"`.

I consider this an acceptable cost, because the only alternative
would be very messy to implement, and add a lot of brittle and
complex code for relatively little benefit.

If this calculation changes, we will need to instead walk
the current tracker tree whenever a random generator is being
constructed, check for random generators on the path to root,
and take a seed from them.
2022-05-17 21:49:26 +02:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Add pipeline running tests under Valgrind to GitHub Action 2022-04-24 13:34:50 +02:00
CMake Add Wfloat-equal to default-enabled warnings 2022-05-14 15:47:20 +02:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs Add --list-listeners option 2022-05-10 20:57:59 +02:00
examples Add -Wsuggest-destructor-override to enabled warnings 2022-05-03 13:54:02 +02:00
extras Bump version to v3.0.0 preview 5 2022-04-20 23:46:07 +02:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src Only reseed the internal RNG when a test is first entered 2022-05-17 21:49:26 +02:00
tests Make Random*Generators be seedable 2022-05-17 17:57:21 +02:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools Fix release automation script 2022-05-16 18:39:01 +02:00
.bazelrc Add default reporter for Bazel integration (#2399) 2022-04-08 18:01:59 +02:00
.clang-format Clang-format configuration added. 2020-07-22 21:43:30 +02:00
.gitattributes Update gitattributes 2018-07-23 10:15:52 +02:00
.gitignore Clean up .gitignore 2022-05-01 23:10:37 +02:00
BUILD.bazel Add default reporter for Bazel integration (#2399) 2022-04-08 18:01:59 +02:00
CMakeLists.txt Remove some old commented out CMake code 2022-04-28 10:53:03 +02:00
CMakePresets.json Add basic CMake presets 2022-02-22 15:47:11 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-08-17 07:45:12 +01:00
Doxyfile Simple Doxygen file 2020-11-26 18:43:31 +01:00
LICENSE.txt Renamed licence file, license should now be detected by github 2017-03-20 08:59:25 +01:00
README.md Reorganize the main readme 2021-11-16 23:46:22 +01:00
SECURITY.md Add SECURITY.md 2021-11-26 00:10:01 +01:00
WORKSPACE Add default reporter for Bazel integration (#2399) 2022-04-08 18:01:59 +02:00
appveyor.yml Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
codecov.yml Sweep out two leftover references to master 2020-10-23 23:02:44 +02:00
conanfile.py proper support for lib suffix in conan 2022-02-05 20:53:43 +01:00
mdsnippets.json Add infrastructure for embedding code samples in docs. 2020-10-28 11:38:06 +01:00

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's the 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. Tests autoregister themselves and do not have to be named with valid identifiers, assertions look like normal C++ code, and sections provide a nice way to share set-up and tear-down code in tests.

Catch2 v3 is being developed!

You are on the devel branch, where the next major version, v3, of Catch2 is being developed. As it is a significant rework, you will find that parts of this documentation are likely still stuck on v2.

For stable (and documentation-matching) version of Catch2, go to the v2.x branch.

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.

How to use it

This documentation comprises these three parts:

More