A test runner that stores the results. More...

#include <recorder.h>

Inheritance diagram for beast::unit_test::recorder:

Collaboration diagram for beast::unit_test::recorder:

[legend]

Public Member Functions
	recorder ()=default

results const &	report () const
	Returns a report with the results of all completed suites.

void	arg (std::string const &s)
	Set the argument string.

std::string const &	arg () const
	Returns the argument string.

template<class = void>
bool	run (suite_info const &s)
	Run the specified suite.

template<class FwdIter >
bool	run (FwdIter first, FwdIter last)
	Run a sequence of suites.

template<class FwdIter , class Pred >
bool	run_if (FwdIter first, FwdIter last, Pred pred=Pred{})
	Conditionally run a sequence of suites.

template<class SequenceContainer >
bool	run_each (SequenceContainer const &c)
	Run all suites in a container.

template<class SequenceContainer , class Pred >
bool	run_each_if (SequenceContainer const &c, Pred pred=Pred{})
	Conditionally run suites in a container.

Private Member Functions
virtual void	on_suite_begin (suite_info const &info) override
	Called when a new suite starts.

virtual void	on_suite_end () override
	Called when a suite ends.

virtual void	on_case_begin (std::string const &name) override
	Called when a new case starts.

virtual void	on_case_end () override
	Called when a new case ends.

virtual void	on_pass () override
	Called for each passing condition.

virtual void	on_fail (std::string const &reason) override
	Called for each failing condition.

virtual void	on_log (std::string const &s) override
	Called when a test logs output.

template<class = void>
void	testcase (std::string const &name)

template<class = void>
void	pass ()

template<class = void>
void	fail (std::string const &reason)

template<class = void>
void	log (std::string const &s)

Private Attributes
results	m_results

suite_results	m_suite

case_results	m_case

std::string	arg_

bool	default_ = false

bool	failed_ = false

bool	cond_ = false

std::recursive_mutex	mutex_

Detailed Description

A test runner that stores the results.

Definition at line 15 of file recorder.h.

Constructor & Destructor Documentation

◆ recorder()

beast::unit_test::recorder::recorder ( )

default

Member Function Documentation

◆ report()

results const & beast::unit_test::recorder::report ( ) const

Returns a report with the results of all completed suites.

Definition at line 27 of file recorder.h.

◆ on_suite_begin()

virtual void beast::unit_test::recorder::on_suite_begin ( suite_info const & )

overrideprivatevirtual

Called when a new suite starts.

Reimplemented from beast::unit_test::runner.

Definition at line 34 of file recorder.h.

◆ on_suite_end()

virtual void beast::unit_test::recorder::on_suite_end ( )

overrideprivatevirtual

Called when a suite ends.

Reimplemented from beast::unit_test::runner.

Definition at line 40 of file recorder.h.

◆ on_case_begin()

virtual void beast::unit_test::recorder::on_case_begin ( std::string const & )

overrideprivatevirtual

Called when a new case starts.

Reimplemented from beast::unit_test::runner.

Definition at line 46 of file recorder.h.

◆ on_case_end()

virtual void beast::unit_test::recorder::on_case_end ( )

overrideprivatevirtual

Called when a new case ends.

Reimplemented from beast::unit_test::runner.

Definition at line 52 of file recorder.h.

◆ on_pass()

virtual void beast::unit_test::recorder::on_pass ( )

overrideprivatevirtual

Called for each passing condition.

Reimplemented from beast::unit_test::runner.

Definition at line 59 of file recorder.h.

◆ on_fail()

virtual void beast::unit_test::recorder::on_fail ( std::string const & )

overrideprivatevirtual

Called for each failing condition.

Reimplemented from beast::unit_test::runner.

Definition at line 65 of file recorder.h.

◆ on_log()

virtual void beast::unit_test::recorder::on_log ( std::string const & )

overrideprivatevirtual

Called when a test logs output.

Reimplemented from beast::unit_test::runner.

Definition at line 71 of file recorder.h.

◆ arg() [1/2]

void beast::unit_test::runner::arg ( std::string const & s )

inherited

Set the argument string.

