micro_os_plus::micro_test_plus::top_suite Class Reference

The implicit top-level suite owned by every runner instance. More...

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

Inheritance diagram for micro_os_plus::micro_test_plus::top_suite:

Public Member Functions
	top_suite (const char *name, class runner &runner)
	Constructs the top-level suite with a name and runner reference.
	top_suite (const top_suite &)=delete
	Deleted copy constructor to prevent copying.
	top_suite (top_suite &&)=delete
	Deleted move constructor to prevent moving.
virtual	~top_suite () override
	Virtual destructor.
void	abort (const reflection::source_location &sl=reflection::source_location::current())
	Aborts test execution via the owning runner.
size_t	children_subtests_count (void) const noexcept
	Returns the number of direct child subtests owned by this node.
size_t	current_subtest_index () const noexcept
	Returns the index of the most recently created child subtest.
size_t	increment_subtest_index () noexcept
	Increments and returns the child subtest sequential index.
void	name (const char *new_name) noexcept
	Sets the name of the top-level suite.
const char *	name (void) const noexcept
	Gets the node name.
top_suite &	operator= (const top_suite &)=delete
	Deleted copy assignment operator to prevent copying.
top_suite &	operator= (top_suite &&)=delete
	Deleted move assignment operator to prevent moving.
size_t	own_index () const noexcept
	Returns the positional index of this object within its parent.
void	own_index (size_t index) noexcept
	Sets the positional index of this object within its parent.
class reporter &	reporter (void) const noexcept
	Gets the test reporter associated with this test runnable.
virtual void	run (void) override
	Executes the suite body by invoking the stored callable.
class runner &	runner (void) const noexcept
	Gets the test runner associated with this test runnable.
template<typename Callable_T, typename... Args_T>
void	test (const char *name, Callable_T &&callable, Args_T &&... arguments)
	Adds a test case to the suite.
const detail::timestamps &	timings () const noexcept
	Gets the timings for this suite (const overload).
detail::timestamps &	timings () noexcept
	Gets the timings for this suite.
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	after_subtest_create_ (std::unique_ptr< subtest > child_test, suite &suite)
	Registers a newly constructed child subtest and executes it immediately.

Protected Attributes
std::function< void(suite &)>	callable_
	Callable storing the test body and any bound arguments. Invoked with a reference to the derived Self_T instance.
std::vector< std::unique_ptr< subtest > >	children_subtests_
	Owning collection of direct child subtests.
size_t	current_subtest_index_
	The subtest index, counting from 1.
const char *	name_
	The test node name.
size_t	own_index_
	The test index, counting from 1.
class runner &	runner_
	Reference to the test runner that owns this object.
detail::timestamps	timings_
	Timing measurements for this suite's execution.
runner_totals	totals_
	Totals for the test node, including nested cases.

Detailed Description

top_suite is a thin specialisation of suite used as the implicit root context for the runner. It is created by the runner constructor and is available to user code via runner::initialise(), which returns a reference to it. Unlike regular suite objects, top_suite is not stored in the runner's child-suite vector; instead it is a direct member of runner.

Users do not normally construct top_suite directly.

Definition at line 838 of file test.h.

Constructor & Destructor Documentation

top_suite() [1/3]

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

Parameters

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

Initialises the base suite with name, the given runner, and a no-op callable. Sets own_index to 1, reserving index 0 for the runner itself. If tracing is enabled, the name is output for diagnostic purposes.

Definition at line 397 of file test.cpp.

      : suite{ name, runner, [] (suite&) noexcept {} }
  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
    trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
 
    own_index (1);
  }

References micro_os_plus::micro_test_plus::suite::suite(), name(), and micro_os_plus::micro_test_plus::detail::runnable< suite >::own_index().

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

top_suite() [2/3]

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

delete

References top_suite().

top_suite() [3/3]

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

delete

References top_suite().

~top_suite()

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

overridevirtual

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.

Definition at line 423 of file test.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
    trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name_);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
  }

References micro_os_plus::micro_test_plus::detail::runnable< suite >::name_.

Member Function Documentation

abort()

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

inherited

Parameters

sl	The source location from which the abort is triggered.

Returns

Does not return.

Delegates immediately to runner_.abort(), passing the supplied source location so that the error message identifies the call site before the process is terminated via ::abort().

Definition at line 369 of file test.cpp.

    {
      runner_.abort (sl);
    }

after_subtest_create_()

void micro_os_plus::micro_test_plus::detail::runnable_base::after_subtest_create_ ( std::unique_ptr< subtest > child_test, suite & suite )

protectedinherited

Parameters

