2
0
mirror of https://github.com/boostorg/test.git synced 2026-02-25 16:42:54 +00:00
Files
test/doc/test_output/log_format.qbk
Gennadiy Rozental 3906cc513f Copyright update
2015-09-25 04:20:51 -04:00

102 lines
3.8 KiB
Plaintext

[/
/ Copyright (c) 2003 Boost.Test contributors
/
/ Distributed under the Boost Software License, Version 1.0. (See accompanying
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
[section Log formats]
[section:log_human_readable_format Human readable log format]
The human readable log format is designed to closely match an errors description produced by the Microsoft family
of C++ compilers. This format allows jumping to the error location, if test module output is redirected into IDE
output window. The rest of the log messages are designed to produce the most human friendly description of the
events occurring in test module. This is a default format generated by test modules.
Here the list of events along with corresponding message and the condition that has to be satisfied for it to appear
in the output.
[table
[
[Event]
[Condition]
[Output]
]
[ [On testing start]
[threshold != log_nothing]
[`Running <total number of test cases> test case(s) ...`] ]
[ [On testing start]
[threshold != log_nothing, show_build_info is set]
[
[pre Platform: $BOOST_PLATFORM
Compiler: $BOOST_COMPILER
STL : $BOOST_STDLIB
Boost : $BOOST_VERSION]] ]
[ [On abnormal testing termination]
[threshold <= log_messages]
[`Test is aborted`] ]
[ [On test unit start]
[threshold <= log_test_units]
[`Entering test <test unit type> <test unit name>`] ]
[ [On test unit end]
[threshold <= log_test_units; testing time is reported only if elapsed time is more than 1 us.]
[`Leaving test <test unit type> <test unit name>; testing time <value>`] ]
[ [On skipped test unit]
[threshold <= log_test_units]
[`Test <test unit type> <test unit name> is skipped`] ]
[ [On uncaught C++ exception]
[threshold <= log_cpp_exception_errors. Checkpoint message is reported only if provided]
[`unknown location(0): fatal error in <test case name>: <explanation> <last checkpoint location>: last checkpoint: <checkpoint message>`] ]
[ [On resumable system error]
[threshold <= log_system_errors. Checkpoint message is reported only if provided]
[`unknown location(0): fatal error in <test case name>: <explanation> <last checkpoint location>: last checkpoint: <checkpoint message>`] ]
[ [On fatal system error]
[threshold <= log_fatal_errors. Checkpoint message is reported only if provided]
[`unknown location(0): fatal error in <test case name>: <explanation> <last checkpoint location>: last checkpoint: <checkpoint message>`] ]
[ [On passed test assertion]
[threshold <= log_successful_tests]
[`<assertion location>: info: check<assertion expression> passed`] ]
[ [On failed WARNING level test assertion]
[threshold <= log_warnings]
[`<assertion location>: warning in <test case name>: condition <assertion description> is not satisfied`]]
[ [On failed CHECK level test assertion]
[threshold <= log_all_errors]
[`<assertion location>: error in <test case name>: check <assertion description> failed`] ]
[ [On failed REQUIRE level test assertion]
[threshold <= log_fatal_errors]
[`<assertion location>: fatal error in <test case name>: critical check <assertion description> failed`]]
[ [On test log message]
[threshold <= log_messages]
[`<Message content>`]]
]
Advanced [link boost_test.testing_tools testing tools] may produce more detailed error messages.
[endsect] [/ human readable report]
[/ -------------------------------------------------------------------------------------------------- ]
[section:log_xml_format XML based log output format]
This log format is designed for automated test results processing. The test log output XML schema depends on the
active log level threshold.
[/TODO: Fix this section]
[endsect]
[endsect] [/section:log_xml_format ]