README.md (10485B)
1 <p align="center"><img src="scripts/data/logo/logo_1.svg"></p> 2 3 <b> 4 <table> 5 <tr> 6 <td> 7 master branch 8 </td> 9 <td> 10 <a href="https://github.com/doctest/doctest/actions?query=branch%3Amaster"><img src="https://github.com/doctest/doctest/workflows/CI/badge.svg?branch=master"></a> 11 </td> 12 <td> 13 <a href="https://codecov.io/gh/doctest/doctest/branch/master"><img src="https://codecov.io/gh/doctest/doctest/branch/master/graph/badge.svg?token=fAdZl67WN7"/></a> 14 </td> 15 </tr> 16 <tr> 17 <td> 18 dev branch 19 </td> 20 <td> 21 <a href="https://github.com/doctest/doctest/actions?query=branch%3Adev"><img src="https://github.com/doctest/doctest/workflows/CI/badge.svg?branch=dev"></a> 22 </td> 23 <td> 24 <a href="https://codecov.io/gh/doctest/doctest/branch/dev"><img src="https://codecov.io/gh/doctest/doctest/branch/dev/graph/badge.svg?token=fAdZl67WN7"/></a> 25 </td> 26 </tr> 27 </table> 28 </b> 29 30 **doctest** is a new C++ testing framework but is by far the fastest both in compile times (by [**orders of magnitude**](doc/markdown/benchmarks.md)) and runtime compared to other feature-rich alternatives. It brings the ability of compiled languages such as [**D**](https://dlang.org/spec/unittest.html) / [**Rust**](https://doc.rust-lang.org/book/second-edition/ch11-00-testing.html) / [**Nim**](https://nim-lang.org/docs/unittest.html) to have tests written directly in the production code thanks to a fast, transparent and flexible test runner with a clean interface. 31 32 [](https://en.wikipedia.org/wiki/C%2B%2B#Standardization) 33 [](https://opensource.org/licenses/MIT) 34 [](https://raw.githubusercontent.com/doctest/doctest/master/doctest/doctest.h) 35 [](https://bestpractices.coreinfrastructure.org/projects/503) 36 [](https://lgtm.com/projects/g/doctest/doctest/context:cpp) 37 [](https://discord.gg/PGXn9YmyF3) 38 [](https://godbolt.org/z/4s389Kbfs) 39 <!-- 40 [](https://isocpp.org/) 41 [](https://github.com/doctest/doctest/blob/master/doc/markdown/readme.md#reference) 42 --> 43 44 [<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" align="right">](https://www.patreon.com/onqtam) 45 46 The framework is and will stay free but needs your support to sustain its development. There are lots of <a href="https://github.com/doctest/doctest/issues/600"><b>new features</b></a> and maintenance to do. If you work for a company using **doctest** or have the means to do so, please consider financial support. Monthly donations via Patreon and one-offs via PayPal. 47 48 [<img src="https://raw.githubusercontent.com/aha999/DonateButtons/master/paypal-donate-icon-7.png" width=100 align="right">](https://www.paypal.me/onqtam/10) 49 50 A complete example with a self-registering test that compiles to an executable looks like this: 51 52  53 54 There are many C++ testing frameworks - [Catch](https://github.com/catchorg/Catch2), [Boost.Test](http://www.boost.org/doc/libs/1_64_0/libs/test/doc/html/index.html), [UnitTest++](https://github.com/unittest-cpp/unittest-cpp), [cpputest](https://github.com/cpputest/cpputest), [googletest](https://github.com/google/googletest) and [others](https://en.wikipedia.org/wiki/List_of_unit_testing_frameworks#C.2B.2B). 55 56 The **key** differences between it and other testing frameworks are that it is light and unintrusive: 57 - Ultra light on compile times both in terms of [**including the header**](doc/markdown/benchmarks.md#cost-of-including-the-header) and writing [**thousands of asserts**](doc/markdown/benchmarks.md#cost-of-an-assertion-macro) 58 - Doesn't produce any warnings even on the [**most aggressive**](scripts/cmake/common.cmake#L84) warning levels for **MSVC**/**GCC**/**Clang** 59 - Can remove **everything** testing-related from the binary with the [**```DOCTEST_CONFIG_DISABLE```**](doc/markdown/configuration.md#doctest_config_disable) identifier 60 - [**thread-safe**](doc/markdown/faq.md#is-doctest-thread-aware) - asserts can be used from multiple threads spawned from a single test case - [**example**](examples/all_features/concurrency.cpp) 61 - asserts can be used [**outside of a testing context**](doc/markdown/assertions.md#using-asserts-out-of-a-testing-context) - as a general purpose assert library - [**example**](examples/all_features/asserts_used_outside_of_tests.cpp) 62 - No global namespace pollution (everything is in ```doctest::```) & doesn't drag **any** headers with it 63 - [**Portable**](doc/markdown/features.md#extremely-portable) C++11 (use tag [**1.2.9**](https://github.com/doctest/doctest/tree/1.2.9) for C++98) with over 100 different CI builds (static analysis, sanitizers..) 64 - binaries (exe/dll) can use the test runner of another binary => tests in a single registry - [**example**](examples/executable_dll_and_plugin/) 65 66  67 68 This allows the framework to be used in more ways than any other - tests can be written directly in the production code! 69 70 *Tests can be a form of documentation and should be able to reside near the production code which they test.* 71 72 - 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 its source file - or even header file! 73 - Tests in the production code can be thought of as documentation/up-to-date comments - showcasing the APIs 74 - Testing internals that are not exposed through the public API and headers is no longer a mind-bending exercise 75 - [**Test-driven development**](https://en.wikipedia.org/wiki/Test-driven_development) in C++ has never been easier! 76 77 The framework can be used just like any other without mixing production code and tests - check out the [**features**](doc/markdown/features.md). 78 79 **doctest** is modeled after [**Catch**](https://github.com/catchorg/Catch2) and some parts of the code have been taken directly - check out [**the differences**](doc/markdown/faq.md#how-is-doctest-different-from-catch). 80 81 [This table](https://github.com/martinmoene/catch-lest-other-comparison) compares **doctest** / [**Catch**](https://github.com/catchorg/Catch2) / [**lest**](https://github.com/martinmoene/lest) which are all very similar. 82 83 Checkout the [**CppCon 2017 talk**](https://cppcon2017.sched.com/event/BgsI/mix-tests-and-production-code-with-doctest-implementing-and-using-the-fastest-modern-c-testing-framework) on [**YouTube**](https://www.youtube.com/watch?v=eH1CxEC29l8) to get a better understanding of how the framework works and read about how to use it in [**the JetBrains article**](https://blog.jetbrains.com/rscpp/better-ways-testing-with-doctest/) - highlighting the unique aspects of the framework! On a short description on how to use the framework along production code you could refer to [**this GitHub issue**](https://github.com/doctest/doctest/issues/252). There is also an [**older article**](https://accu.org/var/uploads/journals/Overload137.pdf) in the february edition of ACCU Overload 2017. 84 85 [](https://www.youtube.com/watch?v=eH1CxEC29l8) 86 87 Documentation 88 ------------- 89 90 Project: 91 92 - [Features and design goals](doc/markdown/features.md) - the complete list of features 93 - [Community driven roadmap](https://github.com/doctest/doctest/issues/600) - upcoming features 94 - [Benchmarks](doc/markdown/benchmarks.md) - compile-time and runtime supremacy 95 - [Contributing](CONTRIBUTING.md) - how to make a proper pull request 96 - [Changelog](CHANGELOG.md) - generated changelog based on closed issues/PRs 97 98 Usage: 99 100 - [Tutorial](doc/markdown/tutorial.md) - make sure you have read it before the other parts of the documentation 101 - [Assertion macros](doc/markdown/assertions.md) 102 - [Test cases, subcases and test fixtures](doc/markdown/testcases.md) 103 - [Parameterized test cases](doc/markdown/parameterized-tests.md) 104 - [Command line](doc/markdown/commandline.md) 105 - [Logging macros](doc/markdown/logging.md) 106 - [```main()``` entry point](doc/markdown/main.md) 107 - [Configuration](doc/markdown/configuration.md) 108 - [String conversions](doc/markdown/stringification.md) 109 - [Reporters](doc/markdown/reporters.md) 110 - [Extensions](doc/markdown/extensions.md) 111 - [FAQ](doc/markdown/faq.md) 112 - [Build systems](doc/markdown/build-systems.md) 113 - [Examples](examples) 114 115 Contributing 116 ------------ 117 118 [<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" align="right">](https://www.patreon.com/onqtam) 119 120 Support the development of the project with donations! There is a list of planned features which are all important and big - see the [**roadmap**](https://github.com/doctest/doctest/issues/600). 121 122 [<img src="https://raw.githubusercontent.com/aha999/DonateButtons/master/paypal-donate-icon-7.png" width=100 align="right">](https://www.paypal.me/onqtam/10) 123 124 If you work for a company using **doctest** or have the means to do so, please consider financial support. 125 126 Contributions in the form of issues and pull requests are welcome as well - check out the [**Contributing**](CONTRIBUTING.md) page. 127 128 Stargazers over time 129 ------------ 130 131 [](https://starchart.cc/doctest/doctest) 132 133 Logo 134 ------------ 135 136 The [logo](scripts/data/logo) is licensed under a Creative Commons Attribution 4.0 International License. Copyright © 2019 [area55git](https://github.com/area55git) [](https://creativecommons.org/licenses/by/4.0/) 137 138 <p align="center"><img src="scripts/data/logo/icon_2.svg"></p>