@micro-os-plus/micro-test-plus 3.2.3 → 3.3.1

package/src/test-reporter.cpp

@@ -62,6 +62,10 @@ namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
 
+  test_reporter::~test_reporter () = default;
+
+  // --------------------------------------------------------------------------
+
   /**
    * @details
    * The `endl` function inserts a newline character into the specified
@@ -73,127 +77,10 @@ namespace micro_os_plus::micro_test_plus
   test_reporter&
   endl (test_reporter& stream)
   {
-    reporter.endline ();
+    reporter->endline ();
     return stream;
   }
 
-  // --------------------------------------------------------------------------
-
-  /**
-   * @details
-   * This method outputs the prefix for a passing test result, applying the
-   * appropriate colour formatting and symbols to clearly indicate success. If
-   * the output occurs within a test case, 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.
-   *
-   * The prefix/suffix methods help shorten the code
-   * generated by the template methods.
-   */
-  void
-  test_reporter::output_pass_prefix_ (std::string& message)
-  {
-    *this << colors_.pass;
-    if (is_in_test_case_)
-      {
-        *this << "  ";
-      }
-    *this << "  ✓ ";
-    *this << colors_.none;
-    if (!message.empty ())
-      {
-        *this << message.c_str ();
-      }
-  }
-
-  /**
-   * @details
-   * The `endl` function acts as a stream manipulator for the `test_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 `test_reporter` output operators
-   * provides a familiar and convenient mechanism for managing line breaks,
-   * similar to standard C++ stream manipulators.
-   *
-   * The prefix/suffix methods help shorten the code
-   * generated by the template methods.
-   */
-  void
-  test_reporter::output_pass_suffix_ (void)
-  {
-    *this << endl;
-
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method outputs the prefix for a failing test result, applying the
-   * appropriate colour formatting and symbols to clearly indicate failure. If
-   * the output occurs within a test case, 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.
-   */
-  void
-  test_reporter::output_fail_prefix_ (
-      std::string& message, const reflection::source_location& location)
-  {
-    *this << colors_.fail;
-    if (is_in_test_case_)
-      {
-        *this << "  ";
-      }
-    *this << "  ✗ ";
-    *this << colors_.none;
-    if (!message.empty ())
-      {
-        *this << message.c_str ();
-        *this << " ";
-      }
-    *this << colors_.fail << "FAILED" << colors_.none;
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wsign-conversion"
-#elif defined(__GNUC__)
-#pragma GCC diagnostic ignored "-Wnarrowing"
-#pragma GCC diagnostic ignored "-Wsign-conversion"
-#endif
-    *this << " (" << reflection::short_name (location.file_name ()) << ":"
-          << type_traits::genuine_integral_value<unsigned int>{
-               location.line ()
-             };
-#pragma GCC diagnostic pop
-  }
-
-  /**
-   * @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
-   * 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.
-   */
-  void
-  test_reporter::output_fail_suffix_ (bool abort)
-  {
-    *this << ")";
-    if (abort)
-      {
-        *this << " aborted...";
-      }
-    *this << endl;
-
-    flush ();
-  }
-
   /**
    * @details
    * This operator overload enables manipulators, such as `endl`, to be used
@@ -211,34 +98,6 @@ namespace micro_os_plus::micro_test_plus
     return *this;
   }
 
-  /**
-   * @details
-   * This method appends a newline character to the internal output buffer of
-   * the `test_reporter` and immediately flushes the stream. This ensures that
-   * each line of test output is clearly separated and promptly displayed,
-   * enhancing the readability and organisation of test results across all test
-   * cases and folders.
-   */
-  void
-  test_reporter::endline (void)
-  {
-    out_.append ("\n");
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method flushes the output buffer of the `test_reporter` by
-   * synchronising it with the standard output stream. This guarantees that all
-   * pending test output is immediately written and visible, ensuring prompt
-   * and reliable reporting of test results across all test cases and folders.
-   */
-  void
-  test_reporter::flush (void)
-  {
-    fflush (stdout); // Sync STDOUT.
-  }
-
   /**
    * @details
    * This operator overload appends the contents of the provided
@@ -534,240 +393,6 @@ namespace micro_os_plus::micro_test_plus
     return *this;
   }
 
-  /**
-   * @details
-   * This method marks the beginning of a test case, setting the internal state
-   * to indicate that test output is now within a test case context. If there
-   * is pending output and the verbosity level is set to verbose, it ensures
-   * that output is properly separated and displayed, adding an empty line if
-   * necessary. The output buffer is cleared and the stream is flushed to
-   * guarantee that all previous output is visible before the new test case
-   * begins. This approach enhances the clarity and organisation of test
-   * results across all test cases and folders.
-   */
-  void
-  test_reporter::begin_test_case ([[maybe_unused]] const char* name)
-  {
-    is_in_test_case_ = true;
-
-    if (!out_.empty () && (verbosity == verbosity::verbose))
-      {
-        if (add_empty_line)
-          {
-            printf ("\n");
-          }
-        output ();
-        add_empty_line = true;
-      }
-
-    out_.clear ();
-
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method marks the end of a test case, summarising its outcome and
-   * outputting the results with appropriate formatting and colour coding. If
-   * any checks have failed, a failure message is displayed, including the
-   * number of successful and failed checks. For passing test cases, a success
-   * message is shown with the total number of checks. The output is adjusted
-   * according to the verbosity level, and additional spacing is managed for
-   * clarity. The output buffer is cleared and the stream is flushed to ensure
-   * all results are immediately visible, supporting clear and organised
-   * reporting across all test cases and folders.
-   */
-  void
-  test_reporter::end_test_case ([[maybe_unused]] const char* name)
-  {
-    if (verbosity == verbosity::normal || verbosity == verbosity::verbose)
-      {
-        if (current_test_suite->current_test_case.failed_checks > 0)
-          {
-            if (true /* add_empty_line */)
-              {
-                printf ("\n");
-              }
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-            printf ("  • %s - test case started\n", name);
-            output ();
-            printf (
-                "  %s✗%s %s - test case %sFAILED%s (%d %s passed, %d "
-                "failed)\n",
-                colors_.fail, colors_.none, name, colors_.fail, colors_.none,
-                current_test_suite->current_test_case.successful_checks,
-                current_test_suite->current_test_case.successful_checks == 1
-                    ? "check"
-                    : "checks",
-                current_test_suite->current_test_case.failed_checks);
-#pragma GCC diagnostic pop
-            add_empty_line = true;
-          }
-        else
-          {
-            if (add_empty_line)
-              {
-                printf ("\n");
-              }
-            if (verbosity == verbosity::verbose)
-              {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-                printf ("  • %s - test case started\n", name);
-                output ();
-                printf (
-                    "  %s✓%s %s - test case passed (%d %s)\n", colors_.pass,
-                    colors_.none, name,
-                    current_test_suite->current_test_case.successful_checks,
-                    current_test_suite->current_test_case.successful_checks
-                            == 1
-                        ? "check"
-                        : "checks");
-#pragma GCC diagnostic pop
-                add_empty_line = true;
-              }
-            else
-              {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-                printf (
-                    "  %s✓%s %s - test case passed (%d %s)\n", colors_.pass,
-                    colors_.none, name,
-                    current_test_suite->current_test_case.successful_checks,
-                    current_test_suite->current_test_case.successful_checks
-                            == 1
-                        ? "check"
-                        : "checks");
-#pragma GCC diagnostic pop
-
-                add_empty_line = false;
-              }
-          }
-      }
-
-    out_.clear ();
-    flush ();
-
-    is_in_test_case_ = false;
-  }
-
-  /**
-   * @details
-   * This method marks the beginning of a test suite, ensuring that output is
-   * properly separated and clearly presented. If there is pending output, the
-   * stream is flushed and an empty line is added for clarity. For silent or
-   * quiet verbosity levels, output is suppressed. Otherwise, a message
-   * indicating the start of the test suite is displayed. This approach
-   * enhances the organisation and readability of test results across all test
-   * cases and folders.
-   */
-  void
-  test_reporter::begin_test_suite (const char* name)
-  {
-    if (add_empty_line)
-      {
-        flush ();
-        printf ("\n");
-      }
-
-    if (verbosity == verbosity::silent || verbosity == verbosity::quiet)
-      {
-        add_empty_line = false;
-        return;
-      }
-
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-    printf ("• %s - test suite started\n", name);
-#pragma GCC diagnostic pop
-
-    add_empty_line = true;
-  }
-
-  /**
-   * @details
-   * This method marks the end of a test suite, summarising the overall results
-   * and presenting them with appropriate formatting and colour coding. If the
-   * suite contains test cases and the verbosity is not set to quiet, an empty
-   * line is added for clarity. For suites with no failed checks and at least
-   * one successful check, a success message is displayed, including the number
-   * of checks and test cases. Otherwise, a failure message is shown, detailing
-   * the number of successful and failed checks, as well as the total number of
-   * test cases. The output is immediately flushed to ensure prompt and
-   * organised reporting across all test cases and folders.
-   */
-  void
-  test_reporter::end_test_suite (test_suite_base& suite)
-  {
-    if (verbosity == verbosity::silent)
-      {
-        return;
-      }
-
-    if (suite.test_cases () > 0 && verbosity != verbosity::quiet)
-      {
-        printf ("\n");
-        add_empty_line = true;
-      }
-
-    // Also fail if none passed.
-    if (suite.failed_checks () == 0 && suite.successful_checks () != 0)
-      {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-        printf ("%s✓%s %s - test suite passed (%d %s in %d test %s)\n",
-                colors_.pass, colors_.none, suite.name (),
-                suite.successful_checks (),
-                suite.successful_checks () == 1 ? "check" : "checks",
-                suite.test_cases (),
-                suite.test_cases () == 1 ? "case" : "cases");
-#pragma GCC diagnostic pop
-      }
-    else
-      {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-        printf ("%s✗%s %s - test suite %sFAILED%s (%d %s passed, %d failed, "
-                "in %d test %s)\n",
-                colors_.fail, colors_.none, suite.name (), colors_.fail,
-                colors_.none, suite.successful_checks (),
-                suite.successful_checks () == 1 ? "check" : "checks",
-                suite.failed_checks (), suite.test_cases (),
-                suite.test_cases () == 1 ? "case" : "cases");
-#pragma GCC diagnostic pop
-      }
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method writes the contents of the internal output buffer to the
-   * standard output stream without appending a newline character. After
-   * outputting the buffer, it is cleared to prepare for subsequent output.
-   * This approach ensures that test results are presented promptly and
-   * efficiently, supporting clear and organised reporting across all test
-   * cases and folders.
-   */
-  void
-  test_reporter::output (void)
-  {
-    printf ("%s", out_.c_str ()); // No `\n` here.
-    out_.clear ();
-  }
-
   // --------------------------------------------------------------------------
 } // namespace micro_os_plus::micro_test_plus
 

package/src/test-runner.cpp

@@ -45,6 +45,7 @@
 #include <micro-os-plus/micro-test-plus.h>
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <vector>
 
 // ----------------------------------------------------------------------------
@@ -99,6 +100,14 @@ namespace micro_os_plus::micro_test_plus
     printf ("%s\n", __PRETTY_FUNCTION__);
 #endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+#if defined(_WIN32)
+    timespec_get (&begin_time, TIME_UTC);
+#else
+    clock_gettime (CLOCK_MONOTONIC, &begin_time);
+#endif
+#endif
+
     argc_ = argc;
     argv_ = argv;
 
@@ -120,6 +129,7 @@ namespace micro_os_plus::micro_test_plus
 #endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
 
     verbosity_t verbosity = verbosity::normal;
+    const char* reporter_name = "tap";
     for (int i = 0; i < argc; ++i)
       {
         if (strcmp (argv[i], "--verbose") == 0)
@@ -134,10 +144,27 @@ namespace micro_os_plus::micro_test_plus
           {
             verbosity = verbosity::silent;
           }
+        else if (strncmp (argv[i], "--reporter=", 11) == 0)
+          {
+            reporter_name = argv[i] + 11;
+          }
       }
 
-    // Pass the verbosity to the reporter.
-    reporter.verbosity = verbosity;
+    // Initialize and configure the reporter.
+    if (strcmp (reporter_name, "basic") == 0)
+      {
+        reporter = new test_reporter_basic ();
+      }
+    else if (strcmp (reporter_name, "tap") == 0)
+      {
+        reporter = new test_reporter_tap ();
+      }
+    else
+      {
+        fprintf (stderr, "error: unknown reporter '%s'\n", reporter_name);
+        exit (1);
+      }
+    reporter->verbosity = verbosity;
 
     // ------------------------------------------------------------------------
 
@@ -177,11 +204,12 @@ namespace micro_os_plus::micro_test_plus
 
     // ------------------------------------------------------------------------
 
-    default_test_suite_ = new test_suite_base (default_suite_name_);
-    current_test_suite = default_test_suite_;
+    default_test_suite = new test_suite_base (default_suite_name_);
+    current_test_suite = default_test_suite;
 
     // Deferred to first test case or test suite end, to allow various
     // initialisations to display their messages.
+    // reporter->begin_test (test_suites_count ());
     // default_test_suite_->begin_test_suite ();
   }
 #pragma GCC diagnostic pop
@@ -191,29 +219,48 @@ namespace micro_os_plus::micro_test_plus
   {
     bool was_successful = true;
 
-    if (!default_test_suite_->unused ())
+    if (!default_test_suite->unused ())
       {
-        default_test_suite_->end_test_suite ();
-        was_successful = default_test_suite_->was_successful ();
+        default_test_suite->end_test_suite ();
+        was_successful = default_test_suite->was_successful ();
+
+        totals.successful_checks += default_test_suite->successful_checks ();
+        totals.failed_checks += default_test_suite->failed_checks ();
+        totals.test_cases_count += default_test_suite->test_cases_count ();
       }
 
-    if (suites_ != nullptr)
+    if (test_suites != nullptr)
       {
-        for (auto suite : *suites_)
+        for (auto test_suite : *test_suites)
           {
-            current_test_suite = suite;
+            current_test_suite = test_suite;
 
-            suite->begin_test_suite ();
-            suite->run ();
-            suite->end_test_suite ();
+            test_suite->begin_test_suite ();
+            test_suite->run ();
+            test_suite->end_test_suite ();
 
-            was_successful &= suite->was_successful ();
+            was_successful &= test_suite->was_successful ();
+
+            totals.successful_checks += test_suite->successful_checks ();
+            totals.failed_checks += test_suite->failed_checks ();
+            totals.test_cases_count += test_suite->test_cases_count ();
           }
-        if (reporter.verbosity != verbosity::silent)
+        if (reporter->verbosity != verbosity::silent)
           {
             // printf ("\n");
           }
       }
+
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+#if defined(_WIN32)
+    timespec_get (&end_time, TIME_UTC);
+#else
+    clock_gettime (CLOCK_MONOTONIC, &end_time);
+#endif
+#endif
+
+    reporter->end_test (*this);
+
     return was_successful ? 0 : 1;
   }
 
@@ -235,11 +282,12 @@ namespace micro_os_plus::micro_test_plus
     printf ("%s\n", __PRETTY_FUNCTION__);
 #endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
-    if (suites_ == nullptr)
+    if (test_suites == nullptr)
       {
-        suites_ = new std::vector<test_suite_base*> ();
+        test_suites = new std::vector<test_suite_base*> ();
       }
-    suites_->push_back (suite);
+    test_suites->push_back (suite);
+    suite->index = test_suites->size () + 1;
   }
 
   /**

package/src/test-suite.cpp

@@ -121,9 +121,17 @@ namespace micro_os_plus::micro_test_plus
   void
   test_suite_base::begin_test_suite (void)
   {
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+#if defined(_WIN32)
+    timespec_get (&begin_time, TIME_UTC);
+#else
+    clock_gettime (CLOCK_MONOTONIC, &begin_time);
+#endif
+#endif
+
     process_deferred_begin = false;
 
-    reporter.begin_test_suite (name_);
+    reporter->begin_test_suite (name_);
   }
 
   /**
@@ -140,9 +148,19 @@ namespace micro_os_plus::micro_test_plus
   {
     if (process_deferred_begin)
       {
+        reporter->begin_test (runner.test_suites_count ());
+
         begin_test_suite ();
       }
-    reporter.end_test_suite (*this);
+
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+#if defined(_WIN32)
+    timespec_get (&end_time, TIME_UTC);
+#else
+    clock_gettime (CLOCK_MONOTONIC, &end_time);
+#endif
+#endif
+    reporter->end_test_suite (*this);
   }
 
   /**
@@ -160,15 +178,17 @@ namespace micro_os_plus::micro_test_plus
   {
     if (process_deferred_begin)
       {
+        reporter->begin_test (runner.test_suites_count ());
+
         begin_test_suite ();
       }
 
     test_case_name_ = name;
-    ++test_cases_;
+    ++test_cases_count_;
 
     current_test_case = {};
 
-    reporter.begin_test_case (test_case_name_);
+    reporter->begin_test_case (test_case_name_);
   }
 
   /**
@@ -182,7 +202,7 @@ namespace micro_os_plus::micro_test_plus
   void
   test_suite_base::end_test_case (void)
   {
-    reporter.end_test_case (test_case_name_);
+    reporter->end_test_case (test_case_name_);
   }
 
   /**
@@ -213,6 +233,39 @@ namespace micro_os_plus::micro_test_plus
     ++current_test_case.failed_checks;
   }
 
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+  /**
+   * @details
+   * Subtracts `begin_time` from `end_time` using monotonic clock arithmetic,
+   * handling the nanosecond borrow correctly, then splits the result into
+   * whole milliseconds and the sub-millisecond remainder expressed in
+   * microseconds (0–999).
+   */
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wshadow"
+  void
+  test_suite_base::compute_elapsed_time (timespec& begin_time,
+                                         timespec& end_time,
+                                         long& milliseconds,
+                                         long& microseconds)
+  {
+    long long delta_ns = end_time.tv_nsec - begin_time.tv_nsec;
+    long long delta_s = end_time.tv_sec - begin_time.tv_sec;
+    if (delta_ns < 0)
+      {
+        delta_ns += 1000000000LL;
+        --delta_s;
+      }
+
+    // Split into milliseconds and microseconds.
+    const long long total_us = delta_s * 1000000LL + delta_ns / 1000LL;
+    milliseconds = static_cast<long> (total_us / 1000LL);
+    microseconds = static_cast<long> (total_us % 1000LL);
+  }
+#pragma GCC diagnostic pop
+
+#endif
+
   // ==========================================================================
 
   /**