micro-test-plus 4.1.1
µTest++ Testing Framework
Loading...
Searching...
No Matches
micro_os_plus::micro_test_plus::runner Class Reference
µOS++ Topics » µTest++ » C++ API » Test Runners

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

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

Inheritance diagram for micro_os_plus::micro_test_plus::runner:

Public Member Functions

 runner (const char *top_suite_name)
 Deprecated constructor for the runner class.
 runner (const runner &)=delete
 Deleted copy constructor to prevent copying.
 runner (runner &&)=delete
 Deleted move constructor to prevent moving.
 runner (void)
 Constructor for the runner class.
virtual ~runner () override
 Destructor for the runner class.
void abort (const reflection::source_location &sl=reflection::source_location::current())
 Aborts test execution immediately.
int exit_code (void)
 Returns 0 if all tests were successful, 1 otherwise.
class suite & initialise (int argc, char *argv[], const char *top_suite_name="")
 Initialises the test runner with command-line arguments.
const char * name (void) const noexcept
 Gets the node name.
runner & operator= (const runner &)=delete
 Deleted copy assignment operator to prevent copying.
runner & operator= (runner &&)=delete
 Deleted move assignment operator to prevent moving.
class reporter & reporter (void) const noexcept
 Returns a reference to the test reporter.
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.
size_t suites_count (void) const noexcept
 Returns the count of test suites.
const detail::timestamps & timings () const noexcept
 Gets the timings for this runner (const overload).
detail::timestamps & timings () noexcept
 Gets the timings for this runner.
virtual size_t total_suites_count (void) const noexcept
 Returns the total count of registered test suites.
const runner_totals & totals () const noexcept
 Gets the totals for the test (const overload).
runner_totals & totals () noexcept
 Gets the totals for the test.

Protected Member Functions

void register_suite_ (std::unique_ptr< class suite > suite)
 Registers a test suite with the runner.
virtual void run_suites_ (void)
 Runs all registered test suites.

Protected Attributes

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

Detailed Description

The runner class is responsible for managing the registration and execution of test suites within the µTest++ framework. It maintains a collection of test suites, each of which registers itself automatically upon construction, enabling seamless integration and execution of tests across different components and folders of a project.

The test runner provides methods for initialising the test environment, registering test suites, retrieving the runner's name, and determining the overall test result via an exit code. It also offers an abort mechanism for terminating test execution in exceptional circumstances.

All members and methods are defined within the micro_os_plus::micro_test_plus namespace, ensuring clear separation from user code and minimising the risk of naming conflicts.

Definition at line 110 of file runner.h.

Constructor & Destructor Documentation

◆ runner() [1/4]

micro_os_plus::micro_test_plus::runner::runner ( void )
Parameters
None.

The constructor initialises a new runner instance together with its top suite (top_suite_). If tracing is enabled, it outputs the function signature for diagnostic purposes.

Definition at line 116 of file runner.cpp.

116 : test_node{ "runner" }, top_suite_{ "", *this }
117 {
118#if defined(MICRO_OS_PLUS_TRACE) \
119 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
120#if defined(__GNUC__)
121#pragma GCC diagnostic push
122#if defined(__clang__)
123#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
124#endif
125#endif
126 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name ());
127#if defined(__GNUC__)
128#pragma GCC diagnostic pop
129#endif
130#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
131 }
micro_os_plus::micro_test_plus::detail::test_node::name
const char * name(void) const noexcept
Gets the node name.
Definition test-inlines.h:92
micro_os_plus::micro_test_plus::detail::test_node::test_node
test_node(const char *name)
Constructs a test node.
Definition test.cpp:93
micro_os_plus::micro_test_plus::runner::top_suite_
class top_suite top_suite_
The implicit top-level suite; always present and executed first.
Definition runner.h:291

References micro_os_plus::micro_test_plus::detail::test_node::test_node(), micro_os_plus::micro_test_plus::detail::test_node::name(), and top_suite_.

Referenced by runner(), runner(), micro_os_plus::micro_test_plus::static_runner::static_runner(), micro_os_plus::micro_test_plus::static_runner::static_runner(), operator=(), operator=(), micro_os_plus::micro_test_plus::static_runner::operator=(), and micro_os_plus::micro_test_plus::static_runner::register_static_suite().

◆ runner() [2/4]

micro_os_plus::micro_test_plus::runner::runner ( const char * top_suite_name)
Parameters
[in]top_suite_nameThe name given to the implicit top suite. Defaults to an empty string.
Deprecated
Use the anonymous constructor.

