@micro-os-plus/micro-test-plus 2.1.1 → 3.0.0

package/src/micro-test-plus.cpp

@@ -1,252 +1,169 @@
 /*
  * This file is part of the µOS++ distribution.
- *   (https://github.com/micro-os-plus)
+ *   (https://github.com/micro-os-plus/)
  * Copyright (c) 2021 Liviu Ionescu.
  *
  * 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/>.
+ *
+ * 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>.
  */
 
+// ----------------------------------------------------------------------------
+
+#if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
+#include <micro-os-plus/config.h>
+#endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
+
 #include <micro-os-plus/micro-test-plus.h>
-#include <stdio.h>
 #include <cstring>
+// <iostream> is too heavy for embedded, use printf().
+#include <stdio.h>
+#include <unistd.h>
 
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUC__)
-#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Waggregate-return"
 #if defined(__clang__)
 #pragma clang diagnostic ignored "-Wc++98-compat"
-#endif
+#pragma clang diagnostic ignored "-Wexit-time-destructors"
+#pragma clang diagnostic ignored "-Wglobal-constructors"
 #endif
 
-namespace micro_os_plus
+namespace micro_os_plus::micro_test_plus
 {
-  namespace micro_test_plus
-  {
-
-    // ------------------------------------------------------------------------
-
-    session::session ()
-    {
-      this->argc_ = 0;
-      this->argv_ = nullptr;
-
-      passed_ = 0;
-      failed_ = 0;
-      test_cases_ = 0;
-    }
-
-    session::session (int argc, char* argv[])
-    {
-      init (argc, argv);
-    }
-
-    void
-    session::init (int argc, char* argv[])
-    {
-      this->argc_ = argc;
-      this->argv_ = argv;
+  // --------------------------------------------------------------------------
+  // Public API.
 
-      passed_ = 0;
-      failed_ = 0;
-      test_cases_ = 0;
-
-#if defined(__clang__)
-      printf ("Built with clang " __VERSION__);
-#elif defined(__GNUC__)
-      printf ("Built with GCC " __VERSION__);
-#elif defined(_MSC_VER)
-      // https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=msvc-170
-      printf ("Built with MSVC %d", _MSC_VER);
-#else
-      printf ("Built with an unknown compiler");
-#endif
-#if defined(__ARM_PCS_VFP)
-      printf (", with FP");
-#else
-      printf (", no FP");
-#endif
-#if defined(__EXCEPTIONS)
-      printf (", with exceptions");
-#else
-      printf (", no exceptions");
-#endif
-#if defined(DEBUG)
-      printf (", with DEBUG");
-#endif
-      puts (".");
-
-#if defined(DEBUG)
-      printf ("argv[] = ");
-      for (int i = 0; i < argc; ++i)
-        {
-          printf ("'%s' ", argv[i]);
-        }
-      puts ("");
+  void
+  initialize (int argc, char* argv[], const char* name)
+  {
+#if defined(MICRO_TEST_PLUS_TRACE)
+    printf ("%s\n", __PRETTY_FUNCTION__);
 #endif
-    }
+    runner.initialize (argc, argv, name);
+  }
 
-    void
-    session::start_suite (const char* name)
-    {
-      name_ = name;
-      printf ("\n%s started\n", name);
-    }
-
-    void
-    session::run_test_case (void (*function) (session&), const char* name)
-    {
-      printf ("\n  %s\n", name);
+  int
+  exit_code (void)
+  {
+    return runner.exit_code ();
+  }
 
-      (*function) (*this);
-      test_cases_++;
-    }
+  // --------------------------------------------------------------------------
+  // Too small to deserve a separate source file.
+  namespace reflection
+  {
 
-#if defined(__GNUC__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wunused-parameter"
-#endif
-    void
-    session::pass (const char* message, const char* file, int line)
+    const char*
+    short_name (const char* name)
     {
-      // The file name and line number are unused in this version;
-      // they are present only in case future versions will keep a
-      // log off all tests.
-      printf ("    ✓ %s\n", message);
-      passed_++;
+      const char* p = strrchr (name, '/');
+      if (p != nullptr)
+        return p + 1;
+      else
+        return name;
     }
-#if defined(__GNUC__)
-#pragma GCC diagnostic pop
-#endif
 
-    void
-    session::fail (const char* message, const char* file, int line)
-    {
-      printf ("    ✗ %s", message);
-      print_where_ (" (in '%s:%d')", file, line);
-      printf ("\n");
+  } // namespace reflection
 
-      failed_++;
-    }
-
-    void
-    session::expect_true (bool condition, const char* message,
-                          const char* file, int line)
+  namespace utility
+  {
+    [[nodiscard]] bool
+    is_match (std::string_view input, std::string_view pattern)
     {
-      if (condition)
+      if (std::empty (pattern))
         {
-          printf ("    ✓ %s\n", message);
-          passed_++;
+          return std::empty (input);
         }
-      else
+
+      if (std::empty (input))
         {
-          printf ("    ✗ %s", message);
-          print_where_ (" (in '%s:%d')", file, line);
-          printf ("\n");
-          failed_++;
+          return pattern[0] == '*' ? is_match (input, pattern.substr (1))
+                                   : false;
         }
-    }
 
-    void
-    session::expect_eq (int actual, int expected, const char* message,
-                        const char* file, int line)
-    {
-      if (actual == expected)
+      if (pattern[0] != '?' and pattern[0] != '*' and pattern[0] != input[0])
         {
-          printf ("    ✓ %s\n", message);
-          passed_++;
+          return false;
         }
-      else
+
+      if (pattern[0] == '*')
         {
-          printf ("    ✗ %s (expected %d, got %d", message, expected, actual);
-          print_where_ (", in '%s:%d'", file, line);
-          printf (")\n");
-          failed_++;
+          for (decltype (std::size (input)) i = 0u; i <= std::size (input);
+               ++i)
+            {
+              if (is_match (input.substr (i), pattern.substr (1)))
+                {
+                  return true;
+                }
+            }
+          return false;
         }
+
+      return is_match (input.substr (1), pattern.substr (1));
     }
 
-    void
-    session::expect_eq (long actual, long expected, const char* message,
-                        const char* file, int line)
+  } // namespace utility
+
+  namespace detail
+  {
+    deferred_reporter_base::deferred_reporter_base (
+        bool value, const reflection::source_location location)
+        : value_{ value }, location_{ location }
     {
-      if (actual == expected)
+      if (value_)
         {
-          printf ("    ✓ %s\n", message);
-          passed_++;
+          current_test_suite->increment_successful ();
         }
       else
         {
-          printf ("    ✗ %s (expected %ld, got %ld", message, expected,
-                  actual);
-          print_where_ (", in '%s:%d'", file, line);
-          printf (")\n");
-          failed_++;
+          current_test_suite->increment_failed ();
         }
     }
 
-    void
-    session::expect_eq (const char* actual, const char* expected,
-                        const char* message, const char* file, int line)
+    deferred_reporter_base::~deferred_reporter_base ()
     {
-      if (std::strcmp (actual, expected) == 0)
-        {
-          printf ("    ✓ %s\n", message);
-          passed_++;
-        }
-      else
+#if 0 // defined(MICRO_TEST_PLUS_TRACE)
+      printf ("%s\n", __PRETTY_FUNCTION__);
+#endif // MICRO_TEST_PLUS_TRACE
+
+      if (abort_ && !value_)
         {
-          printf ("    ✗ %s (expected '%s', got '%s'", message, expected,
-                  actual);
-          print_where_ (", in '%s:%d'", file, line);
-          printf (")\n");
-          failed_++;
+          printf ("\n");
+          reporter.output ();
+          abort ();
         }
     }
 
-#if defined(__GNUC__)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wformat-nonliteral"
-#endif
+  } // namespace detail
 
-    void
-    session::print_where_ (const char* format, const char* file, int line)
-    {
-      if (file != nullptr)
-        {
-          printf (format, file, line);
-        }
-    }
+  // ==========================================================================
 
 #if defined(__GNUC__)
-#pragma GCC diagnostic pop
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wexit-time-destructors"
+#pragma clang diagnostic ignored "-Wglobal-constructors"
+#endif
 #endif
 
-    int
-    session::result (void)
-    {
-      // Also fail if none passed.
-      if (failed_ == 0 && passed_ != 0)
-        {
-          printf ("\n%s passed (%d tests in %d test cases)\n", name_, passed_,
-                  test_cases_);
-          return 0;
-        }
-      else
-        {
-          printf (
-              "\n%s failed (%d tests passed, %d failed, in %d test cases)\n",
-              name_, passed_, failed_, test_cases_);
-          return 1;
-        }
-    }
+  // Static instances;
+  test_runner runner;
+  test_reporter reporter;
 
-    // ------------------------------------------------------------------------
-  } // namespace micro_test_plus
-} // namespace micro_os_plus
+  test_suite_base* current_test_suite;
 
 #if defined(__GNUC__)
 #pragma GCC diagnostic pop
 #endif
 
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
 // ----------------------------------------------------------------------------