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_OS_PLUS_MICRO_TEST_PLUS_TEST_RUNNER_H_
#define MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_RUNNER_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if __has_include("micro-os-plus/project-config.h")
#include "micro-os-plus/project-config.h"
#endif // __has_include("micro-os-plus/project-config.h")
 
#if __has_include("micro-os-plus/micro-test-plus-defines.h")
#include "micro-os-plus/micro-test-plus-defines.h"
#endif // __has_include("micro-os-plus/micro-test-plus-defines.h")
 
#include "timings.h"
#include "test.h"
#include "reflection.h"
 
#include <functional>
#include <memory>
#include <string>
 
// ----------------------------------------------------------------------------
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Wpadded"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#else // GCC only
#pragma GCC diagnostic ignored "-Wsuggest-final-types"
#pragma GCC diagnostic ignored "-Wsuggest-final-methods"
#pragma GCC diagnostic ignored "-Wredundant-tags"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
// ============================================================================

namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  class suite;
  class top_suite;
  class reporter;
 
  // ==========================================================================

  class runner : public detail::test_node
  {
  public:
    runner (void);

    runner (const char* top_suite_name);

    runner (const runner&) = delete;

    runner (runner&&) = delete;

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

    runner&
    operator= (runner&&)
        = delete;

    virtual ~runner () override;

    class suite&
    initialise (int argc, char* argv[], const char* top_suite_name = "");

    int
    exit_code (void);

    template <typename Callable_T, typename... Args_T>
    void
    suite (const char* name, Callable_T&& callable, Args_T&&... arguments);
 
    // ------------------------------------------------------------------------

    [[noreturn]] void
    abort (const reflection::source_location& sl
           = reflection::source_location::current ());
 
    // ------------------------------------------------------------------------
    // Getters.

    [[nodiscard]] virtual size_t
    total_suites_count (void) const noexcept;

    [[nodiscard]] class reporter&
    reporter (void) const noexcept;

    [[nodiscard]] detail::timestamps&
    timings () noexcept;

    [[nodiscard]] const detail::timestamps&
    timings () const noexcept;

    [[nodiscard]] size_t
    suites_count (void) const noexcept;
 
  protected:
    virtual void
    run_suites_ (void);

    void
    register_suite_ (std::unique_ptr<class suite> suite);
 
    // ------------------------------------------------------------------------
  protected:
    class top_suite top_suite_;

    std::vector<std::unique_ptr<class suite>> children_suites_;

    std::unique_ptr<class reporter> reporter_;

    detail::timestamps timings_;

    std::string top_suite_name_;
  };
 
  // ==========================================================================

  class static_runner final : public runner
  {
  public:
    static_runner (void);

    static_runner (const char* top_suite_name);

    static_runner (const static_runner&) = delete;

    static_runner (static_runner&&) = delete;

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

    static_runner&
    operator= (static_runner&&)
        = delete;

    virtual ~static_runner () override;
 
    // ------------------------------------------------------------------------

    static void
    register_static_suite (static_runner& runner, static_suite& suite);

    [[nodiscard]] size_t
    static_suites_count (void) const noexcept;

    [[nodiscard]] virtual size_t
    total_suites_count (void) const noexcept final override;
 
  protected:
    void
    run_suites_ (void) override;
 
  protected:
    std::vector<static_suite*>* static_children_suites_;
  };
 
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
 
// ----------------------------------------------------------------------------
 
#endif // defined(__cplusplus)
 
// ============================================================================
// Templates, inlines & constexpr implementations.
 
#include "inlines/runner-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_OS_PLUS_MICRO_TEST_PLUS_TEST_RUNNER_H_
 
// ----------------------------------------------------------------------------