Non-template base for all runnable objects (suites and test cases). More...

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

Inheritance diagram for micro_os_plus::micro_test_plus::detail::runnable_base:

Public Member Functions
	runnable_base (const char *name, runner &test_runner, size_t own_index)
	Constructs a runnable_base with a name, runner, and index.
	runnable_base (const runnable_base &)=delete
	Deleted copy constructor to prevent copying.
	runnable_base (runnable_base &&)=delete
	Deleted move constructor to prevent moving.
virtual	~runnable_base ()
	Virtual destructor.
const char *	name (void) const noexcept
	Returns the node name.
runnable_base &	operator= (const runnable_base &)=delete
	Deleted copy assignment operator to prevent copying.
runnable_base &	operator= (runnable_base &&)=delete
	Deleted move assignment operator to prevent moving.
const counters &	totals (void) const noexcept
	Returns the totals of the node.
Deprecated Functions of runnable_base
size_t	own_index (void) const noexcept
	Deprecated positional index of this node within its parent.
size_t	current_subtest_index (void) const noexcept
	Deprecated number of the most recent child test point.
size_t	children_subtests_count (void) const noexcept
	Deprecated number of direct child test cases of this node.

Protected Member Functions
bool	accepts_test_case (const suite &target, const located_name &name)
	Checks whether a test case can be created on a suite.
void	after_test_case_create (class test_case &test_case, suite &suite)
	Counts a newly constructed child test case and executes it immediately.
template<typename Callable_T, typename... Args_T>
void	create_test_case (const located_name &name, suite &parent_suite, size_t nesting_depth, Callable_T &&callable, Args_T &&... arguments)
	Creates a child test case, and runs it.
suite *	exchange_running_suite (suite *running) noexcept
	Replaces the suite whose body is running in the owning runner, and returns the previous one.
bool	has_running_test_case_of (const suite &target) const noexcept
	Checks whether the innermost running test case belongs to a suite.
bool	is_aborted (void) const noexcept
	Checks whether the test execution was aborted by the owning runner.
bool	is_listing (void) const noexcept
	Checks whether the owning runner lists the test cases instead of running them.
size_t	next_test_point_number (void) noexcept
	Advances to the next child test point, and returns its number.
void	reject_body_exception (void)
	Reports the exception that escaped the body of a suite while the test cases are listed, and records it.
class test_case *	running_test_case (void) const noexcept
	Returns the innermost test case being run by the owning runner, if any.
class reporter &	test_reporter (void) const noexcept
	Returns the test reporter associated with this test runnable.
runner &	test_runner (void) const noexcept
	Returns the test runner that owns this test runnable.

Protected Attributes
size_t	child_test_cases_count_ = 0
	The number of direct child test cases.
const char *	name_
	The node name.
size_t	own_index_
	The test index, counting from 1.
runner &	runner_
	Reference to the test runner that owns this object.
size_t	test_point_number_ = 0
	The number of the most recent child test point.
counters	totals_
	Totals for the node.

Private Member Functions
void	abort (const reflection::source_location &sl=reflection::source_location::current()) const
	Aborts test execution via the owning runner, for a failed requirement.
virtual void	run (void)=0
	Runs the body of the test case or suite.

Friends
class	check_result
	The check result, which numbers and counts the checks.
class	micro_test_plus::runner
	The runner, which numbers and runs the suites.
class	reporter_human
	The human-readable reporter, which displays the nodes.
class	reporter_tap
	The TAP reporter, which displays the nodes.

Detailed Description

runnable_base is the single base of the nodes of the test tree, and holds the state that is shared by every runnable object:

the node name,
the counters of the passed and failed checks, and of the test cases,
a reference to the owning runner,
the object's own index within its parent,
the number of the most recent test point (check or nested test case), used in the TAP output, and
the number of the direct child test cases, used in the TAP plan; the child test cases themselves are not kept.

The concrete runnable classes (suite, test_case) derive from runnable_base; each refers to its body, which receives a reference to its own class, and implements run(), which invokes the body between the reporter notifications. A suite, which runs later, stores its body in a std::function; a test case, which runs immediately, refers to a body kept by its creator.

