libs/test/doc/testing_tools/testing_tools_summary.qbk

   1 [/
   2  / Copyright (c) 2015 Boost.Test contributors
   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 Summary of the API for writing tests]
   9
  10 [table
  11   [
  12     [Assertions]
  13     [Short description]
  14   ]
  15
  16   [/ ###############################################################################################]
  17   [
  18     [__BOOST_TEST__, __BOOST_TEST_LEVEL__]
  19     [General purpose assertion macro.]
  20   ]
  21
  22   [/ ###############################################################################################]
  23   [
  24     [__BOOST_LEVEL__]
  25     [Simple validation of a boolean predicate value.]
  26   ]
  27
  28   [/ ###############################################################################################]
  29   [
  30     [__BOOST_LEVEL_BITWISE_EQUAL__]
  31     [Bitwise equality test of two elements.]
  32   ]
  33
  34   [/ ###############################################################################################]
  35   [
  36     [__BOOST_LEVEL_EQUAL__]
  37     [Equality test of two elements.]
  38   ]
  39
  40   [/ ###############################################################################################]
  41   [
  42     [__BOOST_LEVEL_EQUAL_COLLECTIONS__]
  43     [Element-wise equality test of two collections.]
  44   ]
  45
  46   [/ ###############################################################################################]
  47   [
  48     [__BOOST_LEVEL_CLOSE__]
  49     [Floating point comparison using a percentage of deviation.]
  50   ]
  51
  52   [/ ###############################################################################################]
  53   [
  54     [__BOOST_LEVEL_CLOSE_FRACTION__]
  55     [Floating point comparison using the fraction of the compared operands.]
  56   ]
  57
  58   [/ ###############################################################################################]
  59   [
  60     [__BOOST_LEVEL_EXCEPTION__]
  61     [Exception detection and validation check.]
  62   ]
  63
  64   [/ ###############################################################################################]
  65   [
  66     [__BOOST_LEVEL_GE__]
  67     [Comparison of two values (with convenient reporting).]
  68   ]
  69
  70   [/ ###############################################################################################]
  71   [
  72     [__BOOST_LEVEL_GT__]
  73     [Comparison of two values (with convenient reporting).]
  74   ]
  75
  76   [/ ###############################################################################################]
  77   [
  78     [__BOOST_LEVEL_LE__]
  79     [Comparison of two values (with convenient reporting).]
  80   ]
  81
  82   [/ ###############################################################################################]
  83   [
  84     [__BOOST_LEVEL_LT__]
  85     [Comparison of two values (with convenient reporting).]
  86   ]
  87
  88   [/ ###############################################################################################]
  89   [
  90     [__BOOST_LEVEL_MESSAGE__]
  91     [Same as __BOOST_LEVEL__ with a custom message in case of failure.]
  92   ]
  93
  94   [/ ###############################################################################################]
  95   [
  96     [__BOOST_LEVEL_NE__]
  97     [Comparison of two values (with convenient reporting).]
  98   ]
  99
 100   [/ ###############################################################################################]
 101   [
 102     [__BOOST_LEVEL_NO_THROW__]
 103     [Checks an expression does not throw any exception.]
 104   ]
 105
 106   [/ ###############################################################################################]
 107   [
 108     [__BOOST_LEVEL_PREDICATE__]
 109     [Checks a list of arguments against a predicate functor.]
 110   ]
 111
 112   [/ ###############################################################################################]
 113   [
 114     [__BOOST_LEVEL_SMALL__]
 115     [Checks a value is small according to a tolerance.]
 116   ]
 117
 118   [/ ###############################################################################################]
 119   [
 120     [__BOOST_LEVEL_THROW__]
 121     [Checks an expression throws a specific type of expression.]
 122   ]
 123
 124   [/ ###############################################################################################]
 125   [
 126     [__BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES__]
 127     [Indicates the number of expected failures for a test case]
 128   ]
 129
 130   [/ ###############################################################################################]
 131   [
 132     [__BOOST_ERROR__]
 133     [Logs an error message, fails but does not abort the current test.]
 134   ]
 135
 136   [/ ###############################################################################################]
 137   [
 138     [__BOOST_FAIL__]
 139     [Logs an error message, fails and aborts the current test.]
 140   ]
 141
 142   [/ ###############################################################################################]
 143   [
 144     [__BOOST_IS_DEFINED__]
 145     [Checks at runtime whether or not the supplied preprocessor symbol is defined.]
 146   ]
 147 ]
 148
 149
 150 [table
 151   [
 152     [Decorators]
 153     [Short description]
 154   ]
 155
 156   [
 157     [__decorator_expected_failures__]
 158     [Indicates the expected failures of a test unit.]
 159   ]
 160
 161   [
 162     [__decorator_timeout__]
 163     [Sets the maximum amount of time a test unit should take.]
 164   ]
 165
 166   [
 167     [__decorator_tolerance__]
 168     [Sets the floating point comparison tolerance for a test unit.]
 169   ]
 170 ]
 171
 172 [table
 173   [
 174     [Control macros]
 175     [Short description]
 176   ]
 177
 178   [
 179     [__BOOST_TEST_TOOLS_UNDER_DEBUGGER__]
 180     [When defined, test assertions are compiled in debugger-friendly mode.]
 181   ]
 182
 183   [
 184     [__BOOST_TEST_TOOLS_DEBUGGABLE__]
 185     [When defined, test assertions are compiled in two modes (debugger-friendly and full-featured), and the version is selected at run-time.]
 186   ]
 187
 188 ]
 189
 190 [endsect] [/ testing tools]