The constructor initialises a new runner instance together with its top suite (top_suite_). If tracing is enabled, it outputs the function signature for diagnostic purposes.

Definition at line 139 of file runner.cpp.

140 : test_node{ "runner" }, top_suite_{ top_suite_name, *this }
141 {
142#if defined(MICRO_OS_PLUS_TRACE) \
143 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
144#if defined(__GNUC__)
145#pragma GCC diagnostic push
146#if defined(__clang__)
147#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
148#endif
149#endif
150 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name ());
151#if defined(__GNUC__)
152#pragma GCC diagnostic pop
153#endif
154#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
155 }

References micro_os_plus::micro_test_plus::detail::test_node::test_node(), micro_os_plus::micro_test_plus::detail::test_node::name(), and top_suite_.

◆ runner() [3/4]

micro_os_plus::micro_test_plus::runner::runner ( const runner & )
delete

References runner().

◆ runner() [4/4]

micro_os_plus::micro_test_plus::runner::runner ( runner && )
delete

References runner().

◆ ~runner()

micro_os_plus::micro_test_plus::runner::~runner ( )
overridevirtual

The reporter_ unique pointer is released automatically. If tracing is enabled, the function signature is output for diagnostic purposes.

Definition at line 162 of file runner.cpp.

163 {
164#if defined(MICRO_OS_PLUS_TRACE) \
165 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
166 trace::printf ("%s\n", __PRETTY_FUNCTION__);
167#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
168
169 // reporter_ is a unique_ptr; destroyed automatically.
170 }

Member Function Documentation

◆ abort()

void micro_os_plus::micro_test_plus::runner::abort ( const reflection::source_location & sl = reflection::source_location::current ())
Parameters
slThe 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().

Definition at line 440 of file runner.cpp.

441 {
442#if defined(MICRO_OS_PLUS_TRACE) \
443 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
444 trace::printf ("%s\n", __PRETTY_FUNCTION__);
445#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
446
447#if defined(__GNUC__)
448#pragma GCC diagnostic push
449#if defined(__clang__)
450#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
451#endif
452#endif
453 fprintf (stderr, "\nerror: test execution aborted at %s:%u\n",
454 reflection::short_name (sl.file_name ()), sl.line ());
455#if defined(__GNUC__)
456#pragma GCC diagnostic pop
457#endif
458
459 ::abort ();
460 }
micro_os_plus::micro_test_plus::runner::abort
void abort(const reflection::source_location &sl=reflection::source_location::current())
Aborts test execution immediately.
Definition runner.cpp:440
micro_os_plus::micro_test_plus::reflection::short_name
const char * short_name(const char *name) noexcept
Extract a short type or function name from a fully qualified name.
Definition reflection.cpp:82

References 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 abort().

◆ exit_code()

int micro_os_plus::micro_test_plus::runner::exit_code ( void )
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.

Definition at line 393 of file runner.cpp.

394 {
395#if defined(MICRO_OS_PLUS_TRACE) \
396 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
397 trace::printf ("%s\n", __PRETTY_FUNCTION__);
398#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
399
400 if (reporter_ == nullptr)
401 {
402 fprintf (stderr, "error: test runner not initialised\n");
403 return 1;
404 }
405
406 top_suite_.timings ().timestamp_end ();
407 reporter_->end_suite (top_suite_);
408 totals_ += top_suite_.totals ();
409
410 run_suites_ ();
411
412 timings_.timestamp_end ();
413 reporter_->end_session (*this);
414
415 const int result = totals_.was_successful () ? 0 : 1;
416
417#if defined(MICRO_OS_PLUS_TRACE) \
418 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
419#if defined(__GNUC__)
420#pragma GCC diagnostic push
421#if defined(__clang__)
422#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
423#endif
424#endif
425 trace::printf ("%s -> %d\n", __PRETTY_FUNCTION__, result);
426#if defined(__GNUC__)
427#pragma GCC diagnostic pop
428#endif
429#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
430
431 return result;
432 }
micro_os_plus::micro_test_plus::detail::test_node::totals_
runner_totals totals_
Totals for the test node, including nested cases.
Definition test.h:229
micro_os_plus::micro_test_plus::runner::timings_
detail::timestamps timings_
Timings for this runner.
Definition runner.h:311
micro_os_plus::micro_test_plus::runner::reporter_
std::unique_ptr< class reporter > reporter_
Pointer to the test reporter used for outputting test results.
Definition runner.h:306
micro_os_plus::micro_test_plus::runner::run_suites_
virtual void run_suites_(void)
Runs all registered test suites.
Definition runner.cpp:346