The user code can read only the name and the totals; the rest of the state, and the functions that run and abort the nodes, are the protocol between the nodes, the runner, the check result, and the reporters, which are friends. The runner numbers and runs the suites, the check result numbers and counts the checks, and the reporters read the indices and the test point numbers.

The class is non-copyable and non-movable to preserve unique ownership and consistent state throughout the test session.

Definition at line 348 of file test.h.

Constructor & Destructor Documentation

◆ runnable_base() [1/3]

micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base	(	const char *	name,
		runner &	test_runner,
		size_t	own_index )

Parameters

name	The name used in reports.
test_runner	The test runner managing this object.
own_index	The positional index of this object within its parent.

The constructor initialises a new instance of the runnable_base class with the specified name, runner reference, and own index; the name pointer is stored, and is expected to point to a string with a lifetime exceeding that of this instance. The totals, the child test point index, and the child test cases count start at zero. If tracing is enabled, the function signature is output for diagnostic purposes.

Definition at line 126 of file test.cpp.

        : name_{ name }, runner_{ test_runner }, own_index_{ own_index }
    {
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
      trace::printf ("%s '%s' %" MICRO_OS_PLUS_MICRO_TEST_PLUS_PRI_SIZE "\n",
                     __PRETTY_FUNCTION__, name, own_index_);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
    }

References MICRO_OS_PLUS_MICRO_TEST_PLUS_PRI_SIZE, micro_test_plus::runner, name(), name_, own_index(), own_index_, runner_, and test_runner().

Referenced by runnable_base(), runnable_base(), micro_os_plus::micro_test_plus::suite::suite(), operator=(), and operator=().

◆ runnable_base() [2/3]

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

delete

A copy would duplicate the counters.

References runnable_base().

◆ runnable_base() [3/3]

micro_os_plus::micro_test_plus::detail::runnable_base::runnable_base ( runnable_base && )

delete

Nodes are referred to by address (e.g. by their children and by the runner), so they must not be relocated.

References runnable_base().

◆ ~runnable_base()

micro_os_plus::micro_test_plus::detail::runnable_base::~runnable_base ( )

virtual

Virtual, so that the derived nodes are destroyed correctly.

Nothing is owned; the child test cases were destroyed when the test() calls that created them returned. If tracing is enabled, the name is output for diagnostic purposes.

Definition at line 142 of file test.cpp.

    {
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
      trace::printf ("%s '%s'\n", __PRETTY_FUNCTION__, name_);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
    }

References 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 () ) const

private

Private, since it is used only by the check result, a friend, for a failed requirement without exceptions; the user code calls runner::abort().

Parameters

sl	The source location from which the abort is triggered.

Returns: Does not return.

Delegates to the private runner::abort(), as caused by a failed requirement, passing the supplied source location, so that the report identifies it. The runner then calls the abort handler, if any, and terminates the process via ::abort().

Definition at line 306 of file test.cpp.

    {
      runner_.abort (sl, true);
    }

References micro_os_plus::micro_test_plus::runner::abort(), and runner_.

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result(), and run().

◆ accepts_test_case()

bool micro_os_plus::micro_test_plus::detail::runnable_base::accepts_test_case	(	const suite &	target,
		const located_name &	name )

nodiscardprotected

Protected, since it is used only by suite::test(). A test case can be created only on the suite whose body is running (the top suite, between runner::add_top_suite() and runner::run_suites(), or the suite being run). A call on any other suite, for example on the top suite from the body of another suite, on a static suite before the runner was initialised, or after runner::run_suites() returned, would run the test case where its results cannot be reported correctly. Such a call is rejected: the failure is reported as a failed check of the running test case, if one runs, otherwise in the running suite, or, when no suite runs, on stderr, and the rejection is remembered by the runner, which makes the exit code non-zero. When the session was declined (option errors, or --help), or aborted, the test cases are ignored silently, as after_test_case_create() ignores them.

Parameters

