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

package/src/test-reporter.cpp

@@ -1,399 +0,0 @@
-/*
- * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
- * Copyright (c) 2021-2026 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.
- *
- * 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.
- */
-
-// ----------------------------------------------------------------------------
-
-/**
- * @file
- * @brief C++ source file with implementations for the µTest++ test reporter
- * methods.
- *
- * @details
- * This source file contains the core implementations for the test reporting
- * facilities of the µTest++ framework. It provides the logic for formatting
- * and outputting test results, including operator overloads for a wide range
- * of value types, containers, and comparison expressions, as well as
- * structured output for logical and exception-related assertions.
- *
- * The test reporter is responsible for presenting test outcomes in a clear,
- * consistent, and expressive manner, supporting both value and pointer
- * semantics, and providing detailed diagnostics for both successful and failed
- * test cases. Special attention is given to formatting, colour highlighting,
- * and extensibility, enabling professional and readable test reports suitable
- * for embedded and general C++ development.
- *
- * All definitions reside within the `micro_os_plus::micro_test_plus`
- * namespace, ensuring clear separation from user code and minimising the risk
- * of naming conflicts.
- *
- * This file must be included when building the µTest++ library.
- */
-
-// ----------------------------------------------------------------------------
-
-#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 "-Wunknown-warning-option"
-#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::~test_reporter () = default;
-
-  // --------------------------------------------------------------------------
-
-  /**
-   * @details
-   * The `endl` function inserts a newline character into the specified
-   * `test_reporter` stream and flushes its output buffer. This operation
-   * ensures that each test output line is clearly separated and immediately
-   * visible, facilitating the readability and clarity of test results across
-   * all test cases and folders within the µTest++ framework.
-   */
-  test_reporter&
-  endl (test_reporter& stream)
-  {
-    reporter->endline ();
-    return stream;
-  }
-
-  /**
-   * @details
-   * This operator overload enables manipulators, such as `endl`, to be used
-   * with the `test_reporter` stream in a manner similar to standard C++
-   * streams. When a manipulator function is passed, it is invoked with the
-   * current `test_reporter` instance, allowing for seamless integration of
-   * stream operations and improved readability of test output across all test
-   * cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (test_reporter& (*func) (test_reporter&))
-  {
-    // Call the endl function.
-    (*func) (*this);
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the contents of the provided
-   * `std::string_view` to the internal output buffer of the `test_reporter`.
-   * It enables seamless streaming of string data into the reporter, supporting
-   * clear and efficient formatting of test output across all test cases and
-   * folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (std::string_view sv)
-  {
-    out_.append (sv);
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the specified character to the internal
-   * output buffer of the `test_reporter`. It enables efficient streaming of
-   * individual characters into the reporter, supporting precise and flexible
-   * formatting of test output across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (char c)
-  {
-    out_.append (1, c);
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the contents of the provided C-style string
-   * to the internal output buffer of the `test_reporter`. It enables efficient
-   * streaming of string literals and character arrays into the reporter,
-   * supporting clear and flexible formatting of test output across all test
-   * cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (const char* s)
-  {
-    out_.append (s);
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the contents of the provided modifiable
-   * C-style string to the internal output buffer of the `test_reporter`. It
-   * enables efficient streaming of mutable string data into the reporter,
-   * supporting clear and flexible formatting of test output across all test
-   * cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (char* s)
-  {
-    out_.append (s);
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * boolean value to the internal output buffer of the `test_reporter`. It
-   * enables clear and direct streaming of boolean results into the reporter,
-   * supporting precise and readable formatting of test output across all test
-   * cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (bool v)
-  {
-    out_.append (v ? "true" : "false");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string "nullptr" to the internal output
-   * buffer of the `test_reporter`. It enables clear and explicit streaming of
-   * null pointer values into the reporter, supporting precise and readable
-   * formatting of test output across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (std::nullptr_t)
-  {
-    out_.append ("nullptr");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed character to the internal output buffer of the `test_reporter`. It
-   * enables precise and readable streaming of character values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (signed char c)
-  {
-    out_.append (std::to_string (c));
-    out_.append ("c");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned character to the internal output buffer of the `test_reporter`.
-   * It enables precise and readable streaming of unsigned character values
-   * into the reporter, supporting clear formatting of test output across all
-   * test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (unsigned char c)
-  {
-    out_.append (std::to_string (static_cast<int> (c)));
-    out_.append ("uc");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed short integer to the internal output buffer of the `test_reporter`.
-   * It enables precise and readable streaming of signed short values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (signed short v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("s");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned short integer to the internal output buffer of the
-   * `test_reporter`. It enables precise and readable streaming of unsigned
-   * short values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (unsigned short v)
-  {
-    out_.append (std::to_string (static_cast<long> (v)));
-    out_.append ("us");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed integer to the internal output buffer of the `test_reporter`. It
-   * enables precise and readable streaming of signed integer values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (signed int v)
-  {
-    out_.append (std::to_string (v));
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned integer to the internal output buffer of the `test_reporter`. It
-   * enables precise and readable streaming of unsigned integer values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (unsigned int v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("u");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed long integer to the internal output buffer of the `test_reporter`.
-   * It enables precise and readable streaming of signed long values into the
-   * reporter, supporting clear formatting of test output across all test cases
-   * and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (signed long v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("l");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned long integer to the internal output buffer of the
-   * `test_reporter`. It enables precise and readable streaming of unsigned
-   * long values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (unsigned long v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("ul");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * signed long long integer to the internal output buffer of the
-   * `test_reporter`. It enables precise and readable streaming of signed long
-   * long values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (signed long long v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("ll");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * unsigned long long integer to the internal output buffer of the
-   * `test_reporter`. It enables precise and readable streaming of unsigned
-   * long long values into the reporter, supporting clear formatting of test
-   * output across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (unsigned long long v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("ull");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * floating-point value to the internal output buffer of the `test_reporter`,
-   * followed by the character 'f' to indicate a float type. It enables precise
-   * and readable streaming of float values into the reporter, supporting clear
-   * formatting of test output across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (float v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("f");
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * double-precision floating-point value to the internal output buffer of the
-   * `test_reporter`. It enables precise and readable streaming of double
-   * values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (double v)
-  {
-    out_.append (std::to_string (v));
-    return *this;
-  }
-
-  /**
-   * @details
-   * This operator overload appends the string representation of the specified
-   * long double-precision floating-point value to the internal output buffer
-   * of the `test_reporter`, followed by the character 'l' to indicate a long
-   * double type. It enables precise and readable streaming of long double
-   * values into the reporter, supporting clear formatting of test output
-   * across all test cases and folders.
-   */
-  test_reporter&
-  test_reporter::operator<< (long double v)
-  {
-    out_.append (std::to_string (v));
-    out_.append ("l");
-    return *this;
-  }
-
-  // --------------------------------------------------------------------------
-} // namespace micro_os_plus::micro_test_plus
-
-// ----------------------------------------------------------------------------

