check-result.cpp

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

 
// ----------------------------------------------------------------------------
 
#include "micro-os-plus/micro-test-plus/check-result.h"
#include "micro-os-plus/micro-test-plus/test.h"
 
#if __has_include("micro-os-plus/diag/trace.h")
#include "micro-os-plus/diag/trace.h"
#endif // __has_include("micro-os-plus/diag/trace.h")
 
#include <exception>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic ignored "-Waggregate-return"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wexit-time-destructors"
#pragma clang diagnostic ignored "-Wglobal-constructors"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================
 
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED)
 
// ----------------------------------------------------------------------------
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
  namespace detail
  {
    check_result::check_result (void) = default;

    void
    check_result::start (bool value, check_kind kind, bool has_expression,
                         const reflection::source_location& location,
                         test_case& test_case, bool writes_passed)
    {
      value_ = value;
      is_written_ = !value || writes_passed;
      info_ = failure_info{ kind, {}, has_expression, location };
      test_case_ = &test_case;
#if defined(__cpp_exceptions)
      uncaught_exceptions_ = std::uncaught_exceptions ();
#endif // defined(__cpp_exceptions)
    }

    check_result::~check_result () noexcept (false)
    {
#if defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED)
      trace::printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
 
      // A result that was not initialised, such as a default argument
      // whose function did not run, reports nothing.
      if (test_case_ == nullptr) [[unlikely]]
        {
          return;
        }
 
      // The index starts at 0; it must be incremented before the check is
      // reported, so that the first check is reported as check #1.
      test_case_->next_test_point_number ();
 
      // The text formatted by this check, even if the formatter was used by
      // other checks in the meantime (when this result was kept).
      auto& expression = test_case_->test_reporter ().expression_;
      const std::string& expression_str = expression.check_text (this);
 
      if (value_) [[likely]]
        {
          if (is_written_)
            {
              test_case_->test_reporter ().pass (info_.message, expression_str,
                                                 *test_case_);
            }
          else
            {
              test_case_->test_reporter ().pass_without_text (*test_case_);
            }
          test_case_->totals_.increment_passed_checks ();
        }
      else
        {
          test_case_->test_reporter ().fail (info_, expression_str,
                                             *test_case_);
          test_case_->totals_.increment_failed_checks ();
        }
 
      expression.end_check (this);
 
      if (info_.kind == check_kind::requirement && !value_) [[unlikely]]
        {
#if defined(__cpp_exceptions)
          if (std::uncaught_exceptions () <= uncaught_exceptions_)
            {
              throw failed_requirement{};
            }
#else
          test_case_->abort (info_.location);
#endif // defined(__cpp_exceptions)
        }
    }
  } // namespace detail
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
// ----------------------------------------------------------------------------
 
#endif // defined(MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED)
 
// ----------------------------------------------------------------------------