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
|
/**********************************************************************
* *
* Minimal unit test framework for CBFlib tests. *
* *
* J. Sloan *
* *
**********************************************************************
* *
* 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 2 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, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA *
* 02111-1307 USA *
* *
**********************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301 USA *
* *
*********************************************************************/
#ifndef _UNITTEST_H_
#define _UNITTEST_H_
#include <stdio.h>
/* Macros to get the current location in a file in form `file:line' */
#define __STR2(n) #n
#define __STR(n) __STR2(n)
#define __WHERE__ __FILE__":"__STR(__LINE__)
typedef struct testResult_t
{
int pass;
int fail;
int skip;
} testResult_t;
/*
Test a component in the form of a test function with signature:
testResult_t testFunc(args...);
by calling it as:
TEST_COMPONENT(testFunc(foo,bar));
Logs the number of passes, failures and skipped sections in the
'testResult_t' variable 'r'. Also reports the number of failed or
skipped tests (if any), and where they failed, to 'stderr'.
*/
#define TEST_COMPONENT(testFunc) \
do { \
const testResult_t t = (testFunc); \
r.pass += t.pass; \
r.fail += t.fail; \
r.skip += t.skip; \
if (t.fail) fprintf(stderr,"%s: test(s) failed in '%s'\n",__WHERE__,#testFunc); \
if (t.skip) fprintf(stderr,"%s: test(s) skipped in '%s'\n",__WHERE__,#testFunc); \
} while (0)
/*
Test the boolean expression 'exp' with:
TEST(exp);
or, to invert it:
TEST(!exp);
GCC produces output in the form:
file:line: error: description
file:line: warning: description
extend this to:
file:line: error: description
file:line: failure: description
file:line: warning: description
in decreasing order of severity.
The test will pass if the result is true, and be recorded in the
'testResult_t' variable 'r'. Also reports where the test failed and
what it was, if it failed, to 'stderr'.
*/
#define TEST(exp) \
do { \
if (!(exp)) { \
++r.fail; \
fprintf(stderr,"%s: failure: '%s'\n",__WHERE__,#exp); \
} else ++r.pass; \
} while (0)
/*
Test the CBF function 'exp', which should return a CBFlib error type.
Require that the function return the error code 'CBF_SUCCESS', otherwise
report the failure was to the 'testResult_t' variable 'r' and print a
message to say where and what the failure was to 'stderr'.
*/
#define TEST_CBF_PASS(exp) \
do { \
const int err = (exp); \
error |= err; \
if (CBF_SUCCESS != err) { \
++r.fail; \
fprintf(stderr,"%s: failure: '%s'\nerror: %s\n",__WHERE__,#exp,cbf_strerror(err)); \
} else ++r.pass; \
} while (0)
/*
Test the CBF function 'exp', which should return a CBFlib error type.
Require that the function DOESN'T return 'CBF_SUCCESS', otherwise
report the failure was to the 'testResult_t' variable 'r' and print a
message to say where and what the failure was to 'stderr'.
*/
#define TEST_CBF_FAIL(exp) \
do { \
const int err = (exp); \
if (CBF_SUCCESS == err) { \
++r.fail; \
fprintf(stderr,"%s: failure: '%s' didn't fail\n",__WHERE__,#exp); \
} else ++r.pass; \
} while (0)
/*
Test the CBF function 'exp', which should return a CBFlib error type.
Require that the function returns 'CBF_NOTFOUND', otherwise
report the failure was to the 'testResult_t' variable 'r' and print a
message to say where and what the failure was to 'stderr'.
*/
#define TEST_CBF_NOTFOUND(exp) \
do { \
const int err = (exp); \
if (CBF_NOTFOUND != err) { \
++r.fail; \
fprintf(stderr,"%s: failure: '%s' didn't return 'CBF_NOTFOUND'\n",__WHERE__,#exp); \
} else ++r.pass; \
} while (0)
/*
More CBFlib error codes could be tested, but are not nearly as widely used as
the 'CBF_SUCCESS' vs anything other than 'CBF_SUCCESS' or 'CBF_NOTFOUND'
convensions. A boolean test is largely satisfactory for the vast majority of
those situations.
*/
/*
inline void fprint_results(FILE * const stream, const testResult_t * const result)
{
fprintf(stream,"%d passed\n%d failed\n%d skipped\n",result->pass,result->fail,result->skip);
}
inline void printf_results(const testResult_t * const result)
{
fprint_results(stdout,result);
}
*/
#define fprint_results(stream,result) fprintf(stream,"%d passed\n%d failed\n%d skipped\n",(result)->pass,(result)->fail,(result)->skip);
#define printf_results(result) fprint_results(stdout,result);
#endif
|