target	The suite on which the test case is created.
name	The name and the location of the test case, for the message.

Return values

true	The test case can be created.
false	The test case must not be created.

The suite whose body runs accepts the test case. When the session was declined, or aborted, the test case is ignored, as after_test_case_create() ignores it.

Otherwise the call is rejected. If a test case runs (and the test cases are not only listed), the failure is reported as a check of that test case, so that it stays in its report. Otherwise, if a suite runs, the failure is reported as a check of that suite, with the same numbering and counting as the unexpected exceptions of the suite body. Otherwise (the runner was not initialised, has not started the suites, or has finished them, or the test cases are listed) the failure is given to runner::reject_call(), which writes the message on stderr and, where the reporter can still write it, as a comment line, for example in the list, and runner::mark_rejected() makes the exit code non-zero, as for the suites added too late.

Definition at line 239 of file test.cpp.

    {
      if (runner_.running_suite_ == &target)
        {
          return true;
        }
 
      if (runner_.aborted_ || runner_.has_option_errors ()
          || runner_.options_.help)
        {
          return false;
        }
 
      std::string message{ "test case '" };
      message.append (name.name ());
      message.append ("' started on suite '");
      message.append (target.name ());
      message.append ("', which is not running");
 
      if (runner_.running_test_case_ != nullptr
          && !runner_.options_.list_tests)
        {
          runner_.running_test_case_->report_rejected_test (message,
                                                            name.location ());
          return false;
        }
 
      suite* running = runner_.running_suite_;
      if (running != nullptr && !runner_.options_.list_tests)
        {
          running->next_test_point_number ();
          running->test_reporter ().fail_suite (message, *running);
          running->totals_.increment_failed_checks ();
          return false;
        }
 
      runner_.reject_call (message, &name.location ());
      return false;
    }

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

◆ after_test_case_create()

void micro_os_plus::micro_test_plus::detail::runnable_base::after_test_case_create	(	class test_case &	test_case,
		suite &	suite )

protected

The child test case is a local object of create_test_case(), and is destroyed when that function returns.

Parameters

test_case	The newly created test_case.
suite	The parent suite to which execution results are reported.

Returns: Nothing.

Counts test_case, which is a local object of the calling create_test_case(), and immediately invokes test_case::run() on it. The test case is not kept; only child_test_cases_count_ is needed later, for the TAP plan.

If the filter patterns do not select the test case (its own name at its nesting level, or the name of suite at level 0, which matters only for the top suite, since the other suites run only when selected), its body is not called: the reporter is notified with skip_test_case() and the parent's skipped test cases counter is incremented. The test case keeps its index and its place among the children, so the TAP plan of the parent remains complete.

Otherwise, while the test case runs, the runner keeps it as its innermost running test case (see suite::test()). The parent's executed test cases counter is incremented after the run, and, if the child failed (a failed check, or a failed nested test case), its failed test cases counter too, so that the parent fails as well, as in node-tap. The child's check counters are intentionally not merged into the parent totals; each test case reports only its own counters. The child's totals are, however, accumulated into suite so that the suite summary reflects all checks performed by its test cases.

While the test cases are listed (see runner_options::list_tests), the selected test case is listed by the runner, and neither run nor counted, except in child_test_cases_count_.

After the test execution was aborted (possible only when the abort handler threw an exception, which the application caught), the report is complete, so the test case is neither run nor reported. The same applies when the runner refused to run the tests because of errors in the options, or because the output file could not be opened (see runner::has_option_errors()), or because the options requested the usage (--help).

