Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit e325ef413c.
PrevUpHomeNext

Summary of the API for declaring and organizing tests

Macro

Short description

BOOST_TEST_CASE

BOOST_TEST_CASE_NAME

Manual registration of a test case

BOOST_AUTO_TEST_CASE

Automatic declaration and registration of a test case

BOOST_PARAM_TEST_CASE

Automatic declaration and registration of a test case with a collection of parameters

BOOST_AUTO_TEST_CASE_TEMPLATE

Automatic declaration and registration of a typed test case

BOOST_TEST_CASE_TEMPLATE

Registration of a typed test case with an boost::mpl like sequence of types

BOOST_TEST_CASE_TEMPLATE_FUNCTION

Declaration of the body of a typed test case

BOOST_DATA_TEST_CASE

Declaration of the body of a test case on datasets

BOOST_DATA_TEST_CASE_F

Same as BOOST_DATA_TEST_CASE with fixtures support

BOOST_TEST_DATASET_MAX_ARITY

Controlling the maximal arity of the data test case declared with BOOST_DATA_TEST_CASE

BOOST_TEST_SUITE

Manual creation of a test suite instance

BOOST_AUTO_TEST_SUITE

Automatic declaration of a test suite

BOOST_AUTO_TEST_SUITE_END

Automatic declaration of a test suite

BOOST_TEST_DECORATOR

Adds decorators to a test unit

BOOST_FIXTURE_TEST_CASE

Declares a test case with a fixture

BOOST_FIXTURE_TEST_SUITE

Declares a fixture for a test suite (the setup/teardown is called for each test of the test suite)

BOOST_TEST_GLOBAL_FIXTURE

Declares a fixture globally to the test module

Decorator

Short description

depends_on

Creates a dependency (in the execution order and default run status) from one test case to another.

description

Attaches a semantic string to a test unit, that is visible from the command line interface.

enabled , disabled

Enables or disables unconditionally a test unit. The action of these decorators may be overridden by the command line interface

enable_if

Enables conditionally a test unit. The action of these decorators may be overridden by the command line interface

fixture

Attaches a fixture to a test unit

label

Labels a test unit to form a logical group

precondition

Enables or disables a test unit based on a predicate evaluated just before the execution of the test case.


PrevUpHomeNext