Reporter Class Referenceabstract

#include <Pt/Unit/Reporter.h>

Test event reporter More...

Inherits NonCopyable.

Inherited by BriefReporter.

Public Member Functions

virtual ~Reporter ()
 Destructor.
 
virtual void reportAssertion (const TestContext &test, const Assertion &a)=0
 Assertion notification. More...
 
virtual void reportError (const TestContext &test)=0
 Error notification. More...
 
virtual void reportException (const TestContext &test, const std::exception &ex)=0
 Exception notification. More...
 
virtual void reportFinish (const TestContext &test)=0
 Finished notification. More...
 
virtual void reportMessage (const std::string &msg)=0
 Message notification. More...
 
virtual void reportStart (const TestContext &test)=0
 Start notification. More...
 
virtual void reportSuccess (const TestContext &test)=0
 Success notification. More...
 

Protected Member Functions

 Reporter ()
 Constructs a reporter.
 

Detailed Description

This class is the base class for all reporters for test events. It lets the implementor override several virtual methods that are called on perticular events during the test. Reporters can be made to print information to the console or write XML logs.

Member Function Documentation

virtual void reportStart ( const TestContext test)
pure virtual

This method is called when a test has started. Every test sends this signal at startup.

Parameters
testThe started test
virtual void reportFinish ( const TestContext test)
pure virtual

This method is called when a test has finished. Every test sends this signal at its end no matter if it failed or succeeded.

Parameters
testThe finished test
virtual void reportMessage ( const std::string &  msg)
pure virtual

This method is called when a test has produced an informational message.

Parameters
msgThe message
virtual void reportSuccess ( const TestContext test)
pure virtual

This method is called when a test was successful.

Parameters
testThe succeeded test
virtual void reportAssertion ( const TestContext test,
const Assertion a 
)
pure virtual

This method is called when a an assertion failed during a test. an assertion fails when a user defined condition is not met.

Parameters
testThe failed test
aThe Assertion that failed
virtual void reportException ( const TestContext test,
const std::exception &  ex 
)
pure virtual

This method is called when a an exception failed during a test. An exception usually means that an error occured that was even u nexpected in a test scenario

Parameters
testThe failed test
exThe Assertion that failed
virtual void reportError ( const TestContext test)
pure virtual

This method is called when a an unknown error occurs during a test.

Parameters
testThe failed test