pytest-cpp
Use pytest runner to discover and execute C++ tests.
Supports Google Test, Boost.Test, and Catch2:
This brings several benefits:
- Allows you to run all your tests in multi-language projects with a single command;
- Execute C++ tests in parallel using pytest-xdist plugin;
- Use
--junitxml
option to produce a single and uniform xml file with all your test suite results; - Filter which tests to run using standard test filtering capabilities, such as
by file names, directories, keywords by using the
-k
option, etc.;
Table of Contents
Installation
Install using pip:
$ pip install pytest-cpp
Usage
$ pytest
Once installed, pytest runs will search and run tests found in executable files, detecting if the suites are Google, Boost, or Catch2 tests automatically.
Configuration Options
Following are the options that can be put in the pytest configuration file related to pytest-cpp.
cpp_files
You can configure which files are tested for suites by using the cpp_files
ini configuration option:
[pytest]
cpp_files = test_suite*
By default matches test_*
and *_test
executable files.
cpp_arguments
Arguments to the C++ tests can be provided with the
cpp_arguments
ini configuration option.
For example:
[pytest]
cpp_arguments =-v --log-dir=logs
You can change this option directly in the command-line using
pytest's -o
option:
$ pytest -o cpp_arguments='-v --log-dir=logs'
Important: do not pass filtering arguments (for example --gtest_filter
), as this will conflict
with the plugin functionality and behave incorrectly.
To filter tests, use the standard pytest filtering facilities (such as -k
).
cpp_ignore_py_files
This option defaults to True
and configures the plugin to ignore *.py
files that
would otherwise match the cpp_files
option.
Set it to False
if you have C++ executable files that end with the *.py
extension.
[pytest]
cpp_ignore_py_files = False
cpp_harness
This option allows the usage of tools that are used by invoking them on the console wrapping the test binary, like valgrind and memcheck:
[pytest]
cpp_harness = valgrind --tool=memcheck
cpp_harness_collect
This option allows the usage of tools or emulators (like wine or qemu) that are used by invoking them on the console wrapping the test binary during a test collection.
Might be used in the combination with cpp_harness
to run a binary in emulators, like wine or qemu
in cross-compilation targets.
[pytest]
cpp_harness_collect = qemu-x86_64 -L libs/
or
[pytest]
cpp_harness_collect = qemu-x86_64 -L libs/
cpp_harness = qemu-x86_64 -L libs/
Changelog
Please consult CHANGELOG.
Support
All feature requests and bugs are welcome, so please make sure to add feature requests and bugs to the issues page!