deferred_reporter_base Class

Base class for a deferred reporter that collects messages into a string. More...

Declaration

class micro_os_plus::micro_test_plus::detail::deferred_reporter_base { ... }

Included Headers

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

Derived Classes

class	deferred_reporter
	Deferred reporter class for a specific expression. More...

Public Constructors Index

	deferred_reporter_base (bool value, const reflection::source_location &location, subtest &subtest)
	Constructs a deferred reporter base. More...
	deferred_reporter_base (const deferred_reporter_base &)=delete
	Deleted copy constructor to prevent copying. More...
	deferred_reporter_base (deferred_reporter_base &&)=delete
	Deleted move constructor to prevent moving. More...

Public Destructor Index

	~deferred_reporter_base ()
	Destructor for the deferred reporter base. More...

Public Operators Index

template <class T>
auto &	operator<< (const T &msg)
	Appends a message to the reporter. More...
deferred_reporter_base &	operator= (const deferred_reporter_base &)=delete
	Deleted copy assignment operator to prevent copying. More...
deferred_reporter_base &	operator= (deferred_reporter_base &&)=delete
	Deleted move assignment operator to prevent moving. More...

Public Member Functions Index

bool	value () const
	Retrieves the result value. More...

Protected Member Attributes Index

bool	abort_ = false
	Indicates whether the reporting should abort further processing. More...
std::string	deferred_output_ {}
	String to collect the expectation message passed via operator<<(). More...
bool	has_expression_ = false
	Indicates whether the reporter has an associated expression. More...
const reflection::source_location	location_ {}
	Stores the source location associated with the report. More...
subtest &	subtest_
	Reference to the test case invoking this report. More...
bool	value_ {}
	Stores the result value of the report. More...

Description

Base class for a deferred reporter that collects messages into a string.

The deferred_reporter_base class serves as the foundational component for deferred reporting within the framework. It is responsible for collecting expectation messages, typically passed via the operator<<(), into a string for later reporting.

This class maintains the result value, abort status, and the source location associated with the report. It is intended exclusively for internal use and is implemented in the include/micro-os-plus/micro-test-plus folder to ensure a structured and modular codebase.

Definition at line 100 of file deferred-reporter.h.

Public Constructors

deferred_reporter_base()

micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base (bool value, const reflection::source_location & location, subtest & subtest)

Constructs a deferred reporter base.

Parameters

value	The result value associated with the report.
location	The source location relevant to the report.
subtest	The subtest that owns this deferred report.

Stores the evaluated Boolean value, the location identifying the source line of the assertion, and a reference to the owning subtest. The subtest's check index counter is incremented immediately so that the first check is reported as check #1.

Declaration at line 110 of file deferred-reporter.h, definition at line 75 of file deferred-reporter.cpp.

75 deferred_reporter_base::deferred_reporter_base (

76 bool value, const reflection::source_location& location,

77 subtest& subtest)

78 : value_{ value }, location_{ location }, subtest_{ subtest }

79 {

80 // The index starts at 0, must be incremented before the first check is

81 // reported, to ensure that the first check is reported as check #1.

82 subtest_.increment_subtest_index ();

83 }

References location_, subtest_, value and value_.

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter::deferred_reporter, deferred_reporter_base, deferred_reporter_base, operator= and operator=.

deferred_reporter_base()

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

delete

Deleted copy constructor to prevent copying.

Definition at line 117 of file deferred-reporter.h.

Reference deferred_reporter_base.

deferred_reporter_base()

micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_reporter_base (deferred_reporter_base &&)

delete

Deleted move constructor to prevent moving.

Definition at line 122 of file deferred-reporter.h.

Reference deferred_reporter_base.

Public Destructor

~deferred_reporter_base()

micro_os_plus::micro_test_plus::detail::deferred_reporter_base::~deferred_reporter_base ()

Destructor for the deferred reporter base.

The destructor finalises the deferred reporting process for a test expression. If the evaluated expression is true, the reporter records a successful outcome along with any accumulated message. If the expression is false, the reporter records a failure, including the abort status, message, and source location for comprehensive reporting.

This mechanism ensures that all relevant information about the test outcome is captured and reported accurately when the deferred reporter goes out of scope.

The destructor ensures that if an abort condition is set and the test expression has failed, the test output is flushed and the process is terminated. This mechanism guarantees immediate feedback and halts further execution upon critical test failures, aiding in rapid identification and resolution of issues during test runs.

Declaration at line 141 of file deferred-reporter.h, definition at line 103 of file deferred-reporter.cpp.

103 deferred_reporter_base::~deferred_reporter_base ()

104 {

105#if defined(MICRO_OS_PLUS_TRACE) \

106 && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS)

107 trace::printf ("%s\n", __PRETTY_FUNCTION__);

108#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS_CONSTRUCTORS

109

110 auto& expression_str = subtest_.reporter ().expression ().str ();

111

112 if (value_) [[likely]]

113 {

114 subtest_.reporter ().pass (deferred_output_, expression_str,

115 subtest_);

116 subtest_.totals ().increment_successful_checks ();

117 }

118 else

