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

package/package.json

@@ -1,25 +1,37 @@
 {
   "name": "@micro-os-plus/micro-test-plus",
-  "version": "3.1.2",
+  "version": "3.2.2",
   "description": "A source code library with µTest++, a lightweight testing framework for embedded platforms",
   "main": "",
   "scripts": {
+    "generate-top-commons": "bash node_modules/@xpack/npm-packages-helper/maintenance-scripts/generate-top-commons.sh --micro-os-plus",
+    "npm-install": "npm install",
+    "npm-link-helpers": "npm link @xpack/npm-packages-helper @xpack/docusaurus-template-liquid",
+    "npm-outdated": "npm outdated",
+    "npm-pack": "npm pack",
+    "npm-link": "npm link",
+    "npm-version-patch": "npm version patch",
+    "npm-version-minor": "npm version minor",
+    "git-log": "git log --pretty='%cd * %h %s' --date=short",
+    "git-pull-helper": "git -C ${HOME}/Work/micro-os-plus/build-helper-xpack.git pull",
+    "deep-clean": "del-cli node_modules package-lock.json *.tgz",
     "postversion": "git push origin --all && git push origin --tags"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/micro-os-plus/micro-test-plus-xpack.git"
+    "url": "git+https://github.com/micro-os-plus/micro-test-plus-xpack.git"
   },
-  "homepage": "https://micro-os-plus.github.io/micro-test-plus-xpack",
   "bugs": {
     "url": "https://github.com/micro-os-plus/micro-test-plus-xpack/issues"
   },
+  "homepage": "https://micro-os-plus.github.io/micro-test-plus-xpack/",
+  "homepagePreview": "https://micro-os-plus.github.io/micro-test-plus-xpack-webpreview/",
   "keywords": [
     "xpack",
+    "micro-os-plus",
     "c++",
     "testing",
-    "framework",
-    "micro-os-plus"
+    "framework"
   ],
   "author": {
     "name": "Liviu Ionescu",
@@ -27,29 +39,30 @@
     "url": "https://github.com/ilg-ul"
   },
   "license": "MIT",
-  "config": {},
   "dependencies": {},
-  "bundleDependencies": [],
   "$devDependenciesUrls": [
-    "https://www.npmjs.com/package/del-cli"
+    "https://www.npmjs.com/package/del-cli",
+    "https://www.npmjs.com/package/json",
+    "https://www.npmjs.com/package/liquidjs"
   ],
   "devDependencies": {
-    "del-cli": "^5.1.0"
+    "del-cli": "^6.0.0",
+    "json": "^11.0.0",
+    "liquidjs": "^10.19.1"
   },
   "xpack": {
-    "minimumXpmRequired": "0.16.2",
-    "actions": {
-      "deep-clean": "del-cli node_modules package-lock.json",
-      "npm-install": "npm install",
-      "git-log": "git log --pretty='%cd * %h %s' --date=short",
-      "npm-pack": "npm pack",
-      "npm-version-patch": "npm version patch",
-      "npm-version-minor": "npm version minor",
-      "npm-version": "echo $(which node) $(node --version) && echo $(which npm) $(npm --version)"
-    },
+    "minimumXpmRequired": "0.20.8",
     "dependencies": {},
     "devDependencies": {},
     "properties": {},
     "buildConfigurations": {}
+  },
+  "topConfig": {
+    "descriptiveName": "µTest++ Testing Framework",
+    "permalinkName": "micro-test-plus",
+    "useDoxygen": "true"
+  },
+  "engines": {
+    "node": " >=18.0.0"
   }
 }

package/src/micro-test-plus.cpp

@@ -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.
  */
 
 // ----------------------------------------------------------------------------
