the lightest feature rich C++ single header testing framework
The doctest library is inspired by the unittest {} functionality of the D programming language and Python's docstrings - tests can be considered a form of documentation and should be able to reside near the production code which they test.
It is heavily influenced by Catch which is currently the most popular, simple and user friendly alternative out there.
- Check out features and design goals to see why this library exists and how it is different from all the rest.
- Check out the tutorial here.
Build status
| Service | branch: master | branch: dev |
|---|---|---|
| Travis-CI (Linux/OSX) |  |  |
| Appveyor (Windows) | ||
| Unit Test Coverage |  |  |
| Static Analysis |  |
Contributing
Support the development of the project with donations! There is a list of planned features which are all important and big - see the roadmap. I work on this project in my spare time and every cent is a big deal. Currently unemployed.
Contributions in the form of issues and pull requests are welcome as well.
Open an issue for a discussion before making a pull request to make sure the contribution goes smoothly.
This framework has some design goals which must be kept. Make sure you have read the features and design goals page.
The master branch is the stable one with the latest release and the dev branch is on the bleeding edge.
All the framework tests have their output collected when the CMake TEST_MODE variable is set to COLLECT (making the new reference output) and later the tests are ran on the CI services (travis and appveyor) - their output is compared with the current reference output in the repository with the COMPARE mode (default mode is NORMAL).
Code should be formatted with a recent-enough clang-format using the config file in the root of the repo (or I will do it...)
Testing with compilers different from GCC/Clang/MSVC (and more platforms) is something the project would benefit from.