References reporter_, run_suites_(), timings_, 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 = "" )
Parameters
argcThe argument count from main().
argvThe argument vector from main().
top_suite_nameThe 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.

Definition at line 191 of file runner.cpp.

192 {
193#if defined(MICRO_OS_PLUS_TRACE) \
194 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
195 trace::printf ("%s\n", __PRETTY_FUNCTION__);
196#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
197
198#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))
199#if defined(MICRO_OS_PLUS_DEBUG)
200 trace::printf ("argv[");
201 for (int i = 0; i < argc; ++i)
202 {
203 if (i > 0)
204 {
205 trace::printf (", ");
206 }
207 trace::printf ("'%s'", argv[i]);
208 }
209 trace::puts ("]");
210#endif // defined(MICRO_OS_PLUS_DEBUG)
211#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
212
213 if (strlen (top_suite_name) > 0)
214 {
215 // If provided by this call, use it, possibly override the
216 // deprecated constructor.
217 top_suite_name_ = top_suite_name;
218 top_suite_.name (top_suite_name_.c_str ());
219 }
220 else if (strlen (top_suite_.name ()) == 0)
221 {
222 // If not provided by the constructor or by this call, try to extract a
223 // name from argv[0], which is commonly the executable name. If that
224 // fails, use a default name.
225 if (argc > 0 && argv != nullptr && argv[0] != nullptr)
226 {
227 std::string_view top_suite_name_view{ utility::extract_file_name (
228 argv[0]) };
229
230 const auto dot_pos = top_suite_name_view.rfind ('.');
231 if (dot_pos != std::string_view::npos)
232 {
233 top_suite_name_view = top_suite_name_view.substr (0, dot_pos);
234 }
235
236 top_suite_name_ = top_suite_name_view;
237 }
238 else
239 {
240 top_suite_name_ = "default suite";
241 }
242 top_suite_.name (top_suite_name_.c_str ());
243 }
244
245 std::vector<std::string_view> argvs (argv, argv + argc);
246
247 std::string_view reporter_name{ "tap" };
248 static constexpr std::string_view reporter_prefix{ "--reporter=" };
249 for (size_t i = 0; i < argvs.size (); ++i)
250 {
251 if (argvs[i].starts_with (reporter_prefix))
252 {
253 reporter_name = argvs[i].substr (reporter_prefix.size ());
254 }
255 else if (argvs[i]
256 == reporter_prefix.substr (0, reporter_prefix.size () - 1))
257 {
258 if (i + 1 < argvs.size ())
259 {
260 reporter_name = argvs[++i];
261 }
262 else
263 {
264 fprintf (stderr, "error: --reporter option requires a "
265 "reporter name argument\n");
266 exit (1);
267 }
268 }
269 }
270
271 // Initialise and configure the reporter.
272 if (reporter_name == "human")
273 {
274 reporter_ = std::make_unique<reporter_human> (
275 std::make_unique<std::vector<std::string_view>> (
276 std::move (argvs)));
277 }
278 else if (reporter_name == "tap")
279 {
280 reporter_ = std::make_unique<reporter_tap> (
281 std::make_unique<std::vector<std::string_view>> (
282 std::move (argvs)));
283 }
284 else
285 {
286 fprintf (stderr, "error: unknown reporter '%.*s'\n",
287 static_cast<int> (reporter_name.size ()),
288 reporter_name.data ());
289 exit (1);
290 }
291
292 // ------------------------------------------------------------------------
293
294 timings_.timestamp_begin ();
295 reporter_->begin_session (*this);
296
297 top_suite_.timings ().timestamp_begin ();
298 reporter_->begin_suite (top_suite_);
299
300 return top_suite_;
301 }
micro_os_plus::micro_test_plus::runner::top_suite_name_
std::string top_suite_name_
Owned storage for the implicit top-suite name.
Definition runner.h:316
micro_os_plus::micro_test_plus::utility::extract_file_name
const char * extract_file_name(const char *path) noexcept
Extracts the file name component from a full path.
Definition utility.cpp:93

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

◆ name()

const char * micro_os_plus::micro_test_plus::detail::test_node::name ( void ) const
inlinenodiscardnoexceptinherited
Parameters
None.
Returns
A pointer to the null-terminated test node name.

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

Definition at line 92 of file test-inlines.h.

93 {
94 return name_;
95 }
micro_os_plus::micro_test_plus::detail::test_node::name_
const char * name_
The test node name.
Definition test.h:224

References 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(), micro_os_plus::micro_test_plus::static_runner::static_runner(), micro_os_plus::micro_test_plus::static_runner::static_runner(), 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().

◆ operator=() [1/2]

