2 * Copyright (c) 2004 Nik Clayton
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 static int no_plan
= 0;
35 static int skip_all
= 0;
36 static int have_plan
= 0;
37 static unsigned int test_count
= 0; /* Number of tests that have been run */
38 static unsigned int e_tests
= 0; /* Expected number of tests to run */
39 static unsigned int failures
= 0; /* Number of tests that failed */
40 static char *todo_msg
= NULL
;
41 static char *todo_msg_fixed
= "libtap malloc issue";
43 static int test_died
= 0;
45 /* Encapsulate the pthread code in a conditional. In the absence of
46 libpthread the code does nothing */
47 #ifdef HAVE_LIBPTHREAD
49 static pthread_mutex_t M
= PTHREAD_MUTEX_INITIALIZER
;
50 # define LOCK pthread_mutex_lock(&M);
51 # define UNLOCK pthread_mutex_unlock(&M);
57 static void _expected_tests(unsigned int);
58 static void _tap_init(void);
59 static void _cleanup(void);
63 void flockfile (FILE * filehandle
) {
68 void funlockfile(FILE * filehandle
) {
74 * Generate a test result.
76 * ok -- boolean, indicates whether or not the test passed.
77 * test_name -- the name of the test, may be NULL
78 * test_comment -- a comment to print afterwards, may be NULL
81 _gen_result(int ok
, const char *func
, char *file
, unsigned int line
,
85 char *local_test_name
= NULL
;
93 /* Start by taking the test name and performing any printf()
95 if(test_name
!= NULL
) {
96 va_start(ap
, test_name
);
97 if (vasprintf(&local_test_name
, test_name
, ap
) == -1) {
98 local_test_name
= NULL
;
102 /* Make sure the test name contains more than digits
103 and spaces. Emit an error message and exit if it
105 if(local_test_name
) {
107 for(c
= local_test_name
; *c
!= '\0'; c
++) {
108 if(!isdigit(*c
) && !isspace(*c
)) {
115 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
116 diag(" Very confusing.");
126 printf("ok %d", test_count
);
128 if(test_name
!= NULL
) {
131 /* Print the test name, escaping any '#' characters it
133 if(local_test_name
!= NULL
) {
135 for(c
= local_test_name
; *c
!= '\0'; c
++) {
138 fputc((int)*c
, stdout
);
141 } else { /* vasprintf() failed, use a fixed message */
142 printf("%s", todo_msg_fixed
);
146 /* If we're in a todo_start() block then flag the test as being
147 TODO. todo_msg should contain the message to print at this
148 point. If it's NULL then asprintf() failed, and we should
149 use the fixed message.
151 This is not counted as a failure, so decrement the counter if
154 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
162 if(getenv("HARNESS_ACTIVE") != NULL
)
165 diag(" Failed %stest (%s:%s() at line %d)",
166 todo
? "(TODO) " : "", file
, func
, line
);
168 free(local_test_name
);
172 /* We only care (when testing) that ok is positive, but here we
173 specifically only want to return 1 or 0 */
178 * Initialise the TAP library. Will only do so once, however many times it's
184 static int run_once
= 0;
189 /* stdout needs to be unbuffered so that the output appears
190 in the same place relative to stderr output as it does
191 with Test::Harness */
198 * Note that there's no plan.
209 fprintf(stderr
, "You tried to plan twice!\n");
224 * Note that the plan is to skip all tests
227 plan_skip_all(char *reason
)
239 printf(" # Skip %s", reason
);
249 * Note the number of tests that will be run.
252 plan_tests(unsigned int tests
)
260 fprintf(stderr
, "You tried to plan twice!\n");
267 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
275 _expected_tests(tests
);
290 vfprintf(stderr
, fmt
, ap
);
299 _expected_tests(unsigned int tests
)
302 printf("1..%d\n", tests
);
307 skip(unsigned int n
, char *fmt
, ...)
310 char *skip_msg
= NULL
;
315 if (asprintf(&skip_msg
, fmt
, ap
) == -1) {
322 printf("ok %d # skip %s\n", test_count
,
324 skip_msg
: "libtap():malloc() failed");
335 todo_start(char *fmt
, ...)
342 if (vasprintf(&todo_msg
, fmt
, ap
) == -1) {
371 /* If there's no plan, just return the number of failures */
372 if(no_plan
|| !have_plan
) {
377 /* Ran too many tests? Return the number of tests that were run
378 that shouldn't have been */
379 if(e_tests
< test_count
) {
380 r
= test_count
- e_tests
;
385 /* Return the number of tests that failed + the number of tests
387 r
= failures
+ e_tests
- test_count
;
394 * Cleanup at the end of the run, produce any final output that might be
403 /* If plan_no_plan() wasn't called, and we don't have a plan,
404 and we're not skipping everything, then something happened
405 before we could produce any output */
406 if(!no_plan
&& !have_plan
&& !skip_all
) {
407 diag("Looks like your test died before it could output anything.");
413 diag("Looks like your test died just after %d.", test_count
);
419 /* No plan provided, but now we know how many tests were run, and can
420 print the header at the end */
421 if(!skip_all
&& (no_plan
|| !have_plan
)) {
422 printf("1..%d\n", test_count
);
425 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
426 diag("Looks like you planned %d %s but ran %d extra.",
427 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
- e_tests
);
432 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
433 diag("Looks like you planned %d %s but only ran %d.",
434 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
);
440 diag("Looks like you failed %d %s of %d.",
441 failures
, failures
== 1 ? "test" : "tests", test_count
);