README.md
1
2
3# What is Boost.Test?
4Boost.Test is a C++03 and C++11/14 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. done
22* 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
23* self-registering test cases, organize cases in test suites, apply fixtures on test cases, suites or globally
24* 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
25* 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
26* 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)
27* powerful command line options and test case filters
28* extensible logging, XML and JUNIT outputs for third-party tools (eg. cont. integration)
29* various usage (shared/static library) for faster compilation/build cycles, smaller binaries
30
31# Copyright and license
32Copyright 2001-2014, Gennadiy Rozental.
33Copyright 2013-2018, Boost.Test team.
34
35Distributed under the Boost Software License, Version 1.0.
36(Get a copy at www.boost.org/LICENSE_1_0.txt)
37
38# Contribute
39Please read [this document](CONTRIBUTE.md) to get started.
40
41### Build Status
42
43Branch | Travis | Appveyor | Coverity Scan | codecov.io | Deps | Docs | Tests |
44:-------------: | ------ | -------- | ------------- | ---------- | ---- | ---- | ----- |
45[`master`](https://github.com/boostorg/test/tree/master) | [](https://travis-ci.org/boostorg/test) | [](https://ci.appveyor.com/project/maintainer/test-xyzzy/branch/master) | [](https://scan.coverity.com/projects/boostorg-test) | [](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)
46[`develop`](https://github.com/boostorg/test/tree/develop) | [](https://travis-ci.org/boostorg/test) | [](https://ci.appveyor.com/project/maintainer/test-xyzzy/branch/develop) | [](https://scan.coverity.com/projects/boostorg-test) | [](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)
47
48
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}