static_runner Class

A runner variant that also manages statically-registered test suites. More...

Declaration

class micro_os_plus::micro_test_plus::static_runner { ... }

Included Headers

#include <micro-os-plus/micro-test-plus.h>

Base class

class	runner
	The test runner for the µTest++ framework. More...

Public Constructors Index

	static_runner (const char *top_suite_name)
	Constructs the static runner with a top-suite name. More...
	static_runner (const static_runner &)=delete
	Deleted copy constructor to prevent copying. More...
	static_runner (static_runner &&)=delete
	Deleted move constructor to prevent moving. More...
	static_runner (void)
	Constructor for the runner class. More...

Public Destructor Index

	~static_runner () override
	Destructor for the static_runner class. More...

Public Operators Index

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

Public Member Functions Index

void	abort (const reflection::source_location &sl=reflection::source_location::current())
	Aborts test execution immediately. More...
int	exit_code (void)
	Returns 0 if all tests were successful, 1 otherwise. More...
class suite &	initialise (int argc, char *argv[], const char *top_suite_name="")
	Initialises the test runner with command-line arguments. More...
const char *	name (void) const noexcept
	Gets the node name. More...
class reporter &	reporter (void) const noexcept
	Returns a reference to the test reporter. More...
size_t	static_suites_count (void) const noexcept
	Returns the total count of registered static test suites. More...
template <typename Callable_T, typename... Args_T>
void	suite (const char *name, Callable_T &&callable, Args_T &&... arguments)
	Adds a test suite to the runner. More...
size_t	suites_count (void) const noexcept
	Returns the count of test suites. More...
const detail::timestamps &	timings () const noexcept
	Gets the timings for this runner (const overload). More...
detail::timestamps &	timings () noexcept
	Gets the timings for this runner. More...
size_t	total_suites_count (void) const noexcept final override
	Returns the total count of all test suites, including static and dynamic. More...
const runner_totals &	totals () const noexcept
	Gets the totals for the test (const overload). More...
runner_totals &	totals () noexcept
	Gets the totals for the test. More...

Protected Member Functions Index

void	register_suite_ (std::unique_ptr< class suite > suite)
	Registers a test suite with the runner. More...
void	run_suites_ (void) override
	Runs all child suites, including statically registered ones. More...

Protected Member Attributes Index

std::vector< std::unique_ptr< class suite > >	children_suites_
	Owning collection of dynamically registered child suites. More...
const char *	name_
	The test node name. More...
std::unique_ptr< class reporter >	reporter_
	Pointer to the test reporter used for outputting test results. More...
std::vector< static_suite * > *	static_children_suites_
	Pointer to the vector of registered static test suites. More...
detail::timestamps	timings_
	Timings for this runner. More...
class { ... }	top_suite_
	The implicit top-level suite; always present and executed first. More...
std::string	top_suite_name_
	Owned storage for the implicit top-suite name. More...
runner_totals	totals_
	Totals for the test node, including nested cases. More...

Public Static Functions Index

static void	register_static_suite (static_runner &runner, static_suite &suite)
	Registers a static test suite with the runner. More...

Description

A runner variant that also manages statically-registered test suites.

static_runner extends runner to handle static_suite objects that are declared at namespace scope and therefore constructed before or after the runner itself, in unspecified static-initialisation order.

The key design constraint is that static_runner instances must themselves be declared at namespace scope (in the BSS segment), so the pointer static_children_suites_ is zero-initialised by the C runtime before any constructor runs. This ensures that static_suite objects constructed before static_runner can safely append themselves to the vector without losing registrations.

During exit_code(), run_suites_() is called, which first runs all dynamically registered suites (base class behaviour) and then iterates over the statically registered suites.

Definition at line 344 of file runner.h.

Public Constructors

static_runner()

micro_os_plus::micro_test_plus::static_runner::static_runner (const char * top_suite_name)

Constructs the static runner with a top-suite name.

Parameters

top_suite_name

The name of the implicit top-level suite. Defaults to an empty string.

Deprecated

Use the anonymous constructor.

