Catch2.hpp

Go to the documentation of this file.

//          Copyright Dominic (DNKpp) Koepke 2024 - 2025.
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          https://www.boost.org/LICENSE_1_0.txt)
 
#ifndef MIMICPP_ADAPTERS_CATCH2_HPP
#define MIMICPP_ADAPTERS_CATCH2_HPP
 
#pragma once
 
#if __has_include("mimic++/Reporting.hpp")
    #include "mimic++/Reporting.hpp"
    #include "mimic++/utilities/C++23Backports.hpp"
#elif not defined(MIMICPP_VERSION)
    #error "It appears that the test-adapter is not included in the mimic++ project or package." \
        "If you plan to use it alongside the mimic++-amalgamated header, please ensure to include the adapter-header afterwards."
#endif
 
#if __has_include(<catch2/catch_test_macros.hpp>)
    #include <catch2/catch_test_macros.hpp>
#else
    #error "Unable to find catch2 includes."
#endif
 
namespace mimicpp::reporting::detail::catch2
{
    inline void send_success(StringViewT const msg)
    {
#ifdef CATCH_CONFIG_PREFIX_ALL
        CATCH_SUCCEED(msg);
#else
        SUCCEED(msg);
#endif
    }
 
    inline void send_warning(StringViewT const msg)
    {
#ifdef CATCH_CONFIG_PREFIX_MESSAGES
        CATCH_WARN(msg);
#else
        WARN(msg);
#endif
    }
 
    [[noreturn]]
    inline void send_fail(StringViewT const msg)
    {
        /* This is a workaround because when there is a `noexcept` function somewhere in the current call-stack,
         * the error message will not be flushed to the actual output before the process termination.
         * So, we catch it here, write another message which seems to flush the current content,
         * so *mimic++* users can see the actual error-description.
         */
        CATCH_TRY
        {
#ifdef CATCH_CONFIG_PREFIX_ALL
            CATCH_FAIL(msg);
#else
            FAIL(msg);
#endif
        }
        CATCH_CATCH_ANON(Catch::TestFailureException const&)
        {
            send_warning("Fatal failure!");
            throw;
        }
    }
}
 
namespace mimicpp::reporting
{
    // GCOVR_EXCL_START

    using Catch2ReporterT = BasicReporter<
        &detail::catch2::send_success,
        &detail::catch2::send_warning,
        &detail::catch2::send_fail>;
 
    // GCOVR_EXCL_STOP
}
 
namespace mimicpp::reporting::detail::catch2
{
    [[maybe_unused]]
    inline const ReporterInstaller<Catch2ReporterT> installer{};
}
 
#ifdef MIMICPP_CONFIG_EXPERIMENTAL_CATCH2_MATCHER_INTEGRATION
 
#include <catch2/matchers/catch_matchers_templated.hpp>
 
template <typename Matcher>
    requires std::derived_from<Matcher, Catch::Matchers::MatcherGenericBase> // new style
          || std::derived_from<Matcher, Catch::Matchers::MatcherUntypedBase> // old style
struct mimicpp::custom::matcher_traits<Matcher>
{
    template <typename T>
    [[nodiscard]]
    static constexpr bool matches(const Matcher& matcher, T& value)
        requires requires { { matcher.match(value) } -> std::convertible_to<bool>; }
    {
        return matcher.match(value);
    }
};
 
#endif
 
#endif