runnable_base Class

Non-template base for all runnable objects (suites and test cases). More...

Declaration

class micro_os_plus::micro_test_plus::detail::runnable_base { ... }

Included Headers

#include "micro-os-plus/micro-test-plus.h"

Derived Classes

class	suite
	A named, runnable test suite registered with the test runner. More...
class	test_case
	A named, runnable test case that lives inside a suite. More...

Friends Index

class	check_result
	The check result, which numbers and counts the checks. More...
class	micro_test_plus::runner
	The runner, which numbers and runs the suites. More...
class	reporter_human
	The human-readable reporter, which displays the nodes. More...
class	reporter_tap
	The TAP reporter, which displays the nodes. More...

Public Constructors Index

	runnable_base (const char *name, runner &test_runner, size_t own_index)
	Constructs a runnable_base with a name, runner, and index. More...
	runnable_base (const runnable_base &)=delete
	Deleted copy constructor to prevent copying. More...
	runnable_base (runnable_base &&)=delete
	Deleted move constructor to prevent moving. More...

Public Destructor Index

	~runnable_base ()
	Virtual destructor. More...

Public Operators Index

runnable_base &	operator= (const runnable_base &)=delete
	Deleted copy assignment operator to prevent copying. More...
runnable_base &	operator= (runnable_base &&)=delete
	Deleted move assignment operator to prevent moving. More...

Public Member Functions Index

const char *	name (void) const noexcept
	Returns the node name. More...
const counters &	totals (void) const noexcept
	Returns the totals of the node. More...

Protected Member Functions Index

bool	accepts_test_case (const suite &target, const located_name &name)
	Checks whether a test case can be created on a suite. More...
void	after_test_case_create (class test_case &test_case, suite &suite)
	Counts a newly constructed child test case and executes it immediately. More...
template <typename Callable_T, typename... Args_T>
void	create_test_case (const located_name &name, suite &parent_suite, size_t nesting_depth, Callable_T &&callable, Args_T &&... arguments)
	Creates a child test case, and runs it. More...
suite *	exchange_running_suite (suite *running) noexcept
	Replaces the suite whose body is running in the owning runner, and returns the previous one. More...
bool	has_running_test_case_of (const suite &target) const noexcept
	Checks whether the innermost running test case belongs to a suite. More...
bool	is_aborted (void) const noexcept
	Checks whether the test execution was aborted by the owning runner. More...
bool	is_listing (void) const noexcept
	Checks whether the owning runner lists the test cases instead of running them. More...
size_t	next_test_point_number (void) noexcept
	Advances to the next child test point, and returns its number. More...
void	reject_body_exception (void)
	Reports the exception that escaped the body of a suite while the test cases are listed, and records it. More...
class test_case *	running_test_case (void) const noexcept
	Returns the innermost test case being run by the owning runner, if any. More...
class reporter &	test_reporter (void) const noexcept
	Returns the test reporter associated with this test runnable. More...
runner &	test_runner (void) const noexcept
	Returns the test runner that owns this test runnable. More...

Private Member Functions Index

void	abort (const reflection::source_location &sl=reflection::source_location::current()) const
	Aborts test execution via the owning runner, for a failed requirement. More...
void	run (void)=0
	Runs the body of the test case or suite. More...

Protected Member Attributes Index

size_t	child_test_cases_count_ = 0
	The number of direct child test cases. More...
const char *	name_
	The node name. More...
size_t	own_index_
	The test index, counting from 1. More...
runner &	runner_
	Reference to the test runner that owns this object. More...
size_t	test_point_number_ = 0
	The number of the most recent child test point. More...
counters	totals_
	Totals for the node. More...

Deprecated Functions of runnable_base Index

size_t	own_index (void) const noexcept
	Deprecated positional index of this node within its parent. More...
size_t	current_subtest_index (void) const noexcept
	Deprecated number of the most recent child test point. More...
size_t	children_subtests_count (void) const noexcept
	Deprecated number of direct child test cases of this node. More...

Description

Non-template base for all runnable objects (suites and test cases).

runnable_base is the single base of the nodes of the test tree, and holds the state that is shared by every runnable object:

• the node name,
• the counters of the passed and failed checks, and of the test cases,
• a reference to the owning runner,
• the object's own index within its parent,
• the number of the most recent test point (check or nested test case), used in the TAP output, and
• the number of the direct child test cases, used in the TAP plan; the child test cases themselves are not kept.

The concrete runnable classes (suite, test_case) derive from runnable_base; each refers to its body, which receives a reference to its own class, and implements run(), which invokes the body between the reporter notifications. A suite, which runs later, stores its body in a std::function; a test case, which runs immediately, refers to a body kept by its creator.

The user code can read only the name and the totals; the rest of the state, and the functions that run and abort the nodes, are the protocol between the nodes, the runner, the check result, and the reporters, which are friends. The runner numbers and runs the suites, the check result numbers and counts the checks, and the reporters read the indices and the test point numbers.

The class is non-copyable and non-movable to preserve unique ownership and consistent state throughout the test session.

Definition at line 348 of file test.h.

Friends

check_result

friend class check_result

The check result, which numbers and counts the checks.

It advances the test point number, updates the totals, and reports the check through the reporter of the node.

Definition at line 366 of file test.h.

366 friend class check_result;

Reference check_result.

Referenced by check_result.

micro_test_plus::runner

friend class micro_test_plus::runner

The runner, which numbers and runs the suites.

It sets the indices of the suites before running them, and selects the suites that refer to it.

