9
3

test_log_output.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Test log output</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="../log_formats.html" title="Log formats">
  9. <link rel="prev" href="../log_formats.html" title="Log formats">
  10. <link rel="next" href="log_human_readable_format.html" title="HRF: Human readable log 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="../log_formats.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../log_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="log_human_readable_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.log_formats.test_log_output"></a><a class="link" href="test_log_output.html" title="Test log output">Test
  28. log output</a>
  29. </h4></div></div></div>
  30. <p>
  31. The test log is produced during the test execution. All entries in the
  32. test log are assigned a particular log level. Only the entries with level
  33. that exceeds the <span class="emphasis"><em>active log level threshold</em></span> actually
  34. appear in the test log output. Log levels are arranged by the 'importance'
  35. of the log entries. Here is the list of all levels in order of increasing
  36. 'importance':
  37. </p>
  38. <a name="test_log_output_table"></a><div class="table">
  39. <a name="boost_test.test_output.log_formats.test_log_output.id_messages"></a><p class="title"><b>Table&#160;4.&#160;Messages</b></p>
  40. <div class="table-contents"><table class="table" summary="Messages">
  41. <colgroup>
  42. <col>
  43. <col>
  44. </colgroup>
  45. <thead><tr>
  46. <th>
  47. <p>
  48. Notifications
  49. </p>
  50. </th>
  51. <th>
  52. <p>
  53. Meaning
  54. </p>
  55. </th>
  56. </tr></thead>
  57. <tbody>
  58. <tr>
  59. <td>
  60. <p>
  61. Success
  62. </p>
  63. </td>
  64. <td>
  65. <p>
  66. This category includes messages that provide information on successfully
  67. passed assertions
  68. </p>
  69. </td>
  70. </tr>
  71. <tr>
  72. <td>
  73. <p>
  74. Test tree traversal
  75. </p>
  76. </td>
  77. <td>
  78. <p>
  79. This category includes messages that are produced by the <span class="emphasis"><em>Unit
  80. Test Framework</em></span> core and indicate which test suites/cases
  81. are currently being executed or skipped
  82. </p>
  83. </td>
  84. </tr>
  85. <tr>
  86. <td>
  87. <p>
  88. General information
  89. </p>
  90. </td>
  91. <td>
  92. <p>
  93. This category includes general information messages produced
  94. in most cases by a test module author using the macro <a class="link" href="../../utf_reference/testout_reference/test_output_macro_message.html" title="BOOST_TEST_MESSAGE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MESSAGE</span></code></a>
  95. </p>
  96. </td>
  97. </tr>
  98. <tr>
  99. <td>
  100. <p>
  101. Warning
  102. </p>
  103. </td>
  104. <td>
  105. <p>
  106. This category includes messages produced by failed <code class="computeroutput"><span class="identifier">WARNING</span></code> level assertions
  107. </p>
  108. </td>
  109. </tr>
  110. <tr>
  111. <td>
  112. <p>
  113. Non fatal error
  114. </p>
  115. </td>
  116. <td>
  117. <p>
  118. This category includes messages produced by failed <code class="computeroutput"><span class="identifier">CHECK</span></code> level assertions
  119. </p>
  120. </td>
  121. </tr>
  122. <tr>
  123. <td>
  124. <p>
  125. Uncaught C++ exceptions
  126. </p>
  127. </td>
  128. <td>
  129. <p>
  130. This category includes messages that are produced by the <span class="emphasis"><em>Unit
  131. Test Framework</em></span> and provide detailed information on
  132. the C++ exceptions uncaught by the test case body.
  133. </p>
  134. </td>
  135. </tr>
  136. <tr>
  137. <td>
  138. <p>
  139. Non-fatal system error
  140. </p>
  141. </td>
  142. <td>
  143. <p>
  144. This category includes messages that are produced by the <span class="emphasis"><em>Unit
  145. Test Framework</em></span> itself and provides information about
  146. caught non-fatal system error. For example it includes messages
  147. produced in the case of test case timeout or if floating point
  148. values calculation errors are caught.
  149. </p>
  150. </td>
  151. </tr>
  152. <tr>
  153. <td>
  154. <p>
  155. Fatal system error
  156. </p>
  157. </td>
  158. <td>
  159. <p>
  160. This category includes messages produced by failed require level
  161. assertions and by the <span class="emphasis"><em>Unit Test Framework</em></span>
  162. itself in case of abnormal test case termination.
  163. </p>
  164. </td>
  165. </tr>
  166. </tbody>
  167. </table></div>
  168. </div>
  169. <br class="table-break"><div class="note"><table border="0" summary="Note">
  170. <tr>
  171. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  172. <th align="left">Note</th>
  173. </tr>
  174. <tr><td align="left" valign="top"><p>
  175. The active log level works namely as threshold, not as selector. For
  176. the given active log level threshold, all test log entries with <span class="emphasis"><em>importance</em></span>
  177. higher than threshold are enabled and all test log entries with <span class="emphasis"><em>importance</em></span>
  178. below threshold are disabled.
  179. </p></td></tr>
  180. </table></div>
  181. <p>
  182. In addition to the levels described above the test log defines two special
  183. log levels. The current log level can be set to:
  184. </p>
  185. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  186. <li class="listitem">
  187. All messages<br> If active log level threshold is set to this value,
  188. all test log entries appear in the output. In practice this is equivalent
  189. to setting the active log level threshold to <span class="emphasis"><em>success information
  190. messages</em></span>
  191. </li>
  192. <li class="listitem">
  193. Nothing<br> If the active log level threshold is set to this value,
  194. none of test log entries appear in the output. This log level is used
  195. to execute a <span class="emphasis"><em>silent</em></span> test that doesn't produce
  196. any test log and only generates a result code indicating whether test
  197. failed or passed.
  198. </li>
  199. </ul></div>
  200. </div>
  201. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  202. <td align="left"></td>
  203. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  204. contributors<p>
  205. Distributed under the Boost Software License, Version 1.0. (See accompanying
  206. 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>)
  207. </p>
  208. </div></td>
  209. </tr></table>
  210. <hr>
  211. <div class="spirit-nav">
  212. <a accesskey="p" href="../log_formats.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../log_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="log_human_readable_format.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  213. </div>
  214. </body>
  215. </html>