Delegates construction to the runner base class with the given top_suite_name. If tracing is enabled, the function signature and suite name are output for diagnostic purposes.

Declaration at line 363 of file runner.h, definition at line 506 of file runner.cpp.

506 static_runner::static_runner (const char* top_suite_name)

507 : runner{ top_suite_name }

508 {

509#if defined(MICRO_OS_PLUS_TRACE) \

510 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)

511#if defined(__GNUC__)

512#pragma GCC diagnostic push

513#if defined(__clang__)

514#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

515#endif

516#endif

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

518#if defined(__GNUC__)

519#pragma GCC diagnostic pop

520#endif

521#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS

522 }

References micro_os_plus::micro_test_plus::runner::runner and micro_os_plus::micro_test_plus::detail::test_node::name.

static_runner()

micro_os_plus::micro_test_plus::static_runner::static_runner (const static_runner &)

delete

Deleted copy constructor to prevent copying.

Definition at line 368 of file runner.h.

Reference static_runner.

static_runner()

micro_os_plus::micro_test_plus::static_runner::static_runner (static_runner &&)

delete

Deleted move constructor to prevent moving.

Definition at line 373 of file runner.h.

Reference static_runner.

static_runner()

micro_os_plus::micro_test_plus::static_runner::static_runner (void)

Constructor for the runner class.

Parameters

None.

Delegates construction to the runner base class. If tracing is enabled, the function signature and suite name are output for diagnostic purposes.

Declaration at line 353 of file runner.h, definition at line 483 of file runner.cpp.

483 static_runner::static_runner (void) : runner{}

484 {

485#if defined(MICRO_OS_PLUS_TRACE) \

486 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)

487#if defined(__GNUC__)

488#pragma GCC diagnostic push

489#if defined(__clang__)

490#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

491#endif

492#endif

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

494#if defined(__GNUC__)

495#pragma GCC diagnostic pop

496#endif

497#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS

498 }

References micro_os_plus::micro_test_plus::runner::runner and micro_os_plus::micro_test_plus::detail::test_node::name.

Referenced by static_runner, static_runner, operator=, operator= and register_static_suite.

Public Destructor

~static_runner()

micro_os_plus::micro_test_plus::static_runner::~static_runner ()

virtual

Destructor for the static_runner class.

If static_children_suites_ is non-null, the dynamically allocated vector of raw pointers is deleted and the pointer is reset to nullptr. The pointed-to static_suite objects are not deleted, as they are static storage-duration objects. If tracing is enabled, the function signature is output for diagnostic purposes.

Declaration at line 392 of file runner.h, definition at line 532 of file runner.cpp.

532 static_runner::~static_runner ()

533 {

534#if defined(MICRO_OS_PLUS_TRACE) \

535 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)

536 trace::printf ("%s\n", __PRETTY_FUNCTION__);

537#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS

538

539 if (static_children_suites_ != nullptr)

540 {

541 // The tests are static, so we do not delete them, but we need to

542 // delete the array of pointers.

543 delete static_children_suites_;

544 static_children_suites_ = nullptr;

545 }

546 }

Reference static_children_suites_.

Public Operators

operator=()

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

delete

Deleted copy assignment operator to prevent copying.

Definition at line 379 of file runner.h.

Reference static_runner.

operator=()

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

delete

Deleted move assignment operator to prevent moving.

Definition at line 386 of file runner.h.

References micro_os_plus::micro_test_plus::runner::runner, static_runner, register_static_suite, static_suites_count and micro_os_plus::micro_test_plus::runner::suite.

Public Member Functions

abort()

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

Aborts test execution immediately.

Parameters

sl	The source location from which the abort is triggered.

Returns

Nothing.

Prints the source location of the fatal error to stderr and then terminates the process via ::abort().

Declaration at line 210 of file runner.h, definition at line 431 of file runner.cpp.

431 runner::abort (const reflection::source_location& sl)