package/src/test-runner.cpp

@@ -1,311 +0,0 @@
-/*
- * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
- * Copyright (c) 2021-2026 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.
- *
- * 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.
- */
-
-// ----------------------------------------------------------------------------
-
-/**
- * @file
- * @brief C++ source file with implementations for the µTest++ test runner
- * methods.
- *
- * @details
- * This source file contains the core implementations for the test runner
- * facilities of the µTest++ framework. It provides the logic for initialising
- * the test environment, registering and managing test suites, handling
- * command-line arguments, orchestrating test execution, and determining the
- * overall test result. The implementation supports automated discovery and
- * execution of test suites, flexible verbosity control, and robust mechanisms
- * for aborting test execution in critical scenarios.
- *
- * All definitions reside within the `micro_os_plus::micro_test_plus`
- * namespace, ensuring clear separation from user code and minimising the risk
- * of naming conflicts.
- *
- * This file must be included when building the µTest++ library.
- */
-
-// ----------------------------------------------------------------------------
-
-#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 <stdlib.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"
-#pragma clang diagnostic ignored "-Wunknown-warning-option"
-#endif
-
-namespace micro_os_plus::micro_test_plus
-{
-  // --------------------------------------------------------------------------
-
-  /**
-   * @details
-   * The constructor initialises a new instance of the `test_runner` class,
-   * preparing the test runner for managing test suites and cases within the
-   * µTest++ framework. If tracing is enabled, it outputs the function
-   * signature for diagnostic purposes. This setup ensures the test runner is
-   * ready to coordinate the registration, execution, and reporting of tests
-   * across all test cases and folders.
-   */
-  test_runner::test_runner ()
-  {
-#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
-    printf ("%s\n", __PRETTY_FUNCTION__);
-#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
-  }
-
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
-#endif
-  /**
-   * @details
-   * This method initialises the test runner by capturing the command-line
-   * arguments and the default test suite name, configuring the framework for
-   * subsequent test execution. It parses the arguments to determine the
-   * desired verbosity level (normal, verbose, quiet, or silent) and applies
-   * this setting to the test reporter. The method also outputs build and
-   * environment information when appropriate, aiding diagnostics and
-   * transparency. Finally, it creates and registers the default test suite,
-   * preparing the framework to manage and execute all test cases and suites
-   * across the project’s folders.
-   */
-  void
-  test_runner::initialize (int argc, char* argv[], const char* name)
-  {
-#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
-    printf ("%s\n", __PRETTY_FUNCTION__);
-#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
-
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-#if defined(_WIN32)
-    timespec_get (&begin_time, TIME_UTC);
-#else
-    clock_gettime (CLOCK_MONOTONIC, &begin_time);
-#endif
-#endif
-
-    argc_ = argc;
-    argv_ = argv;
-
-    default_suite_name_ = name;
-
-#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))
-#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 // defined(MICRO_OS_PLUS_DEBUG)
-#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
-
-    verbosity_t verbosity = verbosity::normal;
-    const char* reporter_name = "tap";
-    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;
-          }
-        else if (strncmp (argv[i], "--reporter=", 11) == 0)
-          {
-            reporter_name = argv[i] + 11;
-          }
-      }
-
-    // Initialize and configure the reporter.
-    if (strcmp (reporter_name, "basic") == 0)
-      {
-        reporter = new test_reporter_basic ();
-      }
-    else if (strcmp (reporter_name, "tap") == 0)
-      {
-        reporter = new test_reporter_tap ();
-      }
-    else
-      {
-        fprintf (stderr, "error: unknown reporter '%s'\n", reporter_name);
-        exit (1);
-      }
-    reporter->verbosity = verbosity;
-
-    // ------------------------------------------------------------------------
-
-#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))
-    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(__APPLE__) || defined(__linux__) || defined(__unix__) \
-      || defined(WIN32))
-// This is relevant only on bare-metal.
-#if defined(__ARM_PCS_VFP) || defined(__ARM_FP)
-        printf (", with FP");
-#else
-        printf (", no FP");
-#endif
-#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 (".");
-      }
-#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
-
-    // ------------------------------------------------------------------------
-
-    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.
-    // reporter->begin_test (test_suites_count ());
-    // default_test_suite_->begin_test_suite ();
-  }
-#pragma GCC diagnostic pop
-
-  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 ();
-
-        totals.successful_checks += default_test_suite->successful_checks ();
-        totals.failed_checks += default_test_suite->failed_checks ();
-        totals.test_cases_count += default_test_suite->test_cases_count ();
-      }
-
-    if (test_suites != nullptr)
-      {
-        for (auto test_suite : *test_suites)
-          {
-            current_test_suite = test_suite;
-
-            test_suite->begin_test_suite ();
-            test_suite->run ();
-            test_suite->end_test_suite ();
-
-            was_successful &= test_suite->was_successful ();
-
-            totals.successful_checks += test_suite->successful_checks ();
-            totals.failed_checks += test_suite->failed_checks ();
-            totals.test_cases_count += test_suite->test_cases_count ();
-          }
-        if (reporter->verbosity != verbosity::silent)
-          {
-            // printf ("\n");
-          }
-      }
-
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-#if defined(_WIN32)
-    timespec_get (&end_time, TIME_UTC);
-#else
-    clock_gettime (CLOCK_MONOTONIC, &end_time);
-#endif
-#endif
-
-    reporter->end_test (*this);
-
-    return was_successful ? 0 : 1;
-  }
-
-  /**
-   * @details
-   * This method registers a new test suite with the test runner. If the
-   * internal collection of test suites has not yet been created, it is
-   * initialised at this point. The provided test suite is then added to the
-   * collection, enabling the framework to manage and execute multiple test
-   * suites across different files and folders within the project.
-   *
-   * Called by test suite constructors to register themselves with the
-   * runner, enabling automatic management and execution.
-   */
-  void
-  test_runner::register_test_suite (test_suite_base* suite)
-  {
-#if 0 // defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
-    printf ("%s\n", __PRETTY_FUNCTION__);
-#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
-
-    if (test_suites == nullptr)
-      {
-        test_suites = new std::vector<test_suite_base*> ();
-      }
-    test_suites->push_back (suite);
-    suite->index = test_suites->size () + 1;
-  }
-
-  /**
-   * @details
-   * This method immediately terminates the process by invoking the standard C
-   * library `abort()` function. It is used to halt test execution in critical
-   * failure scenarios, ensuring that no further tests are run and that the
-   * cause of the failure can be promptly investigated. This approach provides
-   * a robust mechanism for enforcing strict test outcomes across all test
-   * cases and folders.
-   */
-  void
-  test_runner::abort (void)
-  {
-    ::abort ();
-  }
-
-  // --------------------------------------------------------------------------
-} // namespace micro_os_plus::micro_test_plus
-
-// ----------------------------------------------------------------------------