ceph/src/boost/libs/test/doc/test_organization/testorg_summary.qbk

   1 [/
   2  / Copyright (c) 2015 Raffi Enficiaud
   3  /
   4  / Distributed under the Boost Software License, Version 1.0. (See accompanying
   5  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6  /]
   7
   8 [section Summary of the API for declaring and organizing tests]
   9
  10 [table
  11   [
  12     [Macro]
  13     [Short description]
  14   ]
  15
  16   [/ ###############################################################################################]
  17   [/ Test cases]
  18   [
  19     [__BOOST_TEST_CASE__]
  20     [Manual registration of a test case]
  21   ]
  22   [
  23     [__BOOST_AUTO_TEST_CASE__]
  24     [Automatic declaration and registration of a test case]
  25   ]
  26   [
  27     [__BOOST_PARAM_TEST_CASE__]
  28     [Automatic declaration and registration of a test case with a collection of parameters]
  29   ]
  30   [
  31     [__BOOST_AUTO_TEST_CASE_TEMPLATE__]
  32     [Automatic declaration and registration of a typed test case]
  33   ]
  34   [
  35     [__BOOST_TEST_CASE_TEMPLATE__]
  36     [Registration of a typed test case with an `boost::mpl` like sequence of types]
  37   ]
  38   [
  39     [__BOOST_TEST_CASE_TEMPLATE_FUNCTION__]
  40     [Declaration of the body of a typed test case]
  41   ]
  42
  43   [
  44     [__BOOST_DATA_TEST_CASE__]
  45     [Declaration of the body of a test case on datasets]
  46   ]
  47
  48   [
  49     [__BOOST_DATA_TEST_CASE_F__]
  50     [Same as __BOOST_DATA_TEST_CASE__ with fixtures support]
  51   ]
  52
  53   [
  54     [__BOOST_TEST_DATASET_MAX_ARITY__]
  55     [Controlling the maximal arity of the data test case declared with __BOOST_DATA_TEST_CASE__]
  56   ]
  57
  58   [/ ###############################################################################################]
  59   [/ Test suites]
  60   [
  61     [__BOOST_TEST_SUITE__]
  62     [Manual creation of a test suite instance]
  63   ]
  64   [
  65     [__BOOST_AUTO_TEST_SUITE__]
  66     [Automatic declaration of a test suite]
  67   ]
  68   [
  69     [__BOOST_AUTO_TEST_SUITE_END__]
  70     [Automatic declaration of a test suite]
  71   ]
  72
  73   [/ ###############################################################################################]
  74   [/ Decorator]
  75   [
  76     [__BOOST_TEST_DECORATOR__]
  77     [Adds decorators to a test unit]
  78   ]
  79
  80   [/ ###############################################################################################]
  81   [/ Fixtures]
  82   [
  83     [__BOOST_FIXTURE_TEST_CASE__]
  84     [Declares a test case with a fixture]
  85   ]
  86   [
  87     [__BOOST_FIXTURE_TEST_SUITE__]
  88     [Declares a fixture for a test suite (the setup/teardown is called for each test of the test suite)]
  89   ]
  90   [
  91     [__BOOST_GLOBAL_FIXTURE__]
  92     [Declares a fixture globally to the test module]
  93   ]
  94
  95 ]
  96
  97
  98 [table
  99   [
 100     [Decorator]
 101     [Short description]
 102   ]
 103
 104   [
 105     [__decorator_depends_on__]
 106     [Creates a dependency (in the execution order and __default_run_status__) from one test case to another.]
 107   ]
 108
 109   [
 110     [__decorator_description__]
 111     [Attaches a semantic string to a test unit, that is visible from the command line interface.]
 112   ]
 113
 114   [
 115     [__decorator_enabled__ , __decorator_disabled__]
 116     [Enables or disables unconditionally a test unit. The action of these decorators may be overridden by the command line interface]
 117   ]
 118
 119   [
 120     [__decorator_enable_if__]
 121     [Enables conditionally a test unit. The action of these decorators may be overridden by the command line interface]
 122   ]
 123
 124   [
 125     [__decorator_fixture__]
 126     [Attaches a fixture to a test unit]
 127   ]
 128
 129   [
 130     [__decorator_label__]
 131     [Labels a test unit to form a logical group]
 132   ]
 133
 134   [
 135     [__decorator_precondition__]
 136     [Enables or disables a test unit based on a predicate evaluated just before the execution of the test case.]
 137   ]
 138
 139 ]
 140 [endsect]