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

package/src/test-reporter.cpp

@@ -0,0 +1,423 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (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>
+
+// ----------------------------------------------------------------------------
+
+#pragma GCC diagnostic ignored "-Waggregate-return"
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wc++98-compat"
+#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
+#endif
+
+namespace micro_os_plus::micro_test_plus
+{
+  // --------------------------------------------------------------------------
+
+  test_reporter&
+  endl (test_reporter& stream)
+  {
+    reporter.endline ();
+    return stream;
+  }
+
+  // --------------------------------------------------------------------------
+
+  void
+  test_reporter::output_pass_prefix_ (std::string& message)
+  {
+    *this << colors_.pass;
+    if (is_in_test_case_)
+      {
+        *this << "  ";
+      }
+    *this << "  ✓ ";
+    *this << colors_.none;
+    if (!message.empty ())
+      {
+        *this << message.c_str ();
+      }
+  }
+
+  void
+  test_reporter::output_pass_suffix_ (void)
+  {
+    *this << endl;
+
+    flush ();
+  }
+
+  void
+  test_reporter::output_fail_prefix_ (
+      std::string& message, const reflection::source_location& location)
+  {
+    *this << colors_.fail;
+    if (is_in_test_case_)
+      {
+        *this << "  ";
+      }
+    *this << "  ✗ ";
+    *this << colors_.none;
+    if (!message.empty ())
+      {
+        *this << message.c_str ();
+        *this << " ";
+      }
+    *this << colors_.fail << "FAILED" << colors_.none;
+    *this << " (" << reflection::short_name (location.file_name ()) << ":"
+          << type_traits::genuine_integral_value<int>{ location.line () };
+  }
+
+  void
+  test_reporter::output_fail_suffix_ (bool abort)
+  {
+    *this << ")";
+    if (abort)
+      {
+        *this << " aborted...";
+      }
+    *this << endl;
+
+    flush ();
+  }
+
+  test_reporter&
+  test_reporter::operator<< (test_reporter& (*func) (test_reporter&))
+  {
+    // Call the endl function.
+    (*func) (*this);
+    return *this;
+  }
+
+  void
+  test_reporter::endline (void)
+  {
+    out_.append ("\n");
+    flush ();
+  }
+
+  void
+  test_reporter::flush (void)
+  {
+    fflush (stdout); // Sync STDOUT.
+  }
+
+  test_reporter&
+  test_reporter::operator<< (std::string_view sv)
+  {
+    out_.append (sv);
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (char c)
+  {
+    out_.append (1, c);
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (const char* s)
+  {
+    out_.append (s);
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (char* s)
+  {
+    out_.append (s);
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (bool v)
+  {
+    out_.append (v ? "true" : "false");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (std::nullptr_t)
+  {
+    out_.append ("nullptr");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (signed char c)
+  {
+    out_.append (std::to_string (c));
+    out_.append ("c");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (unsigned char c)
+  {
+    out_.append (std::to_string (static_cast<int> (c)));
+    out_.append ("uc");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (signed short v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("s");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (unsigned short v)
+  {
+    out_.append (std::to_string (static_cast<long> (v)));
+    out_.append ("us");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (signed int v)
+  {
+    out_.append (std::to_string (v));
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (unsigned int v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("u");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (signed long v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("l");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (unsigned long v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("ul");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (signed long long v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("ll");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (unsigned long long v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("ull");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (float v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("f");
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (double v)
+  {
+    out_.append (std::to_string (v));
+    return *this;
+  }
+
+  test_reporter&
+  test_reporter::operator<< (long double v)
+  {
+    out_.append (std::to_string (v));
+    out_.append ("l");
+    return *this;
+  }
+
+  void
+  test_reporter::begin_test_case ([[maybe_unused]] const char* name)
+  {
+    is_in_test_case_ = true;
+
+    if (!out_.empty () && (verbosity == verbosity::verbose))
+      {
+        if (add_empty_line)
+          {
+            printf ("\n");
+          }
+        output ();
+        add_empty_line = true;
+      }
+
+    out_.clear ();
+
+    flush ();
+  }
+
+  void
+  test_reporter::end_test_case ([[maybe_unused]] const char* name)
+  {
+    if (verbosity == verbosity::normal || verbosity == verbosity::verbose)
+      {
+        if (current_test_suite->current_test_case.failed_checks > 0)
+          {
+            if (true /* add_empty_line */)
+              {
+                printf ("\n");
+              }
+            printf ("  • %s - test case started\n", name);
+            output ();
+            printf (
+                "  %s✗%s %s - test case %sFAILED%s (%d %s passed, %d "
+                "failed)\n",
+                colors_.fail, colors_.none, name, colors_.fail, colors_.none,
+                current_test_suite->current_test_case.successful_checks,
+                current_test_suite->current_test_case.successful_checks == 1
+                    ? "check"
+                    : "checks",
+                current_test_suite->current_test_case.failed_checks);
+            add_empty_line = true;
+          }
+        else
+          {
+            if (add_empty_line)
+              {
+                printf ("\n");
+              }
+            if (verbosity == verbosity::verbose)
+              {
+                printf ("  • %s - test case started\n", name);
+                output ();
+                printf (
+                    "  %s✓%s %s - test case passed (%d %s)\n", colors_.pass,
+                    colors_.none, name,
+                    current_test_suite->current_test_case.successful_checks,
+                    current_test_suite->current_test_case.successful_checks
+                            == 1
+                        ? "check"
+                        : "checks");
+
+                add_empty_line = true;
+              }
+            else
+              {
+                printf (
+                    "  %s✓%s %s - test case passed (%d %s)\n", colors_.pass,
+                    colors_.none, name,
+                    current_test_suite->current_test_case.successful_checks,
+                    current_test_suite->current_test_case.successful_checks
+                            == 1
+                        ? "check"
+                        : "checks");
+
+                add_empty_line = false;
+              }
+          }
+      }
+
+    out_.clear ();
+    flush ();
+
+    is_in_test_case_ = false;
+  }
+
+  void
+  test_reporter::begin_test_suite (const char* name)
+  {
+    if (add_empty_line)
+      {
+        flush ();
+        printf ("\n");
+      }
+
+    if (verbosity == verbosity::silent || verbosity == verbosity::quiet)
+      {
+        add_empty_line = false;
+        return;
+      }
+
+    printf ("• %s - test suite started\n", name);
+
+    add_empty_line = true;
+  }
+
+  void
+  test_reporter::end_test_suite (test_suite_base& suite)
+  {
+    if (verbosity == verbosity::silent)
+      {
+        return;
+      }
+
+    if (suite.test_cases () > 0 && verbosity != verbosity::quiet)
+      {
+        printf ("\n");
+        add_empty_line = true;
+      }
+
+    // Also fail if none passed.
+    if (suite.failed_checks () == 0 && suite.successful_checks () != 0)
+      {
+        printf ("%s✓%s %s - test suite passed (%d %s in %d test %s)\n",
+                colors_.pass, colors_.none, suite.name (),
+                suite.successful_checks (),
+                suite.successful_checks () == 1 ? "check" : "checks",
+                suite.test_cases (),
+                suite.test_cases () == 1 ? "case" : "cases");
+      }
+    else
+      {
+        printf ("%s✗%s %s - test suite %sFAILED%s (%d %s passed, %d failed, "
+                "in %d test %s)\n",
+                colors_.fail, colors_.none, suite.name (), colors_.fail,
+                colors_.none, suite.successful_checks (),
+                suite.successful_checks () == 1 ? "check" : "checks",
+                suite.failed_checks (), suite.test_cases (),
+                suite.test_cases () == 1 ? "case" : "cases");
+      }
+    flush ();
+  }
+
+  void
+  test_reporter::output (void)
+  {
+    printf ("%s", out_.c_str ()); // No `\n` here.
+    out_.clear ();
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
+// ----------------------------------------------------------------------------

package/src/test-runner.cpp

@@ -0,0 +1,183 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (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 <vector>
+
+// ----------------------------------------------------------------------------
+
+#pragma GCC diagnostic ignored "-Waggregate-return"
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wc++98-compat"
+#pragma clang diagnostic ignored "-Wc++98-c++11-c++14-compat"
+#endif
+
+namespace micro_os_plus::micro_test_plus
+{
+  // --------------------------------------------------------------------------
+
+  test_runner::test_runner ()
+  {
+#if defined(MICRO_TEST_PLUS_TRACE)
+    printf ("%s\n", __PRETTY_FUNCTION__);
+#endif // MICRO_TEST_PLUS_TRACE
+  }
+
+  void
+  test_runner::initialize (int argc, char* argv[], const char* name)
+  {
+#if defined(MICRO_TEST_PLUS_TRACE)
+    printf ("%s\n", __PRETTY_FUNCTION__);
+#endif // MICRO_TEST_PLUS_TRACE
+
+    argc_ = argc;
+    argv_ = argv;
+
+    default_suite_name_ = name;
+
+#if defined(MICRO_OS_PLUS_DEBUG)
+    printf ("argv[");
+    for (int i = 0; i < argc; ++i)
+      {
+        if (i > 0)
+          {
+            printf (", ");
+          }
+        printf ("'%s'", argv[i]);
+      }
+    puts ("]");
+#endif
+
+    verbosity_t verbosity = verbosity::normal;
+    for (int i = 0; i < argc; ++i)
+      {
+        if (strcmp (argv[i], "--verbose") == 0)
+          {
+            verbosity = verbosity::verbose;
+          }
+        else if (strcmp (argv[i], "--quiet") == 0)
+          {
+            verbosity = verbosity::quiet;
+          }
+        else if (strcmp (argv[i], "--silent") == 0)
+          {
+            verbosity = verbosity::silent;
+          }
+      }
+
+    // Pass the verbosity to the reporter.
+    reporter.verbosity = verbosity;
+
+    // ------------------------------------------------------------------------
+
+    if (verbosity == verbosity::normal || verbosity == verbosity::verbose)
+      {
+#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(MICRO_OS_PLUS_DEBUG)
+        printf (", with MICRO_OS_PLUS_DEBUG");
+#endif
+        puts (".");
+      }
+
+    // ------------------------------------------------------------------------
+
+    default_test_suite_ = new test_suite_base (default_suite_name_);
+    current_test_suite = default_test_suite_;
+
+    // Deferred to first test case or test suite end, to allow various
+    // initialisations to display their messages.
+    // default_test_suite_->begin_test_suite ();
+  }
+
+  int
+  test_runner::exit_code (void)
+  {
+    bool was_successful = true;
+
+    if (!default_test_suite_->unused ())
+      {
+        default_test_suite_->end_test_suite ();
+        was_successful = default_test_suite_->was_successful ();
+      }
+
+    if (suites_ != nullptr)
+      {
+        for (auto suite : *suites_)
+          {
+            default_test_suite_ = suite;
+            suite->run ();
+
+            was_successful &= suite->was_successful ();
+          }
+        if (reporter.verbosity != verbosity::silent)
+          {
+            printf ("\n");
+          }
+      }
+    return was_successful ? 0 : 1;
+  }
+
+  void
+  test_runner::register_test_suite (test_suite_base* suite)
+  {
+#if 0 // defined(MICRO_TEST_PLUS_TRACE)
+    printf ("%s\n", __PRETTY_FUNCTION__);
+#endif // MICRO_TEST_PLUS_TRACE
+
+    if (suites_ == nullptr)
+      {
+        suites_ = new std::vector<test_suite_base*> ();
+      }
+    suites_->push_back (suite);
+  }
+
+  void
+  test_runner::abort (void)
+  {
+    ::abort ();
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
+// ----------------------------------------------------------------------------

package/src/test-suite.cpp

@@ -0,0 +1,117 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (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>
+
+// ----------------------------------------------------------------------------
+
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wc++98-compat"
+#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
+#endif
+
+namespace micro_os_plus::micro_test_plus
+{
+  // --------------------------------------------------------------------------
+
+  test_suite_base::test_suite_base (const char* name)
+  {
+#if defined(MICRO_TEST_PLUS_TRACE)
+    printf ("%s\n", __PRETTY_FUNCTION__);
+#endif // MICRO_TEST_PLUS_TRACE
+
+    name_ = name;
+    // The default test suite needs no registration.
+  }
+
+  test_suite_base::~test_suite_base ()
+  {
+  }
+
+  void
+  test_suite_base::run ()
+  {
+#if defined(MICRO_TEST_PLUS_TRACE)
+    printf ("%s\n", __PRETTY_FUNCTION__);
+#endif // MICRO_TEST_PLUS_TRACE
+  }
+
+  void
+  test_suite_base::begin_test_suite (void)
+  {
+    process_deferred_begin = false;
+
+    reporter.begin_test_suite (name_);
+  }
+
+  void
+  test_suite_base::end_test_suite (void)
+  {
+    if (process_deferred_begin)
+      {
+        begin_test_suite ();
+      }
+    reporter.end_test_suite (*this);
+  }
+
+  void
+  test_suite_base::begin_test_case (const char* name)
+  {
+    if (process_deferred_begin)
+      {
+        begin_test_suite ();
+      }
+
+    test_case_name_ = name;
+    ++test_cases_;
+
+    current_test_case = {};
+
+    reporter.begin_test_case (test_case_name_);
+  }
+
+  void
+  test_suite_base::end_test_case (void)
+  {
+    reporter.end_test_case (test_case_name_);
+  }
+
+  void
+  test_suite_base::increment_successful (void)
+  {
+    ++successful_checks_;
+    ++current_test_case.successful_checks;
+  }
+
+  void
+  test_suite_base::increment_failed (void)
+  {
+    ++failed_checks_;
+    ++current_test_case.failed_checks;
+  }
+
+  // --------------------------------------------------------------------------
+} // namespace micro_os_plus::micro_test_plus
+
+// ----------------------------------------------------------------------------