tarch::tests::TreeTestCaseCollection Class Reference

#include <TreeTestCaseCollection.h>

Inheritance diagram for tarch::tests::TreeTestCaseCollection:

Collaboration diagram for tarch::tests::TreeTestCaseCollection:

Public Member Functions
	TreeTestCaseCollection (const std::string &testCaseCollectionName="", bool deleteTestCases=true, bool writeToLog=true)
	Creates a test case collection.
virtual	~TreeTestCaseCollection ()
	Destructor.
virtual void	run ()
	Runs all test cases assigned.
virtual void	run (const std::string &prefix)
	Runs all test cases assigned.
void	addTestCase (const std::string &fullQualifiedPath, TestCase *testCase)
	Adds a new test case.
void	addTestCase (TestCase *testCase)
	Same as above, but fully qualified test case name is extracted from passed object.
Public Member Functions inherited from tarch::tests::TestCase
	TestCase (const std::string &testCaseName)
	Constructor.
virtual	~TestCase ()
	Destructor.
int	getNumberOfErrors () const
std::string	getTestCaseName () const

Static Private Member Functions
static bool	isNameWithoutHierarchy (const std::string &testCaseName)
static std::string	getFirstIdentifierInHierarchy (const std::string &testCaseName)
static std::string	getRemainingPathWithoutIdentifier (const std::string &testCaseName)

Private Attributes
std::list< TestCase * >	_testCases
	Sequence of test cases that are executes on a run() call.
std::map< std::string, TreeTestCaseCollection * >	_subTests
bool	_writeToLog
	Tells the collection wheather to log a progression bar.
bool	_deleteTestCases
	Tells whether the testcases contained should be deleted uppon destruction of this object.

Static Private Attributes
static tarch::logging::Log	_log
	Log interface the class writes to.

Additional Inherited Members
Protected Member Functions inherited from tarch::tests::TestCase
	TestCase ()=delete
Protected Attributes inherited from tarch::tests::TestCase
const std::string	_testCaseName
	Name of the test case.
int	_errors
	Error counter.
bool	_error
	Indicate within macro if one specific validation failed.

Detailed Description

Author

Tobias Weinzierl

Wolfgang Eckhardt

Version

Revision

1.7

Definition at line 24 of file TreeTestCaseCollection.h.

Constructor & Destructor Documentation

TreeTestCaseCollection()

tarch::tests::TreeTestCaseCollection::TreeTestCaseCollection	(	const std::string &	testCaseCollectionName = "",
		bool	deleteTestCases = true,
		bool	writeToLog = true )

Creates a test case collection.

Parameters

testCaseCollectionName

Name of the test case collection. May not contain ::. If you pass in the empty string "", it is a mere container. It still runs all sub test cases, but it does not dump any progress info on this particular package: Usually you get a.b.c ... ok a.b ... ok a ... pass (no local tests) If a is "", then no message is written.

~TreeTestCaseCollection()

virtual tarch::tests::TreeTestCaseCollection::~TreeTestCaseCollection ( )

virtual

Destructor.

Member Function Documentation

addTestCase() [1/2]

void tarch::tests::TreeTestCaseCollection::addTestCase	(	const std::string &	fullQualifiedPath,
		TestCase *	testCase )

Adds a new test case.

Although you pass a pointer, you are still responsible for the instance management.

You have to specify in the constructor of a TestCaseCollection whether it should delete testcases contained on construction.

@Note: default is set to false (i.e. no destruction)

addTestCase() [2/2]

void tarch::tests::TreeTestCaseCollection::addTestCase

(

TestCase *

testCase

)

Same as above, but fully qualified test case name is extracted from passed object.

getFirstIdentifierInHierarchy()

static std::string tarch::tests::TreeTestCaseCollection::getFirstIdentifierInHierarchy ( const std::string & testCaseName )

staticprivate

getRemainingPathWithoutIdentifier()

static std::string tarch::tests::TreeTestCaseCollection::getRemainingPathWithoutIdentifier ( const std::string & testCaseName )

staticprivate

isNameWithoutHierarchy()

static bool tarch::tests::TreeTestCaseCollection::isNameWithoutHierarchy ( const std::string & testCaseName )

staticprivate

run() [1/2]

virtual void tarch::tests::TreeTestCaseCollection::run ( )

virtual

Runs all test cases assigned.

Implements tarch::tests::TestCase.

run() [2/2]

virtual void tarch::tests::TreeTestCaseCollection::run ( const std::string & prefix )

virtual

Runs all test cases assigned.

Field Documentation

_deleteTestCases

bool tarch::tests::TreeTestCaseCollection::_deleteTestCases

private

Tells whether the testcases contained should be deleted uppon destruction of this object.

Definition at line 46 of file TreeTestCaseCollection.h.

_log

tarch::logging::Log tarch::tests::TreeTestCaseCollection::_log

staticprivate

Log interface the class writes to.

Definition at line 41 of file TreeTestCaseCollection.h.

_subTests

std::map<std::string, TreeTestCaseCollection*> tarch::tests::TreeTestCaseCollection::_subTests

private

Definition at line 31 of file TreeTestCaseCollection.h.

_testCases

std::list<TestCase*> tarch::tests::TreeTestCaseCollection::_testCases

private

Sequence of test cases that are executes on a run() call.

The class is not responsible for destroying them.

Definition at line 30 of file TreeTestCaseCollection.h.

_writeToLog

bool tarch::tests::TreeTestCaseCollection::_writeToLog

private

Tells the collection wheather to log a progression bar.

Definition at line 36 of file TreeTestCaseCollection.h.

---

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

• src/tarch/tests/TreeTestCaseCollection.h