432 {

433#if defined(MICRO_OS_PLUS_TRACE) \

434 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

435 trace::printf ("%s\n", __PRETTY_FUNCTION__);

436#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

437

438#if defined(__GNUC__)

439#pragma GCC diagnostic push

440#if defined(__clang__)

441#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

442#endif

443#endif

444 fprintf (stderr, "\nerror: test execution aborted at %s:%u\n",

445 reflection::short_name (sl.file_name ()), sl.line ());

446#if defined(__GNUC__)

447#pragma GCC diagnostic pop

448#endif

449

450 ::abort ();

451 }

References micro_os_plus::micro_test_plus::runner::abort, micro_os_plus::micro_test_plus::reflection::source_location::file_name, micro_os_plus::micro_test_plus::reflection::source_location::line and micro_os_plus::micro_test_plus::reflection::short_name.

Referenced by micro_os_plus::micro_test_plus::runner::abort.

exit_code()

int micro_os_plus::micro_test_plus::runner::exit_code (void)

Returns 0 if all tests were successful, 1 otherwise.

Parameters

None.

Returns

Integer exit code representing the overall test result.

Finalises the top suite by recording its end timestamp and notifying the reporter, then accumulates its totals into the runner totals. Subsequently invokes run_suites_() to sort, execute, and accumulate all registered child suites. Finally, records the session end timestamp, notifies the reporter, and returns 0 if all checks passed or 1 otherwise.

Declaration at line 180 of file runner.h, definition at line 384 of file runner.cpp.

384 runner::exit_code (void)

385 {

386#if defined(MICRO_OS_PLUS_TRACE) \

387 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

388 trace::printf ("%s\n", __PRETTY_FUNCTION__);

389#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

390

391 if (reporter_ == nullptr)

392 {

393 fprintf (stderr, "error: test runner not initialised\n");

394 return 1;

395 }

396

397 top_suite_.timings ().timestamp_end ();

398 reporter_->end_suite (top_suite_);

399 totals_ += top_suite_.totals ();

400

401 run_suites_ ();

402

403 timings_.timestamp_end ();

404 reporter_->end_session (*this);

405

406 const int result = totals_.was_successful () ? 0 : 1;

407

408#if defined(MICRO_OS_PLUS_TRACE) \

409 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

410#if defined(__GNUC__)

411#pragma GCC diagnostic push

412#if defined(__clang__)

413#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

414#endif

415#endif

416 trace::printf ("%s -> %d\n", __PRETTY_FUNCTION__, result);

417#if defined(__GNUC__)

418#pragma GCC diagnostic pop

419#endif

420#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

421

422 return result;

423 }

References micro_os_plus::micro_test_plus::runner::reporter_, micro_os_plus::micro_test_plus::runner::run_suites_, micro_os_plus::micro_test_plus::runner::timings_, micro_os_plus::micro_test_plus::runner::top_suite_ and micro_os_plus::micro_test_plus::detail::test_node::totals_.

initialise()

suite & micro_os_plus::micro_test_plus::runner::initialise (int argc, char * argv=[], const char * top_suite_name="")

Initialises the test runner with command-line arguments.

Parameters

argc	The argument count from main().
argv	The argument vector from main().
top_suite_name	The name given to the implicit top suite. Defaults to an empty string.

Returns

Reference to the top-level test suite.

Captures command-line arguments, selects the reporter implementation (human or tap), starts session timing, and emits the initial reporter notifications for the session and top suite.

If the top suite name is not provided, it attempts to derive a name from argv[0] or defaults to "default suite".

If tracing is enabled, the command-line arguments are also logged for diagnostic purposes.

Declaration at line 170 of file runner.h, definition at line 182 of file runner.cpp.

182 runner::initialise (int argc, char* argv[], const char* top_suite_name)

