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

package/include/micro-os-plus/micro-test-plus/test-reporter.h

@@ -105,9 +105,15 @@ namespace micro_os_plus::micro_test_plus
    */
   struct colors
   {
-    const char* none = "\033[0m"; /**< @brief Default colour. */
-    const char* pass = "\033[32m"; /**< @brief Green colour. */
-    const char* fail = "\033[31m"; /**< @brief Red colour. */
+    const char* none = ""; /**< @brief Default colour. */
+    const char* pass = ""; /**< @brief Green colour. */
+    const char* fail = ""; /**< @brief Red colour. */
+  };
+
+  const colors colors_red_green = {
+    "\033[0m", /**< @brief Default colour. */
+    "\033[32m", /**< @brief Green colour. */
+    "\033[31m" /**< @brief Red colour. */
   };
 
   /**
@@ -162,6 +168,8 @@ namespace micro_os_plus::micro_test_plus
 
   // Requires events::assertion_* for  and detailed operators.
 
+  class test_runner;
+
   /**
    * @brief Reporter to display test results, including operand values and
    * types for failures.
@@ -197,7 +205,7 @@ namespace micro_os_plus::micro_test_plus
     /**
      * @brief Default constructor for the test_reporter class.
      */
-    test_reporter () = default;
+    virtual ~test_reporter ();
 
     /**
      * @brief Selects the appropriate colour code based on a condition.
@@ -611,8 +619,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    endline (void);
+    virtual void
+    endline (void)
+        = 0;
 
     // ------------------------------------------------------------------------
 
@@ -654,8 +663,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    begin_test_case (const char* name);
+    virtual void
+    begin_test_case (const char* name)
+        = 0;
 
     /**
      * @brief Mark the end of a test case.
@@ -664,8 +674,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    end_test_case (const char* name);
+    virtual void
+    end_test_case (const char* name)
+        = 0;
 
     /**
      * @brief Mark the beginning of a test suite.
@@ -674,8 +685,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    begin_test_suite (const char* name);
+    virtual void
+    begin_test_suite (const char* name)
+        = 0;
 
     /**
      * @brief Mark the end of a test suite.
@@ -684,8 +696,31 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    end_test_suite (test_suite_base& suite);
+    virtual void
+    end_test_suite (test_suite_base& suite)
+        = 0;
+
+    /**
+     * @brief Mark the beginning of a test.
+     *
+     * @param test_suites_count The number of test suites.
+     * @par Returns
+     *   Nothing.
+     */
+    virtual void
+    begin_test (size_t test_suites_count)
+        = 0;
+
+    /**
+     * @brief Mark the end of a test.
+     *
+     * @param runner Reference to the test runner.
+     * @par Returns
+     *   Nothing.
+     */
+    virtual void
+    end_test (test_runner& runner)
+        = 0;
 
     /**
      * @brief Flush the current buffered content.
@@ -695,8 +730,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    flush (void);
+    virtual void
+    flush (void)
+        = 0;
 
     /**
      * @brief Output the current buffered content.
@@ -706,8 +742,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    output (void);
+    virtual void
+    output (void)
+        = 0;
 
     /**
      * @brief Controls whether to add an empty line between successful test
@@ -731,8 +768,9 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    output_pass_prefix_ (std::string& message);
+    virtual void
+    output_pass_prefix_ (std::string& message)
+        = 0;
 
     /**
      * @brief Outputs the suffix for a passing condition.
@@ -742,30 +780,37 @@ namespace micro_os_plus::micro_test_plus
      * @par Returns
      *   Nothing.
      */
-    void
-    output_pass_suffix_ (void);
+    virtual void
+    output_pass_suffix_ (void)
+        = 0;
 
     /**
      * @brief Outputs the prefix for a failing condition.
      *
      * @param message The message to display.
+     * @param hasExpression Whether the failure is associated with an
+     * expression.
      * @param location The source location of the failure.
      * @par Returns
      *   Nothing.
      */
-    void
-    output_fail_prefix_ (std::string& message,
-                         const reflection::source_location& location);
+    virtual void
+    output_fail_prefix_ (std::string& message, const bool hasExpression,
+                         const reflection::source_location& location)
+        = 0;
 
     /**
      * @brief Outputs the suffix for a failing condition.
      *
+     * @param location The source location of the failure.
      * @param abort Whether to abort execution after failure.
      * @par Returns
      *   Nothing.
      */
