micro_os_plus::micro_test_plus::detail::test_node Class Reference

Base class for runners and runable tests. More...

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

Inheritance diagram for micro_os_plus::micro_test_plus::detail::test_node:

Public Member Functions
	test_node (const char *name)
	Constructs a test node.
	test_node (const test_node &)=delete
	Deleted copy constructor to prevent copying.
	test_node (test_node &&)=delete
	Deleted move constructor to prevent moving.
virtual	~test_node ()
	Virtual destructor for the test_node class.
const char *	name (void) const noexcept
	Gets the node name.
test_node &	operator= (const test_node &)=delete
	Deleted copy assignment operator to prevent copying.
test_node &	operator= (test_node &&)=delete
	Deleted move assignment operator to prevent moving.
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 Attributes
const char *	name_
	The test node name.
runner_totals	totals_
	Totals for the test node, including nested cases.

Detailed Description

The test_node class provides the foundational interface for managing test within the µTest++ framework. It maintains counters for successful and failed checks, tracks test cases, and offers methods for marking the commencement and completion of test cases and suites.

This class ensures consistent state management and reporting for all derived classes. It also provides utility methods for querying the node's name, the number of successful and failed checks, the number of test cases, and the overall result of the node.

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

Definition at line 145 of file test.h.

Constructor & Destructor Documentation

test_node() [1/3]

micro_os_plus::micro_test_plus::detail::test_node::test_node

(

const char *

name

)

Parameters

[in]

name

The test node name.

Stores the supplied name pointer, which is expected to point to a string with a lifetime exceeding that of this instance. If tracing is enabled, the name is output for diagnostic purposes.

Definition at line 84 of file test.cpp.

                                          : name_{ name }
    {
#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 name(), and name_.

Referenced by 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(), test_node(), test_node(), operator=(), and operator=().

test_node() [2/3]

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

delete

References test_node().

test_node() [3/3]

micro_os_plus::micro_test_plus::detail::test_node::test_node ( test_node && )

delete

References test_node().

~test_node()

micro_os_plus::micro_test_plus::detail::test_node::~test_node ( )

virtual

No resources are owned by test_node; the destructor performs no explicit clean-up. If tracing is enabled, the node name is output for diagnostic purposes.

Definition at line 107 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 name_.

Member Function Documentation

name()

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 91 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]

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

delete

References test_node().

operator=() [2/2]

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

delete

References test_node(), and totals().

totals() [1/2]

const runner_totals & micro_os_plus::micro_test_plus::detail::test_node::totals ( ) const

inlinenodiscardnoexcept

Parameters

None.

Returns

A const reference to the runner_totals instance.

Returns a const reference to the runner_totals member.

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

    {
      return totals_;
    }

References totals_.

totals() [2/2]

runner_totals & micro_os_plus::micro_test_plus::detail::test_node::totals ( )

inlinenodiscardnoexcept

Parameters

None.

Returns

A reference to the runner_totals instance.

Returns a reference to the runner_totals member.

Definition at line 101 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

name_

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

protected

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

totals_

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

protected

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
• test.cpp