2
0
mirror of https://github.com/boostorg/test.git synced 2026-02-19 14:52:09 +00:00
Files
test/doc/v2/html/boost_test/test_output/test.html
2014-01-27 01:35:49 +01:00

233 lines
10 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>-output.log Test log output</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../index.html" title="Boost.Test">
<link rel="up" href="../test_output.html" title="Test output ... or let's see what you got for your money">
<link rel="prev" href="../test_output.html" title="Test output ... or let's see what you got for your money">
<link rel="next" href="testing_tool_args.html" title="Logging tool arguments">
</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="../test_output.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_output.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="testing_tool_args.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_test.test_output.test"></a><a class="link" href="test.html" title="-output.log Test log output">-output.log Test log output</a>
</h3></div></div></div>
<p>
The test log is produced during the test execution. All entries in the test
log are assigned a particular log level. Only the entries with level that
exceeds the <span class="emphasis"><em>active log level threshold</em></span> actually appear
in the test log output. Log levels are arranged by the 'importance' of the
log entries. Here is the list of all levels in order of increasing 'importance':
</p>
<div class="table">
<a name="boost_test.test_output.test.id_messages"></a><p class="title"><b>Table&#160;1.&#160;Messages</b></p>
<div class="table-contents"><table class="table" summary="Messages">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
notifications
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
Success
</p>
</td>
<td>
<p>
This category includes messages that provide information on successfully
passed assertions
</p>
</td>
</tr>
<tr>
<td>
<p>
Test tree traversal
</p>
</td>
<td>
<p>
This category includes messages that are produced by the <span class="emphasis"><em>UTF</em></span>
core and indicate which test suites/cases are currently being executed
or skipped
</p>
</td>
</tr>
<tr>
<td>
<p>
General information
</p>
</td>
<td>
<p>
This category includes general information massages produced in
most cases by a test module author using the macro <code class="computeroutput"><span class="identifier">BOOST_TEST_MESSAGE</span></code>
</p>
</td>
</tr>
<tr>
<td>
<p>
Warning
</p>
</td>
<td>
<p>
This category includes messages produced by failed warning level
assertions
</p>
</td>
</tr>
<tr>
<td>
<p>
Non fatal error
</p>
</td>
<td>
<p>
This category includes messages produced by failed check level
assertions
</p>
</td>
</tr>
<tr>
<td>
<p>
Uncaught C++ exceptions
</p>
</td>
<td>
<p>
This category includes messages that are produced by the <span class="emphasis"><em>UTF</em></span>
and provide detailed information on the C++ exceptions uncaught
by the test case body.
</p>
</td>
</tr>
<tr>
<td>
<p>
Non-fatal system error
</p>
</td>
<td>
<p>
This category includes messages that are produced by the <span class="emphasis"><em>UTF</em></span>
itself and provides information about caught non-fatal system error.
For example it includes messages produced in the case of test case
timeout or if floating point values calculation errors are caught.
</p>
</td>
</tr>
<tr>
<td>
<p>
Fatal system error
</p>
</td>
<td>
<p>
This category includes messages produced by failed require level
assertions and by the <span class="emphasis"><em>UTF</em></span> itself in case of
abnormal test case termination.
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
The active log level works namely as threshold, not as selector. For the
given active log level threshold, all test log entries with <span class="emphasis"><em>importance</em></span>
higher than threshold are enabled and all test log entries with <span class="emphasis"><em>importance</em></span>
below threshold are disabled.
</p></td></tr>
</table></div>
<p>
In addition to the levels described above the test log defines two special
log levels. The current log level can be set to:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
All messages If active log level threshold is set to this value, all
test log entries appear in the output. In practice this is equivalent
to setting the active log level threshold to <span class="emphasis"><em>success information
messages</em></span>
</li>
<li class="listitem">
Nothing If the active log level threshold is set to this value, none
of test log entries appear in the output. This log level is used to execute
a <span class="emphasis"><em>silent</em></span> test that doesn't produce any test log
and only generates a result code indicating whether test failed or passed.
</li>
</ul></div>
<p>
By default the active log level threshold is set to &amp;quot;non fatal error
messages&amp;quot; and the test log output is generated in the human readable
format. The active log level threshold and the output format can be configured
at runtime during a test module invocation and at compile time from within
a test module using the test log public interfaces. For example, for automated
test module output processing it might be more convenient to use the XML
based format.
</p>
<p>
In most cases The <span class="emphasis"><em>UTF</em></span> can't provide an exact location,
where system error occurs or uncaught C++ exception is thrown from. To be
able to pinpoint it as close as possible the <span class="emphasis"><em>UTF</em></span> keeps
track of checkpoints - the location a test module passed through. A test
case entrance and exit points, a test tool invocation point the <span class="emphasis"><em>UTF</em></span>
tracks automatically. Any other checkpoints should be entered by you manually.
The test log provides two macros for this purpose: <code class="computeroutput"><span class="identifier">BOOST_TEST_CHECKPOINT</span></code>
- to specify a <span class="emphasis"><em>named</em></span> checkpoint and <code class="computeroutput"><span class="identifier">BOOST_TEST_PASSPOINT</span></code>
- to specify an <span class="emphasis"><em>unnamed</em></span> checkpoint.
</p>
</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 &#169; 2001-2013 Gennadiy Rozental<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="../test_output.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_output.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="testing_tool_args.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>