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

package/CHANGELOG.md

@@ -6,8 +6,90 @@ Please check
 [GitHub](https://github.com/micro-os-plus/micro-test-plus-xpack/issues/)
 and close existing issues and pull requests.
 
+## 2026-05-11
+
+* v4.1.0 published on npmjs.com
+* 353d2a1 CmakeLists.txt add CXX
+* 68c840b CMake cosmetics in comments
+* 6ba1ac4 CMakeLists.txt duplicate fix
+* 4ea4a84 website doxygen update
+* 5810287 prepare v4.1.0
+* 496bf98 re-generate website commons
+* 4f3a2b9 use local cmake-format & reformat
+
+## 2026-05-10
+
+* fe8d5ac use local clang-format & reformat
+* 9239eca #31: move the top default suite name to initialise()
+* 478a667 website/package*.json update
+* d69a6be re-generate website commons
+* 7e0d3f9 config.doxyfile: add EXCLUDE_PATTERNS
+* 86596a2 update .dox files to remove repetitions
+* dded41a copilot-instructions.md update
+* fbe0cd9 detail.h: add @details
+
+## 2026-05-09
+
+* 597515f website update
+* 88dd73c detail::indent_t
+* a835441 doxygen update
+* a903306 cleanups for includes
+* 8a6ab9f cmake: disable coverage
+* d4216c5 #28: fix circular dependency
+* 8004f37 #28: more includes reworks
+
+## 2026-05-08
+
+* 5b55e3f #28: more inlines fixed, only test-inlines.h remaining
+* 9dd8012 fix illegal character
+* 26675c5 #30: Move internal classes to details namespace
+* cbf8e4c extract exceptions-inline.h
+* fbca56c remove nodiscard from definitions
+* 4ed019a #29: Extract expression formatting code from reporter
+* 9b1369d Merge branch 'xpack-development' of https://github.com/micro-os-plus/micro-test-plus-xpack into xpack-development
+* 4ef8a04 #29: Extract expression formatting code from reporter
+* c9bf9b1 #29: Extract expression formatting code from reporter
+
+## 2026-05-07
+
+* d25e887 #28: Re-organise inlines
+
+## 2026-05-06
+
+* 5c2c832 tests: use add_compile_common_private_options
+* 404fdd2 test-inlines.h: silence warning
+* ee30572 re-generate commons
+* ab9c415 re-generate top commons
+* e8f23ee #27: Split definitions from declarations
+* f6aaa8a tests: use add_compile_common_private_options
+
+## 2026-05-04
+
+* 536e327 website update
+
+## 2026-04-30
+
+* aca5767 platforms/native: remove -stdlib=libc++ from non clang
+* 0cef14e more guards & guard cosmetics
+* e15b6d7 guard include diag/trace.h
+* 0ad8f72 tests: include platform.h
+* 8775c7f website user update
+* 953cc21 includes: add guard to prevent direct includes
+
 ## 2026-04-29
 
+* 8f330f5 re-generate tests commons
+* 7c3b63d fix again blog autoformat
+* e2ddd82 website updates
+* f9a1b1a website: update last blog posts
+* 730a42c website: add link to TAP
+* 08aeb97 website: fix blog posts code block
+* 88273bf .vscode/settings.json: do not reformat mdx
+* 88107e3 re-generate website commons
+* 14309a9 website: blog post release 4.0.0 published
+* 07f01d3 blog posts cosmetics
+* 6e72885 4.0.0
+* cfd4b34 CHANGELOG: publish npm v4.0.0
 * v4.0.0 published on npmjs.com
 * 1105af3 re-format
 * ac64933 CHANGELOG update for v4.0.0

package/CMakeLists.txt

@@ -24,7 +24,11 @@
 # https://cmake.org/cmake/help/v3.20/
 cmake_minimum_required (VERSION 3.20)
 
-project (micro-os-plus-micro-test-plus DESCRIPTION "µTest++")
+project (
+  micro-os-plus-micro-test-plus
+  DESCRIPTION "µTest++"
+  LANGUAGES CXX
+)
 
 # To access the optional functions, include the
 # `cmake/micro-os-plus-build-helper.cmake` file from the
@@ -41,11 +45,14 @@ endif ()
 
 # -----------------------------------------------------------------------------
 
-# The project library definitions.
+# The interface library is the main target of this package, which consumers
+# (like embedded applications) link against. It defines the public API and
+# properties of the library, and compiles the sources that are part of the
+# public API.
 
 # https://cmake.org/cmake/help/v3.20/command/add_library.html?highlight=interface#normal-libraries
-# PRIVATE: build definitions, used internally INTERFACE: usage definitions,
-# passed up to targets linking to it PUBLIC: both
+# Visibility keywords: PRIVATE applies to the target itself; INTERFACE passes
+# properties up to targets that link against it; PUBLIC does both.
 add_library (micro-os-plus-micro-test-plus-interface INTERFACE)
 
 target_include_directories (
@@ -57,6 +64,7 @@ target_sources (
   INTERFACE "src/runner.cpp"
             "src/runner-totals.cpp"
             "src/deferred-reporter.cpp"
+            "src/expression-formatter.cpp"
             "src/reporter.cpp"
             "src/reporter-human.cpp"
             "src/reporter-tap.cpp"
@@ -66,13 +74,9 @@ target_sources (
             "src/utility.cpp"
 )
 
-target_compile_definitions (
-  micro-os-plus-micro-test-plus-interface INTERFACE # None.
-)
+target_compile_definitions (micro-os-plus-micro-test-plus-interface INTERFACE)
 
-target_compile_options (
-  micro-os-plus-micro-test-plus-interface INTERFACE # None.
-)
+target_compile_options (micro-os-plus-micro-test-plus-interface INTERFACE)
 
 target_link_libraries (
   micro-os-plus-micro-test-plus-interface INTERFACE micro-os-plus::diag-trace
@@ -84,37 +88,83 @@ endif ()
 
 # -----------------------------------------------------------------------------
 
-# Optional OBJECT library: sources are compiled once rather than per consumer.
-# Inherits include directories, compile definitions, and compiler options from
-# the interface library via PRIVATE linkage, which avoids propagating the
-# interface library's INTERFACE sources to consumers of the object library. The
-# include directories are re-exported explicitly so that consumers can find the
-# headers.
+# Optional OBJECT library: compiles the library sources once and shares the
+# resulting object files across all test executables, rather than recompiling
+# them per consumer.
+#
+# Include directories are managed explicitly instead of using PRIVATE linkage to
+# the interface library. PRIVATE linkage would cause diag-trace's
+# INTERFACE_SOURCES (trace.cpp) to be compiled into this OBJECT library via
+# transitive propagation, which conflicts with the separate diag-trace
+# compilation in each test executable. Consumers of this OBJECT library are
+# expected to link separately to micro-os-plus::diag-trace and to the
+# platform-specific trace backend.
 add_library (micro-os-plus-micro-test-plus-objects OBJECT)
 
-get_target_property (
+get_property (
   micro-os-plus-micro-test-plus-includes
-  micro-os-plus-micro-test-plus-interface INTERFACE_INCLUDE_DIRECTORIES
+  TARGET micro-os-plus-micro-test-plus-interface
+  PROPERTY INTERFACE_INCLUDE_DIRECTORIES
 )
+# Use PUBLIC so that the include directories are available both for the OBJECT
+# library's own sources and for consumers of the library.
 target_include_directories (
   micro-os-plus-micro-test-plus-objects
-  INTERFACE ${micro-os-plus-micro-test-plus-includes}
+  PUBLIC ${micro-os-plus-micro-test-plus-includes}
 )
 
-get_target_property (
-  micro-os-plus-micro-test-plus-sources micro-os-plus-micro-test-plus-interface
-  INTERFACE_SOURCES
+get_property (
+  micro-os-plus-micro-test-plus-sources
+  TARGET micro-os-plus-micro-test-plus-interface
+  PROPERTY INTERFACE_SOURCES
 )
+# Use PRIVATE to avoid propagating the sources to consumers of the OBJECT
+# library, which would cause duplicate symbol errors at link time.
 target_sources (
   micro-os-plus-micro-test-plus-objects
   PRIVATE ${micro-os-plus-micro-test-plus-sources}
 )
 
-target_link_libraries (
+get_property (
+  micro-os-plus-micro-test-plus-compile-definitions
+  TARGET micro-os-plus-micro-test-plus-interface
+  PROPERTY INTERFACE_COMPILE_DEFINITIONS
+)
+# Use PRIVATE to avoid propagating compile definitions to consumers of the
+# OBJECT library.
+target_compile_definitions (
   micro-os-plus-micro-test-plus-objects
-  PRIVATE micro-os-plus-micro-test-plus-interface
+  PRIVATE ${micro-os-plus-micro-test-plus-compile-definitions}
 )
 
+get_property (
+  micro-os-plus-micro-test-plus-compile-options
+  TARGET micro-os-plus-micro-test-plus-interface
+  PROPERTY INTERFACE_COMPILE_OPTIONS
+)
+# Use PRIVATE to avoid propagating the compile options to consumers of the
+# OBJECT library, which may cause conflicts with consumer-specific compile
+# options.
+target_compile_options (
+  micro-os-plus-micro-test-plus-objects
+  PRIVATE ${micro-os-plus-micro-test-plus-compile-options}
+)
+
+# Add the diag-trace include path in Debug without linking the diag-trace
+# target: linking it would add trace.cpp as an INTERFACE_SOURCE and compile it
+# into the OBJECT library, causing duplicate symbols at link time.
+if (CMAKE_BUILD_TYPE STREQUAL "Debug")
+  get_property (
+    micro-os-plus-diag-trace-includes
+    TARGET micro-os-plus::diag-trace
+    PROPERTY INTERFACE_INCLUDE_DIRECTORIES
+  )
+  target_include_directories (
+    micro-os-plus-micro-test-plus-objects
+    PRIVATE ${micro-os-plus-diag-trace-includes}
+  )
+endif ()
+
 if (COMMAND xpack_display_target_lists)
   xpack_display_target_lists (micro-os-plus-micro-test-plus-objects)
 endif ()

package/README.md

@@ -15,7 +15,8 @@ For information on how to install and use this project, please refer to the
 ## Project source
 
 The source code of the current release is available on
-[GitHub tag v4.0.0 tree](https://github.com/micro-os-plus/micro-test-plus-xpack/tree/v4.0.0).
+GitHub as [micro-os-plus/micro-test-plus-xpack](https://github.com/micro-os-plus/micro-test-plus-xpack),
+the [v4.1.0](https://github.com/micro-os-plus/micro-test-plus-xpack/tree/v4.1.0) tree.
 
 ## License
 
@@ -25,4 +26,4 @@ with all rights reserved to
 [Liviu Ionescu](https://github.com/ilg-ul).
 
 The code from Boost UT is released under the terms of the
-[Boost Version 1.0 Software License](https://www.boost.org/LICENSE_1_0.txt).
+[Boost Software License, Version 1.0](https://www.boost.org/LICENSE_1_0.txt).

package/include/micro-os-plus/micro-test-plus/README.md

@@ -0,0 +1,6 @@
+# Project Headers
+
+The files in this folder are intended for internal use only. Do not include
+them directly in your projects.
+
+Instead, include the public header `<micro-os-plus/micro-test-plus.h>`.

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

@@ -52,6 +52,10 @@
 #include <cstdio>
 #include <string>
 
+#include "type-traits.h"
+#include "reflection.h"
+#include "expression-formatter.h"
+
 // ----------------------------------------------------------------------------
 
 #if defined(__GNUC__)
@@ -71,33 +75,9 @@ namespace micro_os_plus::micro_test_plus
 
   // --------------------------------------------------------------------------
 
-  /**
-   * @namespace micro_os_plus::micro_test_plus::detail
-   * @brief Internal implementation details for the µTest++ framework.
-   *
-   * @details
-   * The `detail` namespace encapsulates the internal mechanisms, helper
-   * structures, and implementation utilities employed by the µTest++ testing
-   * framework. These components do not form part of the public API and may be
-   * modified without prior notice.
-   *
-   * Within this namespace, one will find assertion handling, generic getter
-   * utilities, comparator structures for logical and relational operations,
-   * mechanisms for exception checking, and base classes for deferred reporting
-   * of test results.
-   *
-   * All definitions within `detail` are intended exclusively for internal use,
-   * ensuring a clear distinction between user-facing and internal components.
-   * This approach enhances maintainability, mitigates the risk of naming
-   * conflicts, and keeps the public API succinct.
-   *
-   * The relevant header files are organised within the `include/micro-os-plus`
-   * folder to maintain a structured and modular codebase.
-   */
   namespace detail
   {
-
-    // ------------------------------------------------------------------------
+    // ========================================================================
 
     /**
      * @brief Base class for a deferred reporter that collects messages into a
@@ -145,13 +125,15 @@ namespace micro_os_plus::micro_test_plus
        * @brief Deleted copy assignment operator to prevent copying.
        */
       deferred_reporter_base&
-      operator= (const deferred_reporter_base&) = delete;
+      operator= (const deferred_reporter_base&)
+          = delete;
 
       /**
        * @brief Deleted move assignment operator to prevent moving.
        */
       deferred_reporter_base&
-      operator= (deferred_reporter_base&&) = delete;
+      operator= (deferred_reporter_base&&)
+          = delete;
 
       /**
        * @brief Destructor for the deferred reporter base.
@@ -174,20 +156,13 @@ namespace micro_os_plus::micro_test_plus
       /**
        * @brief Retrieves the result value.
        *
-       *
        * @par Parameters
        *	None.
        * @retval true  The reported condition was met.
        * @retval false The reported condition was not met.
-       *
-       * @details
-       * Returns the result value associated with the report.
        */
       [[nodiscard]] bool
-      value () const
-      {
-        return value_;
-      }
+      value () const;
 
     protected:
       /**
@@ -201,6 +176,11 @@ namespace micro_os_plus::micro_test_plus
        */
       bool abort_ = false;
 
+      /**
+       * @brief Indicates whether the reporter has an associated expression.
+       */
+      bool has_expression_ = false;
+
       /**
        * @brief Stores the source location associated with the report.
        */
@@ -218,19 +198,17 @@ namespace micro_os_plus::micro_test_plus
       subtest& subtest_;
     };
 
-    // ------------------------------------------------------------------------
+    // ========================================================================
 
     /**
-     * @brief Deferred reporter class template for a specific expression.
-     *
-     * @tparam Expr_T The type of the expression being reported.
+     * @brief Deferred reporter class for a specific expression.
      *
      * @details
-     * The `deferred_reporter` class template extends `deferred_reporter_base`
+     * The `deferred_reporter` class extends `deferred_reporter_base`
      * to provide deferred reporting functionality for a specific test
      * expression within the framework.
      *
-     * This class template is responsible for capturing the expression under
+     * This class is responsible for capturing the expression under
      * evaluation, the abort status, and the source location. It is intended
      * exclusively for internal use and is implemented in the
      * `include/micro-os-plus/micro-test-plus` folder to ensure a structured
@@ -238,7 +216,6 @@ namespace micro_os_plus::micro_test_plus
      *
      * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
-    template <class Expr_T>
     class deferred_reporter : public deferred_reporter_base
     {
     public:
@@ -250,25 +227,18 @@ namespace micro_os_plus::micro_test_plus
        * processing.
        * @param location The source location relevant to the report.
        * @param subtest The subtest that owns this deferred report.
-       *
-       * @details
-       * Initialises the reporter with the given expression, abort status, and
-       * source location.
+       * @param expression The expression formatter to format the expression
+       * text.
        */
+      template <class Expr_T>
       deferred_reporter (const Expr_T& expr, bool abort,
                          const reflection::source_location& location,
-                         subtest& subtest);
+                         subtest& subtest, expression_formatter& expression);
 
       /**
        * @brief Destructor for the deferred reporter.
        */
-      ~deferred_reporter ();
-
-    protected:
-      /**
-       * @brief Stores the expression under evaluation.
-       */
-      const Expr_T expr_{};
+      ~deferred_reporter () = default;
     };
 
     // ------------------------------------------------------------------------
@@ -285,6 +255,11 @@ namespace micro_os_plus::micro_test_plus
 
 #endif // __cplusplus
 
+// ============================================================================
+// Templates & constexpr implementations.
+
+#include "inlines/deferred-reporter-inlines.h"
+
 // ----------------------------------------------------------------------------
 
 #endif // MICRO_TEST_PLUS_DEFERRED_REPORTER_H_