@micro-os-plus/micro-test-plus 3.3.1 → 4.1.0

package/src/test-reporter-tap.cpp

@@ -1,530 +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++ TAP test
- * reporter methods.
- *
- * @details
- * This source file contains the implementations for `test_reporter_tap`,
- * a concrete implementation of the `test_reporter` abstract interface that
- * formats test results according to the Test Anything Protocol (TAP).
- *
- * 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 <time.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
-{
-  // --------------------------------------------------------------------------
-
-  /**
-   * @details
-   * This method outputs the prefix for a passing test result, applying the
-   * appropriate colour formatting and symbols to clearly indicate success. If
-   * the output occurs within a test case, additional indentation is applied
-   * for readability. The prefix includes a tick symbol (`✓`) and, if provided,
-   * an associated message. Colour formatting is reset after the prefix to
-   * maintain consistent output style across all test cases and folders.
-   *
-   * The prefix/suffix methods help shorten the code
-   * generated by the template methods.
-   */
-  void
-  test_reporter_tap::output_pass_prefix_ (std::string& message)
-  {
-    if (is_in_test_case_)
-      {
-        *this << "        ";
-      }
-    *this << "ok "
-          << static_cast<int> (current_test_suite->current_test_case.index)
-          << " - ";
-    if (!message.empty ())
-      {
-        *this << message.c_str ();
-      }
-  }
-
-  /**
-   * @details
-   * The `endl` function acts as a stream manipulator for the `test_reporter`,
-   * inserting a line ending into the output buffer and flushing the current
-   * content if necessary. This ensures that test report output is clearly
-   * separated and formatted, improving readability and professionalism in the
-   * presentation of test results.
-   *
-   * Using `endl` in conjunction with the `test_reporter` output operators
-   * provides a familiar and convenient mechanism for managing line breaks,
-   * similar to standard C++ stream manipulators.
-   *
-   * The prefix/suffix methods help shorten the code
-   * generated by the template methods.
-   */
-  void
-  test_reporter_tap::output_pass_suffix_ (void)
-  {
-    *this << endl;
-
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method outputs the prefix for a failing test result, applying the
-   * appropriate colour formatting and symbols to clearly indicate failure. If
-   * the output occurs within a test case, additional indentation is applied
-   * for readability. The prefix includes a cross symbol (`✗`), an optional
-   * message, and the label "FAILED". The source location is appended in
-   * parentheses, showing the file or folder name and line number where the
-   * failure occurred. Colour formatting is reset after the prefix to maintain
-   * consistent output style across all test cases and folders.
-   */
-  void
-  test_reporter_tap::output_fail_prefix_ (
-      std::string& message, [[maybe_unused]] const bool hasExpression,
-      [[maybe_unused]] const reflection::source_location& location)
-  {
-    if (is_in_test_case_)
-      {
-        *this << "        ";
-      }
-    *this << "not ok "
-          << static_cast<int> (current_test_suite->current_test_case.index);
-
-    if (!message.empty ())
-      {
-        *this << " - " << message.c_str ();
-        *this << " ";
-      }
-    *this << endl;
-
-    *this << "            ---";
-    if (hasExpression)
-      {
-        *this << endl;
-        *this << "            expect: ";
-      }
-  }
-
-  /**
-   * @details
-   * This method outputs the suffix for a failing test result by closing the
-   * location information, appending an "aborted..." message if the test was
-   * aborted, and then adding a newline to the test output. The output stream
-   * is flushed to ensure immediate visibility. This approach guarantees that
-   * failure results are clearly separated, promptly reported, and easily
-   * distinguishable across all test cases and folders.
-   */
-  void
-  test_reporter_tap::output_fail_suffix_ (
-      const reflection::source_location& location, bool abort)
-  {
-    if (abort)
-      {
-        *this << " aborted...";
-      }
-    *this << endl;
-    *this << "            at:" << endl;
-
-    *this << "              filename: "
-          << reflection::short_name (location.file_name ()) << endl;
-    *this << "              line: "
-          << type_traits::genuine_integral_value<unsigned int>{ location
-                                                                    .line () }
-          << endl;
-
-    *this << "            ..." << endl;
-
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method appends a newline character to the internal output buffer of
-   * the `test_reporter` and immediately flushes the stream. This ensures that
-   * each line of test output is clearly separated and promptly displayed,
-   * enhancing the readability and organisation of test results across all test
-   * cases and folders.
-   */
-  void
-  test_reporter_tap::endline (void)
-  {
-    out_.append ("\n");
-    flush ();
-  }
-
-  /**
-   * @details
-   * This method flushes the output buffer of the `test_reporter` by
-   * synchronising it with the standard output stream. This guarantees that all
-   * pending test output is immediately written and visible, ensuring prompt
-   * and reliable reporting of test results across all test cases and folders.
-   */
-  void
-  test_reporter_tap::flush (void)
-  {
-    fflush (stdout); // Sync STDOUT.
-  }
-
-  /**
-   * @details
-   * This method marks the beginning of a test case, setting the internal state
-   * to indicate that test output is now within a test case context. If there
-   * is pending output and the verbosity level is set to verbose, it ensures
-   * that output is properly separated and displayed, adding an empty line if
-   * necessary. The output buffer is cleared and the stream is flushed to
-   * guarantee that all previous output is visible before the new test case
-   * begins. This approach enhances the clarity and organisation of test
-   * results across all test cases and folders.
-   */
-  void
-  test_reporter_tap::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 ();
-  }
-
-  /**
-   * @details
-   * This method marks the end of a test case, summarising its outcome and
-   * outputting the results with appropriate formatting and colour coding. If
-   * any checks have failed, a failure message is displayed, including the
-   * number of successful and failed checks. For passing test cases, a success
-   * message is shown with the total number of checks. The output is adjusted
-   * according to the verbosity level, and additional spacing is managed for
-   * clarity. The output buffer is cleared and the stream is flushed to ensure
-   * all results are immediately visible, supporting clear and organised
-   * reporting across all test cases and folders.
-   */
-  void
-  test_reporter_tap::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");
-              }
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-            printf ("    # Subtest: %s - test case started\n", name);
-            output ();
-            printf ("        1..%zu\n",
-                    current_test_suite->current_test_case.index);
-            printf ("    not ok %zu - %s # { test case FAILED, %zu check%s "
-                    "passed, %zu failed }\n",
-                    current_test_suite->test_cases_count (), name,
-                    current_test_suite->current_test_case.successful_checks,
-                    current_test_suite->current_test_case.successful_checks
-                            == 1
-                        ? ""
-                        : "s",
-                    current_test_suite->current_test_case.failed_checks);
-
-#pragma GCC diagnostic pop
-            add_empty_line = true;
-          }
-        else
-          {
-            if (add_empty_line)
-              {
-                printf ("\n");
-              }
-            if (verbosity == verbosity::verbose)
-              {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-                printf ("    # Subtest: %s - test case\n", name);
-                output ();
-                printf ("        1..%zu\n",
-                        current_test_suite->current_test_case.index);
-                printf (
-                    "    ok %zu - %s # { test case passed, %zu check%s }\n",
-                    current_test_suite->test_cases_count (), name,
-                    current_test_suite->current_test_case.successful_checks,
-                    current_test_suite->current_test_case.successful_checks
-                            == 1
-                        ? ""
-                        : "s");
-#pragma GCC diagnostic pop
-                add_empty_line = true;
-              }
-            else
-              {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-                printf (
-                    "    ok %zu - %s # { test case passed, %zu check%s }\n",
-                    current_test_suite->test_cases_count (), name,
-                    current_test_suite->current_test_case.successful_checks,
-                    current_test_suite->current_test_case.successful_checks
-                            == 1
-                        ? ""
-                        : "s");
-#pragma GCC diagnostic pop
-
-                add_empty_line = false;
-              }
-          }
-      }
-
-    out_.clear ();
-    flush ();
-
-    is_in_test_case_ = false;
-  }
-
-  /**
-   * @details
-   * This method marks the beginning of a test suite, ensuring that output is
-   * properly separated and clearly presented. If there is pending output, the
-   * stream is flushed and an empty line is added for clarity. For silent or
-   * quiet verbosity levels, output is suppressed. Otherwise, a message
-   * indicating the start of the test suite is displayed. This approach
-   * enhances the organisation and readability of test results across all test
-   * cases and folders.
-   */
-  void
-  test_reporter_tap::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;
-      }
-
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-    printf ("# Subtest: %s - test suite\n", name);
-#pragma GCC diagnostic pop
-
-    add_empty_line = false;
-  }
-
-  /**
-   * @details
-   * This method marks the end of a test suite, summarising the overall results
-   * and presenting them with appropriate formatting and colour coding. If the
-   * suite contains test cases and the verbosity is not set to quiet, an empty
-   * line is added for clarity. For suites with no failed checks and at least
-   * one successful check, a success message is displayed, including the number
-   * of checks and test cases. Otherwise, a failure message is shown, detailing
-   * the number of successful and failed checks, as well as the total number of
-   * test cases. The output is immediately flushed to ensure prompt and
-   * organised reporting across all test cases and folders.
-   */
-  void
-  test_reporter_tap::end_test_suite (test_suite_base& suite)
-  {
-    if (verbosity == verbosity::silent)
-      {
-        return;
-      }
-
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-    long milliseconds = 0;
-    long microseconds = 0;
-    suite.compute_elapsed_time (suite.begin_time, suite.end_time, milliseconds,
-                                microseconds);
-#endif
-
-    if (suite.test_cases_count () > 0 && verbosity != verbosity::quiet)
-      {
-        // printf ("\n");
-        add_empty_line = true;
-      }
-
-    // Also fail if none passed.
-    if (suite.failed_checks () == 0 && suite.successful_checks () != 0)
-      {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-        if (verbosity != verbosity::quiet)
-          {
-            printf ("    1..%zu\n", suite.test_cases_count ());
-          }
-        printf ("ok %zu - %s # { test suite passed, %zu check%s in %zu test "
-                "case%s",
-                suite.index, suite.name (), suite.successful_checks (),
-                suite.successful_checks () == 1 ? "" : "s",
-                suite.test_cases_count (),
-                suite.test_cases_count () == 1 ? "" : "s");
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-        if (milliseconds > 0 || microseconds > 0)
-          {
-            printf (", time: %ld.%03ld ms", milliseconds, microseconds);
-          }
-#endif
-        printf (" }\n");
-#pragma GCC diagnostic pop
-      }
-    else
-      {
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-        if (verbosity != verbosity::quiet)
-          {
-            printf ("    1..%zu\n", suite.test_cases_count ());
-          }
-        printf ("not ok %zu - %s # { test suite FAILED, %zu check%s passed, "
-                "%zu failed, in %zu test case%s",
-                suite.index, suite.name (), suite.successful_checks (),
-                suite.successful_checks () == 1 ? "" : "s",
-                suite.failed_checks (), suite.test_cases_count (),
-                suite.test_cases_count () == 1 ? "" : "s");
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-        if (milliseconds > 0 || microseconds > 0)
-          {
-            printf (", time: %ld.%03ld ms", milliseconds, microseconds);
-          }
-#endif
-        printf (" }\n");
-#pragma GCC diagnostic pop
-      }
-
-    flush ();
-  }
-
-  void
-  test_reporter_tap::begin_test (size_t test_suites_count)
-  {
-    if (verbosity != verbosity::silent)
-      {
-        printf ("\nTAP version 14\n");
-        printf ("1..%zu\n", test_suites_count ? test_suites_count : 1);
-        flush ();
-      }
-    add_empty_line = false;
-  }
-
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wshadow"
-  void
-  test_reporter_tap::end_test (test_runner& runner)
-  {
-    if (verbosity != verbosity::silent)
-      {
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-        long milliseconds = 0;
-        long microseconds = 0;
-        runner.default_test_suite->compute_elapsed_time (
-            runner.begin_time, runner.end_time, milliseconds, microseconds);
-#endif
-
-#pragma GCC diagnostic push
-#if defined(__clang__)
-#pragma clang diagnostic ignored "-Wunsafe-buffer-usage-in-libc-call"
-#endif
-        printf ("\n# { total: %zu check%s passed, %zu failed, in %zu test "
-                "case%s, %zu test suite%s",
-                runner.totals.successful_checks,
-                runner.totals.successful_checks == 1 ? "" : "s",
-                runner.totals.failed_checks, runner.totals.test_cases_count,
-                runner.totals.test_cases_count == 1 ? "" : "s",
-                runner.test_suites_count (),
-                runner.test_suites_count () == 1 ? "" : "s");
-
-#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
-        if (milliseconds > 0 || microseconds > 0)
-          {
-            printf (", time: %ld.%03ld ms", milliseconds, microseconds);
-          }
-#endif
-        printf (" }\n");
-#pragma GCC diagnostic pop
-        flush ();
-      }
-  }
-#pragma GCC diagnostic pop
-
-  /**
-   * @details
-   * This method writes the contents of the internal output buffer to the
-   * standard output stream without appending a newline character. After
-   * outputting the buffer, it is cleared to prepare for subsequent output.
-   * This approach ensures that test results are presented promptly and
-   * efficiently, supporting clear and organised reporting across all test
-   * cases and folders.
-   */
-  void
-  test_reporter_tap::output (void)
-  {
-    printf ("%s", out_.c_str ()); // No `\n` here.
-    out_.clear ();
-  }
-
-  // --------------------------------------------------------------------------
-} // namespace micro_os_plus::micro_test_plus
-
-// ----------------------------------------------------------------------------