`top_suite` Class

The optional top suite owned by every runner instance. More...

Declaration

class micro_os_plus::micro_test_plus::top_suite { ... }

Included Headers

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

Base class

class	suite
	A named, runnable test suite registered with the test runner. More...

Friends Index

class	micro_test_plus::runner
	The runner, which owns the top suite. More...

Public Constructors Index

	top_suite (const top_suite &)=delete
	Deleted copy constructor to prevent copying. More...

	top_suite (top_suite &&)=delete
	Deleted move constructor to prevent moving. More...

Private Constructors Index

	top_suite (const char *name, runner &test_runner)
	Constructs the top-level suite with a name and runner reference. More...

Public Destructor Index

	~top_suite () override
	Virtual destructor. More...

Public Operators Index

top_suite &	operator= (const top_suite &)=delete
	Deleted copy assignment operator to prevent copying. More...

top_suite &	operator= (top_suite &&)=delete
	Deleted move assignment operator to prevent moving. More...

Public Member Functions Index

const char *	name (void) const noexcept
	Returns the node name. More...

template <typename Callable_T, typename... Args_T>
void	test (const located_name &name, Callable_T &&callable, Args_T &&... arguments)
	Adds a test case to the suite, and runs it. More...

template <typename T, typename Callable_T>
void	test_each (const located_name &name, std::initializer_list< T > values, Callable_T &&callable)
	Adds a test case to the suite for each value of a braced list, and runs them. More...

template <typename Values_T, typename Callable_T>
void	test_each (const located_name &name, Values_T &&values, Callable_T &&callable)
	Adds a test case to the suite for each value of a range or a tuple, and runs them. 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	fail_unexpected_exception (const char *what)
	Reports an exception that escaped the suite body as a failed check of the suite. More...

void	link (void) noexcept
	Inserts this suite into the list of suites. More...

void	run (void) override
	Executes the suite body by invoking the stored callable. More...

void	unlink (void) noexcept
	Removes this suite from the list of suites. 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...

Private Member Attributes Index

std::function< void(suite &)>	callable_
	Callable storing the suite body and any bound arguments. More...

located_name	located_name_
	The name of the suite, with the location where it was given. More...

suite *	next_ = nullptr
	The next suite in the list of suites. More...

detail::stopwatch	stopwatch_
	Stopwatch of this suite. More...

Private Static Attributes Index

static suite *	first_ = nullptr
	The first suite in the list of suites. More...

Deprecated Functions of suite Index

const detail::stopwatch &	timings (void) const noexcept
	Deprecated access to the timings of the suite. More...

detail::stopwatch &	timings (void) noexcept
	Deprecated access to the timings of the suite, as a non-const reference. 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

The optional top suite owned by every runner instance.

top_suite is a thin specialisation of suite, whose body is the code of main(). It is created by the runner constructor, but is part of the session only after runner::add_top_suite(), which returns a reference to it. Unlike the other suites, it is not in the list of suites, sorted by name; it is a direct member of runner, which runs it separately.

The constructor is private; only the runner constructs its top suite.

Definition at line 2497 of file test.h.

Friends

micro_test_plus::runner

friend class micro_test_plus::runner

The runner, which owns the top suite.

It constructs the top suite, whose constructor is private, as a member.

Definition at line 2506 of file test.h.

2506 friend class micro_test_plus::runner;

References micro_test_plus::runner, micro_os_plus::micro_test_plus::detail::runnable_base::name and micro_os_plus::micro_test_plus::detail::runnable_base::test_runner.

Referenced by top_suite and micro_test_plus::runner.

Public Constructors

top_suite()

micro_os_plus::micro_test_plus::top_suite::top_suite (const top_suite &)

delete

Deleted copy constructor to prevent copying.

A copy would duplicate the counters and the stored body.

Definition at line 2528 of file test.h.

Reference top_suite.

top_suite()

micro_os_plus::micro_test_plus::top_suite::top_suite (top_suite &&)

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 2537 of file test.h.

Reference top_suite.

Private Constructors

top_suite()

micro_os_plus::micro_test_plus::top_suite::top_suite (const char * name, runner & test_runner)

Constructs the top-level suite with a name and runner reference.

