@micro-os-plus/micro-test-plus 4.0.0 → 4.1.1

package/src/reporter-human.cpp

@@ -36,13 +36,6 @@
 
 // ----------------------------------------------------------------------------
 
-#if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
-#include <micro-os-plus/config.h>
-#endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
-
-#include <micro-os-plus/micro-test-plus.h>
-#include <micro-os-plus/diag/trace.h>
-
 // For the PRIu32 macro used in snprintf() formatting of uint32_t values.
 #include <cinttypes>
 
@@ -51,6 +44,18 @@
 #include <unistd.h>
 #endif
 
+#if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
+#include <micro-os-plus/config.h>
+#endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
+
+#if defined(MICRO_OS_PLUS_TRACE)
+#include <micro-os-plus/diag/trace.h>
+#endif // MICRO_OS_PLUS_TRACE
+
+#include "micro-os-plus/micro-test-plus/reporter-human.h"
+#include "micro-os-plus/micro-test-plus/runner.h"
+#include "micro-os-plus/micro-test-plus/test.h"
+
 // ----------------------------------------------------------------------------
 
 #if defined(__GNUC__)
@@ -88,7 +93,7 @@ namespace micro_os_plus::micro_test_plus
 #if defined(__APPLE__) || defined(__linux__) || defined(__unix__)
     if (isatty (fileno (stdout)))
       {
-        colours_ = colours_red_green;
+        colours_ = detail::colours_red_green;
       }
 #endif
   }
@@ -126,7 +131,7 @@ namespace micro_os_plus::micro_test_plus
    * folders by allowing `*this << indent(n) << "text"` chaining.
    */
   reporter_human&
