libs/test/doc/html/boost_test/adv_scenarios/external_test_runner.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>The external test runner usage variant</title>
   5 <link rel="stylesheet" href="../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Boost.Test">
   8 <link rel="up" href="../adv_scenarios.html" title="Advanced Usage Scenarios">
   9 <link rel="prev" href="shared_lib_customizations/init_func.html" title="Customizing the module's initialization function">
  10 <link rel="next" href="obsolete_init_func.html" title="The obsolete initialization function">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="shared_lib_customizations/init_func.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adv_scenarios.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="obsolete_init_func.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_test.adv_scenarios.external_test_runner"></a><a class="link" href="external_test_runner.html" title="The external test runner usage variant">The external
  28       test runner usage variant</a>
  29 </h3></div></div></div>
  30 <p>
  31         This usage variant does not provide any <a class="link" href="test_module_runner_overview.html" title="Test module runner">test
  32         runner</a>. You employ it when you only want to define a <a class="link" href="../section_glossary.html#ref_test_tree">test
  33         tree</a> and possibly an <a class="link" href="test_module_init_overview.html" title="Test module's initialization">initialization
  34         function</a>, and expect another (external) program to evaluate these
  35         tests. This external program will come with its own test runner.
  36       </p>
  37 <p>
  38         If you plan to use an external test runner with your test module, you need
  39         to build it as a dynamic library. You need to define macro flag <a class="link" href="../utf_reference/link_references/link_boost_test_dyn_link.html" title="BOOST_TEST_DYN_LINK"><code class="computeroutput"><span class="identifier">BOOST_TEST_DYN_LINK</span></code></a> either in a
  40         makefile or before the header <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span></code> inclusion. An external test runner
  41         utility is required to link with dynamic library.
  42       </p>
  43 <p>
  44         The <span class="emphasis"><em>Unit Test Framework</em></span> comes with an example external
  45         test runner <code class="computeroutput"><span class="identifier">console_test_runner</span></code>:
  46         Given a name of the test module (implemented as a shared library), and a
  47         name of the initialization function defined therein, the program can run
  48         all the tests from the module's test tree.
  49       </p>
  50 </div>
  51 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  52 <td align="left"></td>
  53 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  54       contributors<p>
  55         Distributed under the Boost Software License, Version 1.0. (See accompanying
  56         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>)
  57       </p>
  58 </div></td>
  59 </tr></table>
  60 <hr>
  61 <div class="spirit-nav">
  62 <a accesskey="p" href="shared_lib_customizations/init_func.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adv_scenarios.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="obsolete_init_func.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  63 </div>
  64 </body>
  65 </html>