micro_os_plus::micro_test_plus::detail::runnable< Self_T > Class Template Reference

CRTP base class factoring out callable storage, rule-of-five, and run() logic shared by subtest and suite. More...

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

Inheritance diagram for micro_os_plus::micro_test_plus::detail::runnable< Self_T >:

Public Member Functions
template<typename Callable_T, typename... Args_T>
	runnable (const char *name, class runner &runner, size_t own_index, Callable_T &&callable, Args_T &&... arguments)
	Class template constructor.
	runnable (const runnable &)=delete
	Deleted copy constructor to prevent copying.
	runnable (runnable &&)=delete
	Deleted move constructor to prevent moving.
virtual	~runnable () 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.
const char *	name (void) const noexcept
	Gets the node name.
runnable &	operator= (const runnable &)=delete
	Deleted copy assignment operator to prevent copying.
runnable &	operator= (runnable &&)=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)=0
	Runs the test function by invoking the stored callable with the derived self instance.
class runner &	runner (void) const noexcept
	Gets the test runner associated with this test runnable.
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(Self_T &)>	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_ = 0
	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.
runner_totals	totals_
	Totals for the test node, including nested cases.

Detailed Description

template<typename Self_T>
class micro_os_plus::micro_test_plus::detail::runnable< Self_T >

Template Parameters

Self_T

The concrete derived class type (CRTP pattern). The stored callable receives a Self_T& reference when the test is executed.

Definition at line 443 of file test.h.

Constructor & Destructor Documentation

runnable() [1/3]

template<typename Self_T>

template<typename Callable_T, typename... Args_T>

micro_os_plus::micro_test_plus::detail::runnable< Self_T >::runnable	(	const char *	name,
		class runner &	runner,
		size_t	own_index,
		Callable_T &&	callable,
		Args_T &&...	arguments )

Template Parameters

Callable_T	The callable type.
Args_T	The additional argument types.

Parameters

[in]	name	The test name, used in reports.
[in]	runner	The test runner managing this test.
[in]	own_index	The test index within the runner.
[in]	callable	The callable invoked when the test runs.
[in]	arguments	Additional arguments forwarded to the callable after the leading Self_T& reference.

Binds the callable and its arguments into the stored callable_ function object. When run() is called, the stored function is invoked with a reference to the derived Self_T instance as its first argument, followed by the bound arguments.

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

        : runnable_base{ name, runner, own_index }
    {
      // When there are no extra arguments the callable already has the
      // signature void(Self_T&), so store it directly. Only use std::bind when
      // additional arguments must be pre-bound, to avoid triggering a GCC ARM
      // bug in
      // __is_nothrow_invocable<_Bind<...>, Self_T&> (GCC 15.2.1).
      if constexpr (sizeof...(arguments) == 0)
        {
          callable_ = std::forward<Callable_T> (callable);
        }
      else
        {
          callable_ = std::bind (std::forward<Callable_T> (callable),
                                 std::placeholders::_1,
                                 std::forward<Args_T> (arguments)...);
        }
 
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
#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' %zu\n", __PRETTY_FUNCTION__, name, own_index_);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
    }

References micro_os_plus::micro_test_plus::detail::test_node::name(), micro_os_plus::micro_test_plus::detail::runnable_base::own_index(), and micro_os_plus::micro_test_plus::detail::runnable_base::runner().

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

runnable() [2/3]

template<typename Self_T>

micro_os_plus::micro_test_plus::detail::runnable< Self_T >::runnable ( const runnable< Self_T > & )

delete

References runnable().

runnable() [3/3]

template<typename Self_T>

micro_os_plus::micro_test_plus::detail::runnable< Self_T >::runnable ( runnable< Self_T > && )

delete

References runnable().

~runnable()

template<typename Self_T>

micro_os_plus::micro_test_plus::detail::runnable< Self_T >::~runnable ( )

overridevirtual

No-op in production builds. When tracing is enabled via MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED, emits a trace message identifying the instance being destroyed.

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

    {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
#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_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
    }

References ~runnable(), and micro_os_plus::micro_test_plus::detail::test_node::name_.

Referenced by ~runnable().

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 208 of file test.cpp.

    {
      runner_.abort (sl);
    }

References runner_.

Referenced by operator=().

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 224 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_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
#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_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
      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_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
#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_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
 
      // Accumulate the totals from the child test into the suite totals.
      suite.totals () += subtest.totals ();
    }

References children_subtests_, micro_os_plus::micro_test_plus::detail::runner_totals::increment_executed_subtests(), micro_os_plus::micro_test_plus::detail::test_node::name(), micro_os_plus::micro_test_plus::subtest::run(), and micro_os_plus::micro_test_plus::detail::test_node::totals().

Referenced by operator=().

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

    {
      return children_subtests_.size ();
    }

References children_subtests_.

Referenced by micro_os_plus::micro_test_plus::reporter_tap::end_subtest(), micro_os_plus::micro_test_plus::reporter_tap::end_suite(), and operator=().

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

    {
      return current_subtest_index_;
    }

References current_subtest_index_.

Referenced by operator=(), micro_os_plus::micro_test_plus::reporter_tap::output_fail_prefix_(), and micro_os_plus::micro_test_plus::reporter_tap::output_pass_prefix_().

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

    {
      return ++current_subtest_index_;
    }

References current_subtest_index_.

Referenced by operator=().

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.

    {
      return name_;
    }

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]

template<typename Self_T>

runnable & micro_os_plus::micro_test_plus::detail::runnable< Self_T >::operator= ( const runnable< Self_T > & )

delete

References runnable().

operator=() [2/2]

template<typename Self_T>

runnable & micro_os_plus::micro_test_plus::detail::runnable< Self_T >::operator= ( runnable< Self_T > && )

delete

References runnable().

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

    {
      return own_index_;
    }

References own_index_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable< Self_T >::runnable(), runnable_base(), micro_os_plus::micro_test_plus::reporter_tap::end_subtest(), micro_os_plus::micro_test_plus::reporter_tap::end_suite(), and operator=().

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

    {
      own_index_ = index;
    }

References own_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 196 of file test.cpp.

    {
      return runner_.reporter ();
    }

References runner_.

Referenced by operator=().

run()

template<typename Self_T>

virtual void micro_os_plus::micro_test_plus::detail::runnable< Self_T >::run ( void )

pure virtual

Parameters

None.

Returns

Nothing.

Implemented in micro_os_plus::micro_test_plus::static_suite, micro_os_plus::micro_test_plus::subtest, and micro_os_plus::micro_test_plus::suite.

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

    {
      return runner_;
    }

References runner_.

Referenced by micro_os_plus::micro_test_plus::detail::runnable< Self_T >::runnable(), runnable_base(), and operator=().

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.

    {
      return totals_;
    }

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.

    {
      return totals_;
    }

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

callable_

template<typename Self_T>

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

protected

Definition at line 512 of file test.h.

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.

Referenced by after_subtest_create_(), and children_subtests_count().

current_subtest_index_

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

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.

Referenced by current_subtest_index(), and increment_subtest_index().

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

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 runnable_base(), own_index(), and own_index().

runner_

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

protectedinherited

Definition at line 401 of file test.h.

Referenced by runnable_base(), abort(), reporter(), and runner().

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:

• test.h
• test-inlines.h