child_test	Owning pointer to the newly created subtest.
suite	The parent suite to which execution results are reported.

Returns

Nothing.

Transfers ownership of child_test into children_subtests_ and immediately invokes subtest::run() on the newly stored subtest. The parent's executed-subtest counter is then incremented. The child's check counters are intentionally not merged into the parent totals; each subtest 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 subtests.

Definition at line 394 of file test.cpp.

    {
      // Transfer ownership into the vector.
      children_subtests_.push_back (std::move (child_test));
 
      // Run the child test case immediately.
      class subtest& subtest = *children_subtests_.back ();
      subtest.run ();
 
      // This test executed one more subtest.
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
      trace::printf ("%s subtest '%s' executed one more subtest\n",
                     __PRETTY_FUNCTION__, name ());
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
      totals ().increment_executed_subtests ();
      // Do not accumulate the totals from the child test into the current test
      // totals, each subtest shows only its counters.
 
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
      trace::printf ("%s suite '%s' totals\n", __PRETTY_FUNCTION__,
                     suite.name ());
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS
 
      // Accumulate the totals from the child test into the suite totals.
      suite.totals () += subtest.totals ();
    }

Referenced by micro_os_plus::micro_test_plus::suite::test().

children_subtests_count()

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

inlinenodiscardnoexceptinherited

Parameters

None.

Returns

The number of child subtests.

Returns the number of child subtests owned by this node.

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

    {
      return children_subtests_.size ();
    }

current_subtest_index()

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

inlinenodiscardnoexceptinherited

Parameters

None.

Returns

The current child subtest sequential index.

Returns the sequential index of the most recently created child subtest.

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

    {
      return current_subtest_index_;
    }

increment_subtest_index()

size_t micro_os_plus::micro_test_plus::detail::runnable_base::increment_subtest_index ( )

inlinenoexceptinherited

Parameters

None.

Returns

The new index value after incrementing.

Each call to test() invokes this method before constructing the new subtest, so the index values form a strictly increasing, one-based sequence.

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

    {
      return ++current_subtest_index_;
    }

Referenced by micro_os_plus::micro_test_plus::suite::test().

name() [1/2]

void micro_os_plus::micro_test_plus::top_suite::name ( const char * new_name )

inlinenoexcept

Parameters

[in]

new_name

The new name for the top-level suite.

Sets the name of the top-level suite.

Used internally by the runner to set the name of the top suite after initialisation.

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

  {
    name_ = new_name;
  }

References micro_os_plus::micro_test_plus::detail::runnable< suite >::name_.

Referenced by top_suite(), name(), and operator=().

name() [2/2]

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

inlinenodiscardnoexcept

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

    {
      return name_;
    }

References micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base(), micro_os_plus::micro_test_plus::detail::runnable< suite >::callable_, name(), and micro_os_plus::micro_test_plus::detail::runnable< suite >::own_index().

operator=() [1/2]

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

delete

References top_suite().

operator=() [2/2]

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

delete

References top_suite(), and name().

own_index() [1/2]

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

inlinenodiscardnoexceptinherited

Parameters

None.

Returns

The one-based own index.

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

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

    {
      return own_index_;
    }

Referenced by micro_os_plus::micro_test_plus::top_suite::top_suite(), micro_os_plus::micro_test_plus::top_suite::name(), and micro_os_plus::micro_test_plus::suite::test().

own_index() [2/2]

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

inlinenoexceptinherited

Note

This overload follows the same-name getter/setter pattern used throughout the framework: the getter is the const overload and the setter is the non-const single-argument overload.

Parameters

index

The new index value.

Returns

Nothing.

Sets the positional index of this object within its parent.

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

    {
      own_index_ = index;
    }

reporter()

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

nodiscardnoexceptinherited

Parameters

None.

Returns

A reference to the test reporter.

Delegates immediately to runner_.reporter(), returning the reporter associated with the owning runner instance.

Definition at line 359 of file test.cpp.

    {
      return runner_.reporter ();
    }

Referenced by micro_os_plus::micro_test_plus::static_suite::run().

run()

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

overridevirtualinherited

Parameters

None.

Returns

Nothing.

Invokes the stored callable with the Self_T instance, surrounded by reporter calls to begin and end the suite.

Implements micro_os_plus::micro_test_plus::detail::runnable< suite >.

Reimplemented in micro_os_plus::micro_test_plus::static_suite.

Definition at line 359 of file test.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
    trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name_);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
    class reporter& reporter = this->reporter ();
 
    this->timings ().timestamp_begin ();
    reporter.begin_suite (*this);
 
    // Invoke the callable, passing the self reference followed by the variadic
    // arguments.
    callable_ (*this);
 
    this->timings ().timestamp_end ();
    reporter.end_suite (*this);
  }

