micro-test-plus.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_MICRO_TEST_PLUS_H_
#define MICRO_TEST_PLUS_MICRO_TEST_PLUS_H_
 
// ----------------------------------------------------------------------------
 
#ifdef __cplusplus
 
// ----------------------------------------------------------------------------
 
#if defined(MICRO_OS_PLUS_INCLUDE_CONFIG_H)
#include <micro-os-plus/config.h>
#endif // MICRO_OS_PLUS_INCLUDE_CONFIG_H
 
#include "micro-test-plus/type-traits.h"
#include "micro-test-plus/reflection.h"
 
#include "micro-test-plus/detail.h"
 
#include "micro-test-plus/math.h"
#include "micro-test-plus/literals.h"
#include "micro-test-plus/function-comparators.h"
#include "micro-test-plus/operators.h"
 
#include "micro-test-plus/test-suite.h"
#include "micro-test-plus/test-runner.h"
#include "micro-test-plus/test-reporter.h"
#include "micro-test-plus/test-reporter-basic.h"
#include "micro-test-plus/test-reporter-tap.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"
#pragma clang diagnostic ignored "-Wctad-maybe-unsupported"
#endif
#endif

namespace micro_os_plus::micro_test_plus
{
  // --------------------------------------------------------------------------
 
  extern test_runner runner;
  extern test_reporter* reporter;
  extern test_suite_base* current_test_suite;
 
  // --------------------------------------------------------------------------
  // Public API.

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

  [[nodiscard]] int
  exit_code (void);

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

  template <class Expr_T, type_traits::requires_t<
                              type_traits::is_op_v<Expr_T>
                              or type_traits::is_convertible_v<Expr_T, bool>>
                          = 0>
  constexpr auto
  expect (const Expr_T& expr, const reflection::source_location& sl
                              = reflection::source_location::current ());

  template <class Expr_T, type_traits::requires_t<
                              type_traits::is_op_v<Expr_T>
                              or type_traits::is_convertible_v<Expr_T, bool>>
                          = 0>
  constexpr auto
  assume (const Expr_T& expr, const reflection::source_location& sl
                              = reflection::source_location::current ());
 
  // --------------------------------------------------------------------------
 
#if defined(__cpp_exceptions)

  template <class Exception_T, class Callable_T>
  [[nodiscard]] constexpr auto
  throws (const Callable_T& func);

  template <class Callable_T>
  [[nodiscard]] constexpr auto
  throws (const Callable_T& func);

  template <class Callable_T>
  [[nodiscard]] constexpr auto
  nothrow (const Callable_T& func);
 
#endif
 
  // --------------------------------------------------------------------------

  namespace utility
  {
    [[nodiscard]] bool
    is_match (std::string_view input, std::string_view pattern);

    template <class T, class Delim_T>
    [[nodiscard]] auto
    split (T input, Delim_T delim) -> std::vector<T>;
 
    // ------------------------------------------------------------------------
  } // namespace utility
 
  // --------------------------------------------------------------------------
} // namespace micro_os_plus::micro_test_plus
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
 
// ----------------------------------------------------------------------------
 
#endif // __cplusplus
 
// ===== Inlines & templates implementations
// ====================================
 
// All inlines are included **after** all declarations.
#include "micro-test-plus/inlines/details-inlines.h"
#include "micro-test-plus/inlines/literals-inlines.h"
#include "micro-test-plus/inlines/math-inlines.h"
 
#include "micro-test-plus/inlines/reflection-inlines.h"
#include "micro-test-plus/inlines/test-reporter-inlines.h"
 
#include "micro-test-plus/inlines/function-comparators-inlines.h"
#include "micro-test-plus/inlines/test-suite-inlines.h"
 
#include "micro-test-plus/inlines/micro-test-plus-inlines.h"
 
// ----------------------------------------------------------------------------
 
#endif // MICRO_TEST_PLUS_MICRO_TEST_PLUS_H_
 
// ----------------------------------------------------------------------------