@@ -56,7 +55,7 @@ namespace micro_os_plus::micro_test_plus
   void
   initialize (int argc, char* argv[], const char* name)
   {
-#if defined(MICRO_TEST_PLUS_TRACE)
+#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
     printf ("%s\n", __PRETTY_FUNCTION__);
 #endif
     runner.initialize (argc, argv, name);
@@ -93,17 +92,21 @@ namespace micro_os_plus::micro_test_plus
 #pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
 #endif
       const char* p = strrchr (name, '/');
-#pragma GCC diagnostic pop
       if (p != nullptr)
         return p + 1;
       else
         return name;
+#pragma GCC diagnostic pop
     }
 
   } // namespace reflection
 
   namespace utility
   {
+#if defined(__clang__)
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdocumentation"
+#endif
     /**
      * @details
      * For tests comparing strings, in addition to exact matches,
@@ -111,12 +114,16 @@ namespace micro_os_plus::micro_test_plus
      * (for any characters) and `?` (for a single character)
      *
      * @par Examples
-     *
      * ```cpp
-     * expect (utility::is_match ("abc", "a?c")) << "abc matches a?c";
-     * expect (utility::is_match ("abc", "a*c")) << "abc matches a*c";
+     * namespace mt = micro_os_plus::micro_test_plus;
+     *
+     * mt::expect (mt::utility::is_match ("abc", "a?c")) << "abc matches a?c";
+     * mt::expect (mt::utility::is_match ("abc", "a*c")) << "abc matches a*c";
      * ```
      */
+#if defined(__clang__)
+#pragma clang diagnostic pop
+#endif
     [[nodiscard]] bool
     is_match (std::string_view input, std::string_view pattern)
     {
@@ -172,9 +179,9 @@ namespace micro_os_plus::micro_test_plus
 
     deferred_reporter_base::~deferred_reporter_base ()
     {
-#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
 
       if (abort_ && !value_)
         {

package/src/test-reporter.cpp

@@ -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.
  */
 
 // ----------------------------------------------------------------------------

package/src/test-runner.cpp

@@ -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.
  */
 
 // ----------------------------------------------------------------------------
@@ -40,9 +39,9 @@ namespace micro_os_plus::micro_test_plus
 
   test_runner::test_runner ()
   {
-#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
   }
 
 #pragma GCC diagnostic push
@@ -52,9 +51,9 @@ namespace micro_os_plus::micro_test_plus
   void
   test_runner::initialize (int argc, char* argv[], const char* name)
   {
-#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
 
     argc_ = argc;
     argv_ = argv;
@@ -177,9 +176,9 @@ namespace micro_os_plus::micro_test_plus
   void
   test_runner::register_test_suite (test_suite_base* suite)
   {
-#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
 
     if (suites_ == nullptr)
       {

package/src/test-suite.cpp

@@ -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.
  */
 
 // ----------------------------------------------------------------------------
@@ -37,9 +36,9 @@ namespace micro_os_plus::micro_test_plus
 
   test_suite_base::test_suite_base (const char* name)
   {
-#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
 
     name_ = name;
     // The default test suite needs no registration.
@@ -52,9 +51,9 @@ namespace micro_os_plus::micro_test_plus
   void
   test_suite_base::run ()
   {
-#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
   }
 
   void
@@ -122,9 +121,9 @@ namespace micro_os_plus::micro_test_plus
 
   test_suite::~test_suite ()
   {
-#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
   }
 
   // --------------------------------------------------------------------------

package/xcdl.json

@@ -0,0 +1,32 @@
+{
+  "minimumXcdlRequired": "2.0.0",
+  "license": "MIT",
+  "copyright": "Copyright (c) 2022 Liviu Ionescu. All rights reserved.",
+  "cdlPackage": {
+    "name": "micro-test-plus",
+    "description": "µTest++, a lightweight testing framework for embedded platforms",
+    "parent": "micro-os-plus",
+    "compilerIncludeFolders": [
+      "include"
+    ],
+    "compilerSourceFiles": [
+      "src/micro-test-plus.cpp",
+      "src/test-runner.cpp",
+      "src/test-reporter.cpp",
+      "src/test-suite.cpp"
+    ],
+    "compilerDefinitions": [],
+    "compilerOptions": [],
+    "dependencies": [],
+    "generatedDefinition": "MICRO_OS_PLUS_HAS_MICRO_TEST_PLUS",
+    "cdlOptions": {
+      "trace": {
+        "display": "Enable trace in µTest++",
+        "description": "Log trace diagnostics in the µTest++ testing framework when TRACE is enabled",
+        "valueType": "bool",
+        "requires": "isEnabled('diag-trace')",
+        "generatedDefinition": "MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS"
+      }
+    }
+  }
+}

package/LICENSE-Boost

@@ -1,23 +0,0 @@
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.