aboutsummaryrefslogtreecommitdiff
path: root/test/test_framework.hh
blob: 3f459c16a0b06549300d7e4563cb55c8a48d0de9 (plain)
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_TEST_TEST_FRAMEWORK_HH
#define PALUDIS_GUARD_TEST_TEST_FRAMEWORK_HH 1

#include <paludis/util/stringify.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <string>

/** \file
 * Test framework class definitions.
 *
 * \ingroup Test
 */

namespace test
{
    /**
     * RAII suffix marker for TestCase context.
     *
     * \ingroup Test
     */
    class TestMessageSuffix :
        paludis::PrivateImplementationPattern<TestMessageSuffix>
    {
        public:
            /**
             * Constructor.
             */
            explicit TestMessageSuffix(const std::string & s, bool write = false);

            /**
             * Destructor.
             */
            ~TestMessageSuffix();

            /**
             * Our suffixes.
             */
            static std::string suffixes();
    };

    /**
     * Base TestCase class.
     *
     * \ingroup Test
     */
    class TestCase :
        private paludis::PrivateImplementationPattern<TestCase>
    {
        protected:
            /**
             * Check that a given assertion is true.
             */
            void check(const char * const function, const char * const file,
                    const long line, bool was_ok, const std::string & message) const;

            /**
             * Run the tests (override this in descendents).
             */
            virtual void run() = 0;

        public:
            /**
             * Constructor.
             */
            TestCase(const std::string & name);

            /**
             * Destructor.
             */
            virtual ~TestCase();

            /**
             * Call our run() function, and normalise exceptions.
             */
            void call_run();

            /**
             * Return our name.
             */
            std::string name() const;

            /**
             * Are we repeatable? Override if not.
             */
            virtual bool repeatable() const
            {
                return true;
            }

            /**
             * Should we be skipped?
             */
            virtual bool skip() const
            {
                return false;
            }

            /**
             * After how many seconds should we timeout?
             */
            virtual unsigned max_run_time() const
            {
                return 30;
            }
    };

    /**
     * Thrown if a TestCase failed.
     *
     * \ingroup Test
     * \ingroup grpexceptions
     */
    class TestFailedException : public std::exception
    {
        private:
            const std::string _message;

        public:
            /**
             * Constructor.
             */
            TestFailedException(const char * const function, const char * const file,
                    const long line, const std::string & message) throw ();

            /**
             * Destructor.
             */
            virtual ~TestFailedException() throw ();

            /**
             * Description.
             */
            const char * what() const throw ()
            {
                return _message.c_str();
            }
    };

    /**
     * A list of TestCase instances.
     *
     * \ingroup Test
     */
    class TestCaseList
    {
        private:
            TestCaseList();
            ~TestCaseList();

        public:
            /**
             * Register a TestCase instance.
             */
            static void register_test_case(TestCase * const test_case);

            /**
             * Run all tests.
             */
            static bool run_tests();

            /**
             * Should we use alarm?
             */
            static bool use_alarm;
    };

    /**
     * Change the function used to get a string description of an exception.
     */
    void set_exception_to_debug_string(std::string (*) (const std::exception &));
}

/**
 * Check that a == b.
 */
#define TEST_CHECK_EQUAL(a, b) \
    do { \
        check(__PRETTY_FUNCTION__, __FILE__, __LINE__, a == b, \
                "Expected '" #a "' to equal '" + paludis::stringify(b) + \
                "' but got '" + paludis::stringify(a) + "'"); \
    } while (false)

/**
 * Check that stringify(a) == stringify(b).
 */
#define TEST_CHECK_STRINGIFY_EQUAL(a, b) \
    do { \
        check(__PRETTY_FUNCTION__, __FILE__, __LINE__, paludis::stringify(a) == paludis::stringify(b), \
                "Expected '" #a "' to equal '" + paludis::stringify(b) + \
                "' but got '" + paludis::stringify(a) + "'"); \
    } while (false)

/**
 * Check that a is true.
 */
#define TEST_CHECK(a) \
    do { \
        check(__PRETTY_FUNCTION__, __FILE__, __LINE__, a, \
                "Check '" #a "' failed"); \
    } while (false)

/**
 * Check that a throws an exception of type b.
 */
#define TEST_CHECK_THROWS(a, b) \
    do { \
        try { \
            a; \
            check(__PRETTY_FUNCTION__, __FILE__, __LINE__, false, \
                    "Expected exception of type '" #b "' not thrown"); \
        } catch (b &) { \
            TEST_CHECK(true); \
        } \
    } while (false)

#endif