Test Class Reference

#include <Pt/Unit/Test.h>

Test base class More...

Inherits NonCopyable.

Inherited by Application [private], TestCase, and .

Public Member Functions
virtual	~Test ()
	Destructor.
virtual void	run ()=0
	Runs the test.
const std::string &	name () const
	Returns the name of the test.
void	reportStart (const TestContext &ctx)
	Reports the start of a test.
void	reportFinish (const TestContext &ctx)
	Finished notification.
void	reportSuccess (const TestContext &ctx)
	Success notification.
void	reportAssertion (const TestContext &ctx, const Assertion &ass)
	Assertion notification.
void	reportException (const TestContext &ctx, const std::exception &ex)
	Exception notification.
void	reportError (const TestContext &ctx)
	Error notification.
void	reportMessage (const std::string &msg)
	Message notification.
void	setParent (Test *test)
	Sets the parent test.
Test *	parent ()
	Returns the parent test.
const Test *	parent () const
	Returns the parent test.
void	attachReporter (Reporter &r)
	Add reporter for test events.
void	detachReporter (Reporter &r)
	Removes a reporter.

Protected Member Functions
	Test (const std::string &name)
	Construct a test by name.

Detailed Description

This is the base class for all types of tests that can be registered and run in a test application. It provides a virtual method run that is overriden by the derived classes and signals to inform about events that occur while the test is run.

Constructor & Destructor Documentation

Test()

Test ( const std::string & name )

explicitprotected

Parameters

name	Name of the test

Member Function Documentation

run()

virtual void run ( )

pure virtual

Derived test classes are supposed to implement this method to run the test procedure. A derived class should send the 'started' signal at the begin of the test and send the 'finished' signal at the end of the test. If the test was successful, the 'success' signal is sent, otheriwse one of the signals indicating a failrue. In case of a failed assertion, the signal 'assertion' is sent, if a regular std::exception was the cause of the error the signal 'exception' is sent and and the signal 'error' indicates an unknown exception or error. This method should not propagate any exceptions

Implemented in Application, TestCase, and TestSuite.

reportFinish()

template<class C>

void reportFinish ( const TestContext & ctx )

inherited

This signal is sent when the test finished. It does not indicate that the test was successful.

reportSuccess()

template<class C>

void reportSuccess ( const TestContext & ctx )

inherited

This signal is sent when the test was successful.

reportAssertion()

template<class C>

void reportAssertion ( const TestContext & ctx, const Assertion & ass )

inherited

This signal is sent when a assertion failed.

reportException()

template<class C>

void reportException ( const TestContext & ctx, const std::exception & ex )

inherited

This signal is sent when a regular std::exception occured.

reportError()

template<class C>

void reportError ( const TestContext & ctx )

inherited

This signal is sent when an unknown error occured.

reportMessage()

template<class C>

void reportMessage ( const std::string & msg )

inherited

This signal can be sent to report informational messages.