Definition at line 350 of file test.cpp.

    {
      if (runner_.aborted_ || runner_.has_option_errors ()
          || runner_.options_.help)
        {
          return;
        }
 
      ++child_test_cases_count_;
 
      // While the test cases are listed, the selected ones are listed and
      // the others ignored; none is run.
      if (runner_.options_.list_tests)
        {
          if (runner_.is_selected (suite.name (), 0)
              && runner_.is_selected (test_case.name (),
                                      test_case.nesting_depth ()))
            {
              runner_.list_test_case (suite, test_case);
            }
          return;
        }
 
      // Skip the test cases not selected by the filter; the outer test
      // cases, if any, were selected, otherwise this one was not created.
      if (!runner_.is_selected (suite.name (), 0)
          || !runner_.is_selected (test_case.name (),
                                   test_case.nesting_depth ()))
        {
          test_reporter ().skip_test_case (test_case);
          totals_.increment_skipped_test_cases ();
          return;
        }
 
      // Run the child test case immediately, as the innermost running test
      // case of the runner. The outer one is restored by the guard, also
      // when an exception leaves run() (for example thrown by an abort
      // handler), so that the runner never keeps a destroyed test case.
      {
        struct running_guard
        {
          class test_case*& running;
          class test_case* outer;
 
          ~running_guard ()
          {
            running = outer;
          }
        } guard{ runner_.running_test_case_, runner_.running_test_case_ };
 
        runner_.running_test_case_ = &test_case;
        // A non-virtual call, so that run() is inlined here; each nested
        // test case adds this call chain to the stack.
        test_case.test_case::run ();
      }
 
      // This test executed one more test case.
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
      trace::printf ("%s test case '%s' executed one more test case\n",
                     __PRETTY_FUNCTION__, name ());
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
      totals_.increment_executed_test_cases ();
 
      // Do not accumulate the totals from the child test into the current test
      // totals, each test case shows only its counters. But a failed child
      // fails this test too, as in node-tap; the failure reaches all outer
      // tests, one level at a time, when they end.
      if (!test_case.totals ().passed ())
        {
          totals_.increment_failed_test_cases ();
        }
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
      trace::printf ("%s suite '%s' totals\n", __PRETTY_FUNCTION__,
                     suite.name ());
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
 
      // Accumulate the totals from the child test into the suite totals.
      suite.totals_ += test_case.totals ();
    }

Referenced by create_test_case(), and run().

◆ children_subtests_count()

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

inlinenodiscardnoexcept

Used only for the TAP plan, by the reporters, which access it directly. The test cases skipped by the filter are included.

Parameters: None.

Returns: The number of child test cases.

Deprecated: internal to the framework (since 6.0.0)

Returns the number of direct child test cases, including those skipped by the filter.

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

    {
      return child_test_cases_count_;
    }

References child_test_cases_count_.

Referenced by operator=().

◆ create_test_case()

template<typename Callable_T, typename... Args_T>

void micro_os_plus::micro_test_plus::detail::runnable_base::create_test_case	(	const located_name &	name,
		suite &	parent_suite,
		size_t	nesting_depth,
		Callable_T &&	callable,
		Args_T &&...	arguments )

inlineprotected

The common body of suite::test() and test_case::test(), which differ only in the parent suite and the nesting depth of the test cases they create.

Always inlined into them, even without optimisations, since each nested test case adds one call chain to the stack, and a separate frame for this function would make it longer.

The test case runs and ends within the call, so, without additional arguments, it refers to the callable of the caller, which is neither copied nor moved, and is called in place, so a callable that cannot be copied is accepted, and an lvalue callable keeps the changes of its state. With additional arguments, the callable and the arguments are bound into a body of copies, by bind_callable().

Template Parameters

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

Parameters

name	The test case name or description, used in reports, and the location of the call to test().
parent_suite	The suite to which the test case belongs.
nesting_depth	The depth of nesting of the test case; 1 for the direct children of a suite.
callable	A generic callable object, usually a lambda, invoked to perform the test.
arguments	A possibly empty list of arguments to be passed to the callable.

Returns: Nothing.

Without additional arguments, the child test_case is a local object that refers to the callable of the caller, which is neither copied nor moved, and is called in place (an lvalue callable keeps the changes of its state). A function is referred to through its pointer, and the callable and the additional arguments are bound into a local body, as copies, when there are arguments. The child is constructed with the next test point number of this node as its index, then passed to after_test_case_create(), which counts and runs it.

