README.md
1
2
3# What is Boost.Test?
4Boost.Test is a C++03/11/14/17 unit testing library, available on a wide range of platforms and compilers.
5
6The library is part of [Boost](www.boost.org). The latest release
7of the library is available from the boost web site.
8
9Full instructions for use of this library can be accessed from
10http://www.boost.org/doc/libs/release/libs/test/
11
12# Key features
13
14* Easy to get started with:
15 1. download and deflate the latest boost archive
16 1. create a test module with this (header version):
17 ```
18 #define BOOST_TEST_MODULE your_test_module
19 #include <boost/test/included/unit_test.hpp>
20 ```
21 1. Write your first test case:
22 ```
23 BOOST_AUTO_TEST_CASE( your_test_case ) {
24 std::vector<int> a{1, 2};
25 std::vector<int> b{1, 2};
26 BOOST_TEST( a == b );
27 }
28 ```
29 1. build and run
30 1. done
31* powerful and unique test assertion macro [`BOOST_TEST`](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/testing_tools/boost_test_universal_macro.html), that understands floating points, collections, strings... and uses appropriate comparison paradigm
32* self-registering test cases, organize cases in test suites, apply fixtures on test cases, suites or globally
33* provide assertion [context](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/test_output/test_tools_support_for_logging/contexts.html) for advanced diagnostic on failure
34* powerful and extensible [dataset](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/tests_organization/test_cases/test_case_generation.html) tests
35* add [decoration](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/tests_organization/decorators.html) to test cases and suites for [advanced description](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/tests_organization/semantic.html), [group/label](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/tests_organization/tests_grouping.html), and [dependencies](http://www.boost.org/doc/libs/release/libs/test/doc/html/boost_test/tests_organization/tests_dependencies.html)
36* powerful command line options and test case filters
37* extensible logging, XML and JUNIT outputs for third-party tools (eg. cont. integration)
38* various usage (shared/static library/header only) for faster integration and/or compilation/build cycles, smaller binaries
39
40# Copyright and license
41Copyright 2001-2014, Gennadiy Rozental.<br/>
42Copyright 2013-2020, Boost.Test team.
43
44Distributed under the Boost Software License, Version 1.0.<br/>
45(Get a copy at www.boost.org/LICENSE_1_0.txt)
46
47# Contribute
48Please read [this document](CONTRIBUTE.md) to get started.
49
50# Build Status
51
52Branch | Travis | Appveyor | codecov.io | Deps | Docs | Tests |
53:-------------: | ------ | -------- | ---------- | ---- | ---- | ----- |
54[`master`](https://github.com/boostorg/test/tree/master) | [](https://travis-ci.org/boostorg/test) | [](https://ci.appveyor.com/project/raffienficiaud/test/branch/master) | [](https://codecov.io/gh/boostorg/test/branch/master) | [](https://pdimov.github.io/boostdep-report/master/test.html) | [](http://www.boost.org/doc/libs/master/doc/html/test.html) | [](http://www.boost.org/development/tests/master/developer/test.html)
55[`develop`](https://github.com/boostorg/test/tree/develop) | [](https://travis-ci.org/boostorg/test) | [](https://ci.appveyor.com/project/raffienficiaud/test/branch/develop) | [](https://codecov.io/gh/boostorg/test/branch/develop) | [](https://pdimov.github.io/boostdep-report/develop/test.html) | [](http://www.boost.org/doc/libs/develop/doc/html/test.html) | [](http://www.boost.org/development/tests/develop/developer/test.html)
56
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}