Definition at line 357 of file test.h.

357 friend class micro_test_plus::runner;

Referenced by runnable_base, reporter_tap and run.

reporter_human

friend class reporter_human

The human-readable reporter, which displays the nodes.

It currently uses only the public members of the nodes; the declaration is kept for symmetry with the TAP reporter.

Definition at line 375 of file test.h.

375 friend class reporter_human;

Reference reporter_human.

Referenced by reporter_human.

reporter_tap

friend class reporter_tap

The TAP reporter, which displays the nodes.

It reads the indices and the test point numbers, for the TAP lines and plans, and, when tracing, the numbers of the child test cases.

Definition at line 385 of file test.h.

385 friend class reporter_tap;

References micro_test_plus::runner, name, own_index, reporter_tap and test_runner.

Referenced by reporter_tap.

Public Constructors

runnable_base()

micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base (const char * name, runner & test_runner, size_t own_index)

Constructs a runnable_base with a name, runner, and index.

Parameters

name	The name used in reports.
test_runner	The test runner managing this object.
own_index	The positional index of this object within its parent.

The constructor initialises a new instance of the runnable_base class with the specified name, runner reference, and own index; the name pointer is stored, and is expected to point to a string with a lifetime exceeding that of this instance. The totals, the child test point index, and the child test cases count start at zero. If tracing is enabled, the function signature is output for diagnostic purposes.

Declaration at line 396 of file test.h, definition at line 126 of file test.cpp.

126 runnable_base::runnable_base (const char* name, runner& test_runner,

127 size_t own_index)

128 : name_{ name }, runner_{ test_runner }, own_index_{ own_index }

129 {

130#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)

131 trace::printf ("%s '%s' %" MICRO_OS_PLUS_MICRO_TEST_PLUS_PRI_SIZE "\n",

132 __PRETTY_FUNCTION__, name, own_index_);

133#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED

134 }

References MICRO_OS_PLUS_MICRO_TEST_PLUS_PRI_SIZE, micro_test_plus::runner, name, name_, own_index, own_index_, runner_ and test_runner.

Referenced by runnable_base, runnable_base, micro_os_plus::micro_test_plus::suite::suite, operator= and operator=.

runnable_base()

micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base (const runnable_base &)

delete

Deleted copy constructor to prevent copying.

A copy would duplicate the counters.

Definition at line 404 of file test.h.

Reference runnable_base.

runnable_base()

micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base (runnable_base &&)

delete

Deleted move constructor to prevent moving.

Nodes are referred to by address (e.g. by their children and by the runner), so they must not be relocated.

Definition at line 413 of file test.h.

Reference runnable_base.

Public Destructor

~runnable_base()

micro_os_plus::micro_test_plus::detail::runnable_base::~runnable_base ()

virtual

Virtual destructor.

Virtual, so that the derived nodes are destroyed correctly.

Nothing is owned; the child test cases were destroyed when the test() calls that created them returned. If tracing is enabled, the name is output for diagnostic purposes.

Declaration at line 442 of file test.h, definition at line 142 of file test.cpp.

142 runnable_base::~runnable_base ()

143 {

144#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)

145 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name_);

146#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED

147 }

Reference name_.

Public Operators

operator=()

runnable_base & micro_os_plus::micro_test_plus::detail::runnable_base::operator= (const runnable_base &)

delete

Deleted copy assignment operator to prevent copying.

A copy would duplicate the counters.

Definition at line 422 of file test.h.

Reference runnable_base.

operator=()

runnable_base & micro_os_plus::micro_test_plus::detail::runnable_base::operator= (runnable_base &&)

delete

Deleted move assignment operator to prevent moving.

Nodes are referred to by address (e.g. by their children and by the runner), so they must not be relocated.

Definition at line 433 of file test.h.

References runnable_base, children_subtests_count, current_subtest_index, name, own_index and totals.

Public Member Functions

name()

const char * micro_os_plus::micro_test_plus::detail::runnable_base::name (void)

inline nodiscard noexcept

Returns the node name.

Parameters

None.

Returns

A pointer to the null-terminated node name.

Returns a pointer to the null-terminated name stored in name_.

Declaration at line 454 of file test.h, definition at line 195 of file test-inlines.h.

195 runnable_base::name (void) const noexcept

196 {

197 return name_;

198 }

Reference name_.