-  reporter_human::operator<< (indent_t m)
+  reporter_human::operator<< (detail::indent_t m)
   {
     buffer_.append (m.level * indent_size, ' ');
     return *this;
@@ -288,7 +293,7 @@ namespace micro_os_plus::micro_test_plus
    * cases and folders.
    */
   void
-  reporter_human::begin_suite ([[maybe_unused]] suite& suite)
+  reporter_human::begin_suite (suite& suite)
   {
 #if defined(MICRO_OS_PLUS_TRACE) \
     && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
@@ -481,7 +486,7 @@ namespace micro_os_plus::micro_test_plus
    * results across all test cases and folders.
    */
   void
-  reporter_human::begin_subtest ([[maybe_unused]] subtest& subtest)
+  reporter_human::begin_subtest (subtest& subtest)
   {
 #if defined(MICRO_OS_PLUS_TRACE) \
     && defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
@@ -694,9 +699,9 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This method outputs the prefix for a passing test result, applying the
+   * This method outputs the prefix for a passing check result, applying the
    * appropriate colour formatting and symbols to clearly indicate success. If
-   * the output occurs within a test case, additional indentation is applied
+   * the output occurs within a subtest, additional indentation is applied
    * for readability. The prefix includes a tick symbol (`✓`) and, if provided,
    * an associated message. Colour formatting is reset after the prefix to
    * maintain consistent output style across all test cases and folders.
@@ -705,8 +710,7 @@ namespace micro_os_plus::micro_test_plus
    * generated by the template methods.
    */
   void
-  reporter_human::output_pass_prefix_ (std::string& message,
-                                       [[maybe_unused]] subtest& subtest)
+  reporter_human::output_pass_prefix_ (std::string& message, subtest& subtest)
   {
     size_t level = subtest.nesting_depth ();
 
@@ -720,16 +724,9 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * The `endl` function acts as a stream manipulator for the `reporter`,
-   * inserting a line ending into the output buffer and flushing the current
-   * content if necessary. This ensures that test report output is clearly
-   * separated and formatted, improving readability and professionalism in the
-   * presentation of test results.
-   *
-   * Using `endl` in conjunction with the `reporter` output operators
-   * provides a familiar and convenient mechanism for managing line breaks,
-   * similar to standard C++ stream manipulators.
-   *
+    * Completes pass output by appending `endl` and flushing buffered
+    * content to the configured sinks.
+
    * The prefix/suffix methods help shorten the code
    * generated by the template methods.
    */
@@ -743,9 +740,9 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This method outputs the prefix for a failing test result, applying the
+   * This method outputs the prefix for a failing check result, applying the
    * appropriate colour formatting and symbols to clearly indicate failure. If
-   * the output occurs within a test case, additional indentation is applied
+   * the output occurs within a subtest, additional indentation is applied
    * for readability. The prefix includes a cross symbol (`✗`), an optional
    * message, and the label "FAILED". The source location is appended in
    * parentheses, showing the file or folder name and line number where the
@@ -754,9 +751,8 @@ namespace micro_os_plus::micro_test_plus
    */
   void
   reporter_human::output_fail_prefix_ (
-      std::string& message, const bool hasExpression,
-      const reflection::source_location& location,
-      [[maybe_unused]] subtest& subtest)
+      std::string& message, const bool has_expression,
+      const reflection::source_location& location, subtest& subtest)
   {
 #if defined(__GNUC__)
 #pragma GCC diagnostic push
@@ -779,10 +775,8 @@ namespace micro_os_plus::micro_test_plus
       }
     *this << colours_.fail << "FAILED" << colours_.none;
     *this << " (" << reflection::short_name (location.file_name ()) << ":"
-          << type_traits::genuine_integral_value<unsigned int>{
-               location.line ()
-             };
-    if (hasExpression)
+          << location.line ();
+    if (has_expression)
       {
         *this << ", ";
       }
@@ -794,9 +788,9 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This method outputs the suffix for a failing test result by closing the
-   * location information, appending an "aborted..." message if the test was
-   * aborted, and then adding a newline to the test output. The output stream
+   * This method outputs the suffix for a failing check result by closing the
+   * location information, appending an "aborted..." message if the check was
+   * aborted, and then adding a newline to the output. The output stream
    * is flushed to ensure immediate visibility. This approach guarantees that
    * failure results are clearly separated, promptly reported, and easily
    * distinguishable across all test cases and folders.

package/src/reporter-tap.cpp

@@ -34,15 +34,20 @@
 
 // ----------------------------------------------------------------------------
 
+// For the PRIu32 macro used in snprintf() formatting of uint32_t values.
+#include <cinttypes>
+
 #if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
 #include <micro-os-plus/config.h>
 #endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
-#include <micro-os-plus/micro-test-plus.h>
+#if defined(MICRO_OS_PLUS_TRACE)
 #include <micro-os-plus/diag/trace.h>
+#endif // MICRO_OS_PLUS_TRACE
 
-// For the PRIu32 macro used in snprintf() formatting of uint32_t values.
-#include <cinttypes>
+#include "micro-os-plus/micro-test-plus/reporter-tap.h"
+#include "micro-os-plus/micro-test-plus/runner.h"
+#include "micro-os-plus/micro-test-plus/test.h"
 
 // ----------------------------------------------------------------------------
 
@@ -103,7 +108,7 @@ namespace micro_os_plus::micro_test_plus
    * folders by allowing `*this << indent(n) << "text"` chaining.
    */
   reporter_tap&
-  reporter_tap::operator<< (indent_t m)
+  reporter_tap::operator<< (detail::indent_t m)
   {
     buffer_.append (m.level * indent_size, ' ');
     return *this;
@@ -656,9 +661,9 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This method outputs the prefix for a passing suite result, applying the
+   * This method outputs the prefix for a passing check result, applying the
    * appropriate colour formatting and symbols to clearly indicate success. If
-   * the output occurs within a test case, additional indentation is applied
+   * the output occurs within a subtest, additional indentation is applied
    * for readability. The prefix includes a tick symbol (`✓`) and, if provided,
    * an associated message. Colour formatting is reset after the prefix to
    * maintain consistent output style across all test cases and folders.
@@ -680,16 +685,9 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * The `endl` function acts as a stream manipulator for the `reporter`,
-   * inserting a line ending into the output buffer and flushing the current
-   * content if necessary. This ensures that suite report output is clearly
-   * separated and formatted, improving readability and professionalism in the
-   * presentation of suite results.
-   *
-   * Using `endl` in conjunction with the `reporter` output operators
-   * provides a familiar and convenient mechanism for managing line breaks,
-   * similar to standard C++ stream manipulators.
-   *
+    * Completes pass output by appending `endl` and flushing buffered
+    * content to the configured sinks.
+
    * The prefix/suffix methods help shorten the code
    * generated by the template methods.
    */
@@ -703,18 +701,16 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This method outputs the prefix for a failing suite result, applying the
+   * This method outputs the prefix for a failing check result, applying the
    * appropriate colour formatting and symbols to clearly indicate failure. If
-   * the output occurs within a test case, additional indentation is applied
+   * the output occurs within a subtest, additional indentation is applied
    * for readability. The prefix includes a cross symbol (`✗`), an optional
-   * message, and the label "FAILED". The source location is appended in
-   * parentheses, showing the file or folder name and line number where the
-   * failure occurred. Colour formatting is reset after the prefix to maintain
-   * consistent output style across all test cases and folders.
+   * message, and YAML diagnostics preamble. Colour formatting and line
+   * structure are arranged to conform to TAP14 diagnostics output.
    */
   void
   reporter_tap::output_fail_prefix_ (
-      std::string& message, [[maybe_unused]] const bool hasExpression,
+      std::string& message, const bool has_expression,
       [[maybe_unused]] const reflection::source_location& location,
       subtest& subtest)
   {
@@ -731,7 +727,7 @@ namespace micro_os_plus::micro_test_plus
     // https://testanything.org/tap-version-14-specification.html
     // 2-space indentation for YAML diagnostics.
     *this << indent (level + 1) << "  ---";
-    if (hasExpression)
+    if (has_expression)
       {
         *this << endl;
         *this << indent (level + 1) << "  condition: ";
@@ -740,17 +736,14 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This method outputs the suffix for a failing suite result by closing the
-   * location information, appending an "aborted..." message if the suite was
-   * aborted, and then adding a newline to the suite output. The output stream
-   * is flushed to ensure immediate visibility. This approach guarantees that
-   * failure results are clearly separated, promptly reported, and easily
-   * distinguishable across all test cases and folders.
+   * Completes TAP14 YAML diagnostics for a failing check, optionally appends
+   * an "aborted..." marker, emits source filename/line fields, closes the
+   * YAML block, and flushes the stream.
    */
   void
   reporter_tap::output_fail_suffix_ (
       const reflection::source_location& location, bool abort,
-      [[maybe_unused]] subtest& subtest)
+      subtest& subtest)
   {
     size_t level = subtest.nesting_depth ();
     if (abort)
@@ -766,10 +759,7 @@ namespace micro_os_plus::micro_test_plus
     *this << indent (level + 1)
           << "    filename: " << reflection::short_name (location.file_name ())
           << endl;
-    *this << indent (level + 1) << "    line: "
-          << type_traits::genuine_integral_value<unsigned int>{ location
-                                                                    .line () }
-          << endl;
+    *this << indent (level + 1) << "    line: " << location.line () << endl;
 
     *this << indent (level + 1) << "  ..." << endl;
 

package/src/reporter.cpp

@@ -22,17 +22,14 @@
  *
  * @details
  * This source file contains the core implementations for the test reporting
- * facilities of the µTest++ framework. It provides the logic for formatting
- * and outputting test results, including operator overloads for a wide range
- * of value types, containers, and comparison expressions, as well as
- * structured output for logical and exception-related assertions.
+ * facilities of the µTest++ framework. It provides lifecycle and utility
+ * behaviour for reporters, including command-line option parsing,
+ * output-file handling, informational banner emission, buffering helpers,
+ * stream operators, and pass/fail dispatch to reporter-specific prefix/
+ * suffix hooks.
  *
- * The test reporter is responsible for presenting test outcomes in a clear,
- * consistent, and expressive manner, supporting both value and pointer
- * semantics, and providing detailed diagnostics for both successful and failed
- * test cases. Special attention is given to formatting, colour highlighting,
- * and extensibility, enabling professional and readable test reports suitable
- * for embedded and general C++ development.
+ * Concrete formatting behaviour is implemented by derived reporters
+ * (`reporter_human` and `reporter_tap`).
  *
  * All definitions reside within the `micro_os_plus::micro_test_plus`
  * namespace, ensuring clear separation from user code and minimising the risk
@@ -47,8 +44,11 @@
 #include <micro-os-plus/config.h>
 #endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
-#include <micro-os-plus/micro-test-plus.h>
+#if defined(MICRO_OS_PLUS_TRACE)
 #include <micro-os-plus/diag/trace.h>
+#endif // MICRO_OS_PLUS_TRACE
+
+#include "micro-os-plus/micro-test-plus/reporter.h"
 
 // ----------------------------------------------------------------------------
 
@@ -436,238 +436,43 @@ namespace micro_os_plus::micro_test_plus
 
   /**
    * @details
-   * This operator overload appends the string representation of the specified
-   * boolean value to the internal output buffer of the `reporter`. It
-   * enables clear and direct streaming of boolean results into the reporter,
-   * supporting precise and readable formatting of test output across all test
-   * cases and folders.
-   */
-  reporter&
-  reporter::operator<< (bool v)
-  {
-    buffer_.append (v ? "true" : "false");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string "nullptr" to the internal output
-   * buffer of the `reporter`. It enables clear and explicit streaming of
-   * null pointer values into the reporter, supporting precise and readable
-   * formatting of test output across all test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (std::nullptr_t)
-  {
-    buffer_.append ("nullptr");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed character to the internal output buffer of the `reporter`. It
-   * enables precise and readable streaming of character values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  reporter&
-  reporter::operator<< (signed char c)
-  {
-    append_number_ (buffer_, c);
-    buffer_.append ("c");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned character to the internal output buffer of the `reporter`.
-   * It enables precise and readable streaming of unsigned character values
-   * into the reporter, supporting clear formatting of test output across all
-   * test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (unsigned char c)
-  {
-    append_number_ (buffer_, c);
-    buffer_.append ("uc");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed short integer to the internal output buffer of the `reporter`.
-   * It enables precise and readable streaming of signed short values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  reporter&
-  reporter::operator<< (signed short v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("s");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned short integer to the internal output buffer of the
-   * `reporter`. It enables precise and readable streaming of unsigned
-   * short values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
+   * Outputs a pass prefix, followed by either the provided message or, if
+   * the message is empty, the evaluated expression string itself. A pass
+   * suffix is then appended to complete the output.
    */
-  reporter&
-  reporter::operator<< (unsigned short v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("us");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed integer to the internal output buffer of the `reporter`. It
-   * enables precise and readable streaming of signed integer values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  reporter&
-  reporter::operator<< (signed int v)
-  {
-    append_number_ (buffer_, v);
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned integer to the internal output buffer of the `reporter`. It
-   * enables precise and readable streaming of unsigned integer values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  reporter&
-  reporter::operator<< (unsigned int v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("u");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed long integer to the internal output buffer of the `reporter`.
-   * It enables precise and readable streaming of signed long values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  reporter&
-  reporter::operator<< (signed long v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("l");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned long integer to the internal output buffer of the
-   * `reporter`. It enables precise and readable streaming of unsigned
-   * long values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (unsigned long v)
+  void
+  reporter::pass (std::string& message, const std::string& expression,
+                  subtest& subtest)
   {
-    append_number_ (buffer_, v);
-    buffer_.append ("ul");
-    return *this;
-  }
+    output_pass_prefix_ (message, subtest);
 
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed long long integer to the internal output buffer of the
-   * `reporter`. It enables precise and readable streaming of signed long
-   * long values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (signed long long v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("ll");
-    return *this;
-  }
+    if (message.empty ())
+      {
+        *this << expression;
+      }
 
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned long long integer to the internal output buffer of the
-   * `reporter`. It enables precise and readable streaming of unsigned
-   * long long values into the reporter, supporting clear formatting of test
-   * output across all test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (unsigned long long v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("ull");
-    return *this;
+    output_pass_suffix_ (subtest);
   }
 
   /**
    * @details
-   * This operator overload appends the string representation of the specified
-   * floating-point value to the internal output buffer of the `reporter`,
-   * followed by the character 'f' to indicate a float type. It enables precise
-   * and readable streaming of float values into the reporter, supporting clear
-   * formatting of test output across all test cases and folders.
+   * Reports a test failure, formatting the output with source location and,
+   * when `has_expression` is true, the pre-formatted expression string.
    */
-  reporter&
-  reporter::operator<< (float v)
+  void
+  reporter::fail (bool abort, std::string& message,
+                  const std::string& expression, bool has_expression,
+                  const reflection::source_location& location,
+                  subtest& subtest)
   {
-    append_number_ (buffer_, v);
-    buffer_.append ("f");
-    return *this;
-  }
+    output_fail_prefix_ (message, has_expression, location, subtest);
 
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * double-precision floating-point value to the internal output buffer of the
-   * `reporter`. It enables precise and readable streaming of double
-   * values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (double v)
-  {
-    append_number_ (buffer_, v);
-    return *this;
-  }
+    if (has_expression)
+      {
+        *this << expression;
+      }
 
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * long double-precision floating-point value to the internal output buffer
-   * of the `reporter`, followed by the character 'l' to indicate a long
-   * double type. It enables precise and readable streaming of long double
-   * values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  reporter&
-  reporter::operator<< (long double v)
-  {
-    append_number_ (buffer_, v);
-    buffer_.append ("l");
-    return *this;
+    output_fail_suffix_ (location, abort, subtest);
   }
 
   // --------------------------------------------------------------------------

package/src/runner-totals.cpp

@@ -38,8 +38,11 @@
 #include <micro-os-plus/config.h>
 #endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
-#include <micro-os-plus/micro-test-plus.h>
+#if defined(MICRO_OS_PLUS_TRACE)
 #include <micro-os-plus/diag/trace.h>
+#endif // MICRO_OS_PLUS_TRACE
+
+#include "micro-os-plus/micro-test-plus/runner-totals.h"
 
 // ----------------------------------------------------------------------------
 
@@ -52,7 +55,7 @@
 
 // ============================================================================
 
-namespace micro_os_plus::micro_test_plus
+namespace micro_os_plus::micro_test_plus::detail
 {
   // ===========================================================================
 
@@ -90,6 +93,6 @@ namespace micro_os_plus::micro_test_plus
   }
 
   // --------------------------------------------------------------------------
-} // namespace micro_os_plus::micro_test_plus
+} // namespace micro_os_plus::micro_test_plus::detail
 
 // ----------------------------------------------------------------------------