The child test case and its body, with the copies of the arguments, are destroyed when this function returns, so the memory used by a test session does not grow with the number of test cases; the stack holds one test case and one body for each level of nesting being run. Since the body is not stored in a std::function, it is never allocated, whatever the size of the lambda captures and of the arguments.

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

    {
      size_t own_index = next_test_point_number ();
 
      if constexpr (sizeof...(arguments) == 0
                    && !std::is_function_v<
                        std::remove_reference_t<Callable_T>>)
        {
          // The test case runs and ends within this call, so it refers
          // to the callable of the caller, which is not copied, and is
          // called in place.
          class test_case child_test_case{
            name,      runner_,       parent_suite,
            own_index, nesting_depth, callable_ref<class test_case>{ callable }
          };
 
          after_test_case_create (child_test_case, parent_suite);
        }
      else
        {
          auto body = bind_callable<class test_case> (
              std::forward<Callable_T> (callable),
              std::forward<Args_T> (arguments)...);
          class test_case child_test_case{
            name,      runner_,       parent_suite,
            own_index, nesting_depth, callable_ref<class test_case>{ body }
          };
 
          after_test_case_create (child_test_case, parent_suite);
        }
    }

References after_test_case_create(), micro_os_plus::micro_test_plus::detail::bind_callable(), name(), next_test_point_number(), own_index(), and runner_.

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

◆ current_subtest_index()

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

inlinenodiscardnoexcept

Used only for the TAP output, by the reporters, which access it directly.

Parameters: None.

Returns: The one-based test point number, or 0 before the first test point.

Deprecated: internal to the framework (since 6.0.0)

Returns the number of the most recent child test point.

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

    {
      return test_point_number_;
    }

References test_point_number_.

Referenced by operator=().

◆ exchange_running_suite()

suite * micro_os_plus::micro_test_plus::detail::runnable_base::exchange_running_suite ( suite * running )

protectednoexcept

Protected, since it is used only by suite::run(), to mark the suite whose body is being called, and to restore the previous value when the body returns.

Parameters

running The suite that starts to run, or the previous one, to restore it.

Returns: The suite that was marked as running before the call, or nullptr when none was.

Sets the pointer of the runner, a friend, and returns the previous value, so that the caller can restore it when the body returns.

Definition at line 212 of file test.cpp.

    {
      suite* previous = runner_.running_suite_;
      runner_.running_suite_ = running;
      return previous;
    }

References runner_.

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

◆ has_running_test_case_of()

bool micro_os_plus::micro_test_plus::detail::runnable_base::has_running_test_case_of ( const suite & target ) const

nodiscardprotectednoexcept

Protected, since it is used only by suite::test(), to forward a test case started on the suite to the running test case only when that is a test case of the same suite; the test cases started on another suite are rejected.

Parameters

target The suite to check.

Return values

true	A test case is running, and its parent suite is `target`.
false	No test case is running, or it belongs to another suite.

Reads the pointer of the runner, a friend, and the parent suite of the test case, which runnable_base may access.

Definition at line 199 of file test.cpp.

    {
      const test_case* running = runner_.running_test_case_;
      return running != nullptr && &running->parent_suite_ == &target;
    }

References micro_os_plus::micro_test_plus::test_case::parent_suite_, and runner_.

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

◆ is_aborted()

bool micro_os_plus::micro_test_plus::detail::runnable_base::is_aborted ( void ) const

nodiscardprotectednoexcept

Protected, since it is used only by test_case::run() and suite::run(), to pass on an exception thrown by the abort handler, instead of reporting it as unexpected.

Parameters: None.

Returns: true once runner::abort() was called.

Returns the flag kept by the owning runner, set by runner::abort() and never cleared.

Definition at line 177 of file test.cpp.

    {
      return runner_.aborted_;
    }

References runner_.

Referenced by run(), micro_os_plus::micro_test_plus::suite::run(), and micro_os_plus::micro_test_plus::test_case::run().

◆ is_listing()

bool micro_os_plus::micro_test_plus::detail::runnable_base::is_listing ( void ) const

nodiscardprotectednoexcept

Protected, since it is used only by suite::run(), which then calls the suite body without reporting the suite, so that its test cases are created, and listed instead of run.