Referenced by runnable_base, micro_os_plus::micro_test_plus::runner::runner, micro_os_plus::micro_test_plus::runner::runner, micro_os_plus::micro_test_plus::static_suite::static_suite, micro_os_plus::micro_test_plus::suite::suite, micro_os_plus::micro_test_plus::test_case::test_case, micro_os_plus::micro_test_plus::top_suite::top_suite, accepts_test_case, micro_os_plus::micro_test_plus::runner::add_top_suite, after_test_case_create, micro_os_plus::micro_test_plus::detail::reporter_human::begin_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::begin_suite, micro_os_plus::micro_test_plus::detail::reporter_human::begin_test_case, micro_os_plus::micro_test_plus::detail::reporter_tap::begin_test_case, create_test_case, micro_os_plus::micro_test_plus::test_case::detail::runnable_base, micro_os_plus::micro_test_plus::detail::reporter_human::display_open_heading, micro_os_plus::micro_test_plus::detail::reporter_tap::display_open_heading, micro_os_plus::micro_test_plus::detail::reporter_human::display_open_names, micro_os_plus::micro_test_plus::detail::reporter_human::end_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite, micro_os_plus::micro_test_plus::detail::reporter_human::end_test_case, micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case, micro_os_plus::micro_test_plus::detail::reporter_human::fail_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::fail_suite, micro_os_plus::micro_test_plus::runner::list_test_case, micro_os_plus::micro_test_plus::top_suite::micro_test_plus::runner, operator=, micro_os_plus::micro_test_plus::suite::operator=, micro_os_plus::micro_test_plus::test_case::operator=, micro_os_plus::micro_test_plus::test_case::report_misdirected, micro_os_plus::micro_test_plus::test_case::report_misdirected_test, reporter_tap, run, micro_os_plus::micro_test_plus::detail::reporter_human::skip_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::skip_suite, micro_os_plus::micro_test_plus::detail::reporter_human::skip_test_case, micro_os_plus::micro_test_plus::detail::reporter_tap::skip_test_case, micro_os_plus::micro_test_plus::suite::static_suite, micro_os_plus::micro_test_plus::suite::test, micro_os_plus::micro_test_plus::test_case::test, micro_os_plus::micro_test_plus::suite::test_each, micro_os_plus::micro_test_plus::suite::test_each, micro_os_plus::micro_test_plus::test_case::test_each, micro_os_plus::micro_test_plus::test_case::test_each and micro_os_plus::micro_test_plus::detail::reporter_tap::write_quiet_failures.

totals()

const counters & micro_os_plus::micro_test_plus::detail::runnable_base::totals (void)

inline nodiscard noexcept

Returns the totals of the node.

The reference is read-only, for the const and the non-const nodes alike, so that a test case or a suite cannot modify its own counters, which decide the exit code. The counters are updated only by the framework, which accesses the protected member directly.

Parameters

None.

Returns

A const reference to the counters instance.

Returns a const reference to the counters member.

Declaration at line 471 of file test.h, definition at line 205 of file test-inlines.h.

205 runnable_base::totals (void) const noexcept

206 {

207 return totals_;

208 }

Reference totals_.

Referenced by after_test_case_create, micro_os_plus::micro_test_plus::detail::reporter_human::end_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite, micro_os_plus::micro_test_plus::detail::reporter_human::end_test_case, micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case, micro_os_plus::micro_test_plus::detail::reporter::format_suite_totals, micro_os_plus::micro_test_plus::detail::reporter::format_test_case_totals, operator= and micro_os_plus::micro_test_plus::runner::run_suites.

Protected Member Functions

accepts_test_case()

bool micro_os_plus::micro_test_plus::detail::runnable_base::accepts_test_case (const suite & target, const located_name & name)

nodiscard protected

Checks whether a test case can be created on a suite.

Protected, since it is used only by suite::test(). A test case can be created only on the suite whose body is running (the top suite, between runner::add_top_suite() and runner::run_suites(), or the suite being run). A call on any other suite, for example on the top suite from the body of another suite, on a static suite before the runner was initialised, or after runner::run_suites() returned, would run the test case where its results cannot be reported correctly. Such a call is rejected: the failure is reported as a failed check of the running test case, if one runs, otherwise in the running suite, or, when no suite runs, on stderr, and the rejection is remembered by the runner, which makes the exit code non-zero. When the session was declined (option errors, or --help), or aborted, the test cases are ignored silently, as after_test_case_create() ignores them.

Parameters

target	The suite on which the test case is created.
name	The name and the location of the test case, for the message.

Return Values

true	The test case can be created.
false	The test case must not be created.

The suite whose body runs accepts the test case. When the session was declined, or aborted, the test case is ignored, as after_test_case_create() ignores it.

Otherwise the call is rejected. If a test case runs (and the test cases are not only listed), the failure is reported as a check of that test case, so that it stays in its report. Otherwise, if a suite runs, the failure is reported as a check of that suite, with the same numbering and counting as the unexpected exceptions of the suite body. Otherwise (the runner was not initialised, has not started the suites, or has finished them, or the test cases are listed) the failure is given to runner::reject_call(), which writes the message on stderr and, where the reporter can still write it, as a comment line, for example in the list, and runner::mark_rejected() makes the exit code non-zero, as for the suites added too late.

Declaration at line 721 of file test.h, definition at line 239 of file test.cpp.

239 runnable_base::accepts_test_case (const suite& target,

240 const located_name& name)

241 {

242 if (runner_.running_suite_ == &target)

243 {

244 return true;

245 }

246

247 if (runner_.aborted_ || runner_.has_option_errors ()

248 || runner_.options_.help)

249 {

250 return false;

251 }

252

253 std::string message{ "test case '" };

254 message.append (name.name ());

255 message.append ("' started on suite '");

256 message.append (target.name ());

257 message.append ("', which is not running");

258

259 if (runner_.running_test_case_ != nullptr

260 && !runner_.options_.list_tests)

261 {

262 runner_.running_test_case_->report_rejected_test (message,

263 name.location ());

264 return false;

265 }

266

267 suite* running = runner_.running_suite_;

268 if (running != nullptr && !runner_.options_.list_tests)

269 {

270 running->next_test_point_number ();

271 running->test_reporter ().fail_suite (message, *running);

272 running->totals_.increment_failed_checks ();

273 return false;

274 }

275

276 runner_.reject_call (message, &name.location ());

277 return false;

278 }

