<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Controlling outputs</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="Boost.Test">
<link rel="up" href="../index.html" title="Boost.Test">
<link rel="prev" href="testing_tools/summary.html" title="Summary of the API for writing tests">
<link rel="next" href="test_output/test_tools_support_for_logging.html" title="Tools supports for logging">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_test.test_output"></a><a class="link" href="test_output.html" title="Controlling outputs">Controlling outputs</a>
</h2></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="section"><a href="test_output/test_tools_support_for_logging.html">Tools
supports for logging</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="test_output/test_tools_support_for_logging/testing_tool_output_disable.html">Logging
user defined types</a></span></dt>
<dt><span class="section"><a href="test_output/test_tools_support_for_logging/test_output_macro_message.html">Custom
messages</a></span></dt>
<dt><span class="section"><a href="test_output/test_tools_support_for_logging/checkpoints.html">Checkpoints
for accurate failure location</a></span></dt>
<dt><span class="section"><a href="test_output/test_tools_support_for_logging/contexts.html">Contexts</a></span></dt>
<dt><span class="section"><a href="test_output/test_tools_support_for_logging/log_floating_points.html">Logging
floating point type numbers</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="test_output/log_formats.html">Log formats</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="test_output/log_formats/test_log_output.html">Test
log output</a></span></dt>
<dt><span class="section"><a href="test_output/log_formats/log_human_readable_format.html">HRF:
Human readable log format</a></span></dt>
<dt><span class="section"><a href="test_output/log_formats/log_xml_format.html">XML
log format</a></span></dt>
<dt><span class="section"><a href="test_output/log_formats/log_junit_format.html">JUNIT
log format</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="test_output/report_formats.html">Report formats</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="test_output/report_formats/report_human_readable_format.html">Human
readable report format</a></span></dt>
<dt><span class="section"><a href="test_output/report_formats/report_xml_format.html">XML
based report output format</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="test_output/logging_api.html">Logging API</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="test_output/logging_api/log_ct_output_stream_redirection.html">Log
output stream redirection</a></span></dt>
<dt><span class="section"><a href="test_output/logging_api/log_ct_log_level.html">Log
level configuration</a></span></dt>
<dt><span class="section"><a href="test_output/logging_api/log_ct_log_format.html">Predefined
log format selection</a></span></dt>
<dt><span class="section"><a href="test_output/logging_api/custom_log_formatter.html">Custom
log format support</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="test_output/test_output_progress.html">Progress
display</a></span></dt>
<dt><span class="section"><a href="test_output/summary.html">Summary of the API for
controlling the output</a></span></dt>
</dl></div>
<p>
The output produced by a test module is one of the major assets the <span class="emphasis"><em>Unit
Test Framework</em></span> brings to users. In comparison with any kind of manual/assert
based solution the <span class="emphasis"><em>Unit Test Framework</em></span> provide following
services:
</p>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">All test errors are reported uniformly</span></dt>
<dd><p>
The test execution monitor along with standardized output from all included
<a class="link" href="testing_tools.html" title="Writing unit tests">testing tools</a> provides
uniform reporting for all errors including fatal errors, like memory
assess violation and uncaught exceptions.
</p></dd>
<dt><span class="term">Detailed information on the source of an error</span></dt>
<dd><p>
The <span class="emphasis"><em>Unit Test Framework</em></span> test tool's based assertion
provides as much information as possible about cause of error, usually
allowing you to deduce what is wrong without entering the debugger or
core analysis.
</p></dd>
<dt><span class="term">Separation of the test errors description (test log) from the results
report summary (test results report)</span></dt>
<dd>
<p>
The information produced during test execution, including all error,
warning and info messages from the test tools, executed test units notification
constitute the <span class="bold"><strong>test log</strong></span>.
</p>
<p>
Once testing is completed the <span class="emphasis"><em>Unit Test Framework</em></span>
may produce a summary <span class="bold"><strong>test report</strong></span> with
different levels of detail.
</p>
</dd>
<dt><span class="term">Flexibility in what is shown in the output</span></dt>
<dd><p>
The <span class="emphasis"><em>Unit Test Framework</em></span> provides the ability to
configure what is shown in both the test log and the test report. The
configuration is supported both at runtime (from the command line) and
at compile time from within a test module.
</p></dd>
<dt><span class="term">Flexibility in how output is formatted</span></dt>
<dd><p>
The <span class="emphasis"><em>Unit Test Framework</em></span> provides the ability to
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
supported by the <span class="emphasis"><em>Unit Test Framework</em></span> itself. However
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>
an output for your purposes.
</p></dd>
</dl>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>