Boost C++ Libraries

Table of Contents

Introduction

Design rationale

How to read this documentation

Usage variants

Declaring and organizing tests

Test cases

Test cases without parameters

Data-driven test cases

Template test cases

Parametrized test cases

Test suite

Master Test Suite

Decorators

Suite-level decorators

Explicit decorator declaration

Fixtures

Fixture models

Test case fixture

Test suite entry/exit fixture

Global fixture

Managing test dependencies

Grouping tests into logical units by labels

Enabling or disabling test unit execution

Adding semantic to a test

Summary of the API for declaring and organizing tests

Writing unit tests

Assertion severity level

BOOST_TEST: universal and general purpose assertions

Reported information

Extended comparisons support

Floating point comparison

C-string comparison

Collections comparison

Bitwise comparison

Time-out for test cases

Expected failures specification

Custom predicate support

Output streams testing tool

Technical details

Debugging the assertions

Summary of the API for writing tests

Controlling outputs

Test log output

Verbosity of the logs

Disabling automatic printing for specific types

Custom messages

Checkpoints

Contexts

Logging floating point type numbers

Human readable log format

XML based log output format

Compile time configuration

Log output stream redirection

Log level configuration

Predefined log format selection

Custom log format support

Test reports

Progress display

Summary of the API for controlling the output

Runtime parameters

Test unit filtering

Summary of run-time parameters

Advanced Usage Scenarios

Building the Unit Test Framework

Test module's entry point

Test module's initialization

Test module runner

Single-header variant customizations

Customizing the module's entry point

Customizing the module's initialization function

Static-library variant customizations

Customizing the module's entry point

Customizing the module's initialization function

Shared-library variant customizations

Customizing the module's entry point

Customizing the module's initialization function

The external test runner usage variant

The obsolete initialization function

Practical usage recommendations

General

IDE usage recommendations

Command line usage recommendations

Tutorials

Test driven development with Boost.Test

A testing framework, what for?

Web Wisdom

Frequently Asked Questions

Glossary

Change log

Acknowledgements

Unit Test Framework API reference

Tests declaration and organization

BOOST_TEST_CASE

BOOST_AUTO_TEST_CASE

BOOST_AUTO_TEST_CASE_TEMPLATE

BOOST_TEST_CASE_TEMPLATE

BOOST_TEST_CASE_TEMPLATE_FUNCTION

BOOST_PARAM_TEST_CASE

BOOST_DATA_TEST_CASE

BOOST_TEST_SUITE

BOOST_AUTO_TEST_SUITE

BOOST_AUTO_TEST_SUITE_END

BOOST_FIXTURE_TEST_CASE

BOOST_FIXTURE_TEST_SUITE

BOOST_GLOBAL_FIXTURE

BOOST_TEST_DECORATOR

depends_on (decorator)

description (decorator)

enabled / disabled (decorator)

enable_if (decorator)

fixture (decorator)

label (decorator)

precondition (decorator)

Reference API for writing tests

BOOST_TEST

expected_failures (decorator)

timeout (decorator)

tolerance (decorator)

BOOST_<level>

BOOST_<level>_BITWISE_EQUAL

BOOST_<level>_EQUAL

BOOST_<level>_EQUAL_COLLECTIONS

BOOST_<level>_CLOSE

BOOST_<level>_CLOSE_FRACTION

BOOST_<level>_EXCEPTION

BOOST_<level>_GE

BOOST_<level>_GT

BOOST_<level>_LE

BOOST_<level>_LT

BOOST_<level>_MESSAGE

BOOST_<level>_NE

BOOST_<level>_NO_THROW

BOOST_<level>_PREDICATE

BOOST_<level>_SMALL

BOOST_<level>_THROW

BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES

BOOST_ERROR

BOOST_FAIL

BOOST_IS_DEFINED

BOOST_TEST_TOOLS_UNDER_DEBUGGER

BOOST_TEST_TOOLS_DEBUGGABLE

Controlling tests outputs

BOOST_TEST_CHECKPOINT

BOOST_TEST_PASSPOINT

BOOST_TEST_MESSAGE

BOOST_TEST_INFO

BOOST_TEST_CONTEXT

BOOST_TEST_DONT_PRINT_LOG_VALUE

Runtime parameters reference

show_progress

build_info

auto_start_dbg

catch_system_errors

break_exec_path

color_output

log_format

log_level

run_test

output_format

report_format

result_code

report_level

random

detect_memory_leaks

use_alt_stack

detect_fp_exceptions

log_sink

report_sink

save_pattern

list_content

Build scenarios and behaviors

BOOST_TEST_MAIN

BOOST_TEST_MODULE

BOOST_TEST_ALTERNATIVE_INIT_API

BOOST_TEST_NO_LIB

BOOST_TEST_DYN_LINK

BOOST_TEST_NO_MAIN

Reference

Header <boost/test/data/config.hpp>

Header <boost/test/data/monomorphic/array.hpp>

Header <boost/test/data/monomorphic/collection.hpp>

Header <boost/test/data/monomorphic/dataset.hpp>

Header <boost/test/data/monomorphic/fwd.hpp>

Header <boost/test/data/monomorphic/generate.hpp>

Header <boost/test/data/monomorphic/generators.hpp>

Header <boost/test/data/monomorphic/generators/keywords.hpp>

Header <boost/test/data/monomorphic/generators/random.hpp>

Header <boost/test/data/monomorphic/generators/xrange.hpp>

Header <boost/test/data/monomorphic/grid.hpp>

Header <boost/test/data/monomorphic/join.hpp>

Header <boost/test/data/monomorphic/singleton.hpp>

Header <boost/test/data/monomorphic/zip.hpp>

Header <boost/test/data/size.hpp>

Header <boost/test/data/test_case.hpp>

Header <boost/test/debug.hpp>

Header <boost/test/debug_config.hpp>

Header <boost/test/execution_monitor.hpp>

Header <boost/test/framework.hpp>

Header <boost/test/output/compiler_log_formatter.hpp>

Header <boost/test/output/plain_report_formatter.hpp>

Header <boost/test/output/xml_log_formatter.hpp>

Header <boost/test/output/xml_report_formatter.hpp>

Header <boost/test/parameterized_test.hpp>

Header <boost/test/progress_monitor.hpp>

Header <boost/test/results_collector.hpp>

Header <boost/test/results_reporter.hpp>

Header <boost/test/tools/assertion_result.hpp>

Header <boost/test/tools/detail/bitwise_manip.hpp>

Header <boost/test/tools/detail/lexicographic_manip.hpp>

Header <boost/test/tools/detail/per_element_manip.hpp>

Header <boost/test/tools/detail/tolerance_manip.hpp>

Header <boost/test/tools/floating_point_comparison.hpp>

Header <boost/test/tools/output_test_stream.hpp>

Header <boost/test/tree/test_unit.hpp>

Header <boost/test/unit_test.hpp>

Header <boost/test/unit_test_log_formatter.hpp>

Header <boost/test/unit_test_parameters.hpp>

Header <boost/test/utils/algorithm.hpp>

Header <boost/test/utils/is_forward_iterable.hpp>

Header <boost/test/utils/named_params.hpp>