183 {

184#if defined(MICRO_OS_PLUS_TRACE) \

185 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

186 trace::printf ("%s\n", __PRETTY_FUNCTION__);

187#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

188

189#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))

190#if defined(MICRO_OS_PLUS_DEBUG)

191 trace::printf ("argv[");

192 for (int i = 0; i < argc; ++i)

193 {

194 if (i > 0)

195 {

196 trace::printf (", ");

197 }

198 trace::printf ("'%s'", argv[i]);

199 }

200 trace::puts ("]");

201#endif // defined(MICRO_OS_PLUS_DEBUG)

202#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)

203

204 if (strlen (top_suite_name) > 0)

205 {

206 // If provided by this call, use it, possibly override the

207 // deprecated constructor.

208 top_suite_name_ = top_suite_name;

209 top_suite_.name (top_suite_name_.c_str ());

210 }

211 else if (strlen (top_suite_.name ()) == 0)

212 {

213 // If not provided by the constructor or by this call, try to extract a

214 // name from argv[0], which is commonly the executable name. If that

215 // fails, use a default name.

216 if (argc > 0 && argv != nullptr && argv[0] != nullptr)

217 {

218 std::string_view top_suite_name_view{ utility::extract_file_name (

219 argv[0]) };

220

221 const auto dot_pos = top_suite_name_view.rfind ('.');

222 if (dot_pos != std::string_view::npos)

223 {

224 top_suite_name_view = top_suite_name_view.substr (0, dot_pos);

225 }

226

227 top_suite_name_ = top_suite_name_view;

228 }

229 else

230 {

231 top_suite_name_ = "default suite";

232 }

233 top_suite_.name (top_suite_name_.c_str ());

234 }

235

236 std::vector<std::string_view> argvs (argv, argv + argc);

237

238 std::string_view reporter_name{ "tap" };

239 static constexpr std::string_view reporter_prefix{ "--reporter=" };

240 for (size_t i = 0; i < argvs.size (); ++i)

241 {

242 if (argvs[i].starts_with (reporter_prefix))

243 {

244 reporter_name = argvs[i].substr (reporter_prefix.size ());

245 }

246 else if (argvs[i]

247 == reporter_prefix.substr (0, reporter_prefix.size () - 1))

248 {

249 if (i + 1 < argvs.size ())

250 {

251 reporter_name = argvs[++i];

252 }

253 else

254 {

255 fprintf (stderr, "error: --reporter option requires a "

256 "reporter name argument\n");

257 exit (1);

258 }

259 }

260 }

261

262 // Initialise and configure the reporter.

263 if (reporter_name == "human")

264 {

265 reporter_ = std::make_unique<reporter_human> (

266 std::make_unique<std::vector<std::string_view>> (

267 std::move (argvs)));

268 }

269 else if (reporter_name == "tap")

270 {

271 reporter_ = std::make_unique<reporter_tap> (

272 std::make_unique<std::vector<std::string_view>> (

273 std::move (argvs)));

274 }

275 else

276 {

277 fprintf (stderr, "error: unknown reporter '%.*s'\n",

278 static_cast<int> (reporter_name.size ()),

279 reporter_name.data ());

280 exit (1);

281 }

282

283 // ------------------------------------------------------------------------

284

285 timings_.timestamp_begin ();

286 reporter_->begin_session (*this);

287

288 top_suite_.timings ().timestamp_begin ();

289 reporter_->begin_suite (top_suite_);

290

291 return top_suite_;

292 }

References micro_os_plus::micro_test_plus::utility::extract_file_name, micro_os_plus::micro_test_plus::runner::reporter_, micro_os_plus::micro_test_plus::runner::timings_, micro_os_plus::micro_test_plus::runner::top_suite_ and micro_os_plus::micro_test_plus::runner::top_suite_name_.

name()

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

inline nodiscard noexcept

Gets the node name.

Parameters

None.

Returns

A pointer to the null-terminated test node name.

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

Declaration at line 194 of file test.h, definition at line 91 of file test-inlines.h.

91 test_node::name (void) const noexcept

92 {

93 return name_;

94 }

Reference micro_os_plus::micro_test_plus::detail::test_node::name_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable< Self_T >::runnable, micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base, micro_os_plus::micro_test_plus::runner::runner, micro_os_plus::micro_test_plus::runner::runner, static_runner, static_runner, micro_os_plus::micro_test_plus::detail::test_node::test_node, micro_os_plus::micro_test_plus::detail::runnable_base::after_subtest_create_, micro_os_plus::micro_test_plus::reporter_human::begin_subtest, micro_os_plus::micro_test_plus::reporter_tap::begin_subtest, micro_os_plus::micro_test_plus::reporter_human::begin_suite, micro_os_plus::micro_test_plus::reporter_tap::begin_suite, micro_os_plus::micro_test_plus::reporter_human::end_subtest, micro_os_plus::micro_test_plus::reporter_tap::end_subtest, micro_os_plus::micro_test_plus::reporter_human::end_suite, micro_os_plus::micro_test_plus::reporter_tap::end_suite, micro_os_plus::micro_test_plus::runner::operator= and micro_os_plus::micro_test_plus::runner::suite.