119 {

120 subtest_.reporter ().fail (abort_, deferred_output_, expression_str,

121 has_expression_, location_, subtest_);

122 subtest_.totals ().increment_failed_checks ();

123 }

124

125 if (abort_ && !value_) [[unlikely]]

126 {

127 subtest_.reporter ().write_buffer_to_stdout ();

128 subtest_.reporter ().flush ();

129 subtest_.abort (location_);

130 }

131 }

References abort_, deferred_output_, has_expression_, location_, subtest_ and value_.

Public Operators

operator<<()

template <class T>

auto & micro_os_plus::micro_test_plus::detail::deferred_reporter_base::operator<< (const T & msg)

Appends a message to the reporter.

Template Parameters

T	The type of the message to append.

Parameters

msg	The message to append.

Returns

Reference to the current reporter instance.

This operator overload enables the deferred reporter to accumulate expectation messages by appending the provided value to the internal message string.

If the argument is a char, it is appended directly as a character. If the argument is of another arithmetic type, it is converted to a string using a fixed-size buffer and std::to_chars to avoid dynamic memory allocation. For all other types, the value is appended directly.

Declaration at line 153 of file deferred-reporter.h, definition at line 108 of file deferred-reporter-inlines.h.

108 deferred_reporter_base::operator<<(const T& msg)

109 {

110 if constexpr (std::is_same_v<T, char>)

111 {

112 deferred_output_.push_back (msg);

113 }

114 else if constexpr (std::is_arithmetic_v<T>)

115 {

116 // Optimise to avoid dynamic memory allocation in std::to_string by

117 // using a fixed-size buffer and std::to_chars.

118#if defined(__GNUC__)

119#pragma GCC diagnostic push

120#if defined(__clang__)

121#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"

122#endif

123#endif

124 char buf[64];

125 // 64 bytes is sufficient for the longest decimal representation

126 // of any standard arithmetic type (long double ~45 chars).

127 static_assert (sizeof (buf) >= 50,

128 "buf must be large enough for any arithmetic type");

129 auto [ptr, ec] = std::to_chars (buf, buf + sizeof (buf), msg);

130 if (ec == std::errc{})

131 deferred_output_.append (buf, ptr);

132#if defined(__GNUC__)

133#pragma GCC diagnostic pop

134#endif

135 }

136 else

137 {

138 deferred_output_.append (msg);

139 }

140 return *this;

141 }

Reference deferred_output_.

operator=()

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

delete

Deleted copy assignment operator to prevent copying.

Definition at line 128 of file deferred-reporter.h.

Reference deferred_reporter_base.

operator=()

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

delete

Deleted move assignment operator to prevent moving.

Definition at line 135 of file deferred-reporter.h.

Reference deferred_reporter_base.

Public Member Functions

value()

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::value ()

inline nodiscard

Retrieves the result value.

Parameters

None.

Return Values

true	The reported condition was met.
false	The reported condition was not met.

Returns the result value stored in value_.

Declaration at line 165 of file deferred-reporter.h, definition at line 87 of file deferred-reporter-inlines.h.

87 deferred_reporter_base::value () const

88 {

89 return value_;

90 }

Reference value_.

Referenced by deferred_reporter_base.

Protected Member Attributes

abort_

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::abort_ = false

protected

Indicates whether the reporting should abort further processing.

Definition at line 177 of file deferred-reporter.h.

177 bool abort_ = false;

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter::deferred_reporter and ~deferred_reporter_base.

deferred_output_

std::string micro_os_plus::micro_test_plus::detail::deferred_reporter_base::deferred_output_ {}

protected

String to collect the expectation message passed via operator<<().

Definition at line 193 of file deferred-reporter.h.

193 std::string deferred_output_{};

Referenced by ~deferred_reporter_base and operator<<.

has_expression_

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::has_expression_ = false

protected

Indicates whether the reporter has an associated expression.

Definition at line 182 of file deferred-reporter.h.

182 bool has_expression_ = false;

Referenced by micro_os_plus::micro_test_plus::detail::deferred_reporter::deferred_reporter and ~deferred_reporter_base.

location_

const reflection::source_location micro_os_plus::micro_test_plus::detail::deferred_reporter_base::location_ {}

protected

Stores the source location associated with the report.

Definition at line 187 of file deferred-reporter.h.

187 const reflection::source_location location_{};

Referenced by deferred_reporter_base and ~deferred_reporter_base.

subtest_

subtest& micro_os_plus::micro_test_plus::detail::deferred_reporter_base::subtest_

protected

Reference to the test case invoking this report.

Definition at line 198 of file deferred-reporter.h.

198 subtest& subtest_;

Referenced by deferred_reporter_base and ~deferred_reporter_base.

value_

bool micro_os_plus::micro_test_plus::detail::deferred_reporter_base::value_ {}

protected

Stores the result value of the report.

Definition at line 171 of file deferred-reporter.h.

171 bool value_{};

Referenced by deferred_reporter_base, ~deferred_reporter_base and value.

---

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

• deferred-reporter.h
• deferred-reporter-inlines.h
• deferred-reporter.cpp

---

Generated via doxygen2docusaurus 2.2.0 by Doxygen 1.17.0.