libs/test/doc/test.qbk

   1 [/
   2  / Copyright (c) 2003 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 [library Boost.Test
   9     [quickbook 1.7]
  10     [copyright 2001 - 2019 Boost.Test contributors]
  11     [id boost_test]
  12     [purpose Testing library]
  13     [license
  14         Distributed under the Boost Software License, Version 1.0.
  15         (See accompanying file LICENSE_1_0.txt or copy at
  16         [@http://www.boost.org/LICENSE_1_0.txt])
  17     ]
  18     [authors [Rozental, Gennadiy] [Enficiaud, Raffi]]
  19     [category Correctness and testing]
  20 ]
  21
  22 [template ticket[number]'''<ulink url="https://svn.boost.org/trac/boost/ticket/'''[number]'''">'''#[number]'''</ulink>''']
  23 [template pull_request[number]'''<ulink url="https://github.com/boostorg/test/pull/'''[number]'''">'''#PR-[number]'''</ulink>''']
  24 [template github_issue[number]'''<ulink url="https://github.com/boostorg/test/issues/'''[number]'''">'''#GH-[number]'''</ulink>''']
  25
  26 [def __UTF__ /Unit Test Framework/]
  27 [def __PEM__ /Program Execution Monitor]
  28
  29 [def __IEEE754__ [*IEEE754]]
  30
  31 [def __part_faq__                         [link boost_test.section_faq FAQ]]
  32
  33 [/ content in the test organization]
  34
  35 [def __floating_points_testing_tools__    [link boost_test.testing_tools.extended_comparison.floating_point.floating_points_comparison_theory Floating point comparison algorithms]]
  36 [def __master_test_suite__                [link boost_test.tests_organization.test_tree.master_test_suite master test suite]]
  37
  38 [def __runtime_configuration__            [link boost_test.runtime_config runtime configuration]]
  39 [def __output_test_stream_tool__          [link boost_test.testing_tools.output_stream_testing output test stream]]
  40
  41 [def __auto_linking__                     [link ref_pem_auto_link automatic linking]]
  42
  43 [def __BOOST_TEST_ALTERNATIVE_INIT_API__  [link boost_test.utf_reference.link_references.link_boost_test_alternative_init_macro `BOOST_TEST_ALTERNATIVE_INIT_API`]]
  44 [def __BOOST_TEST_MAIN__                  [link boost_test.utf_reference.link_references.link_boost_test_main_macro             `BOOST_TEST_MAIN`]]
  45 [def __BOOST_TEST_DYN_LINK__              [link boost_test.utf_reference.link_references.link_boost_test_dyn_link               `BOOST_TEST_DYN_LINK`]]
  46 [def __BOOST_TEST_NO_LIB__                [link boost_test.utf_reference.link_references.link_boost_test_no_lib                 `BOOST_TEST_NO_LIB`]]
  47 [def __BOOST_TEST_NO_MAIN__               [link boost_test.utf_reference.link_references.link_boost_test_no_main                `BOOST_TEST_NO_MAIN`]]
  48 [def __BOOST_TEST_MODULE__                [link boost_test.utf_reference.link_references.link_boost_test_module_macro           `BOOST_TEST_MODULE`]]
  49 [def __BOOST_TEST_GLOBAL_CONFIGURATION__  [link boost_test.utf_reference.link_references.link_boost_test_global_configuration   `BOOST_TEST_GLOBAL_CONFIGURATION`]]
  50
  51 [def __BOOST_TEST_CHECKPOINT__            [link boost_test.utf_reference.testout_reference.test_output_macro_checkpoint   `BOOST_TEST_CHECKPOINT`]]
  52 [def __BOOST_TEST_PASSPOINT__             [link boost_test.utf_reference.testout_reference.test_output_macro_passpoint    `BOOST_TEST_PASSPOINT`]]
  53 [def __BOOST_TEST_MESSAGE__               [link boost_test.utf_reference.testout_reference.test_output_macro_message      `BOOST_TEST_MESSAGE`]]
  54 [def __BOOST_TEST_INFO__                  [link boost_test.utf_reference.testout_reference.test_output_macro_info         `BOOST_TEST_INFO`]]
  55 [def __BOOST_TEST_CONTEXT__               [link boost_test.utf_reference.testout_reference.test_output_macro_context      `BOOST_TEST_CONTEXT`]]
  56 [def __BOOST_TEST_INFO_SCOPE__            [link boost_test.utf_reference.testout_reference.test_output_macro_context_sticky `BOOST_TEST_INFO_SCOPE`]]
  57 [def __BOOST_TEST_DONT_PRINT_LOG_VALUE__  [link boost_test.utf_reference.testout_reference.test_output_macro_disable_type `BOOST_TEST_DONT_PRINT_LOG_VALUE`]]
  58
  59
  60 [/ Assertions ]
  61 [def __BOOST_TEST__                       [link boost_test.utf_reference.testing_tool_ref.assertion_boost_test_universal_macro `BOOST_TEST`]]
  62 [def __BOOST_TEST_LEVEL__                 [link boost_test.utf_reference.testing_tool_ref.assertion_boost_test_universal_macro `BOOST_TEST_<level>`]]
  63 [def __BOOST_TEST_REQUIRE__               [link boost_test.utf_reference.testing_tool_ref.assertion_boost_test_universal_macro `BOOST_TEST_REQUIRE`]]
  64
  65 [def __BOOST_LEVEL__                      [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level `BOOST_<level>`]]
  66
  67 [def __BOOST_LEVEL_MESSAGE__              [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_message `BOOST_<level>_MESSAGE`]]
  68
  69 [def __BOOST_LEVEL_EQUAL__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_eq `BOOST_<level>_EQUAL`]]
  70
  71 [def __BOOST_LEVEL_PREDICATE__            [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_predicate `BOOST_<level>_PREDICATE`]]
  72 [def __BOOST_LEVEL_EQUAL_COLLECTIONS__    [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_eq_collections `BOOST_<level>_EQUAL_COLLECTIONS`]]
  73 [def __BOOST_LEVEL_NE__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_ne `BOOST_<level>_NE`]]
  74 [def __BOOST_LEVEL_GE__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_ge `BOOST_<level>_GE`]]
  75 [def __BOOST_LEVEL_GT__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_gt `BOOST_<level>_GT`]]
  76 [def __BOOST_LEVEL_LE__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_le `BOOST_<level>_LE`]]
  77 [def __BOOST_LEVEL_LT__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_lt `BOOST_<level>_LT`]]
  78
  79 [def __BOOST_LEVEL_NO_THROW__             [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_no_throw `BOOST_<level>_NO_THROW`]]
  80 [def __BOOST_LEVEL_THROW__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_throw `BOOST_<level>_THROW`]]
  81 [def __BOOST_LEVEL_EXCEPTION__            [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception `BOOST_<level>_EXCEPTION`]]
  82
  83 [def __BOOST_LEVEL_BITWISE_EQUAL__        [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_bitwise_eq `BOOST_<level>_BITWISE_EQUAL`]]
  84 [def __BOOST_ERROR__                      [link boost_test.utf_reference.testing_tool_ref.assertion_boost_error `BOOST_ERROR`]]
  85 [def __BOOST_FAIL__                       [link boost_test.utf_reference.testing_tool_ref.assertion_boost_fail `BOOST_FAIL`]]
  86 [def __BOOST_IS_DEFINED__                 [link boost_test.utf_reference.testing_tool_ref.assertion_boost_is_defined `BOOST_IS_DEFINED`]]
  87
  88 [def __BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES__ [link boost_test.utf_reference.testing_tool_ref.test_org_boost_test_case_expected_failure `BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES`]]
  89
  90 [/ Assertions / floating point]
  91 [def __BOOST_LEVEL_SMALL__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_small `BOOST_<level>_SMALL`]]
  92 [def __BOOST_CHECK_SMALL__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_small `BOOST_CHECK_SMALL`]]
  93 [def __BOOST_LEVEL_CLOSE__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_close `BOOST_<level>_CLOSE`]]
  94 [def __BOOST_CHECK_CLOSE__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_close `BOOST_CHECK_CLOSE`]]
  95 [def __BOOST_LEVEL_CLOSE_FRACTION__       [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_close_fraction `BOOST_<level>_CLOSE_FRACTION`]]
  96
  97 [/ Assertion control]
  98 [def __BOOST_TEST_TOOLS_UNDER_DEBUGGER__  [link boost_test.utf_reference.testing_tool_ref.assertion_control_under_debugger `BOOST_TEST_TOOLS_UNDER_DEBUGGER`]]
  99 [def __BOOST_TEST_TOOLS_DEBUGGABLE__      [link boost_test.utf_reference.testing_tool_ref.assertion_control_under_debuggable `BOOST_TEST_TOOLS_DEBUGGABLE`]]
 100
 101 [/ Tests cases organization]
 102 [def __BOOST_AUTO_TEST_CASE__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_auto_test_case `BOOST_AUTO_TEST_CASE`]]
 103 [def __BOOST_TEST_CASE__                        [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case `BOOST_TEST_CASE`]]
 104 [def __BOOST_TEST_CASE_NAME__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case `BOOST_TEST_CASE_NAME`]]
 105 [def __BOOST_AUTO_TEST_CASE_TEMPLATE__          [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_auto_template `BOOST_AUTO_TEST_CASE_TEMPLATE`]]
 106 [def __BOOST_TEST_CASE_TEMPLATE__               [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_template `BOOST_TEST_CASE_TEMPLATE`]]
 107 [def __BOOST_TEST_CASE_TEMPLATE_FUNCTION__      [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_template_function `BOOST_TEST_CASE_TEMPLATE_FUNCTION`]]
 108 [/ parametrized test cases]
 109 [def __BOOST_PARAM_TEST_CASE__                  [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_parameter `BOOST_PARAM_TEST_CASE`]]
 110 [def __BOOST_DATA_TEST_CASE__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_test_dataset `BOOST_DATA_TEST_CASE`]]
 111 [def __BOOST_DATA_TEST_CASE_F__                 [link boost_test.utf_reference.test_org_reference.test_org_boost_test_dataset_fixture `BOOST_DATA_TEST_CASE_F`]]
 112 [def __BOOST_TEST_DATASET_MAX_ARITY__           [link boost_test.utf_reference.test_org_reference.test_org_boost_test_dataset `BOOST_TEST_DATASET_MAX_ARITY`]]
 113
 114 [/ test suites]
 115 [def __BOOST_AUTO_TEST_SUITE__                  [link boost_test.utf_reference.test_org_reference.test_org_boost_auto_test_suite `BOOST_AUTO_TEST_SUITE`]]
 116 [def __BOOST_AUTO_TEST_SUITE_END__              [link boost_test.utf_reference.test_org_reference.test_org_boost_auto_test_suite_end `BOOST_AUTO_TEST_SUITE_END`]]
 117 [def __BOOST_TEST_SUITE__                       [link boost_test.utf_reference.test_org_reference.test_org_boost_test_suite `BOOST_TEST_SUITE`]]
 118 [/ decorator]
 119 [def __BOOST_TEST_DECORATOR__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_test_decorator `BOOST_TEST_DECORATOR`]]
 120 [/ fixtures]
 121 [def __BOOST_FIXTURE_TEST_CASE__                [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_fixture     `BOOST_FIXTURE_TEST_CASE`]]
 122 [def __BOOST_FIXTURE_TEST_SUITE__               [link boost_test.utf_reference.test_org_reference.test_org_boost_test_suite_fixture    `BOOST_FIXTURE_TEST_SUITE`]]
 123 [def __BOOST_GLOBAL_FIXTURE__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_global_fixture        `BOOST_GLOBAL_FIXTURE`]]
 124 [def __BOOST_TEST_GLOBAL_FIXTURE__              [link boost_test.utf_reference.test_org_reference.test_org_boost_test_global_fixture   `BOOST_TEST_GLOBAL_FIXTURE`]]
 125
 126 [/ log]
 127 [def __BOOST_TEST_LOG_LEVEL__                   [link boost_test.utf_reference.rt_param_reference.log_level `BOOST_TEST_LOG_LEVEL`]] [/ this is an environment variable]
 128
 129 [/ runtime/cla parameters]
 130 [def __default_run_status__                     [link ref_default_run_status ['default run status]]]
 131 [def __param_run_test__                         [link boost_test.utf_reference.rt_param_reference.run_test `run_test`]]
 132
 133 [/ decorators]
 134 [def __decorator_label__                        [link boost_test.utf_reference.test_org_reference.decorator_label `label`]]
 135 [def __decorator_enabled__                      [link boost_test.utf_reference.test_org_reference.decorator_enabled `enabled`]]
 136 [def __decorator_disabled__                     [link boost_test.utf_reference.test_org_reference.decorator_enabled `disabled`]]
 137 [def __decorator_enable_if__                    [link boost_test.utf_reference.test_org_reference.decorator_enable_if `enable_if`]]
 138 [def __decorator_depends_on__                   [link boost_test.utf_reference.test_org_reference.decorator_depends_on `depends_on`]]
 139 [def __decorator_precondition__                 [link boost_test.utf_reference.test_org_reference.decorator_precondition `precondition`]]
 140 [def __decorator_fixture__                      [link boost_test.utf_reference.test_org_reference.decorator_fixture `fixture`]]
 141 [def __decorator_description__                  [link boost_test.utf_reference.test_org_reference.decorator_description   `description`]]
 142
 143 [def __decorator_expected_failures__            [link boost_test.utf_reference.testing_tool_ref.decorator_expected_failures `expected_failures`]]
 144 [def __decorator_timeout__                      [link boost_test.utf_reference.testing_tool_ref.decorator_timeout `timeout`]]
 145 [def __decorator_tolerance__                    [link boost_test.utf_reference.testing_tool_ref.decorator_tolerance `tolerance`]]
 146
 147
 148
 149 [/=============================================================================]
 150 [/ templates ]
 151
 152
 153 [template bt_example[name descr rule]
 154
 155 [h5 Example: [descr]]
 156
 157 [import ../examples/[name].[rule].cpp]
 158 [import ../examples/[name].output]
 159 [table
 160   [[Code]]
 161   [[[example_code]]]
 162 ]
 163
 164 [table
 165   [[Output]]
 166   [[[example_output]]]
 167 ]
 168 ] [/ end bt_example]
 169
 170
 171 [/ ### template for the example page  ]
 172 [template bt_example_page[name descr]
 173
 174 [section:ref_[name] [descr]]
 175
 176 [import examples/[name].run-fail.cpp]
 177 [import examples/[name].output]
 178
 179 [heading Source]
 180 [example_code]
 181
 182 [heading Output]
 183 [example_output]
 184
 185 [endsect]
 186
 187 ] [/ end bt_example_page]
 188
 189
 190
 191
 192 [/=============================================================================]
 193
 194 [/ introduction material and general presentation ]
 195 [include introduction/introduction.qbk]
 196
 197 [/ ##### Users guide ##### ]
 198 [/ intro into usage variants]
 199 [include usage_variants.qbk]
 200
 201 [/ organizing, generating and registering tests]
 202 [include test_organization/test_organization.qbk]
 203
 204 [/ creating assertions]
 205 [include testing_tools/testing_tools.qbk]
 206
 207 [/ controlling outputs]
 208 [include test_output/test_output.qbk]
 209
 210 [/ command line + environment options]
 211 [include runtime_configuration/runtime_configuration.qbk]
 212
 213 [/ ##### Advanced scenarios ##### ]
 214 [include adv_scenarios.qbk]
 215
 216 [/=============================================================================]
 217
 218 [/TOFIX ]
 219 [/include program_execution_monitor.qbk]
 220
 221 [/=============================================================================]
 222
 223 [include usage_recommendations.qbk]
 224
 225 [/=============================================================================]
 226 [/ Closing parts]
 227
 228 [include closing_chapters/faq.qbk]
 229 [include closing_chapters/glossary.qbk]
 230 [include closing_chapters/change_log.qbk]
 231 [include closing_chapters/acknowledgments.qbk]
 232
 233
 234 [/=============================================================================]
 235 [/ References]
 236
 237 [section:utf_reference __UTF__ API reference]
 238 [include test_organization/testorg_reference.qbk]
 239 [include testing_tools/testing_tools_reference.qbk]
 240 [include test_output/testout_reference.qbk]
 241 [include runtime_configuration/runtime_config_reference.qbk]
 242 [include adv_scenarios/link_reference.qbk]
 243 [/ doxygen auto-generated reference documentation]
 244 [xinclude doxygen_reference_generated_doc.xml]
 245 [endsect]
 246
 247
 248
 249 [/=============================================================================]
 250
 251
 252
 253 [/ EOF]