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

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

Inheritance diagram for micro_os_plus::micro_test_plus::static_runner:

Public Member Functions
	static_runner (const char *top_suite_name)
	Constructs the static runner with a top-suite name.
	static_runner (const static_runner &)=delete
	Deleted copy constructor to prevent copying.
	static_runner (static_runner &&)=delete
	Deleted move constructor to prevent moving.
	static_runner (void)
	Constructor for the runner class.
virtual	~static_runner () override
	Destructor for the static_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.
static_runner &	operator= (const static_runner &)=delete
	Deleted copy assignment operator to prevent copying.
static_runner &	operator= (static_runner &&)=delete
	Deleted move assignment operator to prevent moving.
class reporter &	reporter (void) const noexcept
	Returns a reference to the test reporter.
size_t	static_suites_count (void) const noexcept
	Returns the total count of registered static test suites.
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 final override
	Returns the total count of all test suites, including static and dynamic.
const runner_totals &	totals () const noexcept
	Gets the totals for the test (const overload).
runner_totals &	totals () noexcept
	Gets the totals for the test.

Static Public Member Functions
static void	register_static_suite (static_runner &runner, static_suite &suite)
	Registers a static test suite with the runner.

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

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.
std::vector< static_suite * > *	static_children_suites_
	Pointer to the vector of registered static test suites.
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

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

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

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

Definition at line 344 of file runner.h.

Constructor & Destructor Documentation

◆ static_runner() [1/4]

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

Parameters: None.

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

Definition at line 492 of file runner.cpp.

                                    : runner{}
  {
#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 micro_os_plus::micro_test_plus::runner::runner(), and micro_os_plus::micro_test_plus::detail::test_node::name().

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

◆ static_runner() [2/4]

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

Parameters

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

Deprecated: Use the anonymous constructor.

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

Definition at line 515 of file runner.cpp.

      : runner{ top_suite_name }
  {
#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 micro_os_plus::micro_test_plus::runner::runner(), and micro_os_plus::micro_test_plus::detail::test_node::name().

◆ static_runner() [3/4]

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

delete

References static_runner().

◆ static_runner() [4/4]

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

delete

References static_runner().

◆ ~static_runner()

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

overridevirtual

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

Definition at line 541 of file runner.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
    trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
 
    if (static_children_suites_ != nullptr)
      {
        // The tests are static, so we do not delete them, but we need to
        // delete the array of pointers.
        delete static_children_suites_;
        static_children_suites_ = nullptr;
      }
  }

References static_children_suites_.

Member Function Documentation

◆ abort()

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

inherited

Parameters

sl	The source location from which the abort is triggered.

Returns: Nothing.

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

Definition at line 440 of file runner.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
    trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
#endif
#endif
    fprintf (stderr, "\nerror: test execution aborted at %s:%u\n",
             reflection::short_name (sl.file_name ()), sl.line ());
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
 
    ::abort ();
  }

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 )

inherited

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.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
    trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
    if (reporter_ == nullptr)
      {
        fprintf (stderr, "error: test runner not initialised\n");
        return 1;
      }
 
    top_suite_.timings ().timestamp_end ();
    reporter_->end_suite (top_suite_);
    totals_ += top_suite_.totals ();
 
    run_suites_ ();
 
    timings_.timestamp_end ();
    reporter_->end_session (*this);
 
    const int result = totals_.was_successful () ? 0 : 1;
 
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_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 -> %d\n", __PRETTY_FUNCTION__, result);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
    return result;
  }

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 = "" )

inherited

Parameters

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

Returns: Reference to the top-level test suite.

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

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

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

Definition at line 191 of file runner.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
    trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))
#if defined(MICRO_OS_PLUS_DEBUG)
    trace::printf ("argv[");
    for (int i = 0; i < argc; ++i)
      {
        if (i > 0)
          {
            trace::printf (", ");
          }
        trace::printf ("'%s'", argv[i]);
      }
    trace::puts ("]");