runner & micro_os_plus::micro_test_plus::runner::operator= ( const runner & )
delete

References runner().

◆ operator=() [2/2]

runner & micro_os_plus::micro_test_plus::runner::operator= ( runner && )
delete

References runner(), micro_os_plus::micro_test_plus::reflection::source_location::current(), micro_os_plus::micro_test_plus::detail::test_node::name(), register_suite_(), reporter(), run_suites_(), suite(), suites_count(), and timings().

◆ register_suite_()

void micro_os_plus::micro_test_plus::runner::register_suite_ ( std::unique_ptr< class suite > suite)
protected
Parameters
[in]suiteOwning 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.

Definition at line 316 of file runner.cpp.

317 {
318#if defined(MICRO_OS_PLUS_TRACE) \
319 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
320#if defined(__GNUC__)
321#pragma GCC diagnostic push
322#if defined(__clang__)
323#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
324#endif
325#endif
326 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, suite->name ());
327#if defined(__GNUC__)
328#pragma GCC diagnostic pop
329#endif
330#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
331
332 children_suites_.push_back (std::move (suite));
333 }
micro_os_plus::micro_test_plus::runner::suite
void suite(const char *name, Callable_T &&callable, Args_T &&... arguments)
Adds a test suite to the runner.
Definition runner-inlines.h:113
micro_os_plus::micro_test_plus::runner::children_suites_
std::vector< std::unique_ptr< class suite > > children_suites_
Owning collection of dynamically registered child suites.
Definition runner.h:301

References children_suites_, and suite().

Referenced by operator=(), and suite().

◆ reporter()

class reporter & micro_os_plus::micro_test_plus::runner::reporter ( void ) const
inlinenodiscardnoexcept
Parameters
None.
Returns
Reference to the test reporter.

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

Definition at line 77 of file runner-inlines.h.

78 {
79 return *reporter_;
80 }

References reporter_.

Referenced by operator=().

◆ run_suites_()

void micro_os_plus::micro_test_plus::runner::run_suites_ ( void )
protectedvirtual
Parameters
None.

Sorts children_suites_ alphabetically by suite name using a selection sort on unique_ptr::swap, avoiding the -Waggregate-return diagnostic that std::sort would trigger on unique-pointer iterators. Each suite is assigned a 1-based index offset by the top-suite index, executed via suite::run(), and its totals are accumulated into the runner totals. The executed-subtest counter is not incremented; suites are not counted as subtests.

Reimplemented in micro_os_plus::micro_test_plus::static_runner.

Definition at line 346 of file runner.cpp.

347 {
348 // Use selection sort with unique_ptr::swap (returns void) to avoid
349 // std::sort triggering -Waggregate-return via std::move_backward,
350 // which returns a class-type iterator when operating on unique_ptr
351 // elements.
352 const size_t n = children_suites_.size ();
353 for (size_t i = 0; i < n; ++i)
354 {
355 size_t min_idx = i;
356 for (size_t j = i + 1; j < n; ++j)
357 {
358 if (std::string_view{ children_suites_[j]->name () }
359 < std::string_view{ children_suites_[min_idx]->name () })
360 min_idx = j;
361 }
362 if (min_idx != i)
363 children_suites_[i].swap (children_suites_[min_idx]);
364 }
365
366 for (size_t i = 0; i < n; ++i)
367 {
368 auto* suite_ptr = children_suites_[i].get ();
369
370 // +1 for 1-based index, +1 for top suite
371 suite_ptr->own_index (i + 1 + 1);
372
373 // Run the child suite immediately.
374 suite_ptr->run ();
375
376 // Accumulate the totals from the child suite into the runner
377 // totals.
378 // DO NOT increment executed_subtests here.
379 totals_ += suite_ptr->totals ();
380 }
381 }

References children_suites_, and micro_os_plus::micro_test_plus::detail::test_node::totals_.

Referenced by exit_code(), operator=(), and micro_os_plus::micro_test_plus::static_runner::run_suites_().

◆ 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 )
Template Parameters
Callable_TThe type of a callable object.
Args_TThe types of the callable arguments.
Parameters
[in]nameThe test suite name or description, used in reports.
[in]callableA generic callable object, usually a lambda, invoked to perform the test suite.
[in]argumentsA 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.

Definition at line 113 of file runner-inlines.h.