Referenced by operator=().

runner()

class runner & micro_os_plus::micro_test_plus::detail::runnable_base::runner ( void ) const

inlinenodiscardnoexceptinherited

Parameters

None.

Returns

A reference to the test runner.

Returns a reference to the owning test runner.

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

    {
      return runner_;
    }

Referenced by micro_os_plus::micro_test_plus::suite::suite(), and micro_os_plus::micro_test_plus::suite::test().

test()

template<typename Callable_T, typename... Args_T>

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

inherited

Template Parameters

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

Parameters

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

The test function template registers and executes a test case within the µTest++ framework. 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. The test case is reported using the provided name, and its execution is managed by the framework's test runner.

Each test case typically involves evaluating a logical expression, such as comparing a computed result to an expected value. For C++ projects, it is also possible to verify whether evaluating an expression throws exceptions. Each test either succeeds or fails, and for expectations, the test runner maintains counts of successful and failed checks.

This function template enables flexible and expressive test case definitions, supporting both parameterised and non-parameterised tests. It is typically invoked at global scope or within test suite definitions to ensure automatic registration and execution.

A test case is characterised by a name, a function that performs the checks, and optionally, arguments to be passed to that function. The implementation of test invokes the provided function with the given arguments and reports the results to the test runner.

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";
});

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

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
    trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
    size_t own_index = increment_subtest_index ();
    auto child_subtest
        = std::make_unique<subtest> (name, runner (), *this, own_index, 1,
                                     std::forward<Callable_T> (callable),
                                     std::forward<Args_T> (arguments)...);
 
    after_subtest_create_ (std::move (child_subtest), *this);
  }

References micro_os_plus::micro_test_plus::detail::runnable< suite >::after_subtest_create_(), micro_os_plus::micro_test_plus::detail::runnable< suite >::increment_subtest_index(), micro_os_plus::micro_test_plus::detail::runnable< suite >::name(), micro_os_plus::micro_test_plus::detail::runnable< suite >::own_index(), and micro_os_plus::micro_test_plus::detail::runnable< suite >::runner().

Referenced by operator=().

timings() [1/2]

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

inlinenodiscardnoexceptinherited

Parameters

None.

Returns

A const reference to the timestamps instance.

Returns a const reference to the timestamps member.

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

  {
    return timings_;
  }

References timings_.

timings() [2/2]

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

inlinenodiscardnoexceptinherited

Parameters

None.

Returns

A reference to the timestamps instance.

Returns a reference to the timestamps member.

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

  {
    return timings_;
  }

References timings_.

Referenced by micro_os_plus::micro_test_plus::reporter_human::end_suite(), micro_os_plus::micro_test_plus::reporter_tap::end_suite(), operator=(), and micro_os_plus::micro_test_plus::static_suite::run().

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

    {
      return 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 205 of file test-inlines.h.

    {
      return totals_;
    }

Member Data Documentation

callable_

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

protectedinherited

Definition at line 512 of file test.h.

Referenced by micro_os_plus::micro_test_plus::top_suite::name().

children_subtests_

std::vector<std::unique_ptr<subtest> > micro_os_plus::micro_test_plus::detail::runnable_base::children_subtests_

protectedinherited

Each call to test() appends a new subtest to this vector and runs it immediately. The vector retains ownership for the lifetime of the parent runnable.

Definition at line 427 of file test.h.

current_subtest_index_

size_t micro_os_plus::micro_test_plus::detail::runnable_base::current_subtest_index_

protectedinherited

This index is used for reporting and tracking the execution order of subtests within a suite, especially when nested subtests are involved. It is incremented for each subtest created, allowing for clear identification of subtests in reports and diagnostics.

Definition at line 417 of file test.h.

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 micro_os_plus::micro_test_plus::static_suite::~static_suite(), micro_os_plus::micro_test_plus::suite::~suite(), micro_os_plus::micro_test_plus::top_suite::~top_suite(), micro_os_plus::micro_test_plus::top_suite::name(), and micro_os_plus::micro_test_plus::static_suite::run().

own_index_

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

protectedinherited

Definition at line 406 of file test.h.

Referenced by micro_os_plus::micro_test_plus::static_suite::static_suite().

runner_

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

protectedinherited

Definition at line 401 of file test.h.

timings_

detail::timestamps micro_os_plus::micro_test_plus::suite::timings_

protectedinherited

Definition at line 818 of file test.h.

Referenced by timings(), and timings().

totals_

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

protectedinherited

Definition at line 229 of file test.h.

---

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

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