Parameters: None.

Returns: true if runner_options::list_tests was set.

Returns runner_options::list_tests of the session options kept by the owning runner.

Definition at line 188 of file test.cpp.

    {
      return runner_.options_.list_tests;
    }

References runner_.

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

◆ name()

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

inlinenodiscardnoexcept

Parameters: None.

Returns: A pointer to the null-terminated node name.

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

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

    {
      return name_;
    }

References name_.

◆ next_test_point_number()

size_t micro_os_plus::micro_test_plus::detail::runnable_base::next_test_point_number ( void )

inlineprotectednoexcept

Called for each check (by the check result, when the check is reported) and for each nested test case created.

Parameters: None.

Returns: The one-based number of the new test point.

Each call to test() invokes this member function before constructing the new test_case, and each check invokes it from the check result destructor, when the check is reported, so the numbers form a strictly increasing, one-based sequence of TAP test points, in output order.

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

    {
      return ++test_point_number_;
    }

References test_point_number_.

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result(), accepts_test_case(), create_test_case(), micro_os_plus::micro_test_plus::suite::fail_unexpected_exception(), micro_os_plus::micro_test_plus::test_case::fail_unexpected_exception(), micro_os_plus::micro_test_plus::runner::reject_call(), and run().

◆ operator=() [1/2]

runnable_base & micro_os_plus::micro_test_plus::detail::runnable_base::operator= ( const runnable_base & )

delete

A copy would duplicate the counters.

References runnable_base().

◆ operator=() [2/2]

runnable_base & micro_os_plus::micro_test_plus::detail::runnable_base::operator= ( runnable_base && )

delete

Nodes are referred to by address (e.g. by their children and by the runner), so they must not be relocated.

References runnable_base(), children_subtests_count(), current_subtest_index(), name(), own_index(), and totals().

◆ own_index()

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

inlinenodiscardnoexcept

Used only for the TAP output, by the reporters, which access it directly. The setter of v5.0.1, and increment_subtest_index(), were removed, since they allowed the application code to corrupt the numbering of the reports.

Parameters: None.

Returns: The one-based own index.

Deprecated: internal to the framework (since 6.0.0)

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

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

    {
      return own_index_;
    }

References own_index_.

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

◆ reject_body_exception()

void micro_os_plus::micro_test_plus::detail::runnable_base::reject_body_exception ( void )

protected

Protected, since it is used only by suite::run(), when there is no test point to fail. It gives the message, which names the suite, to runner::reject_call(), which writes it on stderr and in the listing, and makes the exit code non-zero.

Parameters: None.

Returns: Nothing.

Builds the message here, and not in suite::run(), to keep the frame of that function, which is on the stack of every session, unchanged. Delegates to the private runner::reject_call(), which writes the message on stderr and in the listing, and marks the runner, so that the exit code of runner::run_suites() is not 0.

Definition at line 289 of file test.cpp.

    {
      std::string message{ "unexpected exception in the body of suite '" };
      message.append (name_);
      message.append ("'");
 
      runner_.reject_call (message);
    }

References name_, micro_os_plus::micro_test_plus::runner::reject_call(), and runner_.

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

◆ run()

virtual void micro_os_plus::micro_test_plus::detail::runnable_base::run ( void )

privatepure virtual

Implemented by test_case and suite, which invoke the stored callable surrounded by the reporter notifications.

Private, since the nodes are run only by the framework: the test cases by after_test_case_create(), when they are created, and the suites by the runner, which is a friend; a second run would report the node twice.

Parameters: None.

Returns: Nothing.

Implemented in micro_os_plus::micro_test_plus::suite, and micro_os_plus::micro_test_plus::test_case.

References abort(), accepts_test_case(), after_test_case_create(), create_test_case(), micro_os_plus::micro_test_plus::reflection::source_location::current(), exchange_running_suite(), has_running_test_case_of(), is_aborted(), is_listing(), micro_test_plus::runner, name(), next_test_point_number(), reject_body_exception(), running_test_case(), test_reporter(), and test_runner().