References micro_os_plus::micro_test_plus::runner::aborted_, micro_os_plus::micro_test_plus::detail::reporter::fail_suite, micro_os_plus::micro_test_plus::runner::has_option_errors, micro_os_plus::micro_test_plus::runner_options::help, micro_os_plus::micro_test_plus::counters::increment_failed_checks, micro_os_plus::micro_test_plus::runner_options::list_tests, micro_os_plus::micro_test_plus::located_name::location, name, micro_os_plus::micro_test_plus::located_name::name, next_test_point_number, micro_os_plus::micro_test_plus::runner::options_, micro_os_plus::micro_test_plus::runner::reject_call, micro_os_plus::micro_test_plus::test_case::report_rejected_test, runner_, micro_os_plus::micro_test_plus::runner::running_suite_, micro_os_plus::micro_test_plus::runner::running_test_case_, test_reporter and totals_.

Referenced by run and micro_os_plus::micro_test_plus::suite::test.

after_test_case_create()

void micro_os_plus::micro_test_plus::detail::runnable_base::after_test_case_create (class test_case & test_case, suite & suite)

protected

Counts a newly constructed child test case and executes it immediately.

The child test case is a local object of create_test_case(), and is destroyed when that function returns.

Parameters

test_case	The newly created test_case.
suite	The parent suite to which execution results are reported.

Returns

Nothing.

Counts test_case, which is a local object of the calling create_test_case(), and immediately invokes test_case::run() on it. The test case is not kept; only child_test_cases_count_ is needed later, for the TAP plan.

If the filter patterns do not select the test case (its own name at its nesting level, or the name of suite at level 0, which matters only for the top suite, since the other suites run only when selected), its body is not called: the reporter is notified with skip_test_case() and the parent's skipped test cases counter is incremented. The test case keeps its index and its place among the children, so the TAP plan of the parent remains complete.

Otherwise, while the test case runs, the runner keeps it as its innermost running test case (see suite::test()). The parent's executed test cases counter is incremented after the run, and, if the child failed (a failed check, or a failed nested test case), its failed test cases counter too, so that the parent fails as well, as in node-tap. The child's check counters are intentionally not merged into the parent totals; each test case reports only its own counters. The child's totals are, however, accumulated into suite so that the suite summary reflects all checks performed by its test cases.

While the test cases are listed (see runner_options::list_tests), the selected test case is listed by the runner, and neither run nor counted, except in child_test_cases_count_.

After the test execution was aborted (possible only when the abort handler threw an exception, which the application caught), the report is complete, so the test case is neither run nor reported. The same applies when the runner refused to run the tests because of errors in the options, or because the output file could not be opened (see runner::has_option_errors()), or because the options requested the usage (--help).

Declaration at line 771 of file test.h, definition at line 350 of file test.cpp.

350 runnable_base::after_test_case_create (class test_case& test_case,

351 suite& suite)

352 {

353 if (runner_.aborted_ || runner_.has_option_errors ()

354 || runner_.options_.help)

355 {

356 return;

357 }

358

359 ++child_test_cases_count_;

360

361 // While the test cases are listed, the selected ones are listed and

362 // the others ignored; none is run.

363 if (runner_.options_.list_tests)

364 {

365 if (runner_.is_selected (suite.name (), 0)

366 && runner_.is_selected (test_case.name (),

367 test_case.nesting_depth ()))

368 {

369 runner_.list_test_case (suite, test_case);

370 }

371 return;

372 }

373

374 // Skip the test cases not selected by the filter; the outer test

375 // cases, if any, were selected, otherwise this one was not created.

376 if (!runner_.is_selected (suite.name (), 0)

377 || !runner_.is_selected (test_case.name (),

378 test_case.nesting_depth ()))

379 {

380 test_reporter ().skip_test_case (test_case);

381 totals_.increment_skipped_test_cases ();

382 return;

383 }

384

385 // Run the child test case immediately, as the innermost running test

386 // case of the runner. The outer one is restored by the guard, also

387 // when an exception leaves run() (for example thrown by an abort

388 // handler), so that the runner never keeps a destroyed test case.

389 {

390 struct running_guard

391 {

392 class test_case*& running;

393 class test_case* outer;

394

395 ~running_guard ()

396 {

397 running = outer;

398 }

399 } guard{ runner_.running_test_case_, runner_.running_test_case_ };

400

401 runner_.running_test_case_ = &test_case;

402 // A non-virtual call, so that run() is inlined here; each nested

403 // test case adds this call chain to the stack.

404 test_case.test_case::run ();

405 }

406

407 // This test executed one more test case.

408#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)

409 trace::printf ("%s test case '%s' executed one more test case\n",

410 __PRETTY_FUNCTION__, name ());

411#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED

412 totals_.increment_executed_test_cases ();

413

414 // Do not accumulate the totals from the child test into the current test

415 // totals, each test case shows only its counters. But a failed child

416 // fails this test too, as in node-tap; the failure reaches all outer

417 // tests, one level at a time, when they end.

418 if (!test_case.totals ().passed ())

419 {

420 totals_.increment_failed_test_cases ();

421 }

422

423#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)

424 trace::printf ("%s suite '%s' totals\n", __PRETTY_FUNCTION__,

425 suite.name ());

426#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED

427

428 // Accumulate the totals from the child test into the suite totals.

429 suite.totals_ += test_case.totals ();

430 }

