libs/test/doc/html/boost_test/test_output/test_tools_support_for_logging/testing_tool_output_disable.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Logging user defined types</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="../test_tools_support_for_logging.html" title="Tools supports for logging">
   9 <link rel="prev" href="../test_tools_support_for_logging.html" title="Tools supports for logging">
  10 <link rel="next" href="test_output_macro_message.html" title="Custom messages">
  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="../test_tools_support_for_logging.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_tools_support_for_logging.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="test_output_macro_message.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.test_output.test_tools_support_for_logging.testing_tool_output_disable"></a><a class="link" href="testing_tool_output_disable.html" title="Logging user defined types">Logging
  28         user defined types</a>
  29 </h4></div></div></div>
  30 <p>
  31           Most of the <a class="link" href="../../testing_tools.html" title="Writing unit tests">testing tools</a>
  32           print values of their arguments to the output stream in some form of log
  33           statement. If arguments type does not support
  34         </p>
  35 <pre class="programlisting"><span class="keyword">operator</span><span class="special">&lt;&lt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&amp;,</span> <span class="identifier">ArgumentType</span> <span class="keyword">const</span><span class="special">&amp;);</span>
  36 </pre>
  37 <p>
  38           interface, you will get a compilation error.
  39         </p>
  40 <p>
  41           The <span class="emphasis"><em>Unit Test Framework</em></span> supports three different methods
  42           for logging user defined types:
  43         </p>
  44 <div class="orderedlist"><ol class="orderedlist" type="1">
  45 <li class="listitem">
  46               through the <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></code>
  47               for that specific type: any type that implements the above interface
  48               has direct support for logging,
  49             </li>
  50 <li class="listitem">
  51               through a customization point responsible for logging a specific type,
  52               which is less intrusive than the implementation of <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></code>. This is explained in more
  53               details in <a class="link" href="testing_tool_output_disable.html#ref_log_output_custom_customization_point">this
  54               section</a>,
  55             </li>
  56 <li class="listitem">
  57               by prohibiting the <a class="link" href="../../testing_tools.html" title="Writing unit tests">testing
  58               tools</a> from logging argument values for specified type through
  59               <a class="link" href="../../utf_reference/testout_reference/test_output_macro_disable_type.html" title="BOOST_TEST_DONT_PRINT_LOG_VALUE"><code class="computeroutput"><span class="identifier">BOOST_TEST_DONT_PRINT_LOG_VALUE</span></code></a>.
  60               This is explained in more details in <a class="link" href="testing_tool_output_disable.html#ref_log_output_custom_avoid_printing">this
  61               section</a>.
  62             </li>
  63 </ol></div>
  64 <a name="ref_log_output_custom_customization_point"></a><h5>
  65 <a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.h0"></a>
  66           <span class="phrase"><a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.user_type_customization_point_fo"></a></span><a class="link" href="testing_tool_output_disable.html#boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.user_type_customization_point_fo">User
  67           type customization point for logging</a>
  68         </h5>
  69 <p>
  70           It is possible to indicate a function, <code class="computeroutput"><span class="identifier">boost_test_print_type</span></code>,
  71           to <span class="emphasis"><em>Unit Test Framework</em></span> that is responsible for the
  72           printing of a user defined type, without the need to override the <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></code>
  73           for that specific type. This is convenient for instance when the <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></code>
  74           has already been defined for other needs.
  75         </p>
  76 <p>
  77           The syntax follows the <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></code>, and this function should be in
  78           the same namespace as the type:
  79         </p>
  80 <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&amp;</span> <span class="identifier">boost_test_print_type</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&amp;</span> <span class="identifier">ostr</span><span class="special">,</span> <span class="identifier">ArgumentType</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">right</span><span class="special">);</span>
  81 </pre>
  82 <h6>
  83 <a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.h1"></a>
  84           <span class="phrase"><a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.example_descr"></a></span><a class="link" href="testing_tool_output_disable.html#boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.example_descr">Example:
  85           Logging customization point usage</a>
  86         </h6>
  87 <div class="informaltable"><table class="table">
  88 <colgroup><col></colgroup>
  89 <thead><tr><th>
  90                   <p>
  91                     Code
  92                   </p>
  93                 </th></tr></thead>
  94 <tbody><tr><td>
  95 <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">logger</span><span class="special">-</span><span class="identifier">customization</span><span class="special">-</span><span class="identifier">point</span>
  96 <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>
  97
  98 <span class="keyword">namespace</span> <span class="identifier">user_defined_namespace</span> <span class="special">{</span>
  99   <span class="keyword">struct</span> <span class="identifier">user_defined_type</span> <span class="special">{</span>
 100       <span class="keyword">int</span> <span class="identifier">value</span><span class="special">;</span>
 101
 102       <span class="identifier">user_defined_type</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">value_</span><span class="special">)</span> <span class="special">:</span> <span class="identifier">value</span><span class="special">(</span><span class="identifier">value_</span><span class="special">)</span>
 103       <span class="special">{}</span>
 104
 105       <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span><span class="keyword">int</span> <span class="identifier">right</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span>
 106           <span class="keyword">return</span> <span class="identifier">right</span> <span class="special">==</span> <span class="identifier">value</span><span class="special">;</span>
 107       <span class="special">}</span>
 108   <span class="special">};</span>
 109 <span class="special">}</span>
 110
 111 <span class="keyword">namespace</span> <span class="identifier">user_defined_namespace</span> <span class="special">{</span>
 112   <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&amp;</span> <span class="identifier">boost_test_print_type</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span><span class="special">&amp;</span> <span class="identifier">ostr</span><span class="special">,</span> <span class="identifier">user_defined_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">right</span><span class="special">)</span> <span class="special">{</span>
 113       <span class="identifier">ostr</span> <span class="special">&lt;&lt;</span> <span class="string">"** value of user_defined_type is "</span> <span class="special">&lt;&lt;</span> <span class="identifier">right</span><span class="special">.</span><span class="identifier">value</span> <span class="special">&lt;&lt;</span> <span class="string">" **"</span><span class="special">;</span>
 114       <span class="keyword">return</span> <span class="identifier">ostr</span><span class="special">;</span>
 115   <span class="special">}</span>
 116 <span class="special">}</span>
 117
 118 <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test1</span><span class="special">)</span>
 119 <span class="special">{</span>
 120     <span class="identifier">user_defined_namespace</span><span class="special">::</span><span class="identifier">user_defined_type</span> <span class="identifier">t</span><span class="special">(</span><span class="number">10</span><span class="special">);</span>
 121     <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="identifier">t</span> <span class="special">==</span> <span class="number">11</span><span class="special">);</span>
 122
 123     <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">user_defined_namespace</span><span class="special">;</span>
 124     <span class="identifier">user_defined_type</span> <span class="identifier">t2</span><span class="special">(</span><span class="number">11</span><span class="special">);</span>
 125     <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="identifier">t2</span> <span class="special">==</span> <span class="number">11</span><span class="special">);</span>
 126 <span class="special">}</span>
 127 </pre>
 128                 </td></tr></tbody>
 129 </table></div>
 130 <div class="informaltable"><table class="table">
 131 <colgroup><col></colgroup>
 132 <thead><tr><th>
 133                   <p>
 134                     Output
 135                   </p>
 136                 </th></tr></thead>
 137 <tbody><tr><td>
 138 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">&gt;</span> <span class="identifier">logger</span><span class="special">-</span><span class="identifier">customization</span><span class="special">-</span><span class="identifier">point</span> <span class="special">--</span><span class="identifier">log_level</span><span class="special">=</span><span class="identifier">all</span>
 139 <span class="identifier">Running</span> <span class="number">1</span> <span class="identifier">test</span> <span class="keyword">case</span><span class="special">...</span>
 140 <span class="identifier">Entering</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"logger-customization-point"</span>
 141 <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">36</span><span class="special">):</span> <span class="identifier">Entering</span> <span class="identifier">test</span> <span class="keyword">case</span> <span class="string">"test1"</span>
 142 <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">39</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="identifier">t</span> <span class="special">==</span> <span class="number">11</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[**</span> <span class="identifier">value</span> <span class="identifier">of</span> <span class="identifier">user_defined_type</span> <span class="identifier">is</span> <span class="number">10</span> <span class="special">**</span> <span class="special">!=</span> <span class="number">11</span><span class="special">]</span>
 143 <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">43</span><span class="special">):</span> <span class="identifier">info</span><span class="special">:</span> <span class="identifier">check</span> <span class="identifier">t2</span> <span class="special">==</span> <span class="number">11</span> <span class="identifier">has</span> <span class="identifier">passed</span>
 144 <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">36</span><span class="special">):</span> <span class="identifier">Leaving</span> <span class="identifier">test</span> <span class="keyword">case</span> <span class="string">"test1"</span><span class="special">;</span> <span class="identifier">testing</span> <span class="identifier">time</span><span class="special">:</span> <span class="number">125u</span><span class="identifier">s</span>
 145 <span class="identifier">Leaving</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"logger-example-customization-point"</span><span class="special">;</span> <span class="identifier">testing</span> <span class="identifier">time</span><span class="special">:</span> <span class="number">157u</span><span class="identifier">s</span>
 146
 147 <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">"logger-customization-point"</span>
 148 </pre>
 149                 </td></tr></tbody>
 150 </table></div>
 151 <a name="ref_log_output_custom_avoid_printing"></a><h5>
 152 <a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.h2"></a>
 153           <span class="phrase"><a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.prohibiting_the_printing_of_a_sp"></a></span><a class="link" href="testing_tool_output_disable.html#boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.prohibiting_the_printing_of_a_sp">Prohibiting
 154           the printing of a specific type</a>
 155         </h5>
 156 <p>
 157           To prohibit the printing of a specific type, use the following statement
 158           on file level before first test case that includes statement failing to
 159           compile:
 160         </p>
 161 <pre class="programlisting"><span class="identifier">BOOST_TEST_DONT_PRINT_LOG_VALUE</span><span class="special">(</span><span class="identifier">ArgumentType</span><span class="special">)</span>
 162 </pre>
 163 <h6>
 164 <a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.h3"></a>
 165           <span class="phrase"><a name="boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.example_descr0"></a></span><a class="link" href="testing_tool_output_disable.html#boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable.example_descr0">Example:
 166           BOOST_TEST_DONT_PRINT_LOG_VALUE usage</a>
 167         </h6>
 168 <div class="informaltable"><table class="table">
 169 <colgroup><col></colgroup>
 170 <thead><tr><th>
 171                   <p>
 172                     Code
 173                   </p>
 174                 </th></tr></thead>
 175 <tbody><tr><td>
 176 <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">example</span>
 177 <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>
 178 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">utility</span><span class="special">&gt;</span>
 179
 180
 181 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">pair_type</span><span class="special">;</span>
 182
 183 <span class="identifier">BOOST_TEST_DONT_PRINT_LOG_VALUE</span><span class="special">(</span> <span class="identifier">pair_type</span> <span class="special">)</span>
 184
 185 <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span> <span class="identifier">test_list</span> <span class="special">)</span>
 186 <span class="special">{</span>
 187   <span class="identifier">pair_type</span> <span class="identifier">p1</span><span class="special">(</span> <span class="number">2</span><span class="special">,</span> <span class="number">5.5f</span> <span class="special">);</span>
 188   <span class="identifier">pair_type</span> <span class="identifier">p2</span><span class="special">(</span> <span class="number">2</span><span class="special">,</span> <span class="number">5.501f</span> <span class="special">);</span>
 189
 190   <span class="identifier">BOOST_CHECK_EQUAL</span><span class="special">(</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">p2</span> <span class="special">);</span>
 191 <span class="special">}</span>
 192 </pre>
 193                 </td></tr></tbody>
 194 </table></div>
 195 <div class="informaltable"><table class="table">
 196 <colgroup><col></colgroup>
 197 <thead><tr><th>
 198                   <p>
 199                     Output
 200                   </p>
 201                 </th></tr></thead>
 202 <tbody><tr><td>
 203 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">Running</span> <span class="number">1</span> <span class="identifier">test</span> <span class="keyword">case</span><span class="special">...</span>
 204 <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">16</span><span class="special">):</span> <span class="identifier">error</span> <span class="identifier">in</span> <span class="string">"test_list"</span><span class="special">:</span> <span class="identifier">check</span> <span class="identifier">p1</span> <span class="special">==</span> <span class="identifier">p2</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span> <span class="special">!=</span> <span class="special">]</span>
 205
 206 <span class="special">***</span> <span class="number">1</span> <span class="identifier">failures</span> <span class="identifier">is</span> <span class="identifier">detected</span> <span class="identifier">in</span> <span class="identifier">test</span> <span class="identifier">suite</span> <span class="string">"example"</span>
 207 </pre>
 208                 </td></tr></tbody>
 209 </table></div>
 210 </div>
 211 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 212 <td align="left"></td>
 213 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 214       contributors<p>
 215         Distributed under the Boost Software License, Version 1.0. (See accompanying
 216         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>)
 217       </p>
 218 </div></td>
 219 </tr></table>
 220 <hr>
 221 <div class="spirit-nav">
 222 <a accesskey="p" href="../test_tools_support_for_logging.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_tools_support_for_logging.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="test_output_macro_message.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 223 </div>
 224 </body>
 225 </html>