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
Mike Crowe 4db8b50aab
Add support for building with Meson (#2530)
The Meson[1] build system makes it easier incorporate third-party
libaries into a project if they also build using Meson.

Let's add a minimal Meson build that's compatible with the CMake build,
along with a GitHub workflow to check that it builds and that at least
the simplest SelfTest runs.

The handling of catch_user_config.hpp is inspired by BUILD.bazel and
doesn't attempt to support any configuratons options. Such features
could be added later.

Meson strongly discourages using wildcards to specify sources, so the
source and header lists are copied from CMakeLists.txt.

Add a new test workflow to test the Meson builds. I was unable to get
these tests to pass with Ubuntu 20.04, so they use Ubuntu 22.04.

I'm neither a CMake nor a Meson expert, but the results seem to work for
me.

[1] https://mesonbuild.com/

Co-authored-by: Mike Crowe <mcrowe@brightsign.biz>
2022-10-01 23:28:30 +02:00
.conan Add support for Components 2020-11-02 15:37:35 +01:00
.github Add support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
CMake Fix building as shared library with MSVC. 2022-09-24 15:15:50 +02:00
data/artwork Move artwork/ to data/artwork/ 2019-12-06 11:36:12 +01:00
docs Fix typos in docs (#2514) 2022-09-09 16:00:39 +02:00
examples Raise the minimum CMake version to 3.10 (#2523) 2022-09-16 17:56:00 +02:00
extras Use DYLD_LIBRARY_PATH on apple platforms. 2022-07-23 20:45:49 +02:00
fuzzing add fuzzer for columns 2020-10-07 17:38:27 +02:00
src Add support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
tests Add support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
third_party fixing UB 2020-07-22 17:17:33 +02:00
tools Add support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
.bazelrc Make Bazel work with CATCH_CONFIG_SHARED_LIBRARY 2022-09-27 22:06:12 +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 Add support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
appveyor.yml Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
BUILD.bazel Make Bazel work with CATCH_CONFIG_SHARED_LIBRARY 2022-09-27 22:06:12 +02:00
CMakeLists.txt Raise the minimum CMake version to 3.10 (#2523) 2022-09-16 17:56:00 +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
codecov.yml Sweep out two leftover references to master 2020-10-23 23:02:44 +02:00
conanfile.py Add lib/cmake/Catch2 to conan builddirs in package recipe so extras/*.cmake files are packaged 2022-06-15 10:50:24 +02: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
mdsnippets.json Add infrastructure for embedding code samples in docs. 2020-10-28 11:38:06 +01:00
meson.build Add support for building with Meson (#2530) 2022-10-01 23:28:30 +02:00
README.md Update the 'Try online' badge link for 3.0.1 2022-06-06 00:29:05 +02:00
SECURITY.md Add SECURITY.md 2021-11-26 00:10:01 +01:00
WORKSPACE.bazel Bazel build: Update of skylib 2022-09-27 22:06:12 +02:00

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