Class progress_monitor_t

boost::unit_test::progress_monitor_t — This class implements test observer interface and updates test progress as test units finish or get aborted.

Synopsis

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


class progress_monitor_t : public boost::unit_test::test_observer {
public:

  // Test observer interface
  virtual void test_start(counter_t, test_unit_id);
  virtual void test_aborted();
  virtual void test_unit_finish(test_unit const &, unsigned long);
  virtual void test_unit_skipped(test_unit const &, const_string);
  virtual int priority();

  // Configuration
  void set_stream(std::ostream &);

  // public member functions
  virtual void test_finish();
  virtual void test_unit_start(test_unit const &);
  virtual void test_unit_skipped(test_unit const &);
  virtual void test_unit_timed_out(test_unit const &);
  virtual void test_unit_aborted(test_unit const &);
  virtual void assertion_result(unit_test::assertion_result);
  virtual void exception_caught(execution_exception const &);
};

Description

`progress_monitor_t` Test observer interface

```
virtual void test_start(counter_t, test_unit_id);
```
Called before the framework starts executing the test cases.
```
virtual void test_aborted();
```
Called when a critical error is detected.
The critical errors are mainly the signals sent by the system and caught by the Boost.Test framework. Since the running binary may be in incoherent/instable state, the test execution is aborted and all remaining tests are discarded.

Note

may be called before test_observer::test_unit_finish()

	Note
may be called before test_observer::test_unit_finish()

virtual void test_unit_finish(test_unit const &, unsigned long);

Called at each end of a test unit.

virtual void test_unit_skipped(test_unit const &, const_string);

```
virtual int priority();
```
The priority indicates the order at which this observer is initialized and tore down in the UTF framework. The order is lowest to highest priority.

`progress_monitor_t` Configuration

```
void set_stream(std::ostream &);
```

`progress_monitor_t` public member functions

```
virtual void test_finish();
```
Called after the framework ends executing the test cases.

Note

The call is made with a reversed priority order.
```
virtual void test_unit_start(test_unit const &);
```
Called before the framework starts executing a test unit.

	Note
The call is made with a reversed priority order.

virtual void test_unit_skipped(test_unit const &);

backward compatibility

```
virtual void test_unit_timed_out(test_unit const &);
```
Called when the test timed out.
This function is called to signal that a test unit (case or suite) timed out. A valid test unit is available through boost::unit_test::framework::current_test_unit
```
virtual void test_unit_aborted(test_unit const &);
```
Called when a test unit indicates a fatal error.
A fatal error happens when
- a strong assertion (with REQUIRE) fails, which indicates that the test case cannot continue
- an unexpected exception is caught by the Boost.Test framework

virtual void assertion_result(unit_test::assertion_result);

```
virtual void exception_caught(execution_exception const &);
```
Called when an exception is intercepted.
In case an exception is intercepted, this call happens before the call to test_unit_aborted in order to log additional data about the exception.

Boost C++ Libraries

Class progress_monitor_t

Synopsis

Description

progress_monitor_t Test observer interface

progress_monitor_t Configuration

progress_monitor_t public member functions

`progress_monitor_t` Test observer interface

`progress_monitor_t` Configuration

`progress_monitor_t` public member functions