#endif // defined(MICRO_OS_PLUS_DEBUG)
#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
 
    if (strlen (top_suite_name) > 0)
      {
        // If provided by this call, use it, possibly override the
        // deprecated constructor.
        top_suite_name_ = top_suite_name;
        top_suite_.name (top_suite_name_.c_str ());
      }
    else if (strlen (top_suite_.name ()) == 0)
      {
        // If not provided by the constructor or by this call, try to extract a
        // name from argv[0], which is commonly the executable name. If that
        // fails, use a default name.
        if (argc > 0 && argv != nullptr && argv[0] != nullptr)
          {
            std::string_view top_suite_name_view{ utility::extract_file_name (
                argv[0]) };
 
            const auto dot_pos = top_suite_name_view.rfind ('.');
            if (dot_pos != std::string_view::npos)
              {
                top_suite_name_view = top_suite_name_view.substr (0, dot_pos);
              }
 
            top_suite_name_ = top_suite_name_view;
          }
        else
          {
            top_suite_name_ = "default suite";
          }
        top_suite_.name (top_suite_name_.c_str ());
      }
 
    std::vector<std::string_view> argvs (argv, argv + argc);
 
    std::string_view reporter_name{ "tap" };
    static constexpr std::string_view reporter_prefix{ "--reporter=" };
    for (size_t i = 0; i < argvs.size (); ++i)
      {
        if (argvs[i].starts_with (reporter_prefix))
          {
            reporter_name = argvs[i].substr (reporter_prefix.size ());
          }
        else if (argvs[i]
                 == reporter_prefix.substr (0, reporter_prefix.size () - 1))
          {
            if (i + 1 < argvs.size ())
              {
                reporter_name = argvs[++i];
              }
            else
              {
                fprintf (stderr, "error: --reporter option requires a "
                                 "reporter name argument\n");
                exit (1);
              }
          }
      }
 
    // Initialise and configure the reporter.
    if (reporter_name == "human")
      {
        reporter_ = std::make_unique<reporter_human> (
            std::make_unique<std::vector<std::string_view>> (
                std::move (argvs)));
      }
    else if (reporter_name == "tap")
      {
        reporter_ = std::make_unique<reporter_tap> (
            std::make_unique<std::vector<std::string_view>> (
                std::move (argvs)));
      }
    else
      {
        fprintf (stderr, "error: unknown reporter '%.*s'\n",
                 static_cast<int> (reporter_name.size ()),
                 reporter_name.data ());
        exit (1);
      }
 
    // ------------------------------------------------------------------------
 
    timings_.timestamp_begin ();
    reporter_->begin_session (*this);
 
    top_suite_.timings ().timestamp_begin ();
    reporter_->begin_suite (top_suite_);
 
    return top_suite_;
  }

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.

    {
      return name_;
    }

References name_.

◆ operator=() [1/2]

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

delete

References static_runner().

◆ operator=() [2/2]

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

delete

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

◆ register_static_suite()

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

static

Parameters

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

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

Definition at line 646 of file runner.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_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__, suite.name ());
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
    if (runner.static_children_suites_ == nullptr)
      {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
        trace::printf ("%s new static_children_suites_ array\n",
                       __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
        runner.static_children_suites_ = new std::vector<static_suite*>;
      }
    runner.static_children_suites_->push_back (&suite);
  }

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

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

◆ register_suite_()

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

protectedinherited

Parameters

[in] suite Owning pointer to the test suite to register.

Returns: Nothing.

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

Definition at line 316 of file runner.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_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__, suite->name ());
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
    children_suites_.push_back (std::move (suite));
  }

References children_suites_, and suite().

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

◆ reporter()

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

inlinenodiscardnoexceptinherited

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.

  {
    return *reporter_;
  }

References reporter_.

Referenced by operator=().

◆ run_suites_()

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

overrideprotectedvirtual

Parameters: None.

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

Reimplemented from micro_os_plus::micro_test_plus::runner.