◆ running_test_case()

test_case * micro_os_plus::micro_test_plus::detail::runnable_base::running_test_case ( void ) const

nodiscardprotectednoexcept

Protected, since it is used only by suite::test(), to run a test case started on the suite from inside a running test case as a nested test case of it.

Parameters: None.

Returns: A pointer to the running test case, or nullptr when no test case is running.

Returns the pointer kept by the owning runner, set by after_test_case_create() while a test case runs.

Definition at line 166 of file test.cpp.

    {
      return runner_.running_test_case_;
    }

References runner_.

Referenced by micro_os_plus::micro_test_plus::test_case::is_misdirected(), micro_os_plus::micro_test_plus::test_case::report_misdirected(), micro_os_plus::micro_test_plus::test_case::report_misdirected_test(), run(), and micro_os_plus::micro_test_plus::suite::test().

◆ test_reporter()

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

nodiscardprotectednoexcept

Protected, since the reporter is internal to the framework; it is used by the suites and the test cases, which derive from this class, and by the check result, which is a friend.

Not named reporter(), which would hide the class detail::reporter in the derived classes.

Parameters: None.

Returns: A reference to the test reporter.

Returns the reporter owned by the runner, through its reporter_ pointer, which is valid after runner::initialise().

Definition at line 155 of file test.cpp.

    {
      return *runner_.reporter_;
    }

References runner_.

◆ test_runner()

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

inlinenodiscardprotectednoexcept

Protected, since the runner is internal to the framework; it is used by the suites and the test cases, which derive from this class and pass it to their nested test cases, and by the runner, which is a friend and selects the static suites it runs.

Not named runner(), which would hide the class runner in the derived classes.

Parameters: None.

Returns: A reference to the test runner.

Returns a reference to the owning test runner.

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

    {
      return runner_;
    }

References runner_.

◆ totals()

const counters & micro_os_plus::micro_test_plus::detail::runnable_base::totals ( void ) const

inlinenodiscardnoexcept

The reference is read-only, for the const and the non-const nodes alike, so that a test case or a suite cannot modify its own counters, which decide the exit code. The counters are updated only by the framework, which accesses the protected member directly.

Parameters: None.

Returns: A const reference to the counters instance.

Returns a const reference to the counters member.

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

    {
      return totals_;
    }

References totals_.

Referenced by after_test_case_create(), micro_os_plus::micro_test_plus::detail::reporter_human::end_suite(), micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite(), micro_os_plus::micro_test_plus::detail::reporter_human::end_test_case(), micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case(), micro_os_plus::micro_test_plus::detail::reporter::format_suite_totals(), micro_os_plus::micro_test_plus::detail::reporter::format_test_case_totals(), operator=(), and micro_os_plus::micro_test_plus::runner::run_suites().

◆ check_result

friend class check_result

friend

It advances the test point number, updates the totals, and reports the check through the reporter of the node.

Definition at line 366 of file test.h.

References check_result.

Referenced by check_result.

◆ micro_test_plus::runner

friend class micro_test_plus::runner

friend

It sets the indices of the suites before running them, and selects the suites that refer to it.

Definition at line 357 of file test.h.

Referenced by runnable_base(), reporter_tap, and run().

◆ reporter_human

friend class reporter_human

friend

It currently uses only the public members of the nodes; the declaration is kept for symmetry with the TAP reporter.

Definition at line 375 of file test.h.

References reporter_human.

Referenced by reporter_human.

◆ reporter_tap

friend class reporter_tap

friend

It reads the indices and the test point numbers, for the TAP lines and plans, and, when tracing, the numbers of the child test cases.

Definition at line 385 of file test.h.

References micro_test_plus::runner, name(), own_index(), reporter_tap, and test_runner().

Referenced by reporter_tap.

Member Data Documentation

◆ child_test_cases_count_

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

protected

Incremented for each call to test(), which creates a child test_case and runs it immediately. The child test cases are not kept after they run, so that the memory does not grow with the number of test cases; only their number is needed later, for the TAP plan.

