Class unit_test_log_formatter

boost::unit_test::unit_test_log_formatter — Abstract Unit Test Framework log formatter interface.

Synopsis

// In header: <boost/test/unit_test_log_formatter.hpp>


class unit_test_log_formatter {
public:

  // Types of log entries (messages written into a log) 
  enum log_entry_types { BOOST_UTL_ET_INFO, BOOST_UTL_ET_MESSAGE, 
                         BOOST_UTL_ET_WARNING, BOOST_UTL_ET_ERROR, 
                         BOOST_UTL_ET_FATAL_ERROR };
  // construct/copy/destruct
  ~unit_test_log_formatter();

  // public member functions
  virtual void log_start(std::ostream &, counter_t) = 0;
  virtual void log_finish(std::ostream &) = 0;
  virtual void log_build_info(std::ostream &) = 0;
  virtual void test_unit_start(std::ostream &, test_unit const &) = 0;
  virtual void 
  test_unit_finish(std::ostream &, test_unit const &, unsigned long) = 0;
  virtual void 
  test_unit_skipped(std::ostream &, test_unit const &, const_string);
  virtual void test_unit_skipped(std::ostream &, test_unit const &);
  virtual void 
  log_exception_start(std::ostream &, log_checkpoint_data const &, 
                      execution_exception const &) = 0;
  virtual void log_exception_finish(std::ostream &) = 0;
  virtual void 
  log_entry_start(std::ostream &, log_entry_data const &, log_entry_types) = 0;
  virtual void log_entry_value(std::ostream &, const_string) = 0;
  virtual void log_entry_value(std::ostream &, lazy_ostream const &);
  virtual void log_entry_finish(std::ostream &) = 0;
  virtual void entry_context_start(std::ostream &, log_level) = 0;
  virtual void log_entry_context(std::ostream &, const_string) = 0;
  virtual void entry_context_finish(std::ostream &) = 0;
};

Description

During the test module execution Unit Test Framework can report messages about success or failure of assertions, which test suites are being run and more (specifically which messages are reported depends on log level threshold selected by the user). All these messages constitute Unit Test Framework log. There are many ways (formats) to present these messages to the user. Boost.Test comes with two formats: "Compiler-like log format" and "XML based log format". Former is intended for human consumption and later is intended for processing by automated regression test systems. If you want to produce some other format you need to implement class with specific interface and use method unit_test_log_t::set_formatter during a test module initialization to set an active formatter. The class unit_test_log_formatter defines this interface.

This interface requires you to format all possible messages being produced in the log. These includes error messages about failed assertions, messages about caught exceptions and information messages about test units being started/ended. All the methods in this interface takes a reference to standard stream as a first argument. This is where final messages needs to be directed to. Also you are given all the information necessary to produce a message.

`unit_test_log_formatter` public construct/copy/destruct

```
~unit_test_log_formatter();
```

`unit_test_log_formatter` public member functions

```
virtual void log_start(std::ostream & os, counter_t test_cases_amount) = 0;
```
Invoked at the beginning of test module execution.

See Also:

log_finish

Parameters:

os

output stream to write a messages to

test_cases_amount

total test case amount to be run
```
virtual void log_finish(std::ostream & os) = 0;
```
Invoked at the end of test module execution.

See Also:

log_start

Parameters:

os

output stream to write a messages into
```
virtual void log_build_info(std::ostream & os) = 0;
```
Invoked when Unit Test Framework build information is requested.

Parameters:

os

output stream to write a messages into
```
virtual void test_unit_start(std::ostream & os, test_unit const & tu) = 0;
```
Invoked when test unit starts (either test suite or test case)

See Also:

test_unit_finish

Parameters:

os

output stream to write a messages into

tu

test unit being started
```
virtual void 
test_unit_finish(std::ostream & os, test_unit const & tu, 
                 unsigned long elapsed) = 0;
```
Invoked when test unit finishes.

See Also:

test_unit_start

