Stream-based Logger for events while running tests. More...

#include <Logger.h>

Inheritance diagram for JonTest::StreamLogger:

Collaboration diagram for JonTest::StreamLogger:

Public Member Functions
	StreamLogger (std::ostream &out, bool verbose)
	Construct the Stream Logger to write to out with the given verbosity.

virtual	~StreamLogger ()
	Destructor – does nothing.

virtual void	start ()
	Start of all testing.

virtual void	startSuite (const std::string &suiteName)
	Start of test suite.

virtual void	startCase (const std::string &suiteName, const std::string &caseName)
	Start of test case.

virtual void	errorCase (const std::string &suiteName, const std::string &caseName, const std::string &casePart, const std::string &message)
	Unexpected error occurred during a part of the test case.

virtual void	failCase (const std::string &suiteName, const std::string &caseName, const std::string &casePart, const TestFailure &failure)
	Test failure occurred during a part of the case.

virtual void	exceptionCase (const std::string &suiteName, const std::string &caseName, const std::string &casePart, const std::exception &unexpected)
	Unexpected exception occurred during a part of the case.

virtual void	endCase (const std::string &suiteName, const std::string &caseName, const bool pass)
	End of test case, with record pass or fail.

virtual void	endSuite (const std::string &suiteName, const Count &count)
	End of test suite, with count of tests run and failed for that suite alone.

virtual void	end (const Count &count)
	End of all testing, suitable to output.

Public Member Functions inherited from JonTest::Logger
virtual	~Logger ()
	Destructor – does nothing.

Protected Attributes
std::ostream &	out
	Stream to write to.

const bool	verbose
	Simple level of verbosity: true for all events, false for critical.

Detailed Description

Stream-based Logger for events while running tests.

Test cases are counted as:

count: Number of test cases that have finished
fails: Number of test cases that have failed
Note
These are defined by calls to endCase(), not by potententially multiple calls between setup(), the test case, and teardown().

Examples: SimpleTest.cpp, and TestCaseOrder.cpp.

Definition at line 88 of file Logger.h.

Constructor & Destructor Documentation

◆ StreamLogger()

JonTest::StreamLogger::StreamLogger	(	std::ostream &	out,
		bool	verbose
	)

Construct the Stream Logger to write to out with the given verbosity.

Parameters

out	Stream to write to
verbose	Simple level of verbosity: true for all events, false for critical

Definition at line 16 of file Logger.cpp.

◆ ~StreamLogger()

JonTest::StreamLogger::~StreamLogger ( )

virtual

Destructor – does nothing.

Definition at line 25 of file Logger.cpp.

Member Function Documentation

◆ end()

void JonTest::StreamLogger::end ( const Count & count )

virtual

End of all testing, suitable to output.

Parameters

count Count of Test Cases run, and Test Cases failed

Implements JonTest::Logger.

Definition at line 117 of file Logger.cpp.

◆ endCase()

void JonTest::StreamLogger::endCase	(	const std::string &	suiteName,
		const std::string &	caseName,
		const bool	pass
	)

virtual

End of test case, with record pass or fail.

Parameters

suiteName	Name of test suite
caseName	Name of test case
pass	true if passed, false if failed

Implements JonTest::Logger.

Definition at line 92 of file Logger.cpp.

◆ endSuite()

void JonTest::StreamLogger::endSuite	(	const std::string &	suiteName,
		const Count &	count
	)

virtual

End of test suite, with count of tests run and failed for that suite alone.

Parameters

suiteName	Name of test suite
count	Count of tests run and failed in this suite

Implements JonTest::Logger.

Definition at line 105 of file Logger.cpp.

◆ errorCase()

void JonTest::StreamLogger::errorCase	(	const std::string &	suiteName,
		const std::string &	caseName,
		const std::string &	casePart,
		const std::string &	message
	)

virtual

Unexpected error occurred during a part of the test case.

Parameters

suiteName	Name of test suite
caseName	Name of test case
casePart	Part of the test case: setup, case, or teardown
message	Error message

Implements JonTest::Logger.

Definition at line 59 of file Logger.cpp.

◆ exceptionCase()

void JonTest::StreamLogger::exceptionCase	(	const std::string &	suiteName,
		const std::string &	caseName,
		const std::string &	casePart,
		const std::exception &	unexpected
	)

virtual

Unexpected exception occurred during a part of the case.

Implements JonTest::Logger.

Definition at line 81 of file Logger.cpp.

◆ failCase()

void JonTest::StreamLogger::failCase	(	const std::string &	suiteName,
		const std::string &	caseName,
		const std::string &	casePart,
		const TestFailure &	failure
	)

virtual

Test failure occurred during a part of the case.

Parameters

suiteName	Name of test suite
caseName	Name of test case
casePart	Part of the test case: setup, case, or teardown
failure	TestFailure as recorded

Implements JonTest::Logger.

Definition at line 70 of file Logger.cpp.

◆ start()

void JonTest::StreamLogger::start ( )

virtual

Start of all testing.

Implements JonTest::Logger.

Definition at line 30 of file Logger.cpp.

◆ startCase()

void JonTest::StreamLogger::startCase	(	const std::string &	suiteName,
		const std::string &	caseName
	)

virtual

Start of test case.

Parameters

suiteName	Name of test suite
caseName	Name of test case

Implements JonTest::Logger.

Definition at line 48 of file Logger.cpp.

◆ startSuite()

void JonTest::StreamLogger::startSuite ( const std::string & suiteName )

virtual

Start of test suite.

Parameters

suiteName Name of test suite

Implements JonTest::Logger.

Definition at line 38 of file Logger.cpp.

Member Data Documentation

◆ out

std::ostream& JonTest::StreamLogger::out

protected

Stream to write to.

Definition at line 92 of file Logger.h.

◆ verbose

const bool JonTest::StreamLogger::verbose

protected

Simple level of verbosity: true for all events, false for critical.

Definition at line 95 of file Logger.h.

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

include/JonTest/Logger.h
src/Logger.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StreamLogger()

◆ ~StreamLogger()

Member Function Documentation

◆ end()

◆ endCase()

◆ endSuite()

◆ errorCase()

◆ exceptionCase()

◆ failCase()

◆ start()

◆ startCase()

◆ startSuite()

Member Data Documentation

◆ out

◆ verbose