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

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

@@ -64,10 +64,11 @@
 #pragma GCC diagnostic ignored "-Waggregate-return"
 #if defined(__clang__)
 #pragma clang diagnostic ignored "-Wc++98-compat"
-#pragma clang diagnostic ignored "-Wunknown-warning-option"
 #endif
 #endif
 
+// ===========================================================================
+
 namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
@@ -155,7 +156,10 @@ namespace micro_os_plus::micro_test_plus
      * @ingroup micro-test-plus-container-operators
      * @brief Equality operator for containers.
      *
-     * @tparam T The container type, constrained to recognised container types.
+     * @tparam Lhs_T The left-hand container type, constrained to recognised
+     * container types.
+     * @tparam Rhs_T The right-hand container type, constrained to recognised
+     * container types.
      *
      * @param [in] lhs The left hand side container operand.
      * @param [in] rhs The right hand side container operand.
@@ -171,19 +175,23 @@ namespace micro_os_plus::micro_test_plus
      * The operator is enabled only for types recognised as containers by the
      * framework's type traits.
      */
-    template <class T,
-              type_traits::requires_t<type_traits::is_container_v<T>> = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires (type_traits::container_like<Lhs_T>
+                and type_traits::container_like<Rhs_T>)
     [[nodiscard]] constexpr auto
-    operator== (T&& lhs, T&& rhs)
+    operator== (const Lhs_T& lhs, const Rhs_T& rhs)
     {
-      return detail::eq_{ static_cast<T&&> (lhs), static_cast<T&&> (rhs) };
+      return detail::eq_{ lhs, rhs };
     }
 
     /**
      * @ingroup micro-test-plus-container-operators
      * @brief Non-equality operator for containers.
      *
-     * @tparam T The container type, constrained to recognised container types.
+     * @tparam Lhs_T The left-hand container type, constrained to recognised
+     * container types.
+     * @tparam Rhs_T The right-hand container type, constrained to recognised
+     * container types.
      *
      * @param [in] lhs The left hand side container operand.
      * @param [in] rhs The right hand side container operand.
@@ -199,12 +207,13 @@ namespace micro_os_plus::micro_test_plus
      * The operator is enabled only for types recognised as containers by the
      * framework's type traits.
      */
-    template <class T,
-              type_traits::requires_t<type_traits::is_container_v<T>> = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires (type_traits::container_like<Lhs_T>
+                and type_traits::container_like<Rhs_T>)
     [[nodiscard]] constexpr auto
-    operator!= (T&& lhs, T&& rhs)
+    operator!= (const Lhs_T& lhs, const Rhs_T& rhs)
     {
-      return detail::ne_{ static_cast<T&&> (lhs), static_cast<T&&> (rhs) };
+      return detail::ne_{ lhs, rhs };
     }
 
     /**
@@ -229,10 +238,8 @@ namespace micro_os_plus::micro_test_plus
      * wrappers, or other custom types, ensuring type-safe and expressive test
      * assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator== (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -261,10 +268,8 @@ namespace micro_os_plus::micro_test_plus
      * constants, wrappers, or other custom types, ensuring type-safe and
      * expressive test assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator!= (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -293,10 +298,8 @@ namespace micro_os_plus::micro_test_plus
      * the framework's strongly-typed constants, wrappers, or other custom
      * types, ensuring type-safe and expressive test assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator> (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -326,10 +329,8 @@ namespace micro_os_plus::micro_test_plus
      * wrappers, or other custom types, ensuring type-safe and expressive test
      * assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator>= (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -358,10 +359,8 @@ namespace micro_os_plus::micro_test_plus
      * framework's strongly-typed constants, wrappers, or other custom types,
      * ensuring type-safe and expressive test assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator< (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -391,10 +390,8 @@ namespace micro_os_plus::micro_test_plus
      * wrappers, or other custom types, ensuring type-safe and expressive test
      * assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator<= (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -423,10 +420,8 @@ namespace micro_os_plus::micro_test_plus
      * strongly-typed constants, wrappers, or other custom types, ensuring
      * type-safe and expressive test assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator and (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -455,10 +450,8 @@ namespace micro_os_plus::micro_test_plus
      * framework's strongly-typed constants, wrappers, or other custom types,
      * ensuring type-safe and expressive test assertions.
      */