Private, since each runner has exactly one top suite, which it constructs as a member.

Parameters

name	The suite name used in reports.
test_runner	The test runner that owns this suite.

Initialises the base suite with name, converted to a located_name, the given test_runner, and a no-op callable. Sets own_index_ to 1, since the top suite is always the first suite of the session; the runner numbers the other suites from 2. If tracing is enabled, the name is output for diagnostic purposes.

Declaration at line 2519 of file test.h, definition at line 783 of file test.cpp.

783 top_suite::top_suite (const char* name, runner& test_runner)

784 : suite{ located_name{ name }, test_runner, [] (suite&) noexcept {} }

785 {

786#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)

787 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name);

788#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED

789

790 own_index_ = 1;

791 }

References micro_os_plus::micro_test_plus::suite::suite, micro_test_plus::runner, micro_os_plus::micro_test_plus::detail::runnable_base::name, micro_os_plus::micro_test_plus::detail::runnable_base::own_index_ and micro_os_plus::micro_test_plus::detail::runnable_base::test_runner.

Referenced by top_suite, top_suite, operator= and operator=.

Public Destructor

~top_suite()

micro_os_plus::micro_test_plus::top_suite::~top_suite ()

Virtual destructor.

Called when the runner is destroyed; the top suite is not in the list of suites, so the suite destructor leaves the list unchanged.

No resources are owned directly by top_suite; the destructor performs no explicit clean-up. If tracing is enabled, the suite name is output for diagnostic purposes.

Declaration at line 2568 of file test.h, definition at line 799 of file test.cpp.

799 top_suite::~top_suite ()

800 {

801#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)

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

803#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED

804 }

Reference micro_os_plus::micro_test_plus::detail::runnable_base::name_.

Public Operators

operator=()

top_suite & micro_os_plus::micro_test_plus::top_suite::operator= (const top_suite &)

delete

Deleted copy assignment operator to prevent copying.

A copy would duplicate the counters and the stored body.

Definition at line 2546 of file test.h.

Reference top_suite.

operator=()

top_suite & micro_os_plus::micro_test_plus::top_suite::operator= (top_suite &&)

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 2557 of file test.h.

Reference top_suite.

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 micro_os_plus::micro_test_plus::detail::runnable_base::name_.

test()

template <typename Callable_T, typename... Args_T>

void micro_os_plus::micro_test_plus::suite::test (const located_name & name, Callable_T && callable, Args_T &&... arguments)

Adds a test case to the suite, and runs it.

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; a string literal, a const char*, a std::string, or a std::string_view, converted implicitly to located_name, which copies it and also captures the location of the call.
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.

The test function template creates a test case (a test_case with nesting depth 1) and runs it immediately. It accepts a descriptive name, a callable object (such as a lambda or function pointer), and an optional list of arguments to be passed to the callable, after the leading test_case& reference. The test case is reported using the provided name.

The test case is created and run by create_test_case(), as a local object destroyed when it returns, together with its stored body and bound arguments; only the number of test cases is kept, for the TAP plan.

Each test case typically involves evaluating logical expressions, such as comparing a computed result to an expected value, with expect() or require(). When exceptions are enabled, it is also possible to verify whether evaluating an expression throws exceptions. Each check either passes or fails, and the suite totals count the passed and failed checks.

It is typically invoked within the body of a suite. When invoked from the body of a running test case of this suite (for example via a captured suite reference), the new test case could not be reported as a sibling of the running one, which has not ended; it is therefore created by the innermost running test case, with test_case::test(), and runs nested in it, as if test() had been called on that test case.

The test case can be created only on the suite whose body is running. A call on another suite (for example on the top suite, captured by reference, from the body of a suite added with runner::add_suite(), or on any suite after runner::run_suites() returned) is rejected: the test case is not run, a failure is reported in the running suite, or, when none runs, an error is written to stderr, and the later calls of runner::run_suites() return a non-zero exit code.

Example

namespace mt = micro_os_plus::micro_test_plus;

ts.test ("Check answer with comparator", [] (auto& t) {

t.expect (mt::eq (compute_answer (), 42)) << "answer is 42";

});

