utst::TestLog Class Reference

This class wraps an output stream and provides an interface for tests to write results. Usually a user does not need to access this class directly but instead uses the macros provided with utst::TestCase. The log level sets how verbose the test output is.

Acceptable log level values are listed below:

errors : Only output errors
minimal : Output errors as well as a list of test case names
moderate : Output errors, test case names, and note/log stream output
verbose : Output everything

List of all members.

Public Methods

~TestLog ()
setLogLevel (const TestLog::LogLevel::type &logLevel)
getLogLevel () const
setLogStream (std::ostream &os)
beginTestSuite (const std::string &testSuiteName)
endTestSuite ()
beginTestCase (const std::string &testCaseName)
endTestCase ()
logTestResult (bool result, const std::string &fileNameStr, int lineNum)
getMsgStream ()

Static Public Methods

instance ()
msgStream ()

Detailed Documentation

Constructor & Destructor Documentation

utst::TestLog::~TestLog

(

)

Basic destructor

Member Function Documentation

TestLog& utst::TestLog::instance ( ) [static]

std::ostream& utst::TestLog::msgStream ( ) [static]

Return a stream to which a user can write messages or other optional information which might help track down why a test is failing.

void utst::TestLog::setLogLevel

(

const TestLog::LogLevel::type &

logLevel

)

Set the current log level for the test log

TestLog::LogLevel::type utst::TestLog::getLogLevel

(

)

const

Get the current log level for the test log

void utst::TestLog::setLogStream

(

std::ostream &

)

Set the current log output stream. The test log saves a pointer to this stream so the caller is responsible for keeping the output stream around for the lifetime of the program.

void utst::TestLog::beginTestSuite

(

const std::string &

testSuiteName

)

Output log info to denote begining of test suite

void utst::TestLog::endTestSuite

(

)

Output log info to denote end of test suite

void utst::TestLog::beginTestCase

(

const std::string &

testCaseName

)

Output log info to denote begining of test case

void utst::TestLog::endTestCase

(

)

Output log info to denote end of test case

std::ostream& utst::TestLog::logTestResult	(	bool	result,
		const std::string &	fileNameStr,
		int	lineNum
	)

Returns a log output stream for test results. The boolean result argument should be whether or not the test passed and the filename/linenum information should indicate where the test was located.

std::ostream& utst::TestLog::getMsgStream

(

)

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

utstTestLog.h

C++ Extensions (cppx) Documentation	Internal Version
Main \| Namespaces \| Classes \| NamespaceMembers \| ClassMembers \| Files