References micro_os_plus::micro_test_plus::runner::aborted_, child_test_cases_count_, micro_os_plus::micro_test_plus::runner::has_option_errors, micro_os_plus::micro_test_plus::runner_options::help, micro_os_plus::micro_test_plus::counters::increment_executed_test_cases, micro_os_plus::micro_test_plus::counters::increment_failed_test_cases, micro_os_plus::micro_test_plus::counters::increment_skipped_test_cases, micro_os_plus::micro_test_plus::runner::is_selected, micro_os_plus::micro_test_plus::runner::list_test_case, micro_os_plus::micro_test_plus::runner_options::list_tests, name, micro_os_plus::micro_test_plus::test_case::nesting_depth, micro_os_plus::micro_test_plus::runner::options_, micro_os_plus::micro_test_plus::counters::passed, runner_, micro_os_plus::micro_test_plus::runner::running_test_case_, micro_os_plus::micro_test_plus::detail::reporter::skip_test_case, test_reporter, totals and totals_.

Referenced by create_test_case and run.

create_test_case()

template <typename Callable_T, typename... Args_T>

void micro_os_plus::micro_test_plus::detail::runnable_base::create_test_case (const located_name & name, suite & parent_suite, size_t nesting_depth, Callable_T && callable, Args_T &&... arguments)

inline protected

Creates a child test case, and runs it.

The common body of suite::test() and test_case::test(), which differ only in the parent suite and the nesting depth of the test cases they create.

Always inlined into them, even without optimisations, since each nested test case adds one call chain to the stack, and a separate frame for this function would make it longer.

The test case runs and ends within the call, so, without additional arguments, it refers to the callable of the caller, which is neither copied nor moved, and is called in place, so a callable that cannot be copied is accepted, and an lvalue callable keeps the changes of its state. With additional arguments, the callable and the arguments are bound into a body of copies, by bind_callable().

Template Parameters

Callable_T	The type of a callable object.
Args_T	The types of the callable arguments.

Parameters

name	The test case name or description, used in reports, and the location of the call to test().
parent_suite	The suite to which the test case belongs.
nesting_depth	The depth of nesting of the test case; 1 for the direct children of a suite.
callable	A generic callable object, usually a lambda, invoked to perform the test.
arguments	A possibly empty list of arguments to be passed to the callable.

Returns

Nothing.

Without additional arguments, the child test_case is a local object that refers to the callable of the caller, which is neither copied nor moved, and is called in place (an lvalue callable keeps the changes of its state). A function is referred to through its pointer, and the callable and the additional arguments are bound into a local body, as copies, when there are arguments. The child is constructed with the next test point number of this node as its index, then passed to after_test_case_create(), which counts and runs it.

The child test case and its body, with the copies of the arguments, are destroyed when this function returns, so the memory used by a test session does not grow with the number of test cases; the stack holds one test case and one body for each level of nesting being run. Since the body is not stored in a std::function, it is never allocated, whatever the size of the lambda captures and of the arguments.

Declaration at line 810 of file test.h, definition at line 292 of file test-inlines.h.

292 runnable_base::create_test_case (const located_name& name,

293 suite& parent_suite, size_t nesting_depth,

294 Callable_T&& callable,

295 Args_T&&... arguments)

296 {

297 size_t own_index = next_test_point_number ();

298

299 if constexpr (sizeof...(arguments) == 0

300 && !std::is_function_v<

301 std::remove_reference_t<Callable_T>>)

302 {

303 // The test case runs and ends within this call, so it refers

304 // to the callable of the caller, which is not copied, and is

305 // called in place.

306 class test_case child_test_case{

307 name, runner_, parent_suite,

308 own_index, nesting_depth, callable_ref<class test_case>{ callable }

309 };

310

311 after_test_case_create (child_test_case, parent_suite);

312 }

313 else

314 {

315 auto body = bind_callable<class test_case> (

316 std::forward<Callable_T> (callable),

317 std::forward<Args_T> (arguments)...);

318 class test_case child_test_case{

319 name, runner_, parent_suite,

320 own_index, nesting_depth, callable_ref<class test_case>{ body }

321 };

322

323 after_test_case_create (child_test_case, parent_suite);

324 }

325 }

References after_test_case_create, micro_os_plus::micro_test_plus::detail::bind_callable, name, next_test_point_number, own_index and runner_.

Referenced by run, micro_os_plus::micro_test_plus::suite::test and micro_os_plus::micro_test_plus::test_case::test.

exchange_running_suite()

suite * micro_os_plus::micro_test_plus::detail::runnable_base::exchange_running_suite (suite * running)

noexcept protected

Replaces the suite whose body is running in the owning runner, and returns the previous one.

Protected, since it is used only by suite::run(), to mark the suite whose body is being called, and to restore the previous value when the body returns.

Parameters

running

The suite that starts to run, or the previous one, to restore it.

Returns

The suite that was marked as running before the call, or nullptr when none was.

Sets the pointer of the runner, a friend, and returns the previous value, so that the caller can restore it when the body returns.

Declaration at line 692 of file test.h, definition at line 212 of file test.cpp.

212 runnable_base::exchange_running_suite (suite* running) noexcept

213 {

214 suite* previous = runner_.running_suite_;

215 runner_.running_suite_ = running;

216 return previous;

217 }

Reference runner_.

Referenced by run and micro_os_plus::micro_test_plus::suite::run.

has_running_test_case_of()

bool micro_os_plus::micro_test_plus::detail::runnable_base::has_running_test_case_of (const suite & target)

nodiscard noexcept protected

Checks whether the innermost running test case belongs to a suite.

Protected, since it is used only by suite::test(), to forward a test case started on the suite to the running test case only when that is a test case of the same suite; the test cases started on another suite are rejected.