Parameters:

elapsed

time in milliseconds spend executing this test unit

os

output stream to write a messages into

tu

test unit being finished
```
virtual void 
test_unit_skipped(std::ostream & os, test_unit const & tu, 
                  const_string reason);
```
Invoked if test unit skipped for any reason.

Parameters:

os

output stream to write a messages into

reason

explanation why was it skipped

tu

skipped test unit

virtual void test_unit_skipped(std::ostream & os, test_unit const & tu);

Deprecated version of this interface.

```
virtual void 
log_exception_start(std::ostream & os, log_checkpoint_data const & lcd, 
                    execution_exception const & ex) = 0;
```
Invoked when Unit Test Framework detects uncaught exception.
Call to this function starts uncaught exception report. It is going to followed by context information. Report is finalized by call to log_exception_finish.

See Also:

log_exception_finish

Parameters:

ex

information about the caught exception

lcd

information about the last checkpoint before the exception was triggered

os

output stream to write a messages into
```
virtual void log_exception_finish(std::ostream & os) = 0;
```
Invoked when Unit Test Framework detects uncaught exception.
Call to this function finishes uncaught exception report.

See Also:

log_exception_start

Parameters:

os

output stream to write a messages into
```
virtual void 
log_entry_start(std::ostream & os, log_entry_data const & led, 
                log_entry_types let) = 0;
```
Invoked by Unit Test Framework to start new log entry.
Call to this function starts new log entry. It is followed by series of log_entry_value calls and finally call to log_entry_finish. A log entry may consist of one or more values being reported. Some of these values will be plain strings, while others can be complicated expressions in a form of "lazy" expression template lazy_ostream.

See Also:

log_entry_value, log_entry_finish

Parameters:

led

log entry attributes

let

log entry type log_entry_finish

os

output stream to write a messages into
```
virtual void log_entry_value(std::ostream & os, const_string value) = 0;
```
Invoked by Unit Test Framework to report a log entry content.
This is one of two overloaded methods to report log entry content. This one is used to report plain string value.

See Also:

log_entry_start, log_entry_finish

Parameters:

os

output stream to write a messages into.

value

log entry string value
```
virtual void log_entry_value(std::ostream & os, lazy_ostream const & value);
```
Invoked by Unit Test Framework to report a log entry content.
This is one of two overloaded methods to report log entry content. This one is used to report some complicated expression passed as an expression template lazy_ostream. In most cases default implementation provided by the framework should work as is (it just converts the lazy expression into a string.

See Also:

log_entry_start, log_entry_finish

Parameters:

os

output stream to write a messages into

value

log entry "lazy" value
```
virtual void log_entry_finish(std::ostream & os) = 0;
```
Invoked by Unit Test Framework to finish a log entry report.

See Also:

log_entry_start, log_entry_start

Parameters:

os

output stream to write a messages into
```
virtual void entry_context_start(std::ostream & os, log_level l) = 0;
```
Invoked by Unit Test Framework to start log entry context report.
Unit Test Framework logs for failed assertions and uncaught exceptions context if one was defined by a test module. Context consists of multiple "scopes" identified by description messages assigned by the test module using BOOST_TEST_INFO/BOOST_TEST_CONTEXT statements.

See Also:

log_entry_context, entry_context_finish

Parameters:

l

entry log_leveg, to be used to fine tune the message

os

output stream to write a messages into
```
virtual void log_entry_context(std::ostream & os, const_string value) = 0;
```
Invoked by Unit Test Framework to report log entry context "scope" description.
Each "scope" description is reported by separate call to log_entry_context.

See Also:

log_entry_start, entry_context_finish

Parameters:

os

output stream to write a messages into

value

context "scope" description
```
virtual void entry_context_finish(std::ostream & os) = 0;
```
Invoked by Unit Test Framework to finish log entry context report.

See Also:

log_entry_start, entry_context_context

Parameters:

os

output stream to write a messages into

Boost C++ Libraries