Definition at line 591 of file runner.cpp.

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED)
    trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
 
    runner::run_suites_ ();
 
    if (static_children_suites_ != nullptr)
      {
        // Use selection sort with std::swap on raw pointers (returns void)
        // to avoid std::sort triggering -Waggregate-return via
        // std::move_backward returning a class-type iterator.
        const size_t n = static_children_suites_->size ();
        auto& suites = *static_children_suites_;
        for (size_t i = 0; i < n; ++i)
          {
            size_t min_idx = i;
            for (size_t j = i + 1; j < n; ++j)
              {
                if (std::string_view{ suites[j]->name () }
                    < std::string_view{ suites[min_idx]->name () })
                  min_idx = j;
              }
            if (min_idx != i)
              std::swap (suites[i], suites[min_idx]);
          }
 
        for (size_t i = 0; i < n; ++i)
          {
            auto* suite_ptr = suites[i];
 
            suite_ptr->own_index (i + 1 + suites_count ());
 
            // Run the child suite immediately.
            suite_ptr->run ();
 
            // Accumulate the totals from the static suite into the runner
            // totals.
            // DO NOT increment executed_subtests here.
            totals_ += suite_ptr->totals ();
          }
      }
  }

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

◆ static_suites_count()

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

nodiscardnoexcept

Parameters: None.

Returns: The total number of registered static test suites.

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

Definition at line 563 of file runner.cpp.

  {
    return static_children_suites_ != nullptr
               ? static_children_suites_->size ()
               : 0;
  }

References static_children_suites_.

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

◆ suite()

template<typename Callable_T, typename... Args_T>

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

inherited

Template Parameters

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

Parameters

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

Returns: Nothing.

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

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

  {
#if defined(MICRO_OS_PLUS_TRACE) \
    && defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_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_ENABLED
 
    auto child_suite = std::make_unique<class suite> (
        name, *this, std::forward<Callable_T> (callable),
        std::forward<Args_T> (arguments)...);
 
    register_suite_ (std::move (child_suite));
  }

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

nodiscardnoexceptinherited

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.

  {
    return children_suites_.size () + 1;
  }

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

inlinenodiscardnoexceptinherited

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.

  {
    return timings_;
  }

References timings_.

◆ timings() [2/2]

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

inlinenodiscardnoexceptinherited

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.

  {
    return timings_;
  }

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::static_runner::total_suites_count ( void ) const

nodiscardfinaloverridevirtualnoexcept

Parameters: None.

Returns: The total number of test suites.

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

Reimplemented from micro_os_plus::micro_test_plus::runner.

Definition at line 576 of file runner.cpp.

  {
    return suites_count () + static_suites_count ();
  }

References static_suites_count(), and micro_os_plus::micro_test_plus::runner::suites_count().

◆ 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

◆ children_suites_

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

protectedinherited

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_

protectedinherited

Definition at line 306 of file runner.h.

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

◆ static_children_suites_

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

protected

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

Definition at line 450 of file runner.h.

Referenced by ~static_runner(), run_suites_(), and static_suites_count().

◆ timings_

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

protectedinherited

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_

protectedinherited

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_

protectedinherited

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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ static_runner() [1/4]

◆ static_runner() [2/4]

◆ static_runner() [3/4]

◆ static_runner() [4/4]

◆ ~static_runner()

Member Function Documentation

◆ abort()

◆ exit_code()

◆ initialise()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ register_static_suite()

◆ register_suite_()

◆ reporter()

◆ run_suites_()

◆ static_suites_count()

◆ suite()

◆ suites_count()

◆ timings() [1/2]

◆ timings() [2/2]

◆ total_suites_count()

◆ totals() [1/2]

◆ totals() [2/2]

Member Data Documentation

◆ children_suites_

◆ name_

◆ reporter_

◆ static_children_suites_

◆ timings_

◆ top_suite_

◆ top_suite_name_

◆ totals_