blob: 963ac989a43d9ea2e09e3111b3421f4939937069 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>The external test runner variant of the UTF</title>
<link rel="stylesheet" href="../../../../style/style.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../../../index.html" title="Boost Test Library">
<link rel="up" href="../usage-variants.html" title="The UTF usage variants or the Buridan's donkey parable">
<link rel="prev" href="single-header-variant.html" title="The single-header variant of the UTF">
<link rel="next" href="../test-runners.html" title="The supplied test runners or where is the entrance?">
<script language="JavaScript1.2" src="../../../../js/boost-test.js"></script>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table width="100%"><tr>
<td width="10%"><a href="../../../index.html"><img alt="Home" width="229" height="61" border="0" src="../../../../../../../libs/test/docbook/img/boost.test.logo.png"></a></td>
<td valign="middle" align="left"> &gt; <a href="../../../utf.html">The Unit Test Framework</a> &gt; <a href="../../user-guide.html">User's guide</a><a href="../../testing-tools.html">
&gt;
</a><a href="../usage-variants.html">Usage variants</a><a href="../test-runners.html">
&gt;
</a><b>External test runner</b>
</td>
<td><div class="spirit-nav">
<a href="single-header-variant.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a href="../test-runners.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div></td>
</tr></table>
<hr>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="utf.user-guide.extern-test-runner-variant"></a>The external test runner variant of the <acronym class="acronym">UTF</acronym>
</h5></div></div></div>
<p class="first-line-indented">
All other usage variants employ the build-in test runners. If you plan to use an external test runner with your
test module you need to build it as a dynamic library. This usage of the <acronym class="acronym">UTF</acronym> is called the external test runner
variant of the <acronym class="acronym">UTF</acronym>. The variant requires you to define the flag
<a class="xref" href="../../compilation.html#utf.flag.dyn-link">BOOST_TEST_DYN_LINK</a> either in a makefile or before the header
<code class="filename">boost/test/unit_test.hpp</code> inclusion. An external test runner utility is
required to link with dynamic library.
</p>
<p class="first-line-indented">
If an external test runner is based on the test runner built in to the dynamic library (like the standalone
boost_test_runner utility supplied by the <acronym class="acronym">UTF</acronym>), it requires you to implement the <a class="link" href="../../user-guide.html#test-module.def">
test module</a> initialization function that matches the alternative initialization function signature. The
<acronym class="acronym">UTF</acronym> provides an ability to <a class="link" href="../initialization.html#utf.user-guide.initialization.auto-generation" title="Automated generation of the test module initialization function">automatically generate
</a> an empty test module initialization function with correct signature if no custom initialization is required
by a test module.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
An advanced test runner doesn't have to be based on the build-in one and may require a different
test module initialization function signature and/or name.
</p></td></tr>
</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-2007 Gennadiy Rozental</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="single-header-variant.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../usage-variants.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../test-runners.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>