reporter()

class reporter & micro_os_plus::micro_test_plus::runner::reporter (void)

inline nodiscard noexcept

Returns a reference to the test reporter.

Parameters

None.

Returns

Reference to the test reporter.

Returns a reference to the reporter object stored in the unique pointer.

Declaration at line 234 of file runner.h, definition at line 76 of file runner-inlines.h.

76 runner::reporter (void) const noexcept

77 {

78 return *reporter_;

79 }

Reference micro_os_plus::micro_test_plus::runner::reporter_.

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

static_suites_count()

size_t micro_os_plus::micro_test_plus::static_runner::static_suites_count (void)

nodiscard noexcept

Returns the total count of registered static test suites.

Parameters

None.

Returns

The total number of registered static test suites.

Returns the number of elements in static_children_suites_, or zero if the vector has not been allocated yet.

Declaration at line 413 of file runner.h, definition at line 554 of file runner.cpp.

554 static_runner::static_suites_count (void) const noexcept

555 {

556 return static_children_suites_ != nullptr

557 ? static_children_suites_->size ()

558 : 0;

559 }

Reference static_children_suites_.

Referenced by operator= and total_suites_count.

suite()

template <typename Callable_T, typename... Args_T>

void micro_os_plus::micro_test_plus::runner::suite (const char * name, Callable_T && callable, Args_T &&... arguments)

Adds a test suite to the runner.

Template Parameters

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

Parameters

[in] name	The test suite name or description, used in reports.
[in] callable	A generic callable object, usually a lambda, invoked to perform the test suite.
[in] arguments	A possibly empty list of arguments to be passed to the callable.

Returns

Nothing.

Constructs a suite object on the heap, binding the callable and any additional arguments, then transfers ownership to the runner via register_suite_(). The suite runs immediately as part of the registration process.

Declaration at line 198 of file runner.h, definition at line 112 of file runner-inlines.h.

112 runner::suite (const char* name, Callable_T&& callable,

113 Args_T&&... arguments)