Parameters

target

The suite to check.

Return Values

true	A test case is running, and its parent suite is target.
false	No test case is running, or it belongs to another suite.

Reads the pointer of the runner, a friend, and the parent suite of the test case, which runnable_base may access.

Declaration at line 643 of file test.h, definition at line 199 of file test.cpp.

199 runnable_base::has_running_test_case_of (

200 const suite& target) const noexcept

201 {

202 const test_case* running = runner_.running_test_case_;

203 return running != nullptr && &running->parent_suite_ == &target;

204 }

References micro_os_plus::micro_test_plus::test_case::parent_suite_ and runner_.

Referenced by run and micro_os_plus::micro_test_plus::suite::test.

is_aborted()

bool micro_os_plus::micro_test_plus::detail::runnable_base::is_aborted (void)

nodiscard noexcept protected

Checks whether the test execution was aborted by the owning runner.

Protected, since it is used only by test_case::run() and suite::run(), to pass on an exception thrown by the abort handler, instead of reporting it as unexpected.

Parameters

None.

Returns

true once runner::abort() was called.

Returns the flag kept by the owning runner, set by runner::abort() and never cleared.

Declaration at line 659 of file test.h, definition at line 177 of file test.cpp.

177 runnable_base::is_aborted (void) const noexcept

178 {

179 return runner_.aborted_;

180 }

Reference runner_.

Referenced by run, micro_os_plus::micro_test_plus::suite::run and micro_os_plus::micro_test_plus::test_case::run.

is_listing()

bool micro_os_plus::micro_test_plus::detail::runnable_base::is_listing (void)

nodiscard noexcept protected

Checks whether the owning runner lists the test cases instead of running them.

Protected, since it is used only by suite::run(), which then calls the suite body without reporting the suite, so that its test cases are created, and listed instead of run.

Parameters

None.

Returns

true if runner_options::list_tests was set.

Returns runner_options::list_tests of the session options kept by the owning runner.

Declaration at line 675 of file test.h, definition at line 188 of file test.cpp.

188 runnable_base::is_listing (void) const noexcept

189 {

190 return runner_.options_.list_tests;

191 }

Reference runner_.

Referenced by run and micro_os_plus::micro_test_plus::suite::run.

next_test_point_number()

size_t micro_os_plus::micro_test_plus::detail::runnable_base::next_test_point_number (void)

inline noexcept protected

Advances to the next child test point, and returns its number.

Called for each check (by the check result, when the check is reported) and for each nested test case created.

Parameters

None.

Returns

The one-based number of the new test point.

Each call to test() invokes this member function before constructing the new test_case, and each check invokes it from the check result destructor, when the check is reported, so the numbers form a strictly increasing, one-based sequence of TAP test points, in output order.

Declaration at line 754 of file test.h, definition at line 255 of file test-inlines.h.

255 runnable_base::next_test_point_number (void) noexcept

256 {

257 return ++test_point_number_;

258 }

Reference test_point_number_.

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result, accepts_test_case, create_test_case, micro_os_plus::micro_test_plus::suite::fail_unexpected_exception, micro_os_plus::micro_test_plus::test_case::fail_unexpected_exception, micro_os_plus::micro_test_plus::runner::reject_call and run.

reject_body_exception()

void micro_os_plus::micro_test_plus::detail::runnable_base::reject_body_exception (void)

protected

Reports the exception that escaped the body of a suite while the test cases are listed, and records it.

Protected, since it is used only by suite::run(), when there is no test point to fail. It gives the message, which names the suite, to runner::reject_call(), which writes it on stderr and in the listing, and makes the exit code non-zero.

Parameters

None.

Returns

Nothing.

Builds the message here, and not in suite::run(), to keep the frame of that function, which is on the stack of every session, unchanged. Delegates to the private runner::reject_call(), which writes the message on stderr and in the listing, and marks the runner, so that the exit code of runner::run_suites() is not 0.

Declaration at line 739 of file test.h, definition at line 289 of file test.cpp.

289 runnable_base::reject_body_exception (void)

290 {

291 std::string message{ "unexpected exception in the body of suite '" };

292 message.append (name_);

293 message.append ("'");

294

295 runner_.reject_call (message);

296 }

References name_, micro_os_plus::micro_test_plus::runner::reject_call and runner_.

Referenced by run and micro_os_plus::micro_test_plus::suite::run.

running_test_case()

test_case * micro_os_plus::micro_test_plus::detail::runnable_base::running_test_case (void)

nodiscard noexcept protected

Returns the innermost test case being run by the owning runner, if any.

Protected, since it is used only by suite::test(), to run a test case started on the suite from inside a running test case as a nested test case of it.

Parameters

None.

Returns

A pointer to the running test case, or nullptr when no test case is running.

Returns the pointer kept by the owning runner, set by after_test_case_create() while a test case runs.

Declaration at line 624 of file test.h, definition at line 166 of file test.cpp.

166 runnable_base::running_test_case (void) const noexcept

167 {

168 return runner_.running_test_case_;

169 }

Reference runner_.

Referenced by micro_os_plus::micro_test_plus::test_case::is_misdirected, micro_os_plus::micro_test_plus::test_case::report_misdirected, micro_os_plus::micro_test_plus::test_case::report_misdirected_test, run and micro_os_plus::micro_test_plus::suite::test.

test_reporter()

reporter & micro_os_plus::micro_test_plus::detail::runnable_base::test_reporter (void)

nodiscard noexcept protected

Returns the test reporter associated with this test runnable.

