test-suite.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.
 *
 * 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_OS_PLUS_TRACE_MICRO_TEST_PLUS)
    printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
 
    name_ = name;
    // The default test suite needs no registration.
  }

  test_suite_base::~test_suite_base ()
  {
  }

  void
  test_suite_base::run ()
  {
#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
    printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
  }

  void
  test_suite_base::begin_test_suite (void)
  {
#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
#if defined(_WIN32)
    timespec_get (&begin_time, TIME_UTC);
#else
    clock_gettime (CLOCK_MONOTONIC, &begin_time);
#endif
#endif
 
    process_deferred_begin = false;
 
    reporter->begin_test_suite (name_);
  }

  void
  test_suite_base::end_test_suite (void)
  {
    if (process_deferred_begin)
      {
        reporter->begin_test (runner.test_suites_count ());
 
        begin_test_suite ();
      }
 
#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_suite (*this);
  }

  void
  test_suite_base::begin_test_case (const char* name)
  {
    if (process_deferred_begin)
      {
        reporter->begin_test (runner.test_suites_count ());
 
        begin_test_suite ();
      }
 
    test_case_name_ = name;
    ++test_cases_count_;
 
    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;
  }
 
#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wshadow"
  void
  test_suite_base::compute_elapsed_time (timespec& begin_time,
                                         timespec& end_time,
                                         long& milliseconds,
                                         long& microseconds)
  {
    long long delta_ns = end_time.tv_nsec - begin_time.tv_nsec;
    long long delta_s = end_time.tv_sec - begin_time.tv_sec;
    if (delta_ns < 0)
      {
        delta_ns += 1000000000LL;
        --delta_s;
      }
 
    // Split into milliseconds and microseconds.
    const long long total_us = delta_s * 1000000LL + delta_ns / 1000LL;
    milliseconds = static_cast<long> (total_us / 1000LL);
    microseconds = static_cast<long> (total_us % 1000LL);
  }
#pragma GCC diagnostic pop
 
#endif
 
  // ==========================================================================

  void
  test_suite::run (void)
  {
    // Run the test suite function prepared with std::bin();
    callable_ ();
  }

  test_suite::~test_suite ()
  {
#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)
    printf ("%s\n", __PRETTY_FUNCTION__);
#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS
  }
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
// ----------------------------------------------------------------------------