@micro-os-plus/micro-test-plus 3.1.2 → 3.2.2

package/CHANGELOG.md

@@ -6,6 +6,191 @@ Please check
 [GitHub](https://github.com/micro-os-plus/micro-test-plus-xpack/issues/)
 and close existing issues and pull requests.
 
+## 2025-03-15
+
+* v3.2.2 published on npmjs.com
+* v3.2.2 prepared
+* 771e589 re-generate commons
+
+## 2025-03-14
+
+* 1475002 re-generate top commons
+* 464a485 re-generate top commons
+* 632bcc8 publish-github-pages update
+* d89c851 website: blog post release 3.2.1 published
+* c70d3e0 3.2.1
+* 60103cd prepare v3.2.1
+* 8daa820 website: update post
+* 703dcf9 website: re-generate commons & blog posts
+* 564f37f tests: re-generate commons
+
+## 2025-03-12
+
+* a7dc192 re-generate commons with long description
+* ae24148 website: re-generate commons
+* 0c97d4e website: re-generate commons
+* 7c01414 website: re-generate commons
+* 31d25ac website: re-generate commons
+
+## 2025-03-11
+
+* e0db831 website: re-generate commons
+* e31417b website: re-generate commons
+* 0350fa2 website: re-generate with longer descriptiveName
+
+## 2025-03-10
+
+* f514bf6 website: re-generate commons
+* 3ba95c6 website: re-generate commons major
+
+## 2025-03-05
+
+* 30197db website: green
+
+## 2025-03-04
+
+* 57afe72 website: fix pathname:// links
+* 24e28c1 website: getting-started rework
+* 73abd63 config.doxyfile: disable XML for now
+* af1383f docusaurus*: use pathname:///
+* d963f3d docusaurus*: accept broken links
+* ba6a4e9 *redirect.ts remove '/reference'
+* d71fa22 re-generate commons
+* 2cc8dd6 website docusaurus test
+
+## 2025-03-03
+
+* 17fc2c5 doxygen/.gitignore
+
+## 2025-03-02
+
+* e233776 website: move doxygen files to separate folder
+* 32ff366 tests/package-lock.json update
+
+## 2025-02-28
+
+* 435d61f copyright notices cosmetics
+* c228aef tests: re-generate commons
+* d178ebe re-generate workflows
+* 5f78801 test-all: fix clear cache syntax
+
+## 2025-02-27
+
+* 9a6ecf5 test-all: fix clear cache syntax
+* 5a78a81 test-all: fix clear cache syntax
+* df341b9 test-all: fix clear cache syntax
+* 4c56913 test-all: clean xPack cache
+* 76606cb re-generate workflows
+* 6472bc0 tests/native/meson -rtlib=compiler-rt
+* e5bed09 tests/native/cmake remove duplicate -stdlib=libc++
+* 5425929 tests/package.json: add native-meson-clang to test-ci
+* 9babed3 tests/native meson -stdlib=libc++
+* 1fe540d reflection.h: unsigned int line
+
+## 2025-02-26
+
+* 4d46b66 package.json fix action test
+* c76db36 package.json add git-pull-helper
+* cac8c46 tests/package.json: bump helper
+* 8274320 tests/package-lock.json update
+* db0f79a re-generate commons
+* 052057d workflows: update
+
+## 2025-02-25
+
+* 808db36 workflows cosmetics
+* 6531845 meson/common-options: fix link_args
+* 241c368 workflows: npm -C
+* b867523 workflows: &&
+* 2636562 workflows: remove windows 2019
+* 8aca778 tests/package-local.json
+* 9650766 re-generate commons
+* 34695b1 xcdl.json update
+
+## 2025-02-24
+
+* cca99a3 package.json: update topConfig
+* 6b926ad package.json update
+* 66412e3 package.json: add topConfig
+* eab469f re-generate workflows
+* 5fc7f95 test-ci.yml: fix install-ci
+* de675ce test-ci.yml: fix install-ci
+* cf02869 rename test-ci.yml
+* 8a8431d ci.yml update
+* 94d8603 tests/package*.json: bump deps
+* 05e42b2 platforms/native: update RPATH
+* 00c2a30 publish-github-pages.yml: update from npm helper
+* 5a1770c website: update for node_modules
+* 328857c re-generate commons
+* a8a661e package*.json: use npm & extract xcdl.json
+* d3c7750 silence documentation warnings
+
+## 2024-11-21
+
+* c3847f1 rename xpack-development
+* e7b1d9b rename MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
+* 459143c package.json: add cdlComponents
+* ffaf7b1 tests/package.json CMAKE_MAKE_PROGRAM only on windows
+* 5cf103a update copyright notice
+
+## 2024-02-14
+
+* a1b201a tests/package.json: add short win path to meson
+* 3269a0e tests/package.json: explicit CMAKE_MAKE_PROGRAM
+
+## 2023-12-26
+
+* 7c113ee README update
+* b534088 credits.md: remove macstadium.com opensource
+* 11ffc8b website/pages/home.md: cleanup dummy links
+* acefd31 publish-github-pages.yml: bump doxygen 1.10.0
+* b24ad6b cmake cosmetics
+
+## 2023-12-06
+
+* 7a2ee88 3.2.0
+* 2a6abf2 prepare v3.2.0
+* 90963ce micro-test-plus.h cosmetics
+* c57c46e literals.h: silence clang deprecation warning
+* f776b18 doxygen metadata: add @headerfile
+* 94ff7d7 website: use to_*
+* 9d4f8bb tests/sample-test.cpp: use to_*
+* 24606d7 literals.h: add to_*, deprecate _*
+
+## 2023-12-05
+
+* 76ddc99 user-guide.md: use mt::
+* 86adedf doxygen metadata: use mt:: in examples
+* 71db099 tests: use explicit mt::
+* c508d4f testing.md: remove reference to test-all.yml
+* 11a1f31 testing.md: update
+* 1ee57a8 testing.md: fix typo
+* 749e2d6 testing.md: add clang 17
+* 221a630 rename xpack-development
+* 06419e5 tests/package.json: enable gcc11
+* 03cb2ed tests/package.json: bump deps
+
+## 2023-12-04
+
+* ebe7e55 package-lock.json updates
+* 17e8859 tests/package.json: add clang 17
+* 75e585a micro-test-plus.cpp: silence warning for clang 17
+
+## 2023-11-30
+
+* b4ff766 website/package.json: #v2.3.1
+* 19a43d6 testing.md update
+* 822e464 rework tests with platforms sub-folder
+* 2aef49a website/package.json: explicit #v2.3.0
+* 313fd41 website/package.json: explicit #2.3.0
+* 80d0fe8 testing.md: updates
+
+## 2023-11-29
+
+* 2227c94 3.1.2
+* 552865e prepare v3.1.2
+* 993d0f7 testing.md: updates
+
 ## 2023-11-28
 
 * 21393a5 ci.yml cosmetics
@@ -69,16 +254,16 @@ and close existing issues and pull requests.
 ## 2023-11-25
 
 * 509ff38 home.md: add Manual Pages
-2023-11-25 * eed0475 tests/package.json: add install/tes-latest
-2023-11-25 * d2a23dd tests/README update
-2023-11-25 * a755996 maintainer.md: update
-2023-11-25 * 17866f0 tests/package.json: add more selected
-2023-11-25 * 593b361 tests/package.json: fix syntax
-2023-11-25 * bbe15ab tests/package.json: fix syntax
-2023-11-25 * 1456260 tests/package.json: re-enable some tests
-2023-11-25 * c8f7c5a tests/package.json: reorder actions
-2023-11-25 * 68626be tests/package.json: fix install-selected
-2023-11-25 * 079df5c tests/package.json: cleanup actions
+* eed0475 tests/package.json: add install/tes-latest
+* d2a23dd tests/README update
+* a755996 maintainer.md: update
+* 17866f0 tests/package.json: add more selected
+* 593b361 tests/package.json: fix syntax
+* bbe15ab tests/package.json: fix syntax
+* 1456260 tests/package.json: re-enable some tests
+* c8f7c5a tests/package.json: reorder actions
+* 68626be tests/package.json: fix install-selected
+* 079df5c tests/package.json: cleanup actions
 
 ## 2023-11-24
 

package/CMakeLists.txt

@@ -1,14 +1,13 @@
 # -----------------------------------------------------------------------------
 #
-# This file is part of the µOS++ distribution.
-# (https://github.com/micro-os-plus/)
-# Copyright (c) 2021 Liviu Ionescu
+# This file is part of the µOS++ project (https://micro-os-plus.github.io/).
+# Copyright (c) 2021 Liviu Ionescu. All rights reserved.
 #
 # Permission to use, copy, modify, and/or distribute this software
 # for any purpose is hereby granted, under the terms of the MIT license.
 #
 # If a copy of the license was not distributed with this file, it can
-# be obtained from https://opensource.org/licenses/MIT/.
+# be obtained from https://opensource.org/licenses/mit.
 #
 # -----------------------------------------------------------------------------
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Liviu Ionescu
+Copyright (c) 2021 Liviu Ionescu. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,25 +1,26 @@
 [![GitHub package.json version](https://img.shields.io/github/package-json/v/micro-os-plus/micro-test-plus-xpack)](https://github.com/micro-os-plus/micro-test-plus-xpack/blob/xpack/package.json)
-[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/micro-os-plus/micro-test-plus-xpack)](https://github.com/micro-os-plus/micro-test-plus-xpack/tags/)
-[![npm (scoped)](https://img.shields.io/npm/v/@micro-os-plus/micro-test-plus.svg?color=blue)](https://www.npmjs.com/package/@micro-os-plus/micro-test-plus/)
-[![license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/micro-os-plus/micro-test-plus-xpack/blob/xpack/LICENSE)
-[![CI on Push](https://github.com/micro-os-plus/micro-test-plus-xpack/actions/workflows/ci.yml/badge.svg)](https://github.com/micro-os-plus/micro-test-plus-xpack/actions/workflows/ci.yml)
-[![Website](https://img.shields.io/website?url=https%3A%2F%2Fmicro-os-plus.github.io%2Fmicro-test-plus-xpack%2F)](https://micro-os-plus.github.io/micro-test-plus-xpack/)
+[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/micro-os-plus/micro-test-plus-xpack?color=blue)](https://github.com/micro-os-plus/micro-test-plus-xpack/tags)
+[![NPM Version](https://img.shields.io/npm/v/@micro-os-plus/micro-test-plus?color=blue)](https://www.npmjs.com/package/@micro-os-plus/micro-test-plus/)
+[![license](https://img.shields.io/github/license/micro-os-plus/micro-test-plus-xpack)](https://github.com/micro-os-plus/micro-test-plus-xpack/blob/xpack/LICENSE)
 
-# A source code library with µTest++, a lightweight testing framework for embedded platforms
+# The µTest++ Testing Framework
 
-The **µTest++** project (_micro test plus_) provides a small memory footprint
-testing framework, intended for running unit tests on embedded
-platforms.
+A source code library with µTest++, a lightweight testing framework for embedded platforms.
 
-## [Project documentation](https://micro-os-plus.github.io/micro-test-plus-xpack/)
+## Project documentation
 
-For information on how to integrate and use this library, please refer to the
-[project documentation](https://micro-os-plus.github.io/micro-test-plus-xpack/) web site.
+For information on how to install and use this project, please refer to the
+[project website](https://micro-os-plus.github.io/micro-test-plus-xpack/).
+
+## Project source
+
+The source code of the current release is available on
+[GitHub tag v3.2.2 tree](https://github.com/micro-os-plus/micro-test-plus-xpack/tree/v3.2.2).
 
 ## License
 
-Unless otherwise stated, the content is released under the terms of the
-[MIT License](https://opensource.org/licenses/mit/),
+Unless otherwise stated, the original content is released under the terms of the
+[MIT License](https://opensource.org/licenses/mit),
 with all rights reserved to
 [Liviu Ionescu](https://github.com/ilg-ul).
 

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

@@ -1,17 +1,16 @@
 /*
- * This file is part of the µOS++ distribution.
- *   (https://github.com/micro-os-plus/)
- * Copyright (c) 2021 Liviu Ionescu.
+ * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
+ * Copyright (c) 2021 Liviu Ionescu. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software
  * for any purpose is hereby granted, under the terms of the MIT license.
  *
  * If a copy of the license was not distributed with this file, it can
- * be obtained from <https://opensource.org/licenses/MIT/>.
+ * be obtained from https://opensource.org/licenses/mit.
  *
  * Major parts of the code are inspired from v1.1.8 of the Boost UT project,
  * released under the terms of the Boost Version 1.0 Software License,
- * which can be obtained from <https://www.boost.org/LICENSE_1_0.txt>.
+ * which can be obtained from https://www.boost.org/LICENSE_1_0.txt.
  */
 
 #ifndef MICRO_TEST_PLUS_DETAIL_H_
@@ -47,6 +46,7 @@ namespace micro_os_plus::micro_test_plus
   {
     /**
      * @brief An object used to pass assertion parameters to the evaluator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Expr_T>
     struct assertion
@@ -95,6 +95,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Equality comparator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct eq_ : type_traits::op
@@ -180,6 +181,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Non-equality comparator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct ne_ : type_traits::op
@@ -254,6 +256,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Greater than comparator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct gt_ : type_traits::op
@@ -311,6 +314,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Greater than or equal comparator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct ge_ : type_traits::op
@@ -368,6 +372,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Less than comparator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct lt_ : type_traits::op
@@ -426,6 +431,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Less than or equal comparator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct le_ : type_traits::op
@@ -485,6 +491,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Logical and operator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct and_ : type_traits::op
@@ -520,6 +527,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Logical or operator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Lhs_T, class Rhs_T>
     struct or_ : type_traits::op
@@ -555,6 +563,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Logical not operator.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class T>
     struct not_ : type_traits::op
@@ -583,6 +592,7 @@ namespace micro_os_plus::micro_test_plus
 #if defined(__cpp_exceptions)
     /**
      * @brief Operator to check if the expression throws a specific exception.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Callable_T, class Exception_T = void>
     struct throws_ : type_traits::op
@@ -617,6 +627,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Operator to check if the expression throws any exception.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Callable_T>
     struct throws_<Callable_T, void> : type_traits::op
@@ -647,6 +658,7 @@ namespace micro_os_plus::micro_test_plus
 
     /**
      * @brief Operator to check if the expression does not throw any exception.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Callable_T>
     struct nothrow_ : type_traits::op
@@ -681,6 +693,7 @@ namespace micro_os_plus::micro_test_plus
     /**
      * @brief Base class for a deferred reporter, that collects the
      * messages into a string.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     class deferred_reporter_base
     {
@@ -715,6 +728,7 @@ namespace micro_os_plus::micro_test_plus
     /**
      * @brief Class template for a deferred reporter specific
      * to an expression.
+     * @headerfile micro-test-plus.h <micro-os-plus/micro-test-plus.h>
      */
     template <class Expr_T>
     class deferred_reporter : public deferred_reporter_base

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

@@ -1,17 +1,16 @@
 /*
- * This file is part of the µOS++ distribution.
- *   (https://github.com/micro-os-plus/)
- * Copyright (c) 2021 Liviu Ionescu.
+ * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
+ * Copyright (c) 2021 Liviu Ionescu. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software
  * for any purpose is hereby granted, under the terms of the MIT license.
  *
  * If a copy of the license was not distributed with this file, it can
- * be obtained from <https://opensource.org/licenses/MIT/>.
+ * be obtained from https://opensource.org/licenses/mit.
  *
  * Major parts of the code are inspired from v1.1.8 of the Boost UT project,
  * released under the terms of the Boost Version 1.0 Software License,
- * which can be obtained from <https://www.boost.org/LICENSE_1_0.txt>.
+ * which can be obtained from https://www.boost.org/LICENSE_1_0.txt.
  */
 
 #ifndef MICRO_TEST_PLUS_INLINES_H_
@@ -43,15 +42,19 @@ namespace micro_os_plus::micro_test_plus
       : test_suite_base{ name },
         callable_{ std::bind (callable, arguments...) }
   {
-#if defined(MICRO_TEST_PLUS_TRACE)
+#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
     printf ("%s\n", __PRETTY_FUNCTION__);
-#endif // MICRO_TEST_PLUS_TRACE
+#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
     runner.register_test_suite (this);
   }
 
   // --------------------------------------------------------------------------
 
+#if defined(__clang__)
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdocumentation"
+#endif
   /**
    * @details
    * A test case is a sequence of test conditions (or simply tests,
@@ -73,20 +76,24 @@ namespace micro_os_plus::micro_test_plus
    * the provided arguments, and reports the results.
    *
    * @par Example
-   *
    * ```cpp
-   *   test_case ("Check answer with comparator", [] {
-   *     expect (eq (compute_answer (), 42)) << "answer is 42";
+   *   namespace mt = micro_os_plus::micro_test_plus;
+   *
+   *   mt::test_case ("Check answer with comparator", [] {
+   *     mt::expect (mt::eq (compute_answer (), 42)) << "answer is 42";
    *   });
    * ```
    */
+#if defined(__clang__)
+#pragma clang diagnostic pop
+#endif
   template <typename Callable_T, typename... Args_T>
   void
   test_case (const char* name, Callable_T&& callable, Args_T&&... arguments)
   {
-#if 0 // defined(MICRO_TEST_PLUS_TRACE)
+#if 0 // defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
     printf ("%s\n", __PRETTY_FUNCTION__);
-#endif // MICRO_TEST_PLUS_TRACE
+#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
     current_test_suite->begin_test_case (name);
     std::invoke (std::forward<Callable_T> (callable),
@@ -123,9 +130,9 @@ namespace micro_os_plus::micro_test_plus
         : deferred_reporter_base{ static_cast<bool> (expr), location },
           expr_{ expr }
     {
-#if 0 // defined(MICRO_TEST_PLUS_TRACE)
+#if 0 // defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
       printf ("%s\n", __PRETTY_FUNCTION__);
-#endif // MICRO_TEST_PLUS_TRACE
+#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
       abort_ = abort;
     }
 
@@ -155,8 +162,10 @@ namespace micro_os_plus::micro_test_plus
      *
      * @par Example
      * ```cpp
-     * expect (std::vector<std::string_view>{ "a", "b" }
-     *             == utility::split<std::string_view> ("a.b", "."))
+     * namespace mt = micro_os_plus::micro_test_plus;
+     *
+     * mt::expect (std::vector<std::string_view>{ "a", "b" }
+     *             == mt::utility::split<std::string_view> ("a.b", "."))
      *         << "a.b splits into [a,b]";
      * ```
      */