The argument string is available to suites and allows for customization of the test. Each suite defines its own syntax for the argumnet string. The same argument is passed to all suites.

Definition at line 46 of file runner.h.

◆ arg() [2/2]

std::string const & beast::unit_test::runner::arg ( ) const

inherited

Returns the argument string.

Definition at line 53 of file runner.h.

◆ run() [1/2]

template<class >

bool beast::unit_test::runner::run ( suite_info const & s )

inherited

Run the specified suite.

Returns: true if any conditions failed.

Definition at line 172 of file runner.h.

◆ run() [2/2]

template<class FwdIter >

bool beast::unit_test::runner::run	(	FwdIter	first,
		FwdIter	last
	)

inherited

Run a sequence of suites.

The expression FwdIter::value_type must be convertible to suite_info.

Returns: true if any conditions failed.

Definition at line 188 of file runner.h.

◆ run_if()

template<class FwdIter , class Pred >

bool beast::unit_test::runner::run_if	(	FwdIter	first,
		FwdIter	last,
		Pred	pred = `Pred{}`
	)

inherited

Conditionally run a sequence of suites.

pred will be called as:

bool pred(suite_info const&);

beast::unit_test::suite_info

Associates a unit test type with metadata.

Definition suite_info.h:20

Returns: true if any conditions failed.

Definition at line 198 of file runner.h.

◆ run_each()

template<class SequenceContainer >

bool beast::unit_test::runner::run_each ( SequenceContainer const & c )

inherited

Run all suites in a container.

Returns: true if any conditions failed.

Definition at line 209 of file runner.h.

◆ run_each_if()

template<class SequenceContainer , class Pred >

bool beast::unit_test::runner::run_each_if	(	SequenceContainer const &	c,
		Pred	pred = `Pred{}`
	)

inherited

Conditionally run suites in a container.

pred will be called as:

bool pred(suite_info const&);

Returns: true if any conditions failed.

Definition at line 219 of file runner.h.

◆ testcase()

template<class >

void beast::unit_test::runner::testcase ( std::string const & name )

privateinherited

Definition at line 230 of file runner.h.

◆ pass()

template<class >

void beast::unit_test::runner::pass ( )

privateinherited

Definition at line 246 of file runner.h.

◆ fail()

template<class >

void beast::unit_test::runner::fail ( std::string const & reason )

privateinherited

Definition at line 257 of file runner.h.

◆ log()

template<class >

void beast::unit_test::runner::log ( std::string const & s )

privateinherited

Definition at line 269 of file runner.h.

Member Data Documentation

◆ m_results

results beast::unit_test::recorder::m_results

private

Definition at line 18 of file recorder.h.

◆ m_suite

suite_results beast::unit_test::recorder::m_suite

private

Definition at line 19 of file recorder.h.

◆ m_case

case_results beast::unit_test::recorder::m_case

private

Definition at line 20 of file recorder.h.

◆ arg_

std::string beast::unit_test::runner::arg_

privateinherited

Definition at line 25 of file runner.h.

◆ default_

bool beast::unit_test::runner::default_ = false

privateinherited

Definition at line 26 of file runner.h.

◆ failed_

bool beast::unit_test::runner::failed_ = false

privateinherited

Definition at line 27 of file runner.h.

◆ cond_

bool beast::unit_test::runner::cond_ = false

privateinherited

Definition at line 28 of file runner.h.

◆ mutex_

std::recursive_mutex beast::unit_test::runner::mutex_

privateinherited

Definition at line 29 of file runner.h.

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ recorder()

Member Function Documentation

◆ report()

◆ on_suite_begin()

◆ on_suite_end()

◆ on_case_begin()

◆ on_case_end()

◆ on_pass()

◆ on_fail()

◆ on_log()

◆ arg() [1/2]

◆ arg() [2/2]

◆ run() [1/2]

◆ run() [2/2]

◆ run_if()

◆ run_each()

◆ run_each_if()

◆ testcase()

◆ pass()

◆ fail()

◆ log()

Member Data Documentation

◆ m_results

◆ m_suite

◆ m_case

◆ arg_

◆ default_

◆ failed_

◆ cond_

◆ mutex_