Definition at line 883 of file test.h.

Referenced by after_test_case_create(), children_subtests_count(), micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite(), and micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case().

◆ name_

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

protected

Not owned; it points to a string whose lifetime exceeds that of the node. Derived classes may access this member directly, in addition to the public name() getter.

Definition at line 823 of file test.h.

◆ own_index_

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

protected

The position of this object within its parent, displayed by the TAP reporter in the ok/not ok lines. Set directly by the runner, which numbers the suites when it runs them, and by the top suite, which, when added, is always the first one.

Definition at line 859 of file test.h.

Referenced by runnable_base(), micro_os_plus::micro_test_plus::suite::suite(), micro_os_plus::micro_test_plus::test_case::test_case(), micro_os_plus::micro_test_plus::top_suite::top_suite(), micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite(), micro_os_plus::micro_test_plus::detail::reporter_tap::end_test_case(), own_index(), micro_os_plus::micro_test_plus::detail::reporter_tap::skip_suite(), and micro_os_plus::micro_test_plus::detail::reporter_tap::skip_test_case().

◆ runner_

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

protected

Provides access to the reporter, to the filter, and to the state of the session (the running test case, and the abort and listing flags), and is used when aborting.

Definition at line 848 of file test.h.

Referenced by runnable_base(), abort(), accepts_test_case(), after_test_case_create(), create_test_case(), exchange_running_suite(), has_running_test_case_of(), is_aborted(), is_listing(), reject_body_exception(), running_test_case(), test_reporter(), and test_runner().

◆ test_point_number_

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

protected

Test points are numbered from 1; the value is 0 before the first one. This number counts the checks and the nested test cases of this object, in execution order, as required by the TAP ok/not ok lines. It is incremented for each check (by the check result) and for each nested test case created.

Definition at line 871 of file test.h.

Referenced by current_subtest_index(), micro_os_plus::micro_test_plus::detail::reporter_tap::end_suite(), micro_os_plus::micro_test_plus::detail::reporter_tap::fail_suite(), next_test_point_number(), micro_os_plus::micro_test_plus::detail::reporter_tap::output_fail_prefix(), micro_os_plus::micro_test_plus::detail::reporter_tap::output_pass_prefix(), and micro_os_plus::micro_test_plus::detail::reporter_tap::pass_without_text().

◆ totals_

counters micro_os_plus::micro_test_plus::detail::runnable_base::totals_

protected

For the suites, the totals include the checks of all their test cases; for a test case, they include only its own checks, plus the counts of its direct nested test cases.

The check counters are updated by the check result, which is a friend; the test case counters by after_test_case_create(), when a nested test case ends. For a suite, the totals of each of its test cases are also added, by the same function.

Definition at line 838 of file test.h.

Referenced by micro_os_plus::micro_test_plus::detail::check_result::~check_result(), accepts_test_case(), after_test_case_create(), micro_os_plus::micro_test_plus::suite::fail_unexpected_exception(), micro_os_plus::micro_test_plus::test_case::fail_unexpected_exception(), micro_os_plus::micro_test_plus::runner::reject_call(), and totals().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ runnable_base() [1/3]

◆ runnable_base() [2/3]

◆ runnable_base() [3/3]

◆ ~runnable_base()

Member Function Documentation

◆ abort()

◆ accepts_test_case()

◆ after_test_case_create()

◆ children_subtests_count()

◆ create_test_case()

◆ current_subtest_index()

◆ exchange_running_suite()

◆ has_running_test_case_of()

◆ is_aborted()

◆ is_listing()

◆ name()

◆ next_test_point_number()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ own_index()

◆ reject_body_exception()

◆ run()

◆ running_test_case()

◆ test_reporter()

◆ test_runner()

◆ totals()

Friends And Related Symbol Documentation

◆ check_result

◆ micro_test_plus::runner

◆ reporter_human

◆ reporter_tap

Member Data Documentation

◆ child_test_cases_count_

◆ name_

◆ own_index_

◆ runner_

◆ test_point_number_

◆ totals_