Boost C++ Libraries

libs/test/doc/test_organization/testorg_summary.qbk

[/
 / Copyright (c) 2015 Raffi Enficiaud
 /
 / Distributed under the Boost Software License, Version 1.0. (See accompanying
 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 /]

[section Summary of the API for declaring and organizing tests]

[table
  [
    [Macro]
    [Short description]
  ]

  [/ ###############################################################################################]
  [/ Test cases]
  [
    [__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__]
  ]

  [/ ###############################################################################################]
  [/ Test suites]
  [
    [__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]
  ]

  [/ ###############################################################################################]
  [/ Decorator]
  [
    [__BOOST_TEST_DECORATOR__]
    [Adds decorators to a test unit]
  ]

  [/ ###############################################################################################]
  [/ Fixtures]
  [
    [__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]
  ]

]


[table
  [
    [Decorator]
    [Short description]
  ]

  [
    [__decorator_depends_on__]
    [Creates a dependency (in the execution order and __default_run_status__) from one test case to another.]
  ]

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

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

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

  [
    [__decorator_fixture__]
    [Attaches a fixture to a test unit]
  ]

  [
    [__decorator_label__]
    [Labels a test unit to form a logical group]
  ]

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

]
[endsect]