test-reporter.h

Go to the documentation of this file.

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

 
#ifndef MICRO_TEST_PLUS_TEST_REPORTER_H_
#define MICRO_TEST_PLUS_TEST_REPORTER_H_
 
// ----------------------------------------------------------------------------
 
#ifdef __cplusplus
 
// ----------------------------------------------------------------------------
 
// #include <functional>
#include <string_view>
#include <string>
 
#include "type-traits.h"
#include "test-suite.h"
#include "detail.h"
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"
#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
#endif
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------

  struct colors
  {
    const char* none = ""; 
    const char* pass = ""; 
    const char* fail = ""; 
  };
 
  const colors colors_red_green = {
    "\033[0m", 
    "\033[32m", 
    "\033[31m" 
  };

  enum class verbosity
  {
    silent = 0, 
    quiet = 1, 
    normal = 2, 
    verbose = 3 
  };

  typedef verbosity verbosity_t;
 
  // Forward definition.
  class test_reporter;

  test_reporter&
  endl (test_reporter& stream);
 
  // Requires events::assertion_* for  and detailed operators.
 
  class test_runner;

  class test_reporter
  {
  public:
    virtual ~test_reporter ();

    [[nodiscard]] inline auto
    color (const bool cond)
    {
      return cond ? colors_.pass : colors_.fail;
    }

    test_reporter&
    operator<< (std::string_view sv);

    test_reporter&
    operator<< (char c);

    test_reporter&
    operator<< (const char* s);

    test_reporter&
    operator<< (char* s);

    test_reporter&
    operator<< (bool v);

    test_reporter& operator<< (std::nullptr_t);

    test_reporter&
    operator<< (signed char c);

    test_reporter&
    operator<< (unsigned char c);

    test_reporter&
    operator<< (signed short v);

    test_reporter&
    operator<< (unsigned short v);

    test_reporter&
    operator<< (signed int v);

    test_reporter&
    operator<< (unsigned int v);

    test_reporter&
    operator<< (signed long v);

    test_reporter&
    operator<< (unsigned long v);

    test_reporter&
    operator<< (signed long long v);

    test_reporter&
    operator<< (unsigned long long v);

    test_reporter&
    operator<< (float v);

    test_reporter&
    operator<< (double v);

    test_reporter&
    operator<< (long double v);

    template <typename T>
    test_reporter&
    operator<< (T* v);

    test_reporter&
    operator<< (test_reporter& (*func) (test_reporter&));
 
    // ------------------------------------------------------------------------
    // Specific operators.

    template <class T>
    test_reporter&
    operator<< (const T& t);

    template <class T>
    test_reporter&
    operator<< (const type_traits::genuine_integral_value<T>& v);

    template <class T,
              type_traits::requires_t<type_traits::is_container_v<T>
                                      and not type_traits::has_npos_v<T>>
              = 0>
    test_reporter&
    operator<< (T&& t);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::eq_<Lhs_T, Rhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::ne_<Lhs_T, Rhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::gt_<Lhs_T, Rhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::ge_<Lhs_T, Rhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::lt_<Rhs_T, Lhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::le_<Rhs_T, Lhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::and_<Lhs_T, Rhs_T>& op);

    template <class Lhs_T, class Rhs_T>
    test_reporter&
    operator<< (const detail::or_<Lhs_T, Rhs_T>& op);

    template <class T>
    test_reporter&
    operator<< (const detail::not_<T>& op);
 
#if defined(__cpp_exceptions)
    template <class Expr_T, class Exception_T>
    test_reporter&
    operator<< (const detail::throws_<Expr_T, Exception_T>& op);

    template <class Expr_T>
    test_reporter&
    operator<< (const detail::throws_<Expr_T, void>& op);

    template <class Expr_T>
    test_reporter&
    operator<< (const detail::nothrow_<Expr_T>& op);
#endif

    virtual void
    endline (void)
        = 0;
 
    // ------------------------------------------------------------------------

    template <class Expr_T>
    void
    pass (Expr_T& expr, std::string& message);

    template <class Expr_T>
    void
    fail (Expr_T& expr, bool abort, std::string& message,
          const reflection::source_location& location);

    virtual void
    begin_test_case (const char* name)
        = 0;

    virtual void
    end_test_case (const char* name)
        = 0;

    virtual void
    begin_test_suite (const char* name)
        = 0;

    virtual void
    end_test_suite (test_suite_base& suite)
        = 0;

    virtual void
    begin_test (size_t test_suites_count)
        = 0;

    virtual void
    end_test (test_runner& runner)
        = 0;

    virtual void
    flush (void)
        = 0;

    virtual void
    output (void)
        = 0;

    bool add_empty_line{ true };

    verbosity_t verbosity{};
 
  protected:
    virtual void
    output_pass_prefix_ (std::string& message)
        = 0;

    virtual void
    output_pass_suffix_ (void)
        = 0;

    virtual void
    output_fail_prefix_ (std::string& message, const bool hasExpression,
                         const reflection::source_location& location)
        = 0;

    virtual void
    output_fail_suffix_ (const reflection::source_location& location,
                         bool abort)
        = 0;

    colors colors_{};

    std::string out_{};

    bool is_in_test_case_ = false;
  };
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
 
// ----------------------------------------------------------------------------
 
#endif // __cplusplus
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_TEST_PLUS_TEST_REPORTER_H_
 
// ----------------------------------------------------------------------------