Protected, since the reporter is internal to the framework; it is used by the suites and the test cases, which derive from this class, and by the check result, which is a friend.

Not named reporter(), which would hide the class detail::reporter in the derived classes.

Parameters

None.

Returns

A reference to the test reporter.

Returns the reporter owned by the runner, through its reporter_ pointer, which is valid after runner::initialise().

Declaration at line 607 of file test.h, definition at line 155 of file test.cpp.

155 runnable_base::test_reporter (void) const noexcept

156 {

157 return *runner_.reporter_;

158 }

Reference runner_.

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result, accepts_test_case, after_test_case_create, micro_os_plus::micro_test_plus::test_case::expect, micro_os_plus::micro_test_plus::suite::fail_unexpected_exception, micro_os_plus::micro_test_plus::test_case::fail_unexpected_exception, micro_os_plus::micro_test_plus::test_case::report_misdirected, micro_os_plus::micro_test_plus::test_case::report_rejected_test, micro_os_plus::micro_test_plus::test_case::require, run, micro_os_plus::micro_test_plus::suite::run and micro_os_plus::micro_test_plus::test_case::run.

test_runner()

runner & micro_os_plus::micro_test_plus::detail::runnable_base::test_runner (void)

inline nodiscard noexcept protected

Returns the test runner that owns this test runnable.

Protected, since the runner is internal to the framework; it is used by the suites and the test cases, which derive from this class and pass it to their nested test cases, and by the runner, which is a friend and selects the static suites it runs.

Not named runner(), which would hide the class runner in the derived classes.

Parameters

None.

Returns

A reference to the test runner.

Returns a reference to the owning test runner.

Declaration at line 589 of file test.h, definition at line 265 of file test-inlines.h.

265 runnable_base::test_runner (void) const noexcept

266 {

267 return runner_;

268 }

Reference runner_.

Referenced by runnable_base, micro_os_plus::micro_test_plus::static_suite::static_suite, micro_os_plus::micro_test_plus::suite::suite, micro_os_plus::micro_test_plus::test_case::test_case, micro_os_plus::micro_test_plus::top_suite::top_suite, micro_os_plus::micro_test_plus::test_case::detail::runnable_base, micro_os_plus::micro_test_plus::static_suite::link_or_reject, micro_os_plus::micro_test_plus::top_suite::micro_test_plus::runner, reporter_tap, run and micro_os_plus::micro_test_plus::suite::static_suite.

Private Member Functions

abort()

void micro_os_plus::micro_test_plus::detail::runnable_base::abort (const reflection::source_location & sl=reflection::source_location::current())

Aborts test execution via the owning runner, for a failed requirement.

Private, since it is used only by the check result, a friend, for a failed requirement without exceptions; the user code calls runner::abort().

Parameters

sl	The source location from which the abort is triggered.

Returns

Does not return.

Delegates to the private runner::abort(), as caused by a failed requirement, passing the supplied source location, so that the report identifies it. The runner then calls the abort handler, if any, and terminates the process via ::abort().

Declaration at line 568 of file test.h, definition at line 306 of file test.cpp.

306 runnable_base::abort (const reflection::source_location& sl) const

307 {

308 runner_.abort (sl, true);

309 }

References micro_os_plus::micro_test_plus::runner::abort and runner_.

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result and run.

run()

virtual void micro_os_plus::micro_test_plus::detail::runnable_base::run (void)

Runs the body of the test case or suite.

Implemented by test_case and suite, which invoke the stored callable surrounded by the reporter notifications.

Private, since the nodes are run only by the framework: the test cases by after_test_case_create(), when they are created, and the suites by the runner, which is a friend; a second run would report the node twice.

Parameters

None.

Returns

Nothing.

Definition at line 551 of file test.h.

References abort, accepts_test_case, after_test_case_create, create_test_case, micro_os_plus::micro_test_plus::reflection::source_location::current, exchange_running_suite, has_running_test_case_of, is_aborted, is_listing, micro_test_plus::runner, name, next_test_point_number, reject_body_exception, running_test_case, test_reporter and test_runner.

Protected Member Attributes

child_test_cases_count_

size_t micro_os_plus::micro_test_plus::detail::runnable_base::child_test_cases_count_ = 0

protected

The number of direct child test cases.

Incremented for each call to test(), which creates a child test_case and runs it immediately. The child test cases are not kept after they run, so that the memory does not grow with the number of test cases; only their number is needed later, for the TAP plan.

Definition at line 883 of file test.h.

883 size_t child_test_cases_count_ = 0;

Referenced by after_test_case_create, children_subtests_count, micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite and micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case.

name_

const char* micro_os_plus::micro_test_plus::detail::runnable_base::name_

protected

The node name.

Not owned; it points to a string whose lifetime exceeds that of the node. Derived classes may access this member directly, in addition to the public name() getter.

Definition at line 823 of file test.h.

823 const char* name_;

Referenced by runnable_base, micro_os_plus::micro_test_plus::suite::suite, micro_os_plus::micro_test_plus::test_case::test_case, ~runnable_base, micro_os_plus::micro_test_plus::static_suite::~static_suite, micro_os_plus::micro_test_plus::suite::~suite, micro_os_plus::micro_test_plus::test_case::~test_case, micro_os_plus::micro_test_plus::top_suite::~top_suite, micro_os_plus::micro_test_plus::runner::add_top_suite, micro_os_plus::micro_test_plus::suite::link, name, reject_body_exception, micro_os_plus::micro_test_plus::suite::run and micro_os_plus::micro_test_plus::test_case::run.

