2
0
mirror of https://github.com/boostorg/test.git synced 2026-02-02 09:12:10 +00:00
Files
test/doc/v2/html/index.html
2014-04-28 14:53:43 +02:00

281 lines
24 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Boost.Test</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Boost.Test">
<link rel="next" href="boost_test/intro.html" title="What is Boost.Test?">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="boost_test/intro.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a></div>
<div class="chapter">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="boost_test"></a>Boost.Test</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Gennadiy</span> <span class="surname">Rozental</span>
</h3></div></div>
<div><p class="copyright">Copyright &#169; 2001-2014 Gennadiy
Rozental</p></div>
<div><div class="legalnotice">
<a name="boost_test.legal"></a><p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></div>
</div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl class="toc">
<dt><span class="section"><a href="boost_test/intro.html">What is Boost.Test?</a></span></dt>
<dt><span class="section"><a href="boost_test/tutorial.html">Tutorials</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/tutorial/hello.html">Hello the testing world!</a></span></dt>
<dt><span class="section"><a href="boost_test/tutorial/bt_and_tdd.html">Boost.Test driven development</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/how_to_read_this_documentation.html">How to read
this documentation?</a></span></dt>
<dt><span class="section"><a href="boost_test/users_guide.html">User's guide</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/users_guide/usage_variants.html">The <span class="emphasis"><em>UTF</em></span>
usage variants</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/users_guide/usage_variants/static_lib_variant.html">The
static library variant of the <span class="emphasis"><em>UTF</em></span></a></span></dt>
<dt><span class="section"><a href="boost_test/users_guide/usage_variants/dynamic_lib_variant.html">The
dynamic library variant of the <span class="emphasis"><em>UTF</em></span></a></span></dt>
<dt><span class="section"><a href="boost_test/users_guide/usage_variants/single_header_variant.html">The
single-header variant of the <span class="emphasis"><em>UTF</em></span></a></span></dt>
<dt><span class="section"><a href="boost_test/users_guide/usage_variants/extern_test_runner_variant.html">The
external test runner variant of the <span class="emphasis"><em>UTF</em></span></a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="section"><a href="boost_test/tests_organization.html">Organizing the tests</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/tests_organization/test_cases.html">Test cases</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/tests_organization/test_cases/test_organization_nullary.html">Nullary
function based test case</a></span></dt>
<dt><span class="section"><a href="boost_test/tests_organization/test_cases/unary_function_based_test_case.html">Unary
function based test case</a></span></dt>
<dt><span class="section"><a href="boost_test/tests_organization/test_cases/test_organization_templates.html">Template
test cases</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/tests_organization/test_organization_test_suite.html">Test
suite</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/tests_organization/test_organization_test_suite/master_test_suite.html">Master
Test Suite</a></span></dt>
<dt><span class="section"><a href="boost_test/tests_organization/test_organization_test_suite/test_suite_expected_failure.html">Expected
failures specification</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/tests_organization/fixtures.html">Fixtures</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/tests_organization/fixtures/generic_fixture_model.html">Generic
fixture model</a></span></dt>
<dt><span class="section"><a href="boost_test/tests_organization/fixtures/per_test_case_fixture.html">Per
test case fixture</a></span></dt>
<dt><span class="section"><a href="boost_test/tests_organization/fixtures/test_suite_level_fixture.html">Test
suite level fixture</a></span></dt>
<dt><span class="section"><a href="boost_test/tests_organization/fixtures/global_fixture.html">Global
fixture</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="section"><a href="boost_test/testing_tools.html">The <span class="emphasis"><em>UTF</em></span>
testing tools</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/testing_tools/tools_assertion_severity_level.html">Assertion
severity level</a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tools/custom_predicates.html">Custom predicate
support</a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tools/output_stream_testing.html">Output
streams testing tool</a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tools/testing_floating_points.html">Floating-point
testing</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/test_output.html">Controlling
the outputs</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/test_output/test_log_output.html">Test log output</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_runtime_config.html">Configuring
the verbosity of the logs</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/testing_tool_output_disable.html">Disabling
automatic printing for specific types</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/test_output_macro_message.html"><code class="computeroutput"><span class="identifier">BOOST_TEST_MESSAGE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/test_output_macro_checkpoint.html"><code class="computeroutput"><span class="identifier">BOOST_TEST_CHECKPOINT</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/test_output_macro_passpoint.html"><code class="computeroutput"><span class="identifier">BOOST_TEST_PASSPOINT</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_floating_points.html">Logging floating
point type numbers</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_human_readable_format.html">Human
readable log format</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_xml_format.html">XML based log
output format</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_compil_time_configuration.html">Compile
time configuration</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/test_output/log_compil_time_configuration/log_ct_output_stream_redirection.html">Log
output stream redirection</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_compil_time_configuration/log_ct_log_level.html">Log
level configuration</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_compil_time_configuration/log_ct_log_format.html">Predefined
log format selection</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/log_compil_time_configuration/custom_log_formatter.html">Custom
log format support</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/test_output/test_reports.html">Test
reports</a></span></dt>
<dt><span class="section"><a href="boost_test/test_output/test_output_progress.html">Progression
display</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/runtime_configuration.html">Runtime
configuration</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/runtime_configuration/running_specific_test_units_sele.html">Running
specific test units selected by their name</a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_configuration/runtime_parameters_summary.html">Runtime
parameters summary</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/the_unit_test_framework_usage_re.html">The
unit test framework usage recommendations</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/the_unit_test_framework_usage_re/general.html">General</a></span></dt>
<dt><span class="section"><a href="boost_test/the_unit_test_framework_usage_re/microsoft_visual_studio_net_usag.html">Microsoft
Visual Studio .NET usage recommendations</a></span></dt>
<dt><span class="section"><a href="boost_test/the_unit_test_framework_usage_re/command_line_usage_recommendatio.html">Command
line usage recommendations</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/section_faq.html">Frequently Asked Questions</a></span></dt>
<dt><span class="section"><a href="boost_test/section_glossary.html">Glossary</a></span></dt>
<dt><span class="section"><a href="boost_test/change_log.html">Change log</a></span></dt>
<dt><span class="section"><a href="boost_test/open_issues.html">Open issues</a></span></dt>
<dt><span class="section"><a href="boost_test/acknowledgements.html">Acknowledgements</a></span></dt>
<dt><span class="section"><a href="boost_test/components.html">Components</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/components/bt_minimal_testing.html">Minimal testing
facility</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/components/bt_minimal_testing/bt_minimal_usage.html">Usage</a></span></dt>
<dt><span class="section"><a href="boost_test/components/bt_minimal_testing/bt_minimal.html">Testing
tools</a></span></dt>
<dt><span class="section"><a href="boost_test/components/bt_minimal_testing/example.html">Example</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/components/section_pem.html">Program Execution
Monitor</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/components/section_pem/usage.html">Usage</a></span></dt>
<dt><span class="section"><a href="boost_test/components/section_pem/configuration.html">Configuration</a></span></dt>
<dt><span class="section"><a href="boost_test/components/section_pem/implementation.html">Implementation</a></span></dt>
<dt><span class="section"><a href="boost_test/components/section_pem/compilation.html">Compilation</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference.html">Runtime parameters
reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/show_progress.html"><code class="computeroutput"><span class="identifier">show_progress</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/build_info.html"><code class="computeroutput"><span class="identifier">build_info</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/auto_start_dbg.html"><code class="computeroutput"><span class="identifier">auto_start_dbg</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/catch_system_errors.html"><code class="computeroutput"><span class="identifier">catch_system_errors</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/break_exec_path.html"><code class="computeroutput"><span class="identifier">break_exec_path</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/color_output.html"><code class="computeroutput"><span class="identifier">color_output</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/log_format.html"><code class="computeroutput"><span class="identifier">log_format</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/log_level.html"><code class="computeroutput"><span class="identifier">log_level</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/run_test.html"><code class="computeroutput"><span class="identifier">run_test</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/output_format.html"><code class="computeroutput"><span class="identifier">output_format</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/report_format.html"><code class="computeroutput"><span class="identifier">report_format</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/result_code.html"><code class="computeroutput"><span class="identifier">result_code</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/report_level.html"><code class="computeroutput"><span class="identifier">report_level</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/random.html"><code class="computeroutput"><span class="identifier">random</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/detect_memory_leaks.html"><code class="computeroutput"><span class="identifier">detect_memory_leaks</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/use_alt_stack.html"><code class="computeroutput"><span class="identifier">use_alt_stack</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/detect_fp_exceptions.html"><code class="computeroutput"><span class="identifier">detect_fp_exceptions</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/log_sink.html"><code class="computeroutput"><span class="identifier">log_sink</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/report_sink.html"><code class="computeroutput"><span class="identifier">report_sink</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/runtime_parameters_reference/save_patterm.html"><code class="computeroutput"><span class="identifier">save_patterm</span></code></a></span></dt>
</dl></dd>
<dt><span class="section"><a href="boost_test/testing_tool_ref.html"><span class="emphasis"><em>UTF</em></span> testing
tools reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_bitwise_eq.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_BITWISE_EQUAL</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_eq.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_EQUAL</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_eq_collections.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_EQUAL_COLLECTIONS</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_close.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_CLOSE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_close_fraction.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_CLOSE_FRACTION</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_exception.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_EXCEPTION</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_ge.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_GE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_gt.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_GT</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_le.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_LE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_lt.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_LT</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_message.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_MESSAGE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_ne.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_NE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_no_throw.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_NO_THROW</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_predicate.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_PREDICATE</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_small.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_SMALL</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_level_throw.html"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special">&lt;</span><span class="identifier">level</span><span class="special">&gt;</span><span class="identifier">_THROW</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_error.html"><code class="computeroutput"><span class="identifier">BOOST_ERROR</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_fail.html"><code class="computeroutput"><span class="identifier">BOOST_FAIL</span></code></a></span></dt>
<dt><span class="section"><a href="boost_test/testing_tool_ref/assertion_boost_is_defined.html"><code class="computeroutput"><span class="identifier">BOOST_IS_DEFINED</span></code></a></span></dt>
</dl></dd>
</dl>
</div>
<div class="blockquote"><blockquote class="blockquote"><p>
<span class="bold"><strong>Test everything that could possibly break</strong></span>
- <span class="emphasis"><em>XP maxim</em></span>
</p></blockquote></div>
<p>
The Boost.Test library provides a matched set of components for writing test
programs, organizing tests into simple test cases and test suites, and controlling
their runtime execution. The Program Execution Monitor is also useful in some
production (non-test) environments.
</p>
<h3>
<a name="boost_test.h0"></a>
<span class="phrase"><a name="boost_test.about_this_documentation"></a></span><a class="link" href="index.html#boost_test.about_this_documentation">About
this documentation</a>
</h3>
<p>
This documentation is <span class="bold"><strong>not</strong></span> intended to be read
though from the beginning to the end by a novice user. You can do that if you
are interested in detailed bottom-up description of all Boost.Test components.
Otherwise you are better off jumping directly to the subject of your interest.
</p>
<p>
For example:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
If you are interested in unit testing framework you may go directly &lt;link
linkend="utf"&gt;there&lt;/link&gt;
</li>
<li class="listitem">
For novice users I recommend to start from simple <a class="link" href="boost_test/tutorial.html" title="Tutorials">tutorials</a>.
</li>
<li class="listitem">
Looking for quick help - check the <a class="link" href="boost_test/section_faq.html" title="Frequently Asked Questions">FAQ</a>
section for resolution to many popular issues you may be faced with. Most
pages should link you directly to the terms that you need to understand it.
</li>
<li class="listitem">
For help with compilation see compilation sections of an appropriate component.
</li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: April 28, 2014 at 12:50:28 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="boost_test/intro.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a></div>
</body>
</html>