mirror of
https://github.com/pineappleEA/pineapple-src.git
synced 2025-02-08 09:54:05 -05:00
58 lines
3.9 KiB
Markdown
58 lines
3.9 KiB
Markdown
|
|
||
|
|
|
||
|
|
# What is Boost.Test?
|
||
|
|
Boost.Test is a C++03/11/14/17 unit testing library, available on a wide range of platforms and compilers.
|
||
|
|
|
||
|
|
The library is part of [Boost](http://www.boost.org). The latest release
|
||
|
|
of the library is available from the boost web site.
|
||
|
|
|
||
|
|
Full instructions for use of this library can be accessed from
|
||
|
|
http://www.boost.org/doc/libs/release/libs/test/
|
||
|
|
|
||
|
|
# Key features
|
||
|
|
|
||
|
|
* Easy to get started with:
|
||
|
|
1. download and deflate the latest boost archive
|
||
|
|
1. create a test module with this (header version):
|
||
|
|
```
|
||
|
|
#define BOOST_TEST_MODULE your_test_module
|
||
|
|
#include <boost/test/included/unit_test.hpp>
|
||
|
|
```
|
||
|
|
1. Write your first test case:
|
||
|
|
```
|
||
|
|
BOOST_AUTO_TEST_CASE( your_test_case ) {
|
||
|
|
std::vector<int> a{1, 2};
|
||
|
|
std::vector<int> b{1, 2};
|
||
|
|
BOOST_TEST( a == b );
|
||
|
|
}
|
||
|
|
```
|
||
|
|
1. build and run
|
||
|
|
1. done
|
||
|
|
* 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
|
||
|
|
* self-registering test cases, organize cases in test suites, apply fixtures on test cases, suites or globally
|
||
|
|
* 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
|
||
|
|
* 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
|
||
|
|
* 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)
|
||
|
|
* powerful command line options and test case filters
|
||
|
|
* extensible logging, XML and JUNIT outputs for third-party tools (eg. cont. integration)
|
||
|
|
* various usage (shared/static library/header only) for faster integration and/or compilation/build cycles, smaller binaries
|
||
|
|
|
||
|
|
# Copyright and license
|
||
|
|
Copyright 2001-2014, Gennadiy Rozental.<br/>
|
||
|
|
Copyright 2013-2020, Boost.Test team.
|
||
|
|
|
||
|
|
Distributed under the Boost Software License, Version 1.0.<br/>
|
||
|
|
(Get a copy at www.boost.org/LICENSE_1_0.txt)
|
||
|
|
|
||
|
|
# Contribute
|
||
|
|
Please read [this document](CONTRIBUTE.md) to get started.
|
||
|
|
|
||
|
|
# Build Status
|
||
|
|
|
||
|
|
Boost.Test uses mostly the facility provided by our wonderful Boost testers (column `Tests` below).
|
||
|
|
|
||
|
|
Branch | Deps | Docs | Tests |
|
||
|
|
:-------------: | ---- | ---- | ----- |
|
||
|
|
[`master`](https://github.com/boostorg/test/tree/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)
|
||
|
|
[`develop`](https://github.com/boostorg/test/tree/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)
|