test_output.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Controlling outputs</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="../index.html" title="Boost.Test">
  9. <link rel="prev" href="testing_tools/summary.html" title="Summary of the API for writing tests">
  10. <link rel="next" href="test_output/test_tools_support_for_logging.html" title="Tools supports for logging">
  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="testing_tools/summary.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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/test_tools_support_for_logging.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27. <a name="boost_test.test_output"></a><a class="link" href="test_output.html" title="Controlling outputs">Controlling outputs</a>
  28. </h2></div></div></div>
  29. <div class="toc"><dl class="toc">
  30. <dt><span class="section"><a href="test_output/test_tools_support_for_logging.html">Tools
  31. supports for logging</a></span></dt>
  32. <dd><dl>
  33. <dt><span class="section"><a href="test_output/test_tools_support_for_logging/testing_tool_output_disable.html">Logging
  34. user defined types</a></span></dt>
  35. <dt><span class="section"><a href="test_output/test_tools_support_for_logging/test_output_macro_message.html">Custom
  36. messages</a></span></dt>
  37. <dt><span class="section"><a href="test_output/test_tools_support_for_logging/checkpoints.html">Checkpoints
  38. for accurate failure location</a></span></dt>
  39. <dt><span class="section"><a href="test_output/test_tools_support_for_logging/contexts.html">Contexts</a></span></dt>
  40. <dt><span class="section"><a href="test_output/test_tools_support_for_logging/log_floating_points.html">Logging
  41. floating point type numbers</a></span></dt>
  42. </dl></dd>
  43. <dt><span class="section"><a href="test_output/log_formats.html">Log formats</a></span></dt>
  44. <dd><dl>
  45. <dt><span class="section"><a href="test_output/log_formats/test_log_output.html">Test
  46. log output</a></span></dt>
  47. <dt><span class="section"><a href="test_output/log_formats/log_human_readable_format.html">HRF:
  48. Human readable log format</a></span></dt>
  49. <dt><span class="section"><a href="test_output/log_formats/log_xml_format.html">XML
  50. log format</a></span></dt>
  51. <dt><span class="section"><a href="test_output/log_formats/log_junit_format.html">JUNIT
  52. log format</a></span></dt>
  53. </dl></dd>
  54. <dt><span class="section"><a href="test_output/report_formats.html">Report formats</a></span></dt>
  55. <dd><dl>
  56. <dt><span class="section"><a href="test_output/report_formats/report_human_readable_format.html">Human
  57. readable report format</a></span></dt>
  58. <dt><span class="section"><a href="test_output/report_formats/report_xml_format.html">XML
  59. based report output format</a></span></dt>
  60. </dl></dd>
  61. <dt><span class="section"><a href="test_output/logging_api.html">Logging API</a></span></dt>
  62. <dd><dl>
  63. <dt><span class="section"><a href="test_output/logging_api/log_ct_output_stream_redirection.html">Log
  64. output stream redirection</a></span></dt>
  65. <dt><span class="section"><a href="test_output/logging_api/log_ct_log_level.html">Log
  66. level configuration</a></span></dt>
  67. <dt><span class="section"><a href="test_output/logging_api/log_ct_log_format.html">Predefined
  68. log format selection</a></span></dt>
  69. <dt><span class="section"><a href="test_output/logging_api/custom_log_formatter.html">Custom
  70. log format support</a></span></dt>
  71. </dl></dd>
  72. <dt><span class="section"><a href="test_output/test_output_progress.html">Progress
  73. display</a></span></dt>
  74. <dt><span class="section"><a href="test_output/summary.html">Summary of the API for
  75. controlling the output</a></span></dt>
  76. </dl></div>
  77. <p>
  78. The output produced by a test module is one of the major assets the <span class="emphasis"><em>Unit
  79. Test Framework</em></span> brings to users. In comparison with any kind of manual/assert
  80. based solution the <span class="emphasis"><em>Unit Test Framework</em></span> provide following
  81. services:
  82. </p>
  83. <div class="variablelist">
  84. <p class="title"><b></b></p>
  85. <dl class="variablelist">
  86. <dt><span class="term">All test errors are reported uniformly</span></dt>
  87. <dd><p>
  88. The test execution monitor along with standardized output from all included
  89. <a class="link" href="testing_tools.html" title="Writing unit tests">testing tools</a> provides
  90. uniform reporting for all errors including fatal errors, like memory
  91. assess violation and uncaught exceptions.
  92. </p></dd>
  93. <dt><span class="term">Detailed information on the source of an error</span></dt>
  94. <dd><p>
  95. The <span class="emphasis"><em>Unit Test Framework</em></span> test tool's based assertion
  96. provides as much information as possible about cause of error, usually
  97. allowing you to deduce what is wrong without entering the debugger or
  98. core analysis.
  99. </p></dd>
  100. <dt><span class="term">Separation of the test errors description (test log) from the results
  101. report summary (test results report)</span></dt>
  102. <dd>
  103. <p>
  104. The information produced during test execution, including all error,
  105. warning and info messages from the test tools, executed test units notification
  106. constitute the <span class="bold"><strong>test log</strong></span>.
  107. </p>
  108. <p>
  109. Once testing is completed the <span class="emphasis"><em>Unit Test Framework</em></span>
  110. may produce a summary <span class="bold"><strong>test report</strong></span> with
  111. different levels of detail.
  112. </p>
  113. </dd>
  114. <dt><span class="term">Flexibility in what is shown in the output</span></dt>
  115. <dd><p>
  116. The <span class="emphasis"><em>Unit Test Framework</em></span> provides the ability to
  117. configure what is shown in both the test log and the test report. The
  118. configuration is supported both at runtime (from the command line) and
  119. at compile time from within a test module.
  120. </p></dd>
  121. <dt><span class="term">Flexibility in how output is formatted</span></dt>
  122. <dd><p>
  123. The <span class="emphasis"><em>Unit Test Framework</em></span> provides the ability to
  124. configure the format of the test module output. At the moment only <a class="link" href="test_output/log_formats.html" title="Log formats">three formats</a> are
  125. supported by the <span class="emphasis"><em>Unit Test Framework</em></span> itself. However
  126. the well defined public interface allows you to <a class="link" href="test_output/logging_api/custom_log_formatter.html" title="Custom log format support">customize</a>
  127. an output for your purposes.
  128. </p></dd>
  129. </dl>
  130. </div>
  131. </div>
  132. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  133. <td align="left"></td>
  134. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  135. contributors<p>
  136. Distributed under the Boost Software License, Version 1.0. (See accompanying
  137. 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>)
  138. </p>
  139. </div></td>
  140. </tr></table>
  141. <hr>
  142. <div class="spirit-nav">
  143. <a accesskey="p" href="testing_tools/summary.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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/test_tools_support_for_logging.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  144. </div>
  145. </body>
  146. </html>