framework/Macros.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

/*
 * Copyright (c) 2017 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_MACROS
#define ARM_COMPUTE_TEST_FRAMEWORK_MACROS

#include "Exceptions.h"
#include "Framework.h"
#include "Registrars.h"
#include "TestCase.h"

#include <sstream>

//
// TEST SUITE MACROS
//
#define TEST_SUITE(SUITE_NAME)  \
    namespace SUITE_NAME##Suite \
    {                           \
    static arm_compute::test::framework::detail::TestSuiteRegistrar SUITE_NAME##Suite_reg{ #SUITE_NAME };

#define TEST_SUITE_END()                                                       \
    static arm_compute::test::framework::detail::TestSuiteRegistrar Suite_end; \
    }
//
// TEST SUITE MACROS END
//

//
// TEST CASE MACROS
//
#define TEST_CASE_CONSTRUCTOR(TEST_NAME) \
    TEST_NAME() = default;
#define DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET)                   \
    template <typename D>                                                \
    explicit TEST_NAME(D &&data) : DataTestCase{ std::forward<D>(data) } \
    {                                                                    \
    }
#define FIXTURE_SETUP(FIXTURE) \
    void do_setup() override   \
    {                          \
        FIXTURE::setup();      \
    }
#define FIXTURE_DATA_SETUP(FIXTURE)          \
    void do_setup() override                 \
    {                                        \
        apply(this, &FIXTURE::setup, _data); \
    }
#define FIXTURE_RUN(FIXTURE) \
    void do_run() override   \
    {                        \
        FIXTURE::run();      \
    }
#define FIXTURE_TEARDOWN(FIXTURE) \
    void do_teardown() override   \
    {                             \
        FIXTURE::teardown();      \
    }
#define TEST_REGISTRAR(TEST_NAME)                                                             \
    static arm_compute::test::framework::detail::TestCaseRegistrar<TEST_NAME> TEST_NAME##_reg \
    {                                                                                         \
        #TEST_NAME                                                                            \
    }
#define DATA_TEST_REGISTRAR(TEST_NAME, DATASET)                                               \
    static arm_compute::test::framework::detail::TestCaseRegistrar<TEST_NAME> TEST_NAME##_reg \
    {                                                                                         \
        #TEST_NAME, DATASET                                                                   \
    }

#define TEST_CASE(TEST_NAME)                                        \
    class TEST_NAME : public arm_compute::test::framework::TestCase \
    {                                                               \
    public:                                                     \
        TEST_CASE_CONSTRUCTOR(TEST_NAME)                            \
        void do_run() override;                                     \
    };                                                              \
    TEST_REGISTRAR(TEST_NAME);                                      \
    void TEST_NAME::do_run()

#define DATA_TEST_CASE(TEST_NAME, DATASET, ...)                                                  \
    class TEST_NAME : public arm_compute::test::framework::DataTestCase<decltype(DATASET)::type> \
    {                                                                                            \
    public:                                                                                  \
        DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET)                                           \
        void do_run() override                                                                   \
        {                                                                                        \
            arm_compute::test::framework::apply(this, &TEST_NAME::run, _data);                   \
        }                                                                                        \
        void run(__VA_ARGS__);                                                                   \
    };                                                                                           \
    DATA_TEST_REGISTRAR(TEST_NAME, DATASET);                                                     \
    void TEST_NAME::run(__VA_ARGS__)

#define FIXTURE_TEST_CASE(TEST_NAME, FIXTURE)                                       \
    class TEST_NAME : public arm_compute::test::framework::TestCase, public FIXTURE \
    {                                                                               \
    public:                                                                     \
        TEST_CASE_CONSTRUCTOR(TEST_NAME)                                            \
        FIXTURE_SETUP(FIXTURE)                                                      \
        void do_run() override;                                                     \
        FIXTURE_TEARDOWN(FIXTURE)                                                   \
    };                                                                              \
    TEST_REGISTRAR(TEST_NAME);                                                      \
    void TEST_NAME::do_run()

#define FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, DATASET)                                                      \
    class TEST_NAME : public arm_compute::test::framework::DataTestCase<decltype(DATASET)::type>, public FIXTURE \
    {                                                                                                            \
    public:                                                                                                  \
        DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET)                                                           \
        FIXTURE_DATA_SETUP(FIXTURE)                                                                              \
        void do_run() override;                                                                                  \
        FIXTURE_TEARDOWN(FIXTURE)                                                                                \
    };                                                                                                           \
    DATA_TEST_REGISTRAR(TEST_NAME, DATASET);                                                                     \
    void TEST_NAME::do_run()

#define REGISTER_FIXTURE_TEST_CASE(TEST_NAME, FIXTURE)                              \
    class TEST_NAME : public arm_compute::test::framework::TestCase, public FIXTURE \
    {                                                                               \
    public:                                                                     \
        TEST_CASE_CONSTRUCTOR(TEST_NAME)                                            \
        FIXTURE_SETUP(FIXTURE)                                                      \
        FIXTURE_RUN(FIXTURE)                                                        \
        FIXTURE_TEARDOWN(FIXTURE)                                                   \
    };                                                                              \
    TEST_REGISTRAR(TEST_NAME)

#define REGISTER_FIXTURE_DATA_TEST_CASE(TEST_NAME, FIXTURE, DATASET)                                             \
    class TEST_NAME : public arm_compute::test::framework::DataTestCase<decltype(DATASET)::type>, public FIXTURE \
    {                                                                                                            \
    public:                                                                                                  \
        DATA_TEST_CASE_CONSTRUCTOR(TEST_NAME, DATASET)                                                           \
        FIXTURE_DATA_SETUP(FIXTURE)                                                                              \
        FIXTURE_RUN(FIXTURE)                                                                                     \
        FIXTURE_TEARDOWN(FIXTURE)                                                                                \
    };                                                                                                           \
    DATA_TEST_REGISTRAR(TEST_NAME, DATASET)
//
// TEST CASE MACROS END
//

#define ARM_COMPUTE_ASSERT_EQUAL(x, y)                                \
    do                                                                \
    {                                                                 \
        const auto &_x = (x);                                         \
        const auto &_y = (y);                                         \
        if(_x != _y)                                                  \
        {                                                             \
            std::stringstream msg;                                    \
            msg << "Assertion " << _x << " != " << _y << " failed.";  \
            throw arm_compute::test::framework::TestError(msg.str()); \
        }                                                             \
    } while(false)

#define ARM_COMPUTE_EXPECT_EQUAL(x, y)                                                        \
    do                                                                                        \
    {                                                                                         \
        const auto &_x = (x);                                                                 \
        const auto &_y = (y);                                                                 \
        if(_x != _y)                                                                          \
        {                                                                                     \
            std::stringstream msg;                                                            \
            msg << "Expectation " << _x << " != " << _y << " failed.";                        \
            arm_compute::test::framework::Framework::get().log_failed_expectation(msg.str()); \
        }                                                                                     \
    } while(false)
#endif /* ARM_COMPUTE_TEST_FRAMEWORK_MACROS */