-    void
-    output_fail_suffix_ (bool abort);
+    virtual void
+    output_fail_suffix_ (const reflection::source_location& location,
+                         bool abort)
+        = 0;
 
     /**
      * @brief ANSI colour codes for output formatting.

package/include/micro-os-plus/micro-test-plus/test-runner.h

@@ -53,6 +53,8 @@
 
 #include <functional>
 
+#include <time.h>
+
 // ----------------------------------------------------------------------------
 
 #if defined(__GNUC__)
@@ -166,6 +168,12 @@ namespace micro_os_plus::micro_test_plus
     void
     register_test_suite (test_suite_base* suite);
 
+    size_t
+    test_suites_count (void)
+    {
+      return (test_suites != nullptr) ? test_suites->size () + 1 : 1;
+    }
+
     /**
      * @brief Retrieves the name of the default test suite.
      *
@@ -191,36 +199,68 @@ namespace micro_os_plus::micro_test_plus
     [[noreturn]] void
     abort (void);
 
-  protected:
+    // ------------------------------------------------------------------------
+  public:
     /**
-     * @brief Stores the argument count passed to the test runner.
+     * @brief Pointer to the array of registered test suites.
+     *
+     * @details
+     * Statically initialised to zero as BSS, such that test suites defined as
+     * static objects in different compilation units can be automatically
+     * executed.
      */
-    int argc_ = 0;
+    std::vector<test_suite_base*>* test_suites; // DO NOT INITIALISE!
 
+    struct
+    {
+      /**
+       * @brief Total number of successful checks in the test suite.
+       */
+      size_t successful_checks = 0;
+
+      /**
+       * @brief Total number of failed checks in the test suite.
+       */
+      size_t failed_checks = 0;
+
+      /**
+       * @brief Total number of test cases in the test suite.
+       */
+      size_t test_cases_count = 0;
+    } totals;
+
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
     /**
-     * @brief Stores the argument vector passed to the test runner.
+     * @brief The timestamp recorded at the beginning of the test suite.
      */
-    char** argv_ = nullptr;
+    timespec begin_time{};
 
     /**
-     * @brief The name of the default test suite.
+     * @brief The timestamp recorded at the end of the test suite.
      */
-    const char* default_suite_name_ = "Test";
+    timespec end_time{};
+#endif
 
     /**
      * @brief Pointer to the default test suite which groups the main tests.
      */
-    test_suite_base* default_test_suite_;
+    test_suite_base* default_test_suite = nullptr;
 
+  protected:
     /**
-     * @brief Pointer to the array of registered test suites.
-     *
-     * @details
-     * Statically initialised to zero as BSS, such that test suites defined as
-     * static objects in different compilation units can be automatically
-     * executed.
+     * @brief Stores the argument count passed to the test runner.
      */
-    std::vector<test_suite_base*>* suites_;
+    int argc_ = 0;
+
+    /**
+     * @brief Stores the argument vector passed to the test runner.
+     */
+    char** argv_ = nullptr;
+
+    /**
+     * @brief The name of the default test suite.
+     */
+    const char* default_suite_name_ = "Test";
   };
 
   // --------------------------------------------------------------------------

package/include/micro-os-plus/micro-test-plus/test-suite.h

@@ -50,6 +50,8 @@
 
 // ----------------------------------------------------------------------------
 
+#include <time.h>
+
 #ifdef __cplusplus
 
 // ----------------------------------------------------------------------------
@@ -209,7 +211,7 @@ namespace micro_os_plus::micro_test_plus
      *	 None.
      * @return An integer with the number of checks that passed.
      */