own_index_

size_t micro_os_plus::micro_test_plus::detail::runnable_base::own_index_

protected

The test index, counting from 1.

The position of this object within its parent, displayed by the TAP reporter in the ok/not ok lines. Set directly by the runner, which numbers the suites when it runs them, and by the top suite, which, when added, is always the first one.

Definition at line 859 of file test.h.

859 size_t own_index_;

Referenced by runnable_base, micro_os_plus::micro_test_plus::suite::suite, micro_os_plus::micro_test_plus::test_case::test_case, micro_os_plus::micro_test_plus::top_suite::top_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case, own_index, micro_os_plus::micro_test_plus::detail::reporter_tap::skip_suite and micro_os_plus::micro_test_plus::detail::reporter_tap::skip_test_case.

runner_

runner& micro_os_plus::micro_test_plus::detail::runnable_base::runner_

protected

Reference to the test runner that owns this object.

Provides access to the reporter, to the filter, and to the state of the session (the running test case, and the abort and listing flags), and is used when aborting.

Definition at line 848 of file test.h.

848 runner& runner_;

Referenced by runnable_base, abort, accepts_test_case, after_test_case_create, create_test_case, exchange_running_suite, has_running_test_case_of, is_aborted, is_listing, reject_body_exception, running_test_case, test_reporter and test_runner.

test_point_number_

size_t micro_os_plus::micro_test_plus::detail::runnable_base::test_point_number_ = 0

protected

The number of the most recent child test point.

Test points are numbered from 1; the value is 0 before the first one. This number counts the checks and the nested test cases of this object, in execution order, as required by the TAP ok/not ok lines. It is incremented for each check (by the check result) and for each nested test case created.

Definition at line 871 of file test.h.

871 size_t test_point_number_ = 0;

Referenced by current_subtest_index, micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite, micro_os_plus::micro_test_plus::detail::reporter_tap::fail_suite, next_test_point_number, micro_os_plus::micro_test_plus::detail::reporter_tap::output_fail_prefix, micro_os_plus::micro_test_plus::detail::reporter_tap::output_pass_prefix and micro_os_plus::micro_test_plus::detail::reporter_tap::pass_without_text.

totals_

counters micro_os_plus::micro_test_plus::detail::runnable_base::totals_

protected

Totals for the node.

For the suites, the totals include the checks of all their test cases; for a test case, they include only its own checks, plus the counts of its direct nested test cases.

The check counters are updated by the check result, which is a friend; the test case counters by after_test_case_create(), when a nested test case ends. For a suite, the totals of each of its test cases are also added, by the same function.

Definition at line 838 of file test.h.

838 counters totals_;

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result, accepts_test_case, after_test_case_create, micro_os_plus::micro_test_plus::suite::fail_unexpected_exception, micro_os_plus::micro_test_plus::test_case::fail_unexpected_exception, micro_os_plus::micro_test_plus::runner::reject_call and totals.

Deprecated Functions of runnable_base

children_subtests_count()

size_t micro_os_plus::micro_test_plus::detail::runnable_base::children_subtests_count (void)

inline nodiscard noexcept

Deprecated number of direct child test cases of this node.

Used only for the TAP plan, by the reporters, which access it directly. The test cases skipped by the filter are included.

Parameters

None.

Returns

The number of child test cases.

Deprecated

internal to the framework (since 6.0.0)

Returns the number of direct child test cases, including those skipped by the filter.

Declaration at line 525 of file test.h, definition at line 241 of file test-inlines.h.

241 runnable_base::children_subtests_count (void) const noexcept

242 {

243 return child_test_cases_count_;

244 }

Reference child_test_cases_count_.

Referenced by operator=.

current_subtest_index()

size_t micro_os_plus::micro_test_plus::detail::runnable_base::current_subtest_index (void)

inline nodiscard noexcept

Deprecated number of the most recent child test point.

Used only for the TAP output, by the reporters, which access it directly.

Parameters

None.

Returns

The one-based test point number, or 0 before the first test point.

Deprecated

internal to the framework (since 6.0.0)

Returns the number of the most recent child test point.

Declaration at line 510 of file test.h, definition at line 229 of file test-inlines.h.

229 runnable_base::current_subtest_index (void) const noexcept

230 {

231 return test_point_number_;

232 }

Reference test_point_number_.

Referenced by operator=.

own_index()

size_t micro_os_plus::micro_test_plus::detail::runnable_base::own_index (void)

inline nodiscard noexcept

Deprecated positional index of this node within its parent.

Used only for the TAP output, by the reporters, which access it directly. The setter of v5.0.1, and increment_subtest_index(), were removed, since they allowed the application code to corrupt the numbering of the reports.

Parameters

None.

Returns

The one-based own index.

Deprecated

internal to the framework (since 6.0.0)

Returns the one-based positional index of this node within its parent.

Declaration at line 494 of file test.h, definition at line 218 of file test-inlines.h.

218 runnable_base::own_index (void) const noexcept

219 {

220 return own_index_;

221 }

Reference own_index_.

Referenced by runnable_base, micro_os_plus::micro_test_plus::test_case::test_case, create_test_case, micro_os_plus::micro_test_plus::test_case::detail::runnable_base, operator= and reporter_tap.

---

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

• test-inlines.h
• test.h
• test.cpp

---

Generated via doxygen2docusaurus 2.2.8 by Doxygen 1.18.0.