Declaration at line 2197 of file test.h, definition at line 968 of file test-inlines.h.

968 suite::test (const located_name& name, Callable_T&& callable,

969 Args_T&&... arguments)

970 {

971#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)

972 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name.name ());

973#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED

974

975 // Called from inside a running test case of this suite; run nested in

976 // it. A running test case of another suite does not qualify; the call

977 // is then rejected below, as for any suite that is not running.

978 if (class test_case* running = running_test_case ();

979 running != nullptr && has_running_test_case_of (*this))

980 {

981 running->test (name, std::forward<Callable_T> (callable),

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

983 return;

984 }

985

986 if (!accepts_test_case (*this, name))

987 {

988 return;

989 }

990

991 create_test_case (name, *this, 1, std::forward<Callable_T> (callable),

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

993 }

References micro_os_plus::micro_test_plus::detail::runnable_base::accepts_test_case, micro_os_plus::micro_test_plus::detail::runnable_base::create_test_case, micro_os_plus::micro_test_plus::detail::runnable_base::has_running_test_case_of, micro_os_plus::micro_test_plus::detail::runnable_base::name, micro_os_plus::micro_test_plus::located_name::name and micro_os_plus::micro_test_plus::detail::runnable_base::running_test_case.

Referenced by micro_os_plus::micro_test_plus::suite::operator=.

test_each()

template <typename T, typename Callable_T>

void micro_os_plus::micro_test_plus::suite::test_each (const located_name & name, std::initializer_list< T > values, Callable_T && callable)

Adds a test case to the suite for each value of a braced list, and runs them.

As the overload for the ranges, for a list written in place, like ts.test_each ("Sizes", { 1, 16, 512 }, ...), whose type cannot be deduced otherwise.

Template Parameters

T	The type of the values.
Callable_T	The type of a callable object.

Parameters

name	The common name of the test cases.
values	The list of values.
callable	A generic callable object, usually a lambda, invoked with the test case and each value.

Returns: Nothing.

Since: 6.0.0

The list is iterated as a range.

Declaration at line 2299 of file test.h, definition at line 1135 of file test-inlines.h.

1135 suite::test_each (const located_name& name, std::initializer_list<T> values,

1136 Callable_T&& callable)

1137 {

1138 detail::test_each_value (*this, name, values, callable);

1139 }

References micro_os_plus::micro_test_plus::detail::runnable_base::name and micro_os_plus::micro_test_plus::detail::test_each_value.

test_each()

template <typename Values_T, typename Callable_T>

void micro_os_plus::micro_test_plus::suite::test_each (const located_name & name, Values_T && values, Callable_T && callable)

Adds a test case to the suite for each value of a range or a tuple, and runs them.

For each value, in order, a test case is added and run, as by test(), with the value as the argument of the callable, which is called as callable (test_case, value). The values may be a range (a container, an array, a span, or a view), or a tuple, whose values may have different types, for a generic callable:

ts.test_each ("Sizes", std::vector<int>{ 1, 16, 512 },

[] (auto& t, int size) { t.expect (mt::gt (size, 0)); });

ts.test_each ("Types", std::tuple{ 42, 1.5, "text" },

[] (auto& t, const auto& value) {

t.expect (mt::eq (value, value));

});

Each test case is named after the common name, followed by the value in parentheses, written as in the messages of the checks (Sizes (16)); a value that cannot be written (see extension::printable), such as an application type without an operator<<, is replaced by its position, starting at 1 (Records (#2)). The location of all the test cases is that of the call.

Template Parameters

Values_T	The type of the range or tuple of values.
Callable_T	The type of a callable object.

Parameters

name	The common name of the test cases; a string literal, a const char*, a std::string, or a std::string_view, converted implicitly to located_name, which also captures the location of the call.
values	The range or tuple of values.
callable	A generic callable object, usually a lambda, invoked with the test case and each value.

Returns: Nothing.

Since: 6.0.0

Forwards to detail::test_each_value(), which adds the test cases with test(), so they are nested in the running test case, if any.

Declaration at line 2273 of file test.h, definition at line 1122 of file test-inlines.h.

1122 suite::test_each (const located_name& name, Values_T&& values,

1123 Callable_T&& callable)

1124 {

1125 detail::test_each_value (*this, name, std::forward<Values_T> (values),

1126 callable);

1127 }

References micro_os_plus::micro_test_plus::detail::runnable_base::name, micro_os_plus::micro_test_plus::suite::test_each and micro_os_plus::micro_test_plus::detail::test_each_value.

Referenced by micro_os_plus::micro_test_plus::suite::operator= and micro_os_plus::micro_test_plus::suite::test_each.

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 micro_os_plus::micro_test_plus::detail::runnable_base::totals_.

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 }

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 }

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::create_test_case and micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::after_test_case_create, micro_os_plus::micro_test_plus::detail::bind_callable, micro_os_plus::micro_test_plus::detail::runnable_base::name, micro_os_plus::micro_test_plus::detail::runnable_base::next_test_point_number, micro_os_plus::micro_test_plus::detail::runnable_base::own_index and micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::test_point_number_.

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 micro_os_plus::micro_test_plus::detail::runnable_base::name_, micro_os_plus::micro_test_plus::runner::reject_call and micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::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, micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

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 micro_os_plus::micro_test_plus::detail::runnable_base::runner_.

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

fail_unexpected_exception()

void micro_os_plus::micro_test_plus::suite::fail_unexpected_exception (const char * what)

Reports an exception that escaped the suite body as a failed check of the suite.

The suite body may throw outside its test cases, for example in a set-up step; the test cases catch their own exceptions. The failure is reported without a source location, since the suites do not record one, and the location of the throw is not known.

Parameters

what	The explanatory string of a std::exception, or nullptr for an exception of another type.

Returns: Nothing.

The failure is reported as a check of the suite: the test point number is incremented first, so that the TAP output numbers it after the test cases already run, and counts it in the plan of the suite, and the failed checks counter is incremented, so that the suite, and through it the session, fail.

The message is unexpected exception in the suite body: followed by what, or unexpected exception of unknown type in the suite body when what is nullptr; as for the test cases, the type of a std::exception is not shown.

Declaration at line 2384 of file test.h, definition at line 701 of file test.cpp.

701 suite::fail_unexpected_exception (const char* what)

702 {

703 next_test_point_number ();

704

705 std::string message{ "unexpected exception" };

706 if (what != nullptr)

707 {

708 message.append (" in the suite body: ");

709 message.append (what);

710 }

711 else

712 {

713 message.append (" of unknown type in the suite body");

714 }

715

716 test_reporter ().fail_suite (message, *this);

717 totals_.increment_failed_checks ();

718 }

References micro_os_plus::micro_test_plus::detail::reporter::fail_suite, micro_os_plus::micro_test_plus::counters::increment_failed_checks, micro_os_plus::micro_test_plus::detail::runnable_base::next_test_point_number, micro_os_plus::micro_test_plus::detail::runnable_base::test_reporter and micro_os_plus::micro_test_plus::detail::runnable_base::totals_.

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

link()

void micro_os_plus::micro_test_plus::suite::link (void)

noexcept

Inserts this suite into the list of suites.

Called by runner::register_suite() and by the static_suite constructor, after the name was copied. The suite is inserted after the suites with names less than or equal to its own, so the list remains sorted by name, and the suites with the same name remain in the order of their insertion. The top suite is not inserted, since the runner runs it separately.

Parameters: None.

Returns: Nothing.

Inserts the suite after the suites with names less than or equal to its own, so the list remains sorted by name, and the suites with the same name remain in the order of their insertion. No memory is allocated. This is the only place where the names of the suites are compared; the runners run the suites in the order of the list.

Declaration at line 2404 of file test.h, definition at line 738 of file test.cpp.

738 suite::link (void) noexcept

739 {

740#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)

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

742#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED

743

744 // std::strcmp() compares as unsigned char, like std::string_view,

745 // without a temporary object (which triggers -Waggregate-return).

746 suite** slot = &first_;

747 while (*slot != nullptr && std::strcmp ((*slot)->name_, name_) <= 0)

748 {

749 slot = &(*slot)->next_;

750 }

751 next_ = *slot;

752 *slot = this;

753 }

References micro_os_plus::micro_test_plus::suite::suite, micro_os_plus::micro_test_plus::suite::first_, micro_os_plus::micro_test_plus::detail::runnable_base::name_ and micro_os_plus::micro_test_plus::suite::next_.

Referenced by micro_os_plus::micro_test_plus::suite::operator=.

run()

void micro_os_plus::micro_test_plus::suite::run (void)

virtual

Executes the suite body by invoking the stored callable.

Private, since the suites are run only once, by the runner, which is a friend.

Parameters: None.

Returns: Nothing.

Invokes the stored callable with this suite, surrounded by reporter calls to begin and end the suite. While the body runs, this suite is marked, in the runner, as the one that accepts new test cases (see accepts_test_case()); the previous one is restored when the body returns, also when it throws.

While the test cases are listed (see runner_options::list_tests), the body is called only to create its test cases, which are listed; the suite is neither reported nor timed, and an exception that escapes the body is reported by reject_body_exception(), on stderr and in the listing, the exit code is not 0, and the listing continues with the next suite.

When exceptions are enabled, an exception that escapes the callable, which can be thrown only outside the test cases, since they catch their own exceptions, is caught and reported as a failed check of this suite, and the suite ends normally, so that the run continues with the next suite; the test cases run before the exception remain reported, and the following ones are not run. A body declared noexcept cannot pass the exception on; the program is then terminated before it reaches this function.

As for the test cases, an exception thrown by the abort handler is passed on, without reporting it, and without ending the suite.

Declaration at line 2364 of file test.h, definition at line 604 of file test.cpp.

604 suite::run (void)

605 {

606#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)

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

608#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED

609

610 // Marks this suite as the one that accepts new test cases, until the

611 // body returns.

612 struct running_guard

613 {

614 suite& self;

615 suite* outer;

616

617 ~running_guard ()

618 {

619 self.exchange_running_suite (outer);

620 }

621 } guard{ *this, exchange_running_suite (this) };

622

623 // While the test cases are listed, the body only creates them, so

624 // that they are listed; the suite is not reported. An exception

625 // thrown by the body is reported on stderr and in the listing, and

626 // the listing continues with the next suite.

627 if (is_listing ())

628 {

629#if defined(__cpp_exceptions)

630 try

631 {

632 callable_ (*this);

633 }

634 catch (...)

635 {

636 if (is_aborted ())

637 {

638 throw;

639 }

640 reject_body_exception ();

641 }

642#else

643 callable_ (*this);

644#endif // defined(__cpp_exceptions)

645 return;

646 }

647

648 detail::reporter& reporter = this->test_reporter ();

649

650 this->stopwatch_.start ();

651 reporter.begin_suite (*this);

652

653#if defined(__cpp_exceptions)

654 try

655 {

656 // Invoke the callable, passing the self reference.

657 callable_ (*this);

658 }

659 catch (const std::exception& e)

660 {

661 if (is_aborted ())

662 {

663 // Thrown by the abort handler; the report is complete.

664 throw;

665 }

666 fail_unexpected_exception (e.what ());

667 }

668 catch (...)

669 {

670 if (is_aborted ())

671 {

672 // Thrown by the abort handler; the report is complete.

673 throw;

674 }

675 fail_unexpected_exception (nullptr);

676 }

677#else

678 // Invoke the callable, passing the self reference.

679 callable_ (*this);

680#endif // defined(__cpp_exceptions)

681

682 this->stopwatch_.stop ();

683 reporter.end_suite (*this);

684 }

Referenced by micro_os_plus::micro_test_plus::suite::operator=.

unlink()

void micro_os_plus::micro_test_plus::suite::unlink (void)

noexcept

Removes this suite from the list of suites.

Called by the destructor; a suite that is not in the list, such as the top suite or a suite rejected by the runner, is left unchanged.

Parameters: None.

Returns: Nothing.

Searches the list for the suite and, if found, bypasses it.

Declaration at line 2420 of file test.h, definition at line 760 of file test.cpp.

760 suite::unlink (void) noexcept

761 {

762 for (suite** slot = &first_; *slot != nullptr; slot = &(*slot)->next_)

763 {

764 if (*slot == this)

765 {

766 *slot = next_;

767 next_ = nullptr;

768 return;

769 }

770 }

771 }

References micro_os_plus::micro_test_plus::suite::suite, micro_os_plus::micro_test_plus::suite::first_ and micro_os_plus::micro_test_plus::suite::next_.

Referenced by micro_os_plus::micro_test_plus::suite::~suite and micro_os_plus::micro_test_plus::suite::operator=.

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 micro_os_plus::micro_test_plus::detail::runnable_base::after_test_case_create, micro_os_plus::micro_test_plus::detail::runnable_base::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_;

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_;

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_;

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 micro_os_plus::micro_test_plus::detail::runnable_base::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, micro_os_plus::micro_test_plus::detail::runnable_base::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_;

Private Member Attributes

callable_

std::function<void (suite&)> micro_os_plus::micro_test_plus::suite::callable_

Callable storing the suite body and any bound arguments.

Invoked by run() with a reference to this suite; a static_suite also stores its body here, so all suite callables receive a suite& reference.

Definition at line 2431 of file test.h.

2431 std::function<void (suite&)> callable_;

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

located_name_

located_name micro_os_plus::micro_test_plus::suite::located_name_

The name of the suite, with the location where it was given.

The suites registered with runner::add_suite(), and the static suites, run later, when the argument passed by the caller no longer exists; it is therefore moved here, and the name of the node points into it. The test cases, which run immediately, refer to the argument of test() instead.

Definition at line 2453 of file test.h.

2453 located_name located_name_;

Referenced by micro_os_plus::micro_test_plus::suite::suite and micro_os_plus::micro_test_plus::runner::add_top_suite.

next_

suite* micro_os_plus::micro_test_plus::suite::next_ = nullptr

The next suite in the list of suites.

Null for the last suite, and for the suites not in the list. Set by link() and unlink(), and read by the runner, which is a friend.

Definition at line 2463 of file test.h.

2463 suite* next_ = nullptr;

Referenced by micro_os_plus::micro_test_plus::suite::link, micro_os_plus::micro_test_plus::runner::run_child_suites, micro_os_plus::micro_test_plus::runner::static_suites_count and micro_os_plus::micro_test_plus::suite::unlink.

stopwatch_

detail::stopwatch micro_os_plus::micro_test_plus::suite::stopwatch_

Stopwatch of this suite.

Measures the duration of the suite; started and stopped by run() (by the runner, for the top suite), and read by the reporters, which are friends.

Definition at line 2441 of file test.h.

2441 detail::stopwatch stopwatch_;

Referenced by micro_os_plus::micro_test_plus::runner::add_top_suite, 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::suite::run, micro_os_plus::micro_test_plus::runner::run_suites, micro_os_plus::micro_test_plus::suite::timings and micro_os_plus::micro_test_plus::suite::timings.

Private Static Attributes

first_

suite * micro_os_plus::micro_test_plus::suite::first_ = nullptr

static

The first suite in the list of suites.

The list includes the registered and the static suites of all runners, sorted by name; each runner selects its own. The pointer is constant-initialised (constinit, in src/test.cpp), so it is null before any constructor runs, whatever the order of the static initialisation across translation units.

Constant-initialised, so it is null before any static constructor runs; the static suites constructed before the runner are therefore not lost.

Definition at line 2475 of file test.h.

2475 static suite* first_;

Deprecated Functions of suite

timings()

const detail::stopwatch & micro_os_plus::micro_test_plus::suite::timings (void)

inline nodiscard noexcept

Deprecated access to the timings of the suite.

Returns the internal stopwatch of the suite, started before its body runs and stopped after it; for the top suite, it is started by runner::add_top_suite() and stopped by runner::run_suites(). In v5.0.1, the returned class was detail::timestamps, now a deprecated alias; only its read-only members are kept. The timings are internal; the elapsed times are shown by the reporters.

Parameters: None.

Returns: A const reference to the stopwatch of the suite.

Deprecated: the timings are internal (since 6.0.0)

Returns a const reference to the stopwatch member.

Declaration at line 2325 of file test.h, definition at line 1148 of file test-inlines.h.

1148 suite::timings (void) const noexcept

1149 {

1150 return stopwatch_;

1151 }

Reference micro_os_plus::micro_test_plus::suite::stopwatch_.

Referenced by micro_os_plus::micro_test_plus::suite::operator=.

timings()

detail::stopwatch & micro_os_plus::micro_test_plus::suite::timings (void)

inline nodiscard noexcept

Deprecated access to the timings of the suite, as a non-const reference.

Kept for the v5.0.1 code that binds a non-const reference (detail::timestamps& t = ts.timings ();). The test code must not start or stop the stopwatch through it, since the reporters show its elapsed time.

Parameters: None.

Returns: A reference to the stopwatch of the suite.

Deprecated: the timings are internal (since 6.0.0)

Returns a reference to the stopwatch member.

Declaration at line 2343 of file test.h, definition at line 1159 of file test-inlines.h.

1159 suite::timings (void) noexcept

1160 {

1161 return stopwatch_;

1162 }

Reference micro_os_plus::micro_test_plus::suite::stopwatch_.

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 micro_os_plus::micro_test_plus::detail::runnable_base::child_test_cases_count_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::test_point_number_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::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 micro_os_plus::micro_test_plus::detail::runnable_base::own_index_.

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

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

Generated via doxygen2docusaurus 2.2.8 by Doxygen 1.18.0.

Declaration​

Included Headers​

Base class​

Friends Index​

Public Constructors Index​

Private Constructors Index​

Public Destructor Index​

Public Operators Index​

Public Member Functions Index​

Protected Member Functions Index​

Private Member Functions Index​

Protected Member Attributes Index​

Private Member Attributes Index​

Private Static Attributes Index​

Deprecated Functions of suite Index​

Deprecated Functions of runnable_base Index​

Description​

Friends​

micro_test_plus::runner​

Public Constructors​

top_suite()​

top_suite()​

Private Constructors​

top_suite()​

Public Destructor​

~top_suite()​

Public Operators​

operator=()​

operator=()​

Public Member Functions​

name()​

test()​

test_each()​

test_each()​

totals()​

Protected Member Functions​

accepts_test_case()​

after_test_case_create()​

create_test_case()​

exchange_running_suite()​

has_running_test_case_of()​

is_aborted()​

is_listing()​

next_test_point_number()​

reject_body_exception()​

running_test_case()​

test_reporter()​

test_runner()​

Private Member Functions​

abort()​

fail_unexpected_exception()​

link()​

run()​

unlink()​

Protected Member Attributes​

child_test_cases_count_​

name_​

own_index_​

runner_​

test_point_number_​

totals_​

Private Member Attributes​

callable_​

located_name_​

next_​

stopwatch_​

Private Static Attributes​

first_​

Deprecated Functions of suite​

timings()​

timings()​

Deprecated Functions of runnable_base​

children_subtests_count()​

current_subtest_index()​

own_index()​

Declaration

Included Headers

Base class

Friends Index

Public Constructors Index

Private Constructors Index

Public Destructor Index

Public Operators Index

Public Member Functions Index

Protected Member Functions Index

Private Member Functions Index

Protected Member Attributes Index

Private Member Attributes Index

Private Static Attributes Index

Deprecated Functions of suite Index

Deprecated Functions of runnable_base Index

Description

Friends

micro_test_plus::runner

Public Constructors

top_suite()

top_suite()

Private Constructors

top_suite()

Public Destructor

~top_suite()

Public Operators

operator=()

operator=()

Public Member Functions

name()

test()

test_each()

test_each()

totals()

Protected Member Functions

accepts_test_case()

after_test_case_create()

create_test_case()

exchange_running_suite()

has_running_test_case_of()

is_aborted()

is_listing()

next_test_point_number()

reject_body_exception()

running_test_case()

test_reporter()

test_runner()

Private Member Functions

abort()

fail_unexpected_exception()

link()

run()

unlink()

Protected Member Attributes

child_test_cases_count_

name_

own_index_

runner_

test_point_number_

totals_

Private Member Attributes

callable_

located_name_

next_

stopwatch_

Private Static Attributes

first_

Deprecated Functions of suite

timings()

timings()

Deprecated Functions of runnable_base

children_subtests_count()

current_subtest_index()

own_index()