-    [[nodiscard]] constexpr int
+    [[nodiscard]] constexpr size_t
     successful_checks (void)
     {
       return successful_checks_;
@@ -222,7 +224,7 @@ namespace micro_os_plus::micro_test_plus
      *	None.
      * @return An integer with the number of checks that failed.
      */
-    [[nodiscard]] constexpr int
+    [[nodiscard]] constexpr size_t
     failed_checks (void)
     {
       return failed_checks_;
@@ -235,10 +237,10 @@ namespace micro_os_plus::micro_test_plus
      *	None.
      * @return An integer with the number of test cases.
      */
-    [[nodiscard]] constexpr int
-    test_cases (void)
+    [[nodiscard]] constexpr size_t
+    test_cases_count (void)
     {
-      return test_cases_;
+      return test_cases_count_;
     }
 
     /**
@@ -263,6 +265,21 @@ namespace micro_os_plus::micro_test_plus
     void
     end_test_suite (void);
 
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+    /**
+     * @brief Computes the elapsed time between `begin_time` and `end_time`.
+     *
+     * @param [out] milliseconds The elapsed time in whole milliseconds.
+     * @param [out] microseconds The sub-millisecond remainder in microseconds
+     *   (0–999).
+     * @par Returns
+     *  Nothing.
+     */
+    void
+    compute_elapsed_time (timespec& begin_time, timespec& end_time,
+                          long& milliseconds, long& microseconds);
+#endif
+
     /**
      * @brief Gets the test suite result.
      *
@@ -288,7 +305,7 @@ namespace micro_os_plus::micro_test_plus
     unused (void)
     {
       return (failed_checks_ == 0 && successful_checks_ == 0
-              && test_cases_ == 0);
+              && test_cases_count_ == 0);
     }
 
   protected:
@@ -305,19 +322,36 @@ namespace micro_os_plus::micro_test_plus
     /**
      * @brief Count of test conditions that passed.
      */
-    int successful_checks_ = 0;
+    size_t successful_checks_ = 0;
 
     /**
      * @brief Count of test conditions that failed.
      */
-    int failed_checks_ = 0;
+    size_t failed_checks_ = 0;
 
     /**
      * @brief Count of test cases in the test suite.
      */
-    int test_cases_ = 0;
+    size_t test_cases_count_ = 0;
 
   public:
+    /**
+     * @brief The test suite index, counting from 1.
+     */
+    size_t index = 1;
+
+#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
+    /**
+     * @brief The timestamp recorded at the beginning of the test suite.
+     */
+    timespec begin_time{};
+
+    /**
+     * @brief The timestamp recorded at the end of the test suite.
+     */
+    timespec end_time{};
+#endif
+
     /**
      * @brief Indicates whether to process deferred begin for test cases.
      */
@@ -335,12 +369,14 @@ namespace micro_os_plus::micro_test_plus
       /**
        * @brief Number of successful checks in the current test case.
        */
-      int successful_checks;
+      size_t successful_checks = 0;
 
       /**
        * @brief Number of failed checks in the current test case.
        */
-      int failed_checks;
+      size_t failed_checks = 0;
+
+      size_t index = 0;
     } current_test_case{};
   };
 

package/include/micro-os-plus/micro-test-plus.h

@@ -76,6 +76,8 @@
 #include "micro-test-plus/test-suite.h"
 #include "micro-test-plus/test-runner.h"
 #include "micro-test-plus/test-reporter.h"
+#include "micro-test-plus/test-reporter-basic.h"
+#include "micro-test-plus/test-reporter-tap.h"
 
 // ----------------------------------------------------------------------------
 
@@ -119,7 +121,7 @@ namespace micro_os_plus::micro_test_plus
   // --------------------------------------------------------------------------
 
   extern test_runner runner;
-  extern test_reporter reporter;
+  extern test_reporter* reporter;
   extern test_suite_base* current_test_suite;
 
   // --------------------------------------------------------------------------
@@ -178,7 +180,7 @@ namespace micro_os_plus::micro_test_plus
    * @par SFINAE
    * Enabled only if `Expr_T` is derived from `detail::op` or
    * is convertible to `bool`.
-   * 
+   *
 
    * @param [in] expr Logical expression to evaluate.
    * @param [in] sl Optional source location, defaulting to the current line.

package/meson.build

@@ -46,6 +46,8 @@ _local_sources += [
   'src/micro-test-plus.cpp',
   'src/test-runner.cpp',
   'src/test-reporter.cpp',
+  'src/test-reporter-basic.cpp',
+  'src/test-reporter-tap.cpp',
   'src/test-suite.cpp',
 ]
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@micro-os-plus/micro-test-plus",
-  "version": "3.2.3",
+  "version": "3.3.1",
   "description": "A source code library with µTest++, a lightweight testing framework for embedded platforms",
   "repository": {
     "type": "git",

package/src/micro-test-plus.cpp

@@ -246,7 +246,7 @@ namespace micro_os_plus::micro_test_plus
       if (abort_ && !value_)
         {
           printf ("\n");
-          reporter.output ();
+          reporter->output ();
           abort ();
         }
     }
@@ -278,18 +278,19 @@ namespace micro_os_plus::micro_test_plus
   test_runner runner;
 
   /**
-   * @brief Global instance of `test_reporter`.
+   * @brief Global pointer to `test_reporter`.
    *
    * @details
-   * This global instance of `test_reporter` is responsible for collecting,
+   * This global pointer to `test_reporter` is responsible for collecting,
    * formatting, and outputting the results of test execution within the
    * µTest++ framework. It manages the reporting of test outcomes, including
    * successes and failures, and ensures that all relevant information is
    * presented clearly to the user. By maintaining a single shared reporter,
    * the framework provides consistent and centralised reporting across all
-   * test cases and folders.
+   * test cases and folders. The reporter is initialized in
+   * test_runner::initialize().
    */
-  test_reporter reporter;
+  test_reporter* reporter = nullptr;
 
   /**
    * @brief Global pointer references the currently active test suite.