libs/test/doc/html/boost_test/test_output/report_formats/report_human_readable_format.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Human readable report format</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="../report_formats.html" title="Report formats">
   9 <link rel="prev" href="../report_formats.html" title="Report formats">
  10 <link rel="next" href="report_xml_format.html" title="XML based report output format">
  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="../report_formats.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../report_formats.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="report_xml_format.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.report_formats.report_human_readable_format"></a><a name="ref_report_formats"></a><a class="link" href="report_human_readable_format.html" title="Human readable report format">Human
  28         readable report format</a>
  29 </h4></div></div></div>
  30 <p>
  31           The human readable report format is designed to produce the most human
  32           friendly description of the results of a test module testing. This is a
  33           default format generated by test modules.
  34         </p>
  35 <p>
  36           Depending on the framework's report level the output looks like this:
  37         </p>
  38 <div class="informaltable"><table class="table">
  39 <colgroup>
  40 <col>
  41 <col>
  42 </colgroup>
  43 <thead><tr>
  44 <th>
  45                   <p>
  46                     Level
  47                   </p>
  48                 </th>
  49 <th>
  50                   <p>
  51                     Output
  52                   </p>
  53                 </th>
  54 </tr></thead>
  55 <tbody>
  56 <tr>
  57 <td>
  58                   <p>
  59                     no report
  60                   </p>
  61                 </td>
  62 <td>
  63                   <p>
  64                     On this level the framework does not produce result report at
  65                     all. It make sense to use this level for test modules running
  66                     unattended (as part of some automated regression testing system,
  67                     for example)
  68                   </p>
  69                 </td>
  70 </tr>
  71 <tr>
  72 <td>
  73                   <p>
  74                     Confirmation
  75                   </p>
  76                 </td>
  77 <td>
  78                   <div class="variablelist">
  79 <p class="title"><b></b></p>
  80 <dl class="variablelist">
  81 <dt><span class="term">Passing test</span></dt>
  82 <dd><p>
  83                           *** No errors detected
  84                         </p></dd>
  85 <dt><span class="term">Skipped test</span></dt>
  86 <dd><p>
  87                           *** The test suite &lt;name&gt; was skipped; see standard
  88                           output for details
  89                         </p></dd>
  90 <dt><span class="term">Aborted test</span></dt>
  91 <dd><p>
  92                           *** The test suite &lt;name&gt; was aborted; see standard
  93                           output for details
  94                         </p></dd>
  95 <dt><span class="term">Failed test without failed assertions</span></dt>
  96 <dd><p>
  97                           *** Errors were detected in the test suite &lt;name&gt;;
  98                           see standard output for details
  99                         </p></dd>
 100 <dt><span class="term">Failed test</span></dt>
 101 <dd><p>
 102                           *** N failures are detected in test suite &lt;name&gt;
 103                         </p></dd>
 104 <dt><span class="term">Failed test with some failures expected</span></dt>
 105 <dd><p>
 106                           *** N failures are detected (M failures are expected) in
 107                           test suite &lt;name&gt;
 108                         </p></dd>
 109 </dl>
 110 </div>
 111                 </td>
 112 </tr>
 113 <tr>
 114 <td>
 115                   <p>
 116                     Detailed
 117                   </p>
 118                 </td>
 119 <td>
 120                   <p>
 121                     On this level we report result for each test units hierarchically
 122                     (each test unit is reported as part of parent test unit report.
 123                     Test cases are reported like this:
 124                   </p>
 125 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">        Test case/suite &lt;name&gt; has passed/was skipped/was aborted/has failed/ with:
 126             N assertions out of M passed
 127             N assertions out of M failed
 128             N warnings out of M failed
 129             X failures expected
 130         </pre>
 131                   <p>
 132                     Only relevant lines will appear. If test case does not have failing
 133                     assertions corresponding line in the report is not shown.
 134                   </p>
 135                   <p>
 136                     Test suite in addition to above lines also report these:
 137                   </p>
 138 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">            N test cases out of M passed
 139             N test cases out of M passed with warnings
 140             N test cases out of M failed
 141             N test cases out of M skipped
 142             N test cases out of M aborted
 143             </pre>
 144                   <p>
 145                     And similarly to above lines only relevant ones will appear in
 146                     output.
 147                   </p>
 148                 </td>
 149 </tr>
 150 <tr>
 151 <td>
 152                   <p>
 153                     Short
 154                   </p>
 155                 </td>
 156 <td>
 157                   <p>
 158                     Short report format is similar to detailed, but only reports
 159                     information for master test suite
 160                   </p>
 161                 </td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 </div>
 166 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 167 <td align="left"></td>
 168 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 169       contributors<p>
 170         Distributed under the Boost Software License, Version 1.0. (See accompanying
 171         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>)
 172       </p>
 173 </div></td>
 174 </tr></table>
 175 <hr>
 176 <div class="spirit-nav">
 177 <a accesskey="p" href="../report_formats.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../report_formats.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="report_xml_format.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 178 </div>
 179 </body>
 180 </html>