GTestSuite.hpp
9.4 KB
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
/***************************************************************************
* GTestSuite.hpp - Abstract test suite base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-2016 by Jean-Baptiste Cayrou *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program 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, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GTestSuite.hpp
* @brief Abstract test suite base class definition
* @author Jean-Baptiste Cayrou
*/
#ifndef GTESTSUITE_HPP
#define GTESTSUITE_HPP
/* __ Forward declarations _______________________________________________ */
class GTestSuite;
/* __ Test suite pointer _________________________________________________ */
typedef void (GTestSuite::*pfunction)(void);
/* __ Includes ___________________________________________________________ */
#include <complex>
#include <vector>
#include <string>
#include "GLog.hpp"
#include "GException.hpp"
#include "GTestCase.hpp"
#include "GTypemaps.hpp"
/***********************************************************************//**
* @class GTestSuite
*
* @brief Abstract test suite class for unit testing on GammaLib fixtures
*
* @todo Detailed explanation.
***************************************************************************/
class GTestSuite : public GBase {
public:
// Constructors and destructors
GTestSuite(void);
GTestSuite(const GTestSuite& testsuite);
GTestSuite(const std::string& name);
virtual ~GTestSuite(void);
// Operators
GTestSuite& operator=(const GTestSuite& testsuite);
GTestCase& operator[](const int& index);
const GTestCase& operator[](const int& index) const;
// Pure virtual methods
virtual GTestSuite* clone(void) const = 0;
virtual std::string classname(void) const = 0;
virtual void set(void) = 0;
// Other methods
void clear(void);
int size(void) const;
void append(pfunction function, const std::string& name);
bool run(void);
const std::string& name(void) const;
void name(const std::string& name);
void cout(const bool& flag);
void test_assert(const bool& result,
const std::string& name,
const std::string& message = "");
void test_value(const int& value,
const int& expected,
const std::string& name = "",
const std::string& message = "");
void test_value(const double& value,
const double& expected,
const std::string& name = "",
const std::string& message = "");
void test_value(const double& value,
const double& expected,
const double& eps,
const std::string& name = "",
const std::string& message = "");
void test_value(const std::complex<double>& value,
const std::complex<double>& expected,
const std::string& name = "",
const std::string& message = "");
void test_value(const std::complex<double>& value,
const std::complex<double>& expected,
const double& eps,
const std::string& name = "",
const std::string& message = "");
void test_value(const std::string& value,
const std::string& expected,
const std::string& name = "",
const std::string& message = "");
void test_try(const std::string& name);
void test_try_success(void);
void test_try_failure(const std::string& message = "",
const std::string& type = "");
void test_try_failure(const std::exception& e);
GException::test_failure& exception_failure(const std::string& message);
GException::test_error& exception_error(const std::string& message);
const int& errors(void) const;
const int& failures(void) const;
int success(void) const;
const time_t& timestamp(void) const;
double duration(void) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GTestSuite& testsuite);
void free_members(void);
std::string format_name(const std::string& name);
// Protected members
std::string m_name; //!< Name of the test suite
std::vector<std::string> m_names; //!< Names of test functions
std::vector<pfunction> m_functions; //!< Test functions of this suite
std::vector<GTestCase*> m_tests; //!< List of test results
std::vector<GTestCase*> m_stack_try; //!< Stack for nested try blocks
int m_index; //!< Index of actual test function
int m_failures; //!< Number of failures
int m_errors; //!< Number of errors
GLog m_log; //!< Log
time_t m_timestamp; //!< Timestamp
};
/***********************************************************************//**
* @brief Return number of tests in test suite
***************************************************************************/
inline
int GTestSuite::size(void) const
{
return (int)m_tests.size();
}
/***********************************************************************//**
* @brief Return test suite name
***************************************************************************/
inline
const std::string& GTestSuite::name(void) const
{
return m_name;
}
/***********************************************************************//**
* @brief Set Test Suite name
*
* @param[in] name Test suite name.
***************************************************************************/
inline
void GTestSuite::name(const std::string& name)
{
m_name = name;
return;
}
/***********************************************************************//**
* @brief Enables/disables logging into standard output stream
*
* @param[in] flag Enable/disable logging (true/false).
*
* Enables or disables logging into the standard output stream.
***************************************************************************/
inline
void GTestSuite::cout(const bool& flag)
{
m_log.cout(flag);
return;
}
/***********************************************************************//**
* @brief Return the number of errors
*
* @return Number of errors.
***************************************************************************/
inline
const int& GTestSuite::errors(void) const
{
return m_errors;
}
/***********************************************************************//**
* @brief Return the number of failures
*
* @return Number of failures.
***************************************************************************/
inline
const int& GTestSuite::failures(void) const
{
return m_failures;
}
/***********************************************************************//**
* @brief Return the timestamp
*
* @return Timestamp.
*
* The timestamp is set at the construction of the object.
***************************************************************************/
inline
const time_t& GTestSuite::timestamp(void) const
{
return m_timestamp;
}
#endif /* GTESTSUITE_HPP */