115 {
116#if defined(MICRO_OS_PLUS_TRACE) \
117 && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
118#if defined(__GNUC__)
119#pragma GCC diagnostic push
120#if defined(__clang__)
121#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
122#endif
123#endif
124 trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name);
125#if defined(__GNUC__)
126#pragma GCC diagnostic pop
127#endif
128#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
129
130 auto child_suite = std::make_unique<class suite> (
131 name, *this, std::forward<Callable_T> (callable),
132 std::forward<Args_T> (arguments)...);
133
134 register_suite_ (std::move (child_suite));
135 }
micro_os_plus::micro_test_plus::runner::register_suite_
void register_suite_(std::unique_ptr< class suite > suite)
Registers a test suite with the runner.
Definition runner.cpp:316

References micro_os_plus::micro_test_plus::detail::test_node::name(), and register_suite_().

Referenced by operator=(), micro_os_plus::micro_test_plus::static_runner::operator=(), micro_os_plus::micro_test_plus::static_runner::register_static_suite(), and register_suite_().

◆ suites_count()

size_t micro_os_plus::micro_test_plus::runner::suites_count ( void ) const
nodiscardnoexcept
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.

Definition at line 468 of file runner.cpp.

469 {
470 return children_suites_.size () + 1;
471 }

References children_suites_.

Referenced by operator=(), micro_os_plus::micro_test_plus::static_runner::run_suites_(), total_suites_count(), and micro_os_plus::micro_test_plus::static_runner::total_suites_count().

◆ timings() [1/2]

const detail::timestamps & micro_os_plus::micro_test_plus::runner::timings ( ) const
inlinenodiscardnoexcept
Parameters
None.
Returns
A const reference to the timestamps instance.

Returns a const reference to the timestamps member.

Definition at line 97 of file runner-inlines.h.

98 {
99 return timings_;
100 }

References timings_.

◆ timings() [2/2]

detail::timestamps & micro_os_plus::micro_test_plus::runner::timings ( )
inlinenodiscardnoexcept
Parameters
None.
Returns
A reference to the timestamps instance.

Returns a reference to the timestamps member.

Definition at line 87 of file runner-inlines.h.

88 {
89 return timings_;
90 }

References timings_.

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

◆ total_suites_count()

size_t micro_os_plus::micro_test_plus::runner::total_suites_count ( void ) const
nodiscardvirtualnoexcept
Parameters
None.
Returns
The total number of test suites managed by this runner.

For the base runner, the total suite count equals suites_count(), as there are no additional static suites.

Reimplemented in micro_os_plus::micro_test_plus::static_runner.

Definition at line 479 of file runner.cpp.

480 {
481 return suites_count ();
482 }
micro_os_plus::micro_test_plus::runner::suites_count
size_t suites_count(void) const noexcept
Returns the count of test suites.
Definition runner.cpp:468

References suites_count().

Referenced by micro_os_plus::micro_test_plus::reporter_human::end_session(), and micro_os_plus::micro_test_plus::reporter_tap::end_session().

◆ totals() [1/2]

const runner_totals & micro_os_plus::micro_test_plus::detail::test_node::totals ( ) const
inlinenodiscardnoexceptinherited
Parameters
None.
Returns
A const reference to the runner_totals instance.

Returns a const reference to the runner_totals member.

Definition at line 112 of file test-inlines.h.

113 {
114 return totals_;
115 }

References totals_.

◆ totals() [2/2]

runner_totals & micro_os_plus::micro_test_plus::detail::test_node::totals ( )
inlinenodiscardnoexceptinherited
Parameters
None.
Returns
A reference to the runner_totals instance.

Returns a reference to the runner_totals member.

Definition at line 102 of file test-inlines.h.

103 {
104 return totals_;
105 }

References 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 operator=().

Member Data Documentation

◆ children_suites_

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

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.

Referenced by register_suite_(), run_suites_(), and suites_count().

◆ name_

const char* micro_os_plus::micro_test_plus::detail::test_node::name_
protectedinherited
Note
Derived classes may access this member directly in addition to the public name() getter.

Definition at line 224 of file test.h.

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

◆ reporter_

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

Definition at line 306 of file runner.h.

Referenced by exit_code(), initialise(), and reporter().

◆ timings_

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

Definition at line 311 of file runner.h.

Referenced by exit_code(), initialise(), timings(), and timings().

◆ top_suite_

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

Definition at line 291 of file runner.h.

Referenced by runner(), runner(), exit_code(), and initialise().

◆ top_suite_name_

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

Definition at line 316 of file runner.h.

Referenced by initialise().

◆ totals_

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

Definition at line 229 of file test.h.

Referenced by micro_os_plus::micro_test_plus::runner::exit_code(), micro_os_plus::micro_test_plus::runner::run_suites_(), micro_os_plus::micro_test_plus::static_runner::run_suites_(), totals(), and totals().

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