114 {

115#if defined(MICRO_OS_PLUS_TRACE) \

116 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

117#if defined(__GNUC__)

118#pragma GCC diagnostic push

119#if defined(__clang__)

120#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

121#endif

122#endif

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

124#if defined(__GNUC__)

125#pragma GCC diagnostic pop

126#endif

127#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

128

129 auto child_suite = std::make_unique<class suite> (

130 name, *this, std::forward<Callable_T> (callable),

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

132

133 register_suite_ (std::move (child_suite));

134 }

References micro_os_plus::micro_test_plus::detail::test_node::name and micro_os_plus::micro_test_plus::runner::register_suite_.

Referenced by micro_os_plus::micro_test_plus::runner::operator=, operator=, register_static_suite and micro_os_plus::micro_test_plus::runner::register_suite_.

suites_count()

size_t micro_os_plus::micro_test_plus::runner::suites_count (void)

nodiscard noexcept

Returns the count of test suites.

Parameters

None.

Returns

The number of test suites, including the top one.

Returns the number of registered child suites plus one, accounting for the top suite.

Declaration at line 264 of file runner.h, definition at line 459 of file runner.cpp.

459 runner::suites_count (void) const noexcept

460 {

461 return children_suites_.size () + 1;

462 }

Reference micro_os_plus::micro_test_plus::runner::children_suites_.

Referenced by micro_os_plus::micro_test_plus::runner::operator=, run_suites_, micro_os_plus::micro_test_plus::runner::total_suites_count and total_suites_count.

timings()

const detail::timestamps & micro_os_plus::micro_test_plus::runner::timings ()

inline nodiscard noexcept

Gets the timings for this runner (const overload).

Parameters

None.

Returns

A const reference to the timestamps instance.

Returns a const reference to the timestamps member.

Declaration at line 254 of file runner.h, definition at line 96 of file runner-inlines.h.

96 runner::timings () const noexcept

97 {

98 return timings_;

99 }

Reference micro_os_plus::micro_test_plus::runner::timings_.

timings()

detail::timestamps & micro_os_plus::micro_test_plus::runner::timings ()

inline nodiscard noexcept

Gets the timings for this runner.

Parameters

None.

Returns

A reference to the timestamps instance.

Returns a reference to the timestamps member.

Declaration at line 244 of file runner.h, definition at line 86 of file runner-inlines.h.

86 runner::timings () noexcept

87 {

88 return timings_;

89 }

Reference micro_os_plus::micro_test_plus::runner::timings_.

Referenced by micro_os_plus::micro_test_plus::reporter_human::end_session, micro_os_plus::micro_test_plus::reporter_tap::end_session and micro_os_plus::micro_test_plus::runner::operator=.

total_suites_count()

size_t micro_os_plus::micro_test_plus::static_runner::total_suites_count (void)

nodiscard noexcept virtual

Returns the total count of all test suites, including static and dynamic.

Parameters

None.

Returns

The total number of test suites.

Returns the combined count of dynamically registered suites (from the base runner) and statically registered suites.

Declaration at line 424 of file runner.h, definition at line 567 of file runner.cpp.

567 static_runner::total_suites_count (void) const noexcept

568 {

569 return suites_count () + static_suites_count ();

570 }

References static_suites_count and micro_os_plus::micro_test_plus::runner::suites_count.

totals()

const runner_totals & micro_os_plus::micro_test_plus::detail::test_node::totals ()

inline nodiscard noexcept

Gets the totals for the test (const overload).

Parameters

None.

Returns

A const reference to the runner_totals instance.

Returns a const reference to the runner_totals member.

Declaration at line 215 of file test.h, definition at line 111 of file test-inlines.h.

111 test_node::totals () const noexcept

112 {

113 return totals_;

114 }

Reference micro_os_plus::micro_test_plus::detail::test_node::totals_.

totals()

runner_totals & micro_os_plus::micro_test_plus::detail::test_node::totals ()

inline nodiscard noexcept

Gets the totals for the test.

Parameters

None.

Returns

A reference to the runner_totals instance.

Returns a reference to the runner_totals member.

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

101 test_node::totals () noexcept

102 {

103 return totals_;

104 }

Reference micro_os_plus::micro_test_plus::detail::test_node::totals_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable_base::after_subtest_create_, micro_os_plus::micro_test_plus::reporter_human::end_session, micro_os_plus::micro_test_plus::reporter_tap::end_session, micro_os_plus::micro_test_plus::reporter_human::end_subtest, micro_os_plus::micro_test_plus::reporter_tap::end_subtest, micro_os_plus::micro_test_plus::reporter_human::end_suite, micro_os_plus::micro_test_plus::reporter_tap::end_suite and micro_os_plus::micro_test_plus::detail::test_node::operator=.

Protected Member Functions

register_suite_()

void micro_os_plus::micro_test_plus::runner::register_suite_ (std::unique_ptr< class suite > suite)

protected

Registers a test suite with the runner.

Parameters

[in] suite

Owning pointer to the test suite to register.

Returns

Nothing.

Takes ownership of the supplied suite unique pointer and appends it to the internal children_suites_ vector, deferring execution until run_suites_() is called. If tracing is enabled, the suite name is logged for diagnostic purposes.

Declaration at line 284 of file runner.h, definition at line 307 of file runner.cpp.

307 runner::register_suite_ (std::unique_ptr<class suite> suite)

308 {

309#if defined(MICRO_OS_PLUS_TRACE) \

310 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

311#if defined(__GNUC__)

312#pragma GCC diagnostic push

313#if defined(__clang__)

314#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

315#endif

316#endif

317 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, suite->name ());

318#if defined(__GNUC__)

319#pragma GCC diagnostic pop

320#endif

321#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

322

323 children_suites_.push_back (std::move (suite));

324 }

