Gitiles
Code Review Sign In
review.mlplatform.org / ml / ComputeLibrary / ef5aac6c1e119e8db16a33332b5551829f409786 / . / tests / framework / Asserts.h
blob: 28d3da9a85762e15de28885249d9ca096fa01074 [file] [log] [blame]
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]1/*
Michele Di Giorgiod340eb22021-04-08 11:05:23 +0100[diff] [blame]2 * Copyright (c) 2017-2021 Arm Limited.
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]3 *
4 * SPDX-License-Identifier: MIT
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24#ifndef ARM_COMPUTE_TEST_FRAMEWORK_ASSERTS
25#define ARM_COMPUTE_TEST_FRAMEWORK_ASSERTS
26
27#include "Exceptions.h"
28#include "Framework.h"
29
30#include <sstream>
31#include <type_traits>
32
33namespace arm_compute
34{
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]35namespace test
36{
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]37namespace framework
38{
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]39// Cast char values to int so that their numeric value are printed.
40inline int make_printable(int8_t value)
41{
42 return value;
43}
44
45inline unsigned int make_printable(uint8_t value)
46{
47 return value;
48}
49
50// Everything else can be printed as its own type.
51template <typename T>
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]52inline T make_printable(T &&value)
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]53{
54 return value;
55}
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]56
steniu01172c58d2017-08-31 13:49:08 +0100[diff] [blame]57inline void ARM_COMPUTE_PRINT_INFO()
58{
59 std::stringstream msg;
60 arm_compute::test::framework::Framework::get().print_test_info(msg);
61 arm_compute::test::framework::Framework::get().log_info(msg.str());
62 arm_compute::test::framework::Framework::get().clear_test_info();
63}
64
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]65#define ARM_COMPUTE_TEST_INFO(INFO) \
66 { \
67 std::stringstream info; \
68 info << INFO; \
69 arm_compute::test::framework::Framework::get().add_test_info(info.str()); \
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]70 }
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]71
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]72namespace detail
73{
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]74#define ARM_COMPUTE_TEST_COMP_FACTORY(SEVERITY, SEVERITY_NAME, COMP, COMP_NAME, ERROR_CALL) \
75 template <typename T, typename U> \
76 void ARM_COMPUTE_##SEVERITY##_##COMP_NAME##_IMPL(T &&x, U &&y, const std::string &x_str, const std::string &y_str, LogLevel level) \
77 { \
78 if(!(x COMP y)) \
79 { \
80 std::stringstream msg; \
81 msg << #SEVERITY_NAME " '" << x_str << " " #COMP " " << y_str << "' failed. [" \
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]82 << std::boolalpha << arm_compute::test::framework::make_printable(x) \
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]83 << " " #COMP " " \
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]84 << std::boolalpha << arm_compute::test::framework::make_printable(y) \
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]85 << "]\n"; \
86 arm_compute::test::framework::Framework::get().print_test_info(msg); \
87 ERROR_CALL \
88 } \
89 arm_compute::test::framework::Framework::get().clear_test_info(); \
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]90 }
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]91
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]92ARM_COMPUTE_TEST_COMP_FACTORY(EXPECT, Expectation, ==, EQUAL, arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), level));)
93ARM_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));)
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]94ARM_COMPUTE_TEST_COMP_FACTORY(ASSERT, Assertion, ==, EQUAL, throw arm_compute::test::framework::TestError(msg.str(), level);)
95ARM_COMPUTE_TEST_COMP_FACTORY(ASSERT, Assertion, !=, NOT_EQUAL, throw arm_compute::test::framework::TestError(msg.str(), level);)
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]96} // namespace detail
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]97
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]98#define ARM_COMPUTE_ASSERT_NOT_EQUAL(X, Y) \
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]99 arm_compute::test::framework::detail::ARM_COMPUTE_ASSERT_NOT_EQUAL_IMPL(X, Y, #X, #Y, LogLevel::ERRORS)
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]100
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]101#define ARM_COMPUTE_ASSERT_EQUAL(X, Y) \
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]102 arm_compute::test::framework::detail::ARM_COMPUTE_ASSERT_EQUAL_IMPL(X, Y, #X, #Y, LogLevel::ERRORS)
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]103
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]104#define ARM_COMPUTE_EXPECT_EQUAL(X, Y, LEVEL) \
105 arm_compute::test::framework::detail::ARM_COMPUTE_EXPECT_EQUAL_IMPL(X, Y, #X, #Y, LEVEL)
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]106
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]107#define ARM_COMPUTE_EXPECT_NOT_EQUAL(X, Y, LEVEL) \
108 arm_compute::test::framework::detail::ARM_COMPUTE_EXPECT_NOT_EQUAL_IMPL(X, Y, #X, #Y, LEVEL)
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]109
Moritz Pflanzer2ac50402017-07-24 15:52:54 +0100[diff] [blame]110#define ARM_COMPUTE_ASSERT(X) \
111 do \
112 { \
113 const auto &x = X; \
114 if(!x) \
115 { \
116 std::stringstream msg; \
117 msg << "Assertion '" #X "' failed.\n"; \
118 arm_compute::test::framework::Framework::get().print_test_info(msg); \
119 throw arm_compute::test::framework::TestError(msg.str(), arm_compute::test::framework::LogLevel::ERRORS); \
120 } \
121 arm_compute::test::framework::Framework::get().clear_test_info(); \
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]122 } while(false)
123
Moritz Pflanzer24a82462017-08-04 11:34:44 +0100[diff] [blame]124#define ARM_COMPUTE_EXPECT(X, LEVEL) \
125 do \
126 { \
127 const auto &x = X; \
128 if(!x) \
129 { \
130 std::stringstream msg; \
131 msg << "Expectation '" #X "' failed.\n"; \
132 arm_compute::test::framework::Framework::get().print_test_info(msg); \
133 arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
134 } \
135 arm_compute::test::framework::Framework::get().clear_test_info(); \
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]136 } while(false)
steniu01172c58d2017-08-31 13:49:08 +0100[diff] [blame]137
Georgios Pinitas0b5af9f2020-06-19 23:22:08 +0100[diff] [blame]138#define ARM_COMPUTE_EXPECT_NO_THROW(X, LEVEL) \
139 do \
140 { \
141 try \
142 { \
143 const auto &x = X; \
144 (void)x; \
145 } \
146 catch(...) \
147 { \
148 std::stringstream msg; \
149 msg << "Expectation '" #X "' to not throw failed.\n"; \
150 arm_compute::test::framework::Framework::get().print_test_info(msg); \
151 arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
152 } \
153 arm_compute::test::framework::Framework::get().clear_test_info(); \
154 } while(false)
155
Michele Di Giorgiod340eb22021-04-08 11:05:23 +0100[diff] [blame]156#if defined(ARM_COMPUTE_ASSERTS_ENABLED)
Georgios Pinitas0b5af9f2020-06-19 23:22:08 +0100[diff] [blame]157#define ARM_COMPUTE_EXPECT_THROW(X, LEVEL) \
158 do \
159 { \
160 bool exception_caught = false; \
161 try \
162 { \
163 const auto &x = X; \
164 (void)x; \
165 } \
166 catch(...) \
167 { \
168 exception_caught = true; \
169 } \
170 if(!exception_caught) \
171 { \
172 std::stringstream msg; \
173 msg << "Expectation '" #X "' to throw failed.\n"; \
174 arm_compute::test::framework::Framework::get().print_test_info(msg); \
175 arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
176 } \
177 arm_compute::test::framework::Framework::get().clear_test_info(); \
178 } while(false)
Michele Di Giorgiod340eb22021-04-08 11:05:23 +0100[diff] [blame]179#else // defined(ARM_COMPUTE_ASSERTS_ENABLED)
180#define ARM_COMPUTE_EXPECT_THROW(X, LEVEL) \
181 do \
182 { \
183 std::stringstream msg; \
184 msg << "'" #X "' Skipped: asserts disabled, cannot throw\n"; \
185 arm_compute::test::framework::Framework::get().print_test_info(msg); \
186 arm_compute::test::framework::Framework::get().log_info(msg.str()); \
187 arm_compute::test::framework::Framework::get().clear_test_info(); \
188 } while(false)
189#endif // defined(ARM_COMPUTE_ASSERTS_ENABLED)
Georgios Pinitas0b5af9f2020-06-19 23:22:08 +0100[diff] [blame]190
Moritz Pflanzer6c6597c2017-09-24 12:09:41 +0100[diff] [blame]191#define ARM_COMPUTE_ASSERT_FAIL(MSG) \
192 do \
193 { \
194 std::stringstream msg; \
195 msg << "Assertion '" << MSG << "' failed.\n"; \
196 arm_compute::test::framework::Framework::get().print_test_info(msg); \
197 throw arm_compute::test::framework::TestError(msg.str(), arm_compute::test::framework::LogLevel::ERRORS); \
198 arm_compute::test::framework::Framework::get().clear_test_info(); \
199 } while(false)
200
201#define ARM_COMPUTE_EXPECT_FAIL(MSG, LEVEL) \
202 do \
203 { \
204 std::stringstream msg; \
205 msg << "Expectation '" << MSG << "' failed.\n"; \
206 arm_compute::test::framework::Framework::get().print_test_info(msg); \
207 arm_compute::test::framework::Framework::get().log_failed_expectation(arm_compute::test::framework::TestError(msg.str(), LEVEL)); \
208 arm_compute::test::framework::Framework::get().clear_test_info(); \
209 } while(false)
Moritz Pflanzerc7d15032017-07-18 16:21:16 +0100[diff] [blame]210} // namespace framework
211} // namespace test
212} // namespace arm_compute
Moritz Pflanzerb7c2a992017-07-18 14:37:35 +0100[diff] [blame]213#endif /* ARM_COMPUTE_TEST_FRAMEWORK_ASSERTS */