-    template <class Lhs_T, class Rhs_T,
-              type_traits::requires_t<type_traits::is_op_v<Lhs_T>
-                                      or type_traits::is_op_v<Rhs_T>>
-              = 0>
+    template <class Lhs_T, class Rhs_T>
+      requires type_traits::any_op<Lhs_T, Rhs_T>
     [[nodiscard]] constexpr auto
     operator or (const Lhs_T& lhs, const Rhs_T& rhs)
     {
@@ -486,7 +479,8 @@ namespace micro_os_plus::micro_test_plus
      * constants, wrappers, or other custom types, ensuring type-safe and
      * expressive test assertions.
      */
-    template <class T, type_traits::requires_t<type_traits::is_op_v<T>> = 0>
+    template <class T>
+      requires type_traits::is_op<T>
     [[nodiscard]] constexpr auto
     operator not(const T& t)
     {

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

@@ -68,10 +68,11 @@
 #pragma GCC diagnostic ignored "-Waggregate-return"
 #if defined(__clang__)
 #pragma clang diagnostic ignored "-Wc++98-compat"
-#pragma clang diagnostic ignored "-Wunknown-warning-option"
 #endif
 #endif
 
+// =============================================================================
+
 namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
@@ -193,11 +194,15 @@ namespace micro_os_plus::micro_test_plus
      *
      * @param name The fully qualified name as a C-string.
      * @return A pointer to the short name within the input string.
+     *
+     * @details
+     * Searches @p name for the last `/` separator and returns a pointer to
+     * the character immediately following it, effectively stripping the
+     * folder path. If no `/` is found, the original pointer is returned
+     * unchanged.
      */
     const char*
-    short_name (const char* name);
-
-    // TODO: update for the new namespaces.
+    short_name (const char* name) noexcept;
 
     /**
      * @brief Extract the type name from the `__PRETTY_FUNCTION__` macro.
@@ -207,6 +212,12 @@ namespace micro_os_plus::micro_test_plus
      * @par Parameters
      *	 None.
      * @return A `std::string_view` containing the extracted type name.
+     *
+     * @details
+     * Constructs a `std::string_view` from `__PRETTY_FUNCTION__` and
+     * parses out the portion that represents the template argument `T`,
+     * using compiler-specific prefix and suffix markers to locate the
+     * type-name substring at compile time.
      */
     template <class T>
     [[nodiscard]] constexpr auto

package/include/micro-os-plus/micro-test-plus/{test-reporter-basic.h → reporter-human.h}

@@ -17,18 +17,18 @@
 
 /**
  * @file
- * @brief C++ header file with declarations for the µTest++ basic test
+ * @brief C++ header file with declarations for the µTest++ human test
  * reporter.
  *
  * @details
- * This header provides the declaration for `test_reporter_basic`, the default
- * concrete implementation of the `test_reporter` abstract interface. It
+ * This header provides the declaration for `reporter_human`, the default
+ * concrete implementation of the `reporter` abstract interface. It
  * formats and presents test results using `printf`-based standard output,
  * accumulating output in an internal string buffer and supporting
  * colour-coded diagnostics and multiple verbosity levels.
  *
  * Users who require custom output behaviour (e.g. redirecting to a serial
- * port on bare-metal targets) may derive a new class from `test_reporter`
+ * port on bare-metal targets) may derive a new class from `reporter`
  * instead of using this class.
  *
  * All definitions reside within the `micro_os_plus::micro_test_plus`
@@ -52,7 +52,7 @@
 
 // ----------------------------------------------------------------------------
 
-#include "test-reporter.h"
+#include "reporter.h"
 
 // ----------------------------------------------------------------------------
 
@@ -64,22 +64,24 @@
 #endif
 #endif
 
+// =============================================================================
+
 namespace micro_os_plus::micro_test_plus
 {
   // --------------------------------------------------------------------------
 
   /**
-   * @brief Basic (standard output) implementation of `test_reporter`.
+   * @brief Human (standard output) implementation of `reporter`.
    *
    * @details
-   * `test_reporter_basic` provides the default concrete implementation of the
-   * `test_reporter` abstract interface, formatting and presenting test results
+   * `reporter_human` provides the default concrete implementation of the
+   * `reporter` abstract interface, formatting and presenting test results
    * using `printf`-based output. It accumulates output in an internal string
    * buffer and writes it to the standard output stream, supporting
    * colour-coded diagnostics and multiple verbosity levels.
    *
    * Users who require custom output behaviour (e.g. redirecting to a serial
-   * port on bare-metal targets) may derive a new class from `test_reporter`
+   * port on bare-metal targets) may derive a new class from `reporter`
    * and supply an instance via the `reporter` global pointer before calling
    * `initialize()`.
    *
@@ -89,160 +91,155 @@ namespace micro_os_plus::micro_test_plus
    *
    * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
    */
-  class test_reporter_basic final : public test_reporter
+  class reporter_human final : public reporter
   {
   public:
     /**
-     * @brief Constructor for the test_reporter_basic class.
+     * @brief Constructor for the reporter_human class.
      *
      * @details
      * The rule of five is enforced to prevent accidental copying or moving.
+     *
+     * @param argvs Owning pointer to the command-line arguments vector;
+     * the reporter takes ownership via move.
      */
-    test_reporter_basic ();
+    reporter_human (std::unique_ptr<std::vector<std::string_view>> argvs);
 
     /**
      * @brief Deleted copy constructor to prevent copying.
      */
-    test_reporter_basic (const test_reporter_basic&) = delete;
+    reporter_human (const reporter_human&) = delete;
 
     /**
      * @brief Deleted move constructor to prevent moving.
      */
-    test_reporter_basic (test_reporter_basic&&) = delete;
+    reporter_human (reporter_human&&) = delete;
 
     /**
      * @brief Deleted copy assignment operator to prevent copying.
      */
-    test_reporter_basic&
-    operator= (const test_reporter_basic&)
-        = delete;
+    reporter_human&
+    operator= (const reporter_human&) = delete;
 
     /**
      * @brief Deleted move assignment operator to prevent moving.
      */
-    test_reporter_basic&
-    operator= (test_reporter_basic&&)
-        = delete;
+    reporter_human&
+    operator= (reporter_human&&) = delete;
 
     /**
-     * @brief Destructor for the test_reporter_basic class.
+     * @brief Destructor for the reporter_human class.
      */
-    ~test_reporter_basic () override = default;
+    ~reporter_human () override;
 
-    /**
-     * @brief Inserts a line ending into the output buffer.
-     *
-     * @par Parameters
-     *	 None.
-     * @par Returns
-     *   Nothing.
-     */
-    void
-    endline (void) override;
+    // ------------------------------------------------------------------------
 
     /**
-     * @brief Mark the beginning of a test case.
+     * @brief Output operator for the `indent_t` manipulator.
      *
-     * @param name The name of the test case.
-     * @par Returns
-     *   Nothing.
+     * @param m The indentation manipulator produced by `indent(n)`.
+     * @return Reference to the current reporter instance.
      */
-    void
-    begin_test_case (const char* name) override;
+    reporter_human&
+    operator<< (indent_t m);
+
+    // Bring base class operator<< overloads into scope to prevent name hiding.
+    using reporter::operator<<;
+
+    // ------------------------------------------------------------------------
 
     /**
-     * @brief Mark the end of a test case.
+     * @brief Mark the beginning of a test suite.
      *
-     * @param name The name of the test case.
+     * @param runner Reference to the test runner.
      * @par Returns
      *   Nothing.
      */
     void
-    end_test_case (const char* name) override;
+    begin_session (runner& runner) override;
 
     /**
-     * @brief Mark the beginning of a test suite.
+     * @brief Mark the end of a test suite.
      *
-     * @param name The name of the test suite.
+     * @param runner Reference to the test runner.
      * @par Returns
      *   Nothing.
      */
     void
-    begin_test_suite (const char* name) override;
+    end_session (runner& runner) override;
 
     /**
-     * @brief Mark the end of a test suite.
+     * @brief Mark the beginning of a suite.
      *
-     * @param suite Reference to the test suite base.
+     * @param suite Reference to the suite.
      * @par Returns
      *   Nothing.
      */
-    void
-    end_test_suite (test_suite_base& suite) override;
+    virtual void
+    begin_suite (suite& suite) override;
 
     /**
-     * @brief Mark the beginning of a test.
+     * @brief Mark the end of a test suite.
      *
-     * @param test_suites_count The number of test suites, or zero if unknown.
+     * @param suite Reference to the test suite.
      * @par Returns
      *   Nothing.
      */
-    void
-    begin_test (size_t test_suites_count) override;
+    virtual void
+    end_suite (suite& suite) override;
 
     /**
-     * @brief Mark the end of a test.
+     * @brief Mark the beginning of a subtest.
      *
-     * @param runner Reference to the test runner.
+     * @param subtest Reference to the subtest.
      * @par Returns
      *   Nothing.
      */
-    void
-    end_test (test_runner& runner) override;
+    virtual void
+    begin_subtest (subtest& subtest) override;
 
     /**
-     * @brief Flush the current buffered content.
+     * @brief Mark the end of a subtest.
      *
-     * @par Parameters
-     *	 None.
+     * @param subtest Reference to the subtest.
      * @par Returns
      *   Nothing.
      */
-    void
-    flush (void) override;
+    virtual void
+    end_subtest (subtest& subtest) override;
 
     /**
-     * @brief Output the current buffered content.
+     * @brief Returns an empty comment prefix string.
      *
      * @par Parameters
      *	 None.
-     * @par Returns
-     *   Nothing.
+     * @return An empty string, as the human-readable format does not
+     * use a comment prefix.
      */
-    void
-    output (void) override;
+    virtual const char*
+    get_comment_prefix (void) override;
 
   protected:
     /**
      * @brief Outputs the prefix for a passing condition.
      *
      * @param message The message to display.
+     * @param subtest The subtest that owns this check.
      * @par Returns
      *   Nothing.
      */
     void
-    output_pass_prefix_ (std::string& message) override;
+    output_pass_prefix_ (std::string& message, subtest& subtest) override;
 
     /**
      * @brief Outputs the suffix for a passing condition.
      *
-     * @par Parameters
-     *	 None.
+     * @param subtest The subtest that owns this check.
      * @par Returns
      *   Nothing.
      */
     void
-    output_pass_suffix_ (void) override;
+    output_pass_suffix_ (subtest& subtest) override;
 
     /**
      * @brief Outputs the prefix for a failing condition.
@@ -251,24 +248,27 @@ namespace micro_os_plus::micro_test_plus
      * @param hasExpression Whether the failure is associated with an
      * expression.
      * @param location The source location of the failure.
+     * @param subtest The subtest that owns this check.
      * @par Returns
      *   Nothing.
      */
     void
     output_fail_prefix_ (std::string& message, const bool hasExpression,
-                         const reflection::source_location& location) override;
+                         const reflection::source_location& location,
+                         subtest& subtest) override;
 
     /**
      * @brief Outputs the suffix for a failing condition.
      *
      * @param location The source location of the failure.
      * @param abort Whether to abort execution after failure.
+     * @param subtest The subtest that owns this check.
      * @par Returns
      *   Nothing.
      */
     void
     output_fail_suffix_ (const reflection::source_location& location,
-                         bool abort) override;
+                         bool abort, subtest& subtest) override;
   };
 
   // --------------------------------------------------------------------------