References micro_os_plus::micro_test_plus::runner::children_suites_ and micro_os_plus::micro_test_plus::runner::suite.

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

run_suites_()

void micro_os_plus::micro_test_plus::static_runner::run_suites_ (void)

protected virtual

Runs all child suites, including statically registered ones.

Parameters

None.

First invokes runner::run_suites_() to execute all dynamically registered child suites. If static_children_suites_ is non-null, its contents are sorted alphabetically by suite name using selection sort on raw pointers, each suite is assigned a 1-based index offset by the dynamic suite count, executed via suite::run(), and its totals are accumulated into the runner totals.

Declaration at line 434 of file runner.h, definition at line 582 of file runner.cpp.

582 static_runner::run_suites_ (void)

583 {

584#if defined(MICRO_OS_PLUS_TRACE) \

585 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

586 trace::printf ("%s\n", __PRETTY_FUNCTION__);

587#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

588

589 runner::run_suites_ ();

590

591 if (static_children_suites_ != nullptr)

592 {

593 // Use selection sort with std::swap on raw pointers (returns void)

594 // to avoid std::sort triggering -Waggregate-return via

595 // std::move_backward returning a class-type iterator.

596 const size_t n = static_children_suites_->size ();

597 auto& suites = *static_children_suites_;

598 for (size_t i = 0; i < n; ++i)

599 {

600 size_t min_idx = i;

601 for (size_t j = i + 1; j < n; ++j)

602 {

603 if (std::string_view{ suites[j]->name () }

604 < std::string_view{ suites[min_idx]->name () })

605 min_idx = j;

606 }

607 if (min_idx != i)

608 std::swap (suites[i], suites[min_idx]);

609 }

610

611 for (size_t i = 0; i < n; ++i)

612 {

613 auto* suite_ptr = suites[i];

614

615 suite_ptr->own_index (i + 1 + suites_count ());

616

617 // Run the child suite immediately.

618 suite_ptr->run ();

619

620 // Accumulate the totals from the static suite into the runner

621 // totals.

622 // DO NOT increment executed_subtests here.

623 totals_ += suite_ptr->totals ();

624 }

625 }

626 }

References micro_os_plus::micro_test_plus::runner::run_suites_, static_children_suites_, micro_os_plus::micro_test_plus::runner::suites_count and micro_os_plus::micro_test_plus::detail::test_node::totals_.

Protected Member Attributes

children_suites_

std::vector<std::unique_ptr<class suite> > micro_os_plus::micro_test_plus::runner::children_suites_

protected

Owning collection of dynamically registered child suites.

Each call to runner::suite() appends a new suite to this vector and runs it immediately. The vector retains ownership of all suites for the lifetime of the runner.

Definition at line 301 of file runner.h.

301 std::vector<std::unique_ptr<class suite>> children_suites_;

Referenced by micro_os_plus::micro_test_plus::runner::register_suite_, micro_os_plus::micro_test_plus::runner::run_suites_ and micro_os_plus::micro_test_plus::runner::suites_count.

name_

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

protected

The test node name.

info

Derived classes may access this member directly in addition to the public name() getter.

Definition at line 224 of file test.h.

224 const char* name_;

Referenced by micro_os_plus::micro_test_plus::detail::test_node::test_node, micro_os_plus::micro_test_plus::detail::runnable< Self_T >::~runnable, micro_os_plus::micro_test_plus::detail::runnable_base::~runnable_base, micro_os_plus::micro_test_plus::detail::test_node::~test_node and micro_os_plus::micro_test_plus::detail::test_node::name.

reporter_

std::unique_ptr<class reporter> micro_os_plus::micro_test_plus::runner::reporter_

protected

Pointer to the test reporter used for outputting test results.

Definition at line 306 of file runner.h.

306 std::unique_ptr<class reporter> reporter_;

Referenced by micro_os_plus::micro_test_plus::runner::exit_code, micro_os_plus::micro_test_plus::runner::initialise and micro_os_plus::micro_test_plus::runner::reporter.

static_children_suites_

