A source xPack with Catch2, a modern, C++-native, test framework for unit-tests.
npm install @xpack-3rd-party/catch2This project provides the Catch2 source libraries as an xPack dependency.
The project is hosted on GitHub as
xpack-3rd-party/catch2-xpack.
This page is addressed to developers who plan to include this package
into their own projects.
For maintainer infos, please see the
README-MAINTAINER-XPACK file.
As a source library xPacks, the easiest way to add it to a project is via
xpm, but it can also be used as any Git project, for example as a submodule.
A recent xpm,
which is a portable Node.js command line application.
For details please follow the instructions in the
install page.
This package is available from npmjs.com as@xpack-3rd-party/catch2
from the npmjs.com registry:
``sh
cd my-project
xpm init # Unless a package.json is already present
xpm install @xpack-3rd-party/catch2@latest
`
If, for any reason, xpm is not available, the next recommended
solution is to link it as a Git submodule below an xpacks folder.
`sh
cd my-project
git init # Unless already a Git project
mkdir -p xpacks
git submodule add https://github.com/xpack-3rd-party/catch2-xpack.git \
xpacks/xpack-3rd-party-catch2
`
There are two active branches:
- xpack, with the latest stable version (default)xpack-develop
- , with the current development version
All development is done in the xpack-develop branch, and contributions via
Pull Requests should be directed to this branch. (Only contributions
related to the xPack integration are accepted, functional contributions
should be addressed to the upstream project.)
When new releases are published, the xpack-develop branch is mergedxpack
into .
This package provides the full Catch2 code, but when
installed via xpm the content is filtered and only the
include folders are used.
In addition to the source files, the
configuration files required to integrate it into
CMake and meson projects, by building a static library.
The project is written in C++
For embedded platforms it can be built
on top of an Arm semihosting environment.
#### Include folders
The following folders should be used during the build:
- single_include
The header files can then be included in user projects with statements like:
`c++`
#define CATCH_CONFIG_MAIN
#include
#### Source folders
- None.
#### Preprocessor definitions
There are several proprocessor definitions used to configure the build.
For embedded platfroms, use:
- -D_POSIX_C_SOURCE=200809L
This will enable POSIX support in newlib.
#### Compiler options
- -std=c++20 or higher for C++ sources-std=c11
- for C sources
#### C++ Namespaces
- Catch
#### C++ Classes
The project includes many classes; see the documentation for details.
#### CMake
To integrate the Google Test source library into a CMake application, add this
folder to the build:
`cmake
add_subdirectory("xpacks/xpack-3rd-party-catch2")
``
The result is a static library that can be added as an application
dependency with:
`cmake`
target_link_libraries(your-target PRIVATE
...
xpack-3rd-party::catch2
)
#### meson
To integrate the Google Test source library into a meson application, add this
folder to the build:
`meson`
subdir('xpacks/xpack-3rd-party-catch2')
The result is a static library and a dependency object that can be added
as an application dependency with:
`meson
exe = executable(
your-target,
c_args: xpack_3rd_party_catch2_dependency_c_args,
cpp_args: xpack_3rd_party_catch2_dependency_cpp_args,
dependencies: [
xpack_3rd_party_catch2_dependency,
],
)
`
A simple example showing how to use the Google Test framework is
presented below and is also available in
tests-xpack/src/sample-test.cpp.
`c++
#define CATCH_CONFIG_MAIN
#include
// ...
TEST_CASE ("Check various conditions")
{
CHECK (compute_one () == 1);
CHECK (strcmp (compute_aaa (), "aaa") == 0);
CHECK (compute_condition ());
}
`
- none
The project is fully tested via GitHub
Actions
on each push.
The test platforms are GNU/Linux, macOS and Windows, the tests are
compiled with GCC, clang and arm-none-eabi-gcc and run natively or
via QEMU.
There are two set of tests, one that runs on every push, with a
limited number of tests, and a set that is triggered manually,
usually before releases, and runs all tests on all supported
platforms.
The full set can be run manually with the following commands:
`sh
cd ~Work/catch2-xpack.git
xpm run install-all
xpm run test-all
``
Tho original documentation is available on-line:
-
The xPack content is released under the
MIT License,
with all rights reserved to
Liviu Ionescu.
The upstream content is provided under the terms of the Boost Software License 1.0.
---
The original README content follows.
The latest version of the single header can be downloaded directly using this link
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.
Catch2 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.
* Why do we need yet another C++ Test Framework?
* Tutorial - getting started
* Reference section - all the details