f4ea19fd326829164ee9cfedd1e2e8c831afd264 - github/onqtam/doctest

commit	f4ea19fd326829164ee9cfedd1e2e8c831afd264	[log] [tgz]
author	onqtam <vik.kirilov@gmail.com>	Tue Sep 20 00:07:56 2016 +0300
committer	onqtam <vik.kirilov@gmail.com>	Wed Sep 21 15:46:15 2016 +0300
tree	103e3749a80ce533f99690130e86cf349bcd0a22
parent	ce59fd1d054fa6afe94ed33c758272cba3e141fc [diff]

tree: 103e3749a80ce533f99690130e86cf349bcd0a22

README.md

The lightest feature-rich C++ single-header testing framework for unit tests and TDD

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.

A complete example with a self-registering test that compiles to an executable looks like this:

cover-example

Note how a standard C++ operator for equality comparison is used - doctest has one core assertion macro (it also has for less than, equals, greater than...) - yet the full expression is decomposed and the left and right values are logged.

It is modeled after Catch which is currently the most popular and easy to use alternative for testing in C++

There are many C++ testing frameworks - Catch, Boost.Test, UnitTest++, cpputest, googletest and many other.

What makes doctest different is that it is ultra light on compile times (by orders of magnitude) and is unintrusive.

The key differences between it and other testing libraries are:

Ultra light - below 10ms of compile time overhead for including the header in a source file
Offers a way to remove everything testing-related from the binary with the DOCTEST_CONFIG_DISABLE identifier
Doesn't pollute the global namespace (everything is in the doctest namespace) and doesn't drag any headers with it
Doesn't produce any warnings even on the most aggressive warning levels for MSVC/GCC/Clang
Very portable and well tested C++98 - per commit tested on CI with over 200 different builds (valgrind, sanitizers...)
Just one header and no external dependencies apart from the C/C++ standard library! (well... same as Catch...)

This allows the library to be used in more ways than any other - tests can be written directly in the production code!

This makes the barrier for writing tests much lower - you don't have to: 1. make a separate source file 2. include a bunch of stuff in it 3. add it to the build system and 4. add it to source control - You can just write the tests for a class or a piece of functionality at the bottom of it's source file - or even header file!
Tests in the production code can be thought of as documentation or up-to-date comments - showing how an API is used
Tests can be shipped to the customer with the software to diagnose a bug faster
Test-driven development in C++ has never been easier!

The library can be used like any other if you don't like the idea of mixing production code and tests - check out the features

master branch	Linux/OSX	Windows
dev branch	Linux/OSX	Windows

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 took a break from working in the industry to make open source software so every cent is a big deal.

If you work for a company using doctest or have the means to do so, please consider financial support.

Contributions in the form of issues and pull requests are welcome as well - check out the Contributing page.

Documentation

Features and design goals - the complete list of features
Roadmap - upcoming features
Tutorial - make sure you have read it before the other parts of the documentation
Benchmarks - compile-time supremacy
Contributing
Examples

The lightest feature-rich C++ single-header testing framework for unit tests and TDD

Contributing

Documentation

Sponsors