std::vector<static_suite*>* micro_os_plus::micro_test_plus::static_runner::static_children_suites_

protected

Pointer to the vector of registered static test suites.

static_runner instances are always declared at namespace scope, so this pointer lives in the BSS segment and is zero-initialised before any constructor runs. This guarantees that static test suites registered before this runner's constructor executes (due to unspecified static initialisation order across translation units) are not lost. The pointer MUST NOT carry an explicit default member initialiser, as that would run during construction and could overwrite a value already set by an earlier-constructed static_suite.

Definition at line 450 of file runner.h.

450 std::vector<static_suite*>* static_children_suites_;

Referenced by ~static_runner, run_suites_ and static_suites_count.

timings_

detail::timestamps micro_os_plus::micro_test_plus::runner::timings_

protected

Timings for this runner.

Definition at line 311 of file runner.h.

311 detail::timestamps timings_;

Referenced by micro_os_plus::micro_test_plus::runner::exit_code, micro_os_plus::micro_test_plus::runner::initialise, micro_os_plus::micro_test_plus::runner::timings and micro_os_plus::micro_test_plus::runner::timings.

top_suite_

class top_suite micro_os_plus::micro_test_plus::runner::top_suite_

protected

The implicit top-level suite; always present and executed first.

Definition at line 291 of file runner.h.

291 class top_suite top_suite_;

Referenced by micro_os_plus::micro_test_plus::runner::runner, micro_os_plus::micro_test_plus::runner::runner, micro_os_plus::micro_test_plus::runner::exit_code and micro_os_plus::micro_test_plus::runner::initialise.

top_suite_name_

std::string micro_os_plus::micro_test_plus::runner::top_suite_name_

protected

Owned storage for the implicit top-suite name.

Definition at line 316 of file runner.h.

316 std::string top_suite_name_;

Referenced by micro_os_plus::micro_test_plus::runner::initialise.

totals_

runner_totals micro_os_plus::micro_test_plus::detail::test_node::totals_

protected

Totals for the test node, including nested cases.

Definition at line 229 of file test.h.

229 runner_totals totals_;

Referenced by micro_os_plus::micro_test_plus::runner::exit_code, micro_os_plus::micro_test_plus::runner::run_suites_, run_suites_, micro_os_plus::micro_test_plus::detail::test_node::totals and micro_os_plus::micro_test_plus::detail::test_node::totals.

Public Static Functions

register_static_suite()

void micro_os_plus::micro_test_plus::static_runner::register_static_suite (static_runner & runner, static_suite & suite)

static

Registers a static test suite with the runner.

Parameters

[in] runner	The static runner instance.
[in] suite	The static test suite to register.

If runner.static_children_suites_ is null, a new std::vector<static_suite*> is heap-allocated and assigned to it. The address of suite is then appended to the vector. This method is intended to be called from the constructor of static_suite, before test execution begins.

Declaration at line 403 of file runner.h, definition at line 637 of file runner.cpp.

637 static_runner::register_static_suite (static_runner& runner,

638 static_suite& suite)

639 {

640#if defined(MICRO_OS_PLUS_TRACE) \

641 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

642#if defined(__GNUC__)

643#pragma GCC diagnostic push

644#if defined(__clang__)

645#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"

646#endif

647#endif

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

649#if defined(__GNUC__)

650#pragma GCC diagnostic pop

651#endif

652#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

653

654 if (runner.static_children_suites_ == nullptr)

655 {

656#if defined(MICRO_OS_PLUS_TRACE) \

657 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

658 trace::printf ("%s new static_children_suites_ array\n",

659 __PRETTY_FUNCTION__);

660#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

661 runner.static_children_suites_ = new std::vector<static_suite*>;

662 }

663 runner.static_children_suites_->push_back (&suite);

664 }

References micro_os_plus::micro_test_plus::runner::runner, static_runner and micro_os_plus::micro_test_plus::runner::suite.

Referenced by operator= and micro_os_plus::micro_test_plus::detail::register_static_suite.

---

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

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

---

Generated via doxygen2docusaurus 2.2.0 by Doxygen 1.17.0.