123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376 |
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
- <title>Summary of the API for declaring and organizing tests</title>
- <link rel="stylesheet" href="../../boostbook.css" type="text/css">
- <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
- <link rel="home" href="../../index.html" title="Boost.Test">
- <link rel="up" href="../tests_organization.html" title="Declaring and organizing tests">
- <link rel="prev" href="semantic.html" title="Adding semantic to a test">
- <link rel="next" href="../testing_tools.html" title="Writing unit tests">
- </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="p" href="semantic.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tests_organization.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../testing_tools.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
- </div>
- <div class="section">
- <div class="titlepage"><div><div><h3 class="title">
- <a name="boost_test.tests_organization.summary_of_the_api_for_declaring"></a><a class="link" href="summary_of_the_api_for_declaring.html" title="Summary of the API for declaring and organizing tests">Summary
- of the API for declaring and organizing tests</a>
- </h3></div></div></div>
- <div class="informaltable"><table class="table">
- <colgroup>
- <col>
- <col>
- </colgroup>
- <thead><tr>
- <th>
- <p>
- Macro
- </p>
- </th>
- <th>
- <p>
- Short description
- </p>
- </th>
- </tr></thead>
- <tbody>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case.html" title="BOOST_TEST_CASE and BOOST_TEST_CASE_NAME"><code class="computeroutput"><span class="identifier">BOOST_TEST_CASE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case.html" title="BOOST_TEST_CASE and BOOST_TEST_CASE_NAME"><code class="computeroutput"><span class="identifier">BOOST_TEST_CASE_NAME</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Manual registration of a test case
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_auto_test_case.html" title="BOOST_AUTO_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_AUTO_TEST_CASE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Automatic declaration and registration of a test case
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case_parameter.html" title="BOOST_PARAM_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_PARAM_TEST_CASE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Automatic declaration and registration of a test case with a collection
- of parameters
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case_auto_template.html" title="BOOST_AUTO_TEST_CASE_TEMPLATE"><code class="computeroutput"><span class="identifier">BOOST_AUTO_TEST_CASE_TEMPLATE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Automatic declaration and registration of a typed test case
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case_template.html" title="BOOST_TEST_CASE_TEMPLATE"><code class="computeroutput"><span class="identifier">BOOST_TEST_CASE_TEMPLATE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Registration of a typed test case with an <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">mpl</span></code>
- like sequence of types
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case_template_function.html" title="BOOST_TEST_CASE_TEMPLATE_FUNCTION"><code class="computeroutput"><span class="identifier">BOOST_TEST_CASE_TEMPLATE_FUNCTION</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Declaration of the body of a typed test case
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_dataset.html" title="BOOST_DATA_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_DATA_TEST_CASE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Declaration of the body of a test case on datasets
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_dataset_fixture.html" title="BOOST_DATA_TEST_CASE_F"><code class="computeroutput"><span class="identifier">BOOST_DATA_TEST_CASE_F</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Same as <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_dataset.html" title="BOOST_DATA_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_DATA_TEST_CASE</span></code></a> with
- fixtures support
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_dataset.html" title="BOOST_DATA_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_TEST_DATASET_MAX_ARITY</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Controlling the maximal arity of the data test case declared with
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_dataset.html" title="BOOST_DATA_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_DATA_TEST_CASE</span></code></a>
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_suite.html" title="BOOST_TEST_SUITE"><code class="computeroutput"><span class="identifier">BOOST_TEST_SUITE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Manual creation of a test suite instance
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_auto_test_suite.html" title="BOOST_AUTO_TEST_SUITE"><code class="computeroutput"><span class="identifier">BOOST_AUTO_TEST_SUITE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Automatic declaration of a test suite
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_auto_test_suite_end.html" title="BOOST_AUTO_TEST_SUITE_END"><code class="computeroutput"><span class="identifier">BOOST_AUTO_TEST_SUITE_END</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Automatic declaration of a test suite
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_decorator.html" title="BOOST_TEST_DECORATOR"><code class="computeroutput"><span class="identifier">BOOST_TEST_DECORATOR</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Adds decorators to a test unit
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_case_fixture.html" title="BOOST_FIXTURE_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_FIXTURE_TEST_CASE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Declares a test case with a fixture
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_suite_fixture.html" title="BOOST_FIXTURE_TEST_SUITE"><code class="computeroutput"><span class="identifier">BOOST_FIXTURE_TEST_SUITE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Declares a fixture for a test suite (the setup/teardown is called
- for each test of the test suite)
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/test_org_boost_test_global_fixture.html" title="BOOST_TEST_GLOBAL_FIXTURE"><code class="computeroutput"><span class="identifier">BOOST_TEST_GLOBAL_FIXTURE</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Declares a fixture globally to the test module
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- <div class="informaltable"><table class="table">
- <colgroup>
- <col>
- <col>
- </colgroup>
- <thead><tr>
- <th>
- <p>
- Decorator
- </p>
- </th>
- <th>
- <p>
- Short description
- </p>
- </th>
- </tr></thead>
- <tbody>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_depends_on.html" title="depends_on (decorator)"><code class="computeroutput"><span class="identifier">depends_on</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Creates a dependency (in the execution order and <a class="link" href="../runtime_config/test_unit_filtering.html#ref_default_run_status"><span class="emphasis"><em>default
- run status</em></span></a>) from one test case to another.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_description.html" title="description (decorator)"><code class="computeroutput"><span class="identifier">description</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Attaches a semantic string to a test unit, that is visible from
- the command line interface.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_enabled.html" title="enabled / disabled (decorator)"><code class="computeroutput"><span class="identifier">enabled</span></code></a> , <a class="link" href="../utf_reference/test_org_reference/decorator_enabled.html" title="enabled / disabled (decorator)"><code class="computeroutput"><span class="identifier">disabled</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Enables or disables unconditionally a test unit. The action of
- these decorators may be overridden by the command line interface
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_enable_if.html" title="enable_if (decorator)"><code class="computeroutput"><span class="identifier">enable_if</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Enables conditionally a test unit. The action of these decorators
- may be overridden by the command line interface
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_fixture.html" title="fixture (decorator)"><code class="computeroutput"><span class="identifier">fixture</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Attaches a fixture to a test unit
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_label.html" title="label (decorator)"><code class="computeroutput"><span class="identifier">label</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Labels a test unit to form a logical group
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="../utf_reference/test_org_reference/decorator_precondition.html" title="precondition (decorator)"><code class="computeroutput"><span class="identifier">precondition</span></code></a>
- </p>
- </td>
- <td>
- <p>
- Enables or disables a test unit based on a predicate evaluated
- just before the execution of the test case.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- </div>
- <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
- <td align="left"></td>
- <td align="right"><div class="copyright-footer">Copyright © 2001-2019 Boost.Test
- contributors<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></td>
- </tr></table>
- <hr>
- <div class="spirit-nav">
- <a accesskey="p" href="semantic.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tests_organization.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../testing_tools.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
- </div>
- </body>
- </html>
|