robottestingframework::TestListener Class Reference

The base class of any test result listeners. More...

#include <robottestingframework/TestListener.h>

Inheritance diagram for robottestingframework::TestListener:

Public Member Functions
	TestListener ()=default
	TestListener constructor. More...
virtual	~TestListener ()=default
	TestListener destructor. More...
virtual void	addReport (const Test *test, TestMessage msg)
	This is called to report any arbitrary message from tests. More...
virtual void	addError (const Test *test, TestMessage msg)
	This is called when an error occurred during test run. More...
virtual void	addFailure (const Test *test, TestMessage msg)
	This is called when a failure occurred during test run. More...
virtual void	startTest (const Test *test)
	This is called when a Test is started. More...
virtual void	endTest (const Test *test)
	This is called when a Test is finished. More...
virtual void	startTestSuite (const Test *test)
	This is called when a TestSuite is started. More...
virtual void	endTestSuite (const Test *test)
	This is called when a TestSuite is finished. More...
virtual void	startTestRunner ()
	This is called when the TestRunner is started. More...
virtual void	endTestRunner ()
	This is called when the TestRunner is finished. More...

Detailed Description

The base class of any test result listeners.

Definition at line 33 of file TestListener.h.

Constructor & Destructor Documentation

TestListener()

robottestingframework::TestListener::TestListener ( )

default

TestListener constructor.

~TestListener()

virtual robottestingframework::TestListener::~TestListener ( )

virtualdefault

TestListener destructor.

Member Function Documentation

addError()

virtual void robottestingframework::TestListener::addError ( const Test *  test, TestMessage  msg  )

inlinevirtual

This is called when an error occurred during test run.

Parameters

test	pointer to the corresponding test
msg	correspoinding error message

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 61 of file TestListener.h.

addFailure()

virtual void robottestingframework::TestListener::addFailure ( const Test *  test, TestMessage  msg  )

inlinevirtual

This is called when a failure occurred during test run.

Parameters

test	pointer to the corresponding test
msg	correspoinding failure message

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 70 of file TestListener.h.

addReport()

virtual void robottestingframework::TestListener::addReport ( const Test *  test, TestMessage  msg  )

inlinevirtual

This is called to report any arbitrary message from tests.

Parameters

test	pointer to the corresponding test
msg	correspoinding error message

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 52 of file TestListener.h.

endTest()

virtual void robottestingframework::TestListener::endTest ( const Test *  test )

inlinevirtual

This is called when a Test is finished.

Parameters

test	pointer to the corresponding test

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 86 of file TestListener.h.

endTestRunner()

virtual void robottestingframework::TestListener::endTestRunner ( )

inlinevirtual

This is called when the TestRunner is finished.

Reimplemented in robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 116 of file TestListener.h.

endTestSuite()

virtual void robottestingframework::TestListener::endTestSuite ( const Test *  test )

inlinevirtual

This is called when a TestSuite is finished.

Parameters

test	pointer to the corresponding test

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 102 of file TestListener.h.

startTest()

virtual void robottestingframework::TestListener::startTest ( const Test *  test )

inlinevirtual

This is called when a Test is started.

Parameters

test	pointer to the corresponding test

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 78 of file TestListener.h.

startTestRunner()

virtual void robottestingframework::TestListener::startTestRunner ( )

inlinevirtual

This is called when the TestRunner is started.

Reimplemented in robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 109 of file TestListener.h.

startTestSuite()

virtual void robottestingframework::TestListener::startTestSuite ( const Test *  test )

inlinevirtual

This is called when a TestSuite is started.

Parameters

test	pointer to the corresponding test

Reimplemented in robottestingframework::TestResultCollector, robottestingframework::ConsoleListener, and robottestingframework::WebProgressListener.

Definition at line 94 of file TestListener.h.

---

The documentation for this class was generated from the following file:

• src/robottestingframework/include/robottestingframework/TestListener.h