test-runner.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_RUNNER_H_
#define MICRO_TEST_PLUS_TEST_RUNNER_H_
 
// ----------------------------------------------------------------------------
 
#ifdef __cplusplus
 
// ----------------------------------------------------------------------------
 
#include <functional>
 
#include <time.h>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
#endif
 
namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  // Forward definition.
  class test_suite_base;
 
  // --------------------------------------------------------------------------

  class test_runner
  {
  public:
    test_runner ();

    test_runner (const test_runner&) = delete;

    test_runner (test_runner&&) = delete;

    test_runner&
    operator= (const test_runner&)
        = delete;

    test_runner&
    operator= (test_runner&&)
        = delete;

    ~test_runner () = default;

    void
    initialize (int argc, char* argv[], const char* name);

    int
    exit_code (void);

    void
    register_test_suite (test_suite_base* suite);
 
    size_t
    test_suites_count (void)
    {
      return (test_suites != nullptr) ? test_suites->size () + 1 : 1;
    }

    constexpr const char*
    name (void)
    {
      return default_suite_name_;
    }

    [[noreturn]] void
    abort (void);
 
    // ------------------------------------------------------------------------
  public:
    std::vector<test_suite_base*>* test_suites; // DO NOT INITIALISE!
 
    struct
    {
      size_t successful_checks = 0;

      size_t failed_checks = 0;

      size_t test_cases_count = 0;
    } totals;
 
#if defined(_WIN32) || defined(CLOCK_MONOTONIC)
    timespec begin_time{};

    timespec end_time{};
#endif

    test_suite_base* default_test_suite = nullptr;
 
  protected:
    int argc_ = 0;

    char** argv_ = nullptr;

    const char* default_suite_name_ = "Test";
  };
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
 
// ----------------------------------------------------------------------------
 
#endif // __cplusplus
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_TEST_PLUS_TEST_RUNNER_H_
 
// ----------------------------------------------------------------------------