libs/test/doc/html/boost_test/adv_scenarios/single_header_customizations/entry_point.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Customizing the module's entry point</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="../single_header_customizations.html" title="Header-only variant customizations">
   9 <link rel="prev" href="multiple_translation_units.html" title="Header-only with multiple translation units">
  10 <link rel="next" href="init_func.html" title="Customizing the module's 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="multiple_translation_units.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../single_header_customizations.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="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><h4 class="title">
  27 <a name="boost_test.adv_scenarios.single_header_customizations.entry_point"></a><a class="link" href="entry_point.html" title="Customizing the module's entry point">Customizing
  28         the module's entry point</a>
  29 </h4></div></div></div>
  30 <p>
  31           In this usage variant and in the translation unit containing the definition
  32           of <a class="link" href="../../utf_reference/link_references/link_boost_test_module_macro.html" title="BOOST_TEST_MODULE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MODULE</span></code></a>, you need to
  33           define the macros <a class="link" href="../../utf_reference/link_references/link_boost_test_no_main.html" title="BOOST_TEST_NO_MAIN"><code class="computeroutput"><span class="identifier">BOOST_TEST_NO_MAIN</span></code></a> and <a class="link" href="../../utf_reference/link_references/link_boost_test_alternative_init_macro.html" title="BOOST_TEST_ALTERNATIVE_INIT_API"><code class="computeroutput"><span class="identifier">BOOST_TEST_ALTERNATIVE_INIT_API</span></code></a>
  34           (their values are irrelevant) prior to including any of the framework's
  35           headers. Next, you have to define your custom entry point, and invoke the
  36           default <a class="link" href="../test_module_runner_overview.html" title="Test module runner">test
  37           runner</a> <code class="computeroutput"><span class="identifier">unit_test_main</span></code>
  38           manually with the default <a class="link" href="../test_module_init_overview.html" title="Test module's initialization">initialization
  39           function</a> <code class="computeroutput"><span class="identifier">init_unit_test</span></code>
  40           as argument.
  41         </p>
  42 <h6>
  43 <a name="boost_test.adv_scenarios.single_header_customizations.entry_point.h0"></a>
  44           <span class="phrase"><a name="boost_test.adv_scenarios.single_header_customizations.entry_point.example_descr"></a></span><a class="link" href="entry_point.html#boost_test.adv_scenarios.single_header_customizations.entry_point.example_descr">Example:
  45           using custom entry point</a>
  46         </h6>
  47 <div class="informaltable"><table class="table">
  48 <colgroup><col></colgroup>
  49 <thead><tr><th>
  50                   <p>
  51                     Code
  52                   </p>
  53                 </th></tr></thead>
  54 <tbody><tr><td>
  55 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_MODULE</span> <span class="identifier">custom_main</span>
  56 <span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_NO_MAIN</span>
  57 <span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_ALTERNATIVE_INIT_API</span>
  58 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">included</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  59 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
  60 <span class="keyword">namespace</span> <span class="identifier">utf</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">;</span>
  61
  62 <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test1</span><span class="special">)</span>
  63 <span class="special">{</span>
  64   <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="keyword">false</span><span class="special">);</span>
  65 <span class="special">}</span>
  66
  67 <span class="keyword">void</span> <span class="identifier">make_use_of</span><span class="special">(</span><span class="keyword">char</span><span class="special">**)</span>
  68 <span class="special">{</span>
  69   <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"Using custom entry point..."</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
  70 <span class="special">}</span>
  71
  72 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[],</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">envp</span><span class="special">[])</span>
  73 <span class="special">{</span>
  74   <span class="identifier">make_use_of</span><span class="special">(</span><span class="identifier">envp</span><span class="special">);</span>
  75   <span class="keyword">return</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">unit_test_main</span><span class="special">(</span><span class="identifier">init_unit_test</span><span class="special">,</span> <span class="identifier">argc</span><span class="special">,</span> <span class="identifier">argv</span><span class="special">);</span>
  76 <span class="special">}</span>
  77 </pre>
  78                 </td></tr></tbody>
  79 </table></div>
  80 <div class="informaltable"><table class="table">
  81 <colgroup><col></colgroup>
  82 <thead><tr><th>
  83                   <p>
  84                     Output
  85                   </p>
  86                 </th></tr></thead>
  87 <tbody><tr><td>
  88 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">&gt;</span> <span class="identifier">custom_main</span>
  89 <span class="identifier">Using</span> <span class="identifier">custom</span> <span class="identifier">entry</span> <span class="identifier">point</span><span class="special">...</span>
  90 <span class="identifier">Running</span> <span class="number">1</span> <span class="identifier">test</span> <span class="keyword">case</span><span class="special">...</span>
  91 <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">10</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test1"</span><span class="special">:</span> <span class="identifier">check</span> <span class="keyword">false</span> <span class="identifier">has</span> <span class="identifier">failed</span>
  92
  93 <span class="special">***</span> <span class="number">1</span> <span class="identifier">failure</span> <span class="identifier">is</span> <span class="identifier">detected</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"custom_main"</span>
  94 </pre>
  95                 </td></tr></tbody>
  96 </table></div>
  97 <p>
  98           In the above example, a custom entry point was selected because the test
  99           module, in addition to command line arguments, needs to obtain also the
 100           information about environment variables.
 101         </p>
 102 <div class="note"><table border="0" summary="Note">
 103 <tr>
 104 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
 105 <th align="left">Note</th>
 106 </tr>
 107 <tr><td align="left" valign="top"><p>
 108             The above example also illustrates that it makes sense to define both
 109             <a class="link" href="../../utf_reference/link_references/link_boost_test_module_macro.html" title="BOOST_TEST_MODULE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MODULE</span></code></a> and <a class="link" href="../../utf_reference/link_references/link_boost_test_no_main.html" title="BOOST_TEST_NO_MAIN"><code class="computeroutput"><span class="identifier">BOOST_TEST_NO_MAIN</span></code></a>. This way,
 110             no <code class="computeroutput"><span class="identifier">main</span></code> is generated
 111             by the framework, but the name specified by <a class="link" href="../../utf_reference/link_references/link_boost_test_module_macro.html" title="BOOST_TEST_MODULE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MODULE</span></code></a> is assigned
 112             to the <a class="link" href="../../tests_organization/test_tree/master_test_suite.html" title="Master test suite">Master
 113             test suite</a>.
 114           </p></td></tr>
 115 </table></div>
 116 <div class="note"><table border="0" summary="Note">
 117 <tr>
 118 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
 119 <th align="left">Note</th>
 120 </tr>
 121 <tr><td align="left" valign="top"><p>
 122             The reason for defining <a class="link" href="../../utf_reference/link_references/link_boost_test_alternative_init_macro.html" title="BOOST_TEST_ALTERNATIVE_INIT_API"><code class="computeroutput"><span class="identifier">BOOST_TEST_ALTERNATIVE_INIT_API</span></code></a>
 123             is described <a class="link" href="../obsolete_init_func.html" title="The obsolete initialization function">here</a>.
 124           </p></td></tr>
 125 </table></div>
 126 </div>
 127 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 128 <td align="left"></td>
 129 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 130       contributors<p>
 131         Distributed under the Boost Software License, Version 1.0. (See accompanying
 132         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>)
 133       </p>
 134 </div></td>
 135 </tr></table>
 136 <hr>
 137 <div class="spirit-nav">
 138 <a accesskey="p" href="multiple_translation_units.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../single_header_customizations.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="init_func.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 139 </div>
 140 </body>
 141 </html>