tests/framework/Asserts.h

/*
 * Copyright (c) 2017-2022 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ARM_COMPUTE_TEST_FRAMEWORK_ASSERTS
#define ARM_COMPUTE_TEST_FRAMEWORK_ASSERTS

#include "Exceptions.h"
#include "Framework.h"

#include <sstream>
#include <type_traits>

#include "utils/TypePrinter.h"

namespace arm_compute
{
namespace test
{
namespace framework
{
// Cast char values to int so that their numeric value are printed.
inline int make_printable(int8_t value)
{
    return value;
}

inline std::string make_printable(const arm_compute::WeightFormat wf)
{
    return arm_compute::to_string(wf);
}

inline unsigned int make_printable(uint8_t value)
{
    return value;
}

// Everything else can be printed as its own type.
template <typename T>
inline T make_printable(T &&value)
{
    return value;
}

inline void ARM_COMPUTE_PRINT_INFO()
{
    std::stringstream msg;
    arm_compute::test::framework::Framework::get().print_test_info(msg);
    arm_compute::test::framework::Framework::get().log_info(msg.str());
    arm_compute::test::framework::Framework::get().clear_test_info();
}

#define ARM_COMPUTE_TEST_INFO(INFO)                                               \
    {                                                                             \
        std::stringstream info;                                                   \
        info << INFO;                                                             \
        arm_compute::test::framework::Framework::get().add_test_info(info.str()); \
    }

namespace detail
{
#define ARM_COMPUTE_TEST_COMP_FACTORY(SEVERITY, SEVERITY_NAME, COMP, COMP_NAME, ERROR_CALL)                                            \
    template <typename T, typename U>                                                                                                  \
    void ARM_COMPUTE_##SEVERITY##_##COMP_NAME##_IMPL(T &&x, U &&y, const std::string &x_str, const std::string &y_str, LogLevel level) \
    {                                                                                                                                  \
        if(!(x COMP y))                                                                                                                \
        {                                                                                                                              \
            std::stringstream msg;                                                                                                     \
            msg << #SEVERITY_NAME " '" << x_str << " " #COMP " " << y_str << "' failed. ["                                             \
                << std::boolalpha << arm_compute::test::framework::make_printable(x)                                                   \
                << " " #COMP " "                                                                                                       \
                << std::boolalpha << arm_compute::test::framework::make_printable(y)                                                   \
                << "]\n";                                                                                                              \
            arm_compute::test::framework::Framework::get().print_test_info(msg);                                                       \
            ERROR_CALL                                                                                                                 \
        }                                                                                                                              \
        arm_compute::test::framework::Framework::get().clear_test_info();                                                              \
    }

ARM_COMPUTE_TEST_COMP_FACTORY(EXPECT, Expectation, ==, EQUAL, arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), level));)
ARM_COMPUTE_TEST_COMP_FACTORY(EXPECT, Expectation, !=, NOT_EQUAL, arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), level));)
ARM_COMPUTE_TEST_COMP_FACTORY(ASSERT, Assertion, ==, EQUAL, throw arm_compute::test::framework::TestError(msg.str(), level);)
ARM_COMPUTE_TEST_COMP_FACTORY(ASSERT, Assertion, !=, NOT_EQUAL, throw arm_compute::test::framework::TestError(msg.str(), level);)
} // namespace detail

#define ARM_COMPUTE_ASSERT_NOT_EQUAL(X, Y) \
    arm_compute::test::framework::detail::ARM_COMPUTE_ASSERT_NOT_EQUAL_IMPL(X, Y, #X, #Y, LogLevel::ERRORS)

#define ARM_COMPUTE_ASSERT_EQUAL(X, Y) \
    arm_compute::test::framework::detail::ARM_COMPUTE_ASSERT_EQUAL_IMPL(X, Y, #X, #Y, LogLevel::ERRORS)

#define ARM_COMPUTE_EXPECT_EQUAL(X, Y, LEVEL) \
    arm_compute::test::framework::detail::ARM_COMPUTE_EXPECT_EQUAL_IMPL(X, Y, #X, #Y, LEVEL)

#define ARM_COMPUTE_EXPECT_NOT_EQUAL(X, Y, LEVEL) \
    arm_compute::test::framework::detail::ARM_COMPUTE_EXPECT_NOT_EQUAL_IMPL(X, Y, #X, #Y, LEVEL)

#define ARM_COMPUTE_ASSERT(X)                                                                                         \
    do                                                                                                                \
    {                                                                                                                 \
        const auto &x = X;                                                                                            \
        if(!x)                                                                                                        \
        {                                                                                                             \
            std::stringstream msg;                                                                                    \
            msg << "Assertion '" #X "' failed.\n";                                                                    \
            arm_compute::test::framework::Framework::get().print_test_info(msg);                                      \
            throw arm_compute::test::framework::TestError(msg.str(), arm_compute::test::framework::LogLevel::ERRORS); \
        }                                                                                                             \
        arm_compute::test::framework::Framework::get().clear_test_info();                                             \
    } while(false)

#define ARM_COMPUTE_EXPECT(X, LEVEL)                                                                                                          \
    do                                                                                                                                        \
    {                                                                                                                                         \
        const auto &x = X;                                                                                                                    \
        if(!x)                                                                                                                                \
        {                                                                                                                                     \
            std::stringstream msg;                                                                                                            \
            msg << "Expectation '" #X "' failed.\n";                                                                                          \
            arm_compute::test::framework::Framework::get().print_test_info(msg);                                                              \
            arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
        }                                                                                                                                     \
        arm_compute::test::framework::Framework::get().clear_test_info();                                                                     \
    } while(false)

#define ARM_COMPUTE_EXPECT_NO_THROW(X, LEVEL)                                                                                                 \
    do                                                                                                                                        \
    {                                                                                                                                         \
        try                                                                                                                                   \
        {                                                                                                                                     \
            const auto &x = X;                                                                                                                \
            (void)x;                                                                                                                          \
        }                                                                                                                                     \
        catch(...)                                                                                                                            \
        {                                                                                                                                     \
            std::stringstream msg;                                                                                                            \
            msg << "Expectation '" #X "' to not throw failed.\n";                                                                             \
            arm_compute::test::framework::Framework::get().print_test_info(msg);                                                              \
            arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
        }                                                                                                                                     \
        arm_compute::test::framework::Framework::get().clear_test_info();                                                                     \
    } while(false)

#if defined(ARM_COMPUTE_ASSERTS_ENABLED)
#define ARM_COMPUTE_EXPECT_THROW(X, LEVEL)                                                                                                    \
    do                                                                                                                                        \
    {                                                                                                                                         \
        bool exception_caught = false;                                                                                                        \
        try                                                                                                                                   \
        {                                                                                                                                     \
            const auto &x = X;                                                                                                                \
            (void)x;                                                                                                                          \
        }                                                                                                                                     \
        catch(...)                                                                                                                            \
        {                                                                                                                                     \
            exception_caught = true;                                                                                                          \
        }                                                                                                                                     \
        if(!exception_caught)                                                                                                                 \
        {                                                                                                                                     \
            std::stringstream msg;                                                                                                            \
            msg << "Expectation '" #X "' to throw failed.\n";                                                                                 \
            arm_compute::test::framework::Framework::get().print_test_info(msg);                                                              \
            arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
        }                                                                                                                                     \
        arm_compute::test::framework::Framework::get().clear_test_info();                                                                     \
    } while(false)
#else // defined(ARM_COMPUTE_ASSERTS_ENABLED)
#define ARM_COMPUTE_EXPECT_THROW(X, LEVEL)                                   \
    do                                                                       \
    {                                                                        \
        std::stringstream msg;                                               \
        msg << "'" #X "' Skipped: asserts disabled, cannot throw\n";         \
        arm_compute::test::framework::Framework::get().print_test_info(msg); \
        arm_compute::test::framework::Framework::get().log_info(msg.str());  \
        arm_compute::test::framework::Framework::get().clear_test_info();    \
    } while(false)
#endif // defined(ARM_COMPUTE_ASSERTS_ENABLED)

#define ARM_COMPUTE_ASSERT_FAIL(MSG)                                                                              \
    do                                                                                                            \
    {                                                                                                             \
        std::stringstream msg;                                                                                    \
        msg << "Assertion '" << MSG << "' failed.\n";                                                             \
        arm_compute::test::framework::Framework::get().print_test_info(msg);                                      \
        throw arm_compute::test::framework::TestError(msg.str(), arm_compute::test::framework::LogLevel::ERRORS); \
        arm_compute::test::framework::Framework::get().clear_test_info();                                         \
    } while(false)

#define ARM_COMPUTE_EXPECT_FAIL(MSG, LEVEL)                                                                                               \
    do                                                                                                                                    \
    {                                                                                                                                     \
        std::stringstream msg;                                                                                                            \
        msg << "Expectation '" << MSG << "' failed.\n";                                                                                   \
        arm_compute::test::framework::Framework::get().print_test_info(msg);                                                              \
        arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
        arm_compute::test::framework::Framework::get().clear_test_info();                                                                 \
    } while(false)
} // namespace framework
} // namespace test
} // namespace arm_compute
#endif /* ARM_COMPUTE_TEST_FRAMEWORK_ASSERTS */