blob: 591b80e9d8051b14001ce643ff2e0b09b2c6c4bc [file] [log] [blame]
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +01001/*
Gian Marco Iodicebf9731e2018-12-12 10:18:04 +00002 * Copyright (c) 2017-2018 ARM Limited.
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +01003 *
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_MACROS
25#define ARM_COMPUTE_TEST_FRAMEWORK_MACROS
26
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +010027#include "Framework.h"
28#include "Registrars.h"
29#include "TestCase.h"
30
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +010031//
32// TEST SUITE MACROS
33//
34#define TEST_SUITE(SUITE_NAME) \
35 namespace SUITE_NAME##Suite \
36 { \
37 static arm_compute::test::framework::detail::TestSuiteRegistrar SUITE_NAME##Suite_reg{ #SUITE_NAME };
38
39#define TEST_SUITE_END() \
40 static arm_compute::test::framework::detail::TestSuiteRegistrar Suite_end; \
41 }
42//
43// TEST SUITE MACROS END
44//
45
46//
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +010047// HELPER MACROS
48//
49
50#define CONCAT(ARG0, ARG1) ARG0##ARG1
51
Gian Marco Iodicebf9731e2018-12-12 10:18:04 +000052#define VARIADIC_SIZE_IMPL(e0, e1, e2, e3, e4, e5, e6, e7, e8, e9, e10, size, ...) size
53#define VARIADIC_SIZE(...) VARIADIC_SIZE_IMPL(__VA_ARGS__, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +010054
55#define JOIN_PARAM1(OP, param) OP(0, param)
56#define JOIN_PARAM2(OP, param, ...) \
57 OP(1, param) \
58 , JOIN_PARAM1(OP, __VA_ARGS__)
59#define JOIN_PARAM3(OP, param, ...) \
60 OP(2, param) \
61 , JOIN_PARAM2(OP, __VA_ARGS__)
62#define JOIN_PARAM4(OP, param, ...) \
63 OP(3, param) \
64 , JOIN_PARAM3(OP, __VA_ARGS__)
65#define JOIN_PARAM5(OP, param, ...) \
66 OP(4, param) \
67 , JOIN_PARAM4(OP, __VA_ARGS__)
68#define JOIN_PARAM6(OP, param, ...) \
69 OP(5, param) \
70 , JOIN_PARAM5(OP, __VA_ARGS__)
71#define JOIN_PARAM7(OP, param, ...) \
72 OP(6, param) \
73 , JOIN_PARAM6(OP, __VA_ARGS__)
74#define JOIN_PARAM8(OP, param, ...) \
75 OP(7, param) \
76 , JOIN_PARAM7(OP, __VA_ARGS__)
77#define JOIN_PARAM9(OP, param, ...) \
78 OP(8, param) \
79 , JOIN_PARAM8(OP, __VA_ARGS__)
80#define JOIN_PARAM10(OP, param, ...) \
81 OP(9, param) \
82 , JOIN_PARAM9(OP, __VA_ARGS__)
Gian Marco Iodicebf9731e2018-12-12 10:18:04 +000083#define JOIN_PARAM11(OP, param, ...) \
84 OP(10, param) \
85 , JOIN_PARAM10(OP, __VA_ARGS__)
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +010086#define JOIN_PARAM(OP, NUM, ...) \
87 CONCAT(JOIN_PARAM, NUM) \
88 (OP, __VA_ARGS__)
89
90#define MAKE_TYPE_PARAM(i, name) typename T##i
91#define MAKE_ARG_PARAM(i, name) const T##i &name
92#define MAKE_TYPE_PARAMS(...) JOIN_PARAM(MAKE_TYPE_PARAM, VARIADIC_SIZE(__VA_ARGS__), __VA_ARGS__)
93#define MAKE_ARG_PARAMS(...) JOIN_PARAM(MAKE_ARG_PARAM, VARIADIC_SIZE(__VA_ARGS__), __VA_ARGS__)
94
95//
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +010096// TEST CASE MACROS
97//
98#define TEST_CASE_CONSTRUCTOR(TEST_NAME) \
99 TEST_NAME() = default;
100#define DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET) \
101 template <typename D> \
102 explicit TEST_NAME(D &&data) : DataTestCase{ std::forward<D>(data) } \
103 { \
104 }
105#define FIXTURE_SETUP(FIXTURE) \
106 void do_setup() override \
107 { \
108 FIXTURE::setup(); \
109 }
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100110#define FIXTURE_DATA_SETUP(FIXTURE) \
111 void do_setup() override \
112 { \
113 apply(this, &FIXTURE::setup<As...>, _data); \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100114 }
115#define FIXTURE_RUN(FIXTURE) \
116 void do_run() override \
117 { \
118 FIXTURE::run(); \
119 }
Joel Liang1c5ffd62017-12-28 10:09:51 +0800120#define FIXTURE_SYNC(FIXTURE) \
121 void do_sync() override \
122 { \
123 FIXTURE::sync(); \
124 }
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100125#define FIXTURE_TEARDOWN(FIXTURE) \
126 void do_teardown() override \
127 { \
128 FIXTURE::teardown(); \
129 }
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100130#define TEST_REGISTRAR(TEST_NAME, MODE, STATUS) \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100131 static arm_compute::test::framework::detail::TestCaseRegistrar<TEST_NAME> TEST_NAME##_reg \
132 { \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100133 #TEST_NAME, MODE, STATUS \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100134 }
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100135#define DATA_TEST_REGISTRAR(TEST_NAME, MODE, STATUS, DATASET) \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100136 static arm_compute::test::framework::detail::TestCaseRegistrar<TEST_NAME<decltype(DATASET)::type>> TEST_NAME##_reg \
137 { \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100138 #TEST_NAME, MODE, STATUS, DATASET \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100139 }
140
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100141#define TEST_CASE_IMPL(TEST_NAME, MODE, STATUS) \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100142 class TEST_NAME : public arm_compute::test::framework::TestCase \
143 { \
144 public: \
145 TEST_CASE_CONSTRUCTOR(TEST_NAME) \
146 void do_run() override; \
147 }; \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100148 TEST_REGISTRAR(TEST_NAME, MODE, STATUS); \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100149 void TEST_NAME::do_run()
150
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100151#define TEST_CASE(TEST_NAME, MODE) \
152 TEST_CASE_IMPL(TEST_NAME, MODE, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE)
153#define EXPECTED_FAILURE_TEST_CASE(TEST_NAME, MODE) \
154 TEST_CASE_IMPL(TEST_NAME, MODE, arm_compute::test::framework::TestCaseFactory::Status::EXPECTED_FAILURE)
155#define DISABLED_TEST_CASE(TEST_NAME, MODE) \
156 TEST_CASE_IMPL(TEST_NAME, MODE, arm_compute::test::framework::TestCaseFactory::Status::DISABLED)
157
158#define DATA_TEST_CASE_IMPL(TEST_NAME, MODE, STATUS, DATASET, ...) \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100159 template <typename T> \
160 class TEST_NAME; \
161 template <typename... As> \
162 class TEST_NAME<std::tuple<As...>> : public arm_compute::test::framework::DataTestCase<decltype(DATASET)::type> \
163 { \
164 public: \
165 DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET) \
166 void do_run() override \
167 { \
168 arm_compute::test::framework::apply(this, &TEST_NAME::run<As...>, _data); \
169 } \
170 template <MAKE_TYPE_PARAMS(__VA_ARGS__)> \
171 void run(MAKE_ARG_PARAMS(__VA_ARGS__)); \
172 }; \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100173 DATA_TEST_REGISTRAR(TEST_NAME, MODE, STATUS, DATASET); \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100174 template <typename... As> \
175 template <MAKE_TYPE_PARAMS(__VA_ARGS__)> \
176 void TEST_NAME<std::tuple<As...>>::run(MAKE_ARG_PARAMS(__VA_ARGS__))
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100177
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100178#define DATA_TEST_CASE(TEST_NAME, MODE, DATASET, ...) \
179 DATA_TEST_CASE_IMPL(TEST_NAME, MODE, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE, DATASET, __VA_ARGS__)
180#define EXPECTED_FAILURE_DATA_TEST_CASE(TEST_NAME, MODE, DATASET, ...) \
181 DATA_TEST_CASE_IMPL(TEST_NAME, MODE, arm_compute::test::framework::TestCaseFactory::Status::EXPECTED_FAILURE, DATASET, __VA_ARGS__)
182#define DISABLED_DATA_TEST_CASE(TEST_NAME, MODE, DATASET, ...) \
183 DATA_TEST_CASE_IMPL(TEST_NAME, MODE, arm_compute::test::framework::TestCaseFactory::Status::DISABLED, DATASET, __VA_ARGS__)
184
185#define FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, STATUS) \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100186 class TEST_NAME : public arm_compute::test::framework::TestCase, public FIXTURE \
187 { \
188 public: \
189 TEST_CASE_CONSTRUCTOR(TEST_NAME) \
190 FIXTURE_SETUP(FIXTURE) \
191 void do_run() override; \
192 FIXTURE_TEARDOWN(FIXTURE) \
193 }; \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100194 TEST_REGISTRAR(TEST_NAME, MODE, STATUS); \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100195 void TEST_NAME::do_run()
196
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100197#define FIXTURE_TEST_CASE(TEST_NAME, FIXTURE, MODE) \
198 FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE)
199#define EXPECTED_FAILURE_FIXTURE_TEST_CASE(TEST_NAME, FIXTURE, MODE) \
200 FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::EXPECTED_FAILURE)
201#define DISABLED_FIXTURE_TEST_CASE(TEST_NAME, FIXTURE, MODE) \
202 FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::DISABLED)
203
204#define FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, STATUS, DATASET) \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100205 template <typename T> \
206 class TEST_NAME; \
207 template <typename... As> \
208 class TEST_NAME<std::tuple<As...>> : public arm_compute::test::framework::DataTestCase<decltype(DATASET)::type>, public FIXTURE \
209 { \
210 public: \
211 DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET) \
212 FIXTURE_DATA_SETUP(FIXTURE) \
213 void do_run() override; \
214 FIXTURE_TEARDOWN(FIXTURE) \
215 }; \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100216 DATA_TEST_REGISTRAR(TEST_NAME, MODE, STATUS, DATASET); \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100217 template <typename... As> \
218 void TEST_NAME<std::tuple<As...>>::do_run()
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100219
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100220#define FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, MODE, DATASET) \
221 FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE, DATASET)
222#define EXPECTED_FAILURE_FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, MODE, DATASET) \
223 FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::EXPECTED_FAILURE, DATASET)
224#define DISABLED_FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, MODE, DATASET) \
225 FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::DISABLED, DATASET)
226
227#define REGISTER_FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, STATUS) \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100228 class TEST_NAME : public arm_compute::test::framework::TestCase, public FIXTURE \
229 { \
230 public: \
231 TEST_CASE_CONSTRUCTOR(TEST_NAME) \
232 FIXTURE_SETUP(FIXTURE) \
233 FIXTURE_RUN(FIXTURE) \
Joel Liang1c5ffd62017-12-28 10:09:51 +0800234 FIXTURE_SYNC(FIXTURE) \
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100235 FIXTURE_TEARDOWN(FIXTURE) \
236 }; \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100237 TEST_REGISTRAR(TEST_NAME, MODE, STATUS)
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100238
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100239#define REGISTER_FIXTURE_TEST_CASE(TEST_NAME, FIXTURE, MODE) \
240 REGISTER_FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE)
241#define EXPECTED_FAILURE_REGISTER_FIXTURE_TEST_CASE(TEST_NAME, FIXTURE, MODE) \
242 REGISTER_FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::EXPECTED_FAILURE)
243#define DISABLED_REGISTER_FIXTURE_TEST_CASE(TEST_NAME, FIXTURE, MODE) \
244 REGISTER_FIXTURE_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::DISABLED)
245
246#define REGISTER_FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, STATUS, DATASET) \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100247 template <typename T> \
248 class TEST_NAME; \
249 template <typename... As> \
250 class TEST_NAME<std::tuple<As...>> : public arm_compute::test::framework::DataTestCase<decltype(DATASET)::type>, public FIXTURE \
251 { \
252 public: \
253 DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET) \
254 FIXTURE_DATA_SETUP(FIXTURE) \
255 FIXTURE_RUN(FIXTURE) \
Joel Liang1c5ffd62017-12-28 10:09:51 +0800256 FIXTURE_SYNC(FIXTURE) \
Moritz Pflanzerb6c8d242017-07-18 13:42:54 +0100257 FIXTURE_TEARDOWN(FIXTURE) \
258 }; \
Moritz Pflanzerbf234e02017-07-24 15:04:14 +0100259 DATA_TEST_REGISTRAR(TEST_NAME, MODE, STATUS, DATASET)
260
261#define REGISTER_FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, MODE, DATASET) \
262 REGISTER_FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE, DATASET)
263#define EXPECTED_FAILURE_REGISTER_FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, MODE, DATASET) \
264 REGISTER_FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::EXPECTED_FAILURE, DATASET)
265#define DISABLED_REGISTER_FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, MODE, DATASET) \
266 REGISTER_FIXTURE_DATA_TEST_CASE_IMPL(TEST_NAME, FIXTURE, MODE, arm_compute::test::framework::TestCaseFactory::Status::DISABLED, DATASET)
Moritz Pflanzerfc95ed22017-07-05 11:07:07 +0100267//
268// TEST CASE MACROS END
269//
Gian Marco Iodicebf9731e2018-12-12 10:18:04 +0000270#endif /* ARM_COMPUTE_TEST_FRAMEWORK_MACROS */