summaryrefslogtreecommitdiffstats
path: root/contrib/idn/idnkit-1.0-src/lib/tests/testsuite.h
blob: a5e47740135ffa15f3e966e5e20a437c16501b12 (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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/* $Id: testsuite.h,v 1.1.1.1 2003/06/04 00:27:03 marka Exp $ */
/*
 * Copyright (c) 2002 Japan Network Information Center.
 * All rights reserved.
 *  
 * By using this file, you agree to the terms and conditions set forth bellow.
 * 
 * 			LICENSE TERMS AND CONDITIONS 
 * 
 * The following License Terms and Conditions apply, unless a different
 * license is obtained from Japan Network Information Center ("JPNIC"),
 * a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
 * Chiyoda-ku, Tokyo 101-0047, Japan.
 * 
 * 1. Use, Modification and Redistribution (including distribution of any
 *    modified or derived work) in source and/or binary forms is permitted
 *    under this License Terms and Conditions.
 * 
 * 2. Redistribution of source code must retain the copyright notices as they
 *    appear in each source code file, this License Terms and Conditions.
 * 
 * 3. Redistribution in binary form must reproduce the Copyright Notice,
 *    this License Terms and Conditions, in the documentation and/or other
 *    materials provided with the distribution.  For the purposes of binary
 *    distribution the "Copyright Notice" refers to the following language:
 *    "Copyright (c) 2000-2002 Japan Network Information Center.  All rights reserved."
 * 
 * 4. The name of JPNIC may not be used to endorse or promote products
 *    derived from this Software without specific prior written approval of
 *    JPNIC.
 * 
 * 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
 *    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JPNIC BE LIABLE
 *    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 *    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 *    ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef IDN_TESTSUITE_H
#define IDN_TESTSUITE_H 1

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Result codes for test case.
 */
typedef enum {
	idn_teststatus_pass,
	idn_teststatus_fail,
	idn_teststatus_skip
} idn_teststatus_t;

/*
 * Testsuite manager type (opaque).
 */
typedef struct idn_testsuite *idn_testsuite_t;

/*
 * Testcase function type.
 */
typedef void (*idn_testsuite_testproc_t)(idn_testsuite_t ctx);

/*
 * Message handler type.
 */
typedef void (*idn_testsuite_msgproc_t)(const char *msg);

/*
 * Create a testsuite manager context.
 *
 * Create an empty context and store it in '*ctxp'.
 * Return 1 on success.  Return 0 if memory is exhausted.
 */
extern int
idn_testsuite_create(idn_testsuite_t *ctxp);

/*
 * Destory the testsuite manager context.
 *
 * Destroy the context created by idn_testsuite_create(), and release
 * memory allocated to the context.
 */
extern void
idn_testsuite_destroy(idn_testsuite_t ctx);

/*
 * Add a test case to the `group' test group.
 * Return 1 on success.  Return 0 if memory is exhausted.
 */
extern int
idn_testsuite_addtestcase(idn_testsuite_t ctx, const char *title,
	                  idn_testsuite_testproc_t proc);

/*
 * Return the number of test cases registered in the context.
 */
extern int
idn_testsuite_ntestcases(idn_testsuite_t ctx);

/*
 * Run test cases registered in the context.
 */
extern void
idn_testsuite_runall(idn_testsuite_t ctx);
extern void
idn_testsuite_run(idn_testsuite_t ctx, char *titles[]);

/*
 * Return the string description of `status'.
 */
extern const char *
idn_teststatus_tostring(idn_teststatus_t status);

/*
 * Return the number of passed/failed/skipped test cases.
 */
extern int
idn_testsuite_npassed(idn_testsuite_t ctx);
extern int
idn_testsuite_nfailed(idn_testsuite_t ctx);
extern int
idn_testsuite_nskipped(idn_testsuite_t ctx);

/*
 * Set/Get status of the test case running currently.
 *
 * These functions must be called by test case function.
 */
extern idn_teststatus_t
idn_testsuite_getstatus(idn_testsuite_t ctx);
extern void
idn_testsuite_setstatus(idn_testsuite_t ctx, idn_teststatus_t status);

/*
 * Enable/Disable verbose mode.
 */
extern void
idn_testsuite_setverbose(idn_testsuite_t ctx);
extern void
idn_testsuite_unsetverbose(idn_testsuite_t ctx);

/*
 * Generic assertion with message
 */
extern void
idn_testsuite_assert(idn_testsuite_t ctx, const char *msg,
		     const char *file, int lineno);

#define ASSERT_THRU(msg) \
    idn_testsuite_assert(ctx__, msg, __FILE__, __LINE__)
#define ASSERT(msg) \
  do { \
    ASSERT_THRU(msg); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/*
 * Assertion function and macro to compare two `int' values.
 * The assertion passes if `gotten' is equal to `expected'.
 */
extern void
idn_testsuite_assertint(idn_testsuite_t ctx, int gotten, int expected,
			const char *file, int lineno);

#define ASSERT_INT(gotten, expected) \
  do { \
    idn_testsuite_assertint(ctx__, gotten, expected, __FILE__, __LINE__); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/*
 * Assertion function and macro to compare two strings.
 * The assertion passes if `gotten' is lexically equal to `expected'.
 */
extern void
idn_testsuite_assertstring(idn_testsuite_t ctx, const char *gotten, 
			   const char *expected, const char *file, int lineno);

#define ASSERT_STRING(gotten, expected) \
  do { \
    idn_testsuite_assertstring(ctx__, gotten, expected, __FILE__, __LINE__); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/*
 * Assertion function and macro to compare two pointers.
 * The assertion passes if `gotten' is equal to `expected'.
 */
extern void
idn_testsuite_assertptr(idn_testsuite_t ctx, const void *gotten, 
			const void *expected, const char *file, int lineno);

#define ASSERT_PTR(gotten, expected) \
  do { \
    idn_testsuite_assertptr(ctx__, gotten, expected, __FILE__, __LINE__); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/*
 * Assertion function and macro to compare two pointers.
 * The assertion passes if `gotten' is NOT equal to `expected'.
 */
extern void
idn_testsuite_assertptrne(idn_testsuite_t ctx, 
			  const void *gotten, const void *unexpected,
			  const char *file, int lineno);

#define ASSERT_PTR_NE(gotten, unexpected) \
  do { \
    idn_testsuite_assertptrne(ctx__, gotten, unexpected, __FILE__, __LINE__); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/*
 * Assertion function and macro to compare two `idn_result_t' values.
 * The assertion passes if `gotten' is equal to `expected'.
 */
extern void
idn_testsuite_assertresult(idn_testsuite_t ctx,
			   idn_result_t gotten, idn_result_t expected,
			   const char *file, int lineno);

#define ASSERT_RESULT(gotten, expected) \
  do { \
    idn_testsuite_assertresult(ctx__, gotten, expected, __FILE__, __LINE__); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/*
 * Assertion function and macro to compare two UCS4 strings.
 * The assertion passes if `gotten' is lexically equal to `expected'.
 */
extern void
idn_testsuite_assertucs4string(idn_testsuite_t ctx,
			       const unsigned long *gotten, 
			       const unsigned long *expected,
			       const char *file,
			       int lineno);

#define ASSERT_UCS4STRING_THRU(gotten, expected) \
  idn_testsuite_assertucs4string(ctx__, gotten, expected, __FILE__, __LINE__)
#define ASSERT_UCS4STRING(gotten, expected) \
  do { \
    ASSERT_UCS4STRING_THRU(gotten, expected); \
    if (idn_testsuite_getstatus(ctx__) != idn_teststatus_pass) \
      goto EXIT__; \
  } while (0)

/* 
 * Shorthands.
 */
#define SKIP_TESTCASE \
  do { \
       idn_testsuite_setstatus(ctx__, idn_teststatus_skip); \
       goto EXIT__; \
  } while (0)

#ifdef __cplusplus
}
#endif

#endif /* IDN_TESTSUITE_H */