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
35 static int no_plan
= 0;
36 static int skip_all
= 0;
37 static int have_plan
= 0;
38 static unsigned int test_count
= 0; /* Number of tests that have been run */
39 static unsigned int e_tests
= 0; /* Expected number of tests to run */
40 static unsigned int failures
= 0; /* Number of tests that failed */
41 static char *todo_msg
= NULL
;
42 static char *todo_msg_fixed
= "libtap malloc issue";
44 static int test_died
= 0;
45 static const int exit_die
= 255; /* exit-code on die() */
48 /* Encapsulate the pthread code in a conditional. In the absence of
49 libpthread the code does nothing */
50 #if defined(LIBTAP_ENABLE_BROKEN_THREAD_SAFE) && defined(HAVE_LIBPTHREAD)
52 static pthread_mutex_t M
= PTHREAD_MUTEX_INITIALIZER
;
53 # define LOCK pthread_mutex_lock(&M);
54 # define UNLOCK pthread_mutex_unlock(&M);
60 static void _expected_tests(unsigned int);
61 static void _tap_init(void);
62 static void _cleanup(void);
65 * Generate a test result.
67 * ok -- boolean, indicates whether or not the test passed.
68 * test_name -- the name of the test, may be NULL
69 * test_comment -- a comment to print afterwards, may be NULL
72 _gen_result(int ok
, const char *func
, const char *file
, unsigned int line
,
73 const char *test_name
, ...)
76 char *local_test_name
= NULL
;
84 /* Start by taking the test name and performing any printf()
86 if(test_name
!= NULL
) {
87 va_start(ap
, test_name
);
88 if (vasprintf(&local_test_name
, test_name
, ap
) < 0)
90 local_test_name
= NULL
;
94 /* Make sure the test name contains more than digits
95 and spaces. Emit an error message and exit if it
99 for(c
= local_test_name
; *c
!= '\0'; c
++) {
100 if(!isdigit(*c
) && !isspace(*c
)) {
107 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
108 diag(" Very confusing.");
118 printf("ok %d", test_count
);
120 if(test_name
!= NULL
) {
123 /* Print the test name, escaping any '#' characters it
125 if(local_test_name
!= NULL
) {
127 for(c
= local_test_name
; *c
!= '\0'; c
++) {
130 fputc((int)*c
, stdout
);
133 } else { /* vasprintf() failed, use a fixed message */
134 printf("%s", todo_msg_fixed
);
138 /* If we're in a todo_start() block then flag the test as being
139 TODO. todo_msg should contain the message to print at this
140 point. If it's NULL then asprintf() failed, and we should
141 use the fixed message.
143 This is not counted as a failure, so decrement the counter if
146 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
154 diag(" Failed %stest (%s:%s() at line %d)",
155 todo
? "(TODO) " : "", file
, func
, line
);
157 free(local_test_name
);
161 /* We only care (when testing) that ok is positive, but here we
162 specifically only want to return 1 or 0 */
167 * Initialise the TAP library. Will only do so once, however many times it's
173 static int run_once
= 0;
180 /* stdout needs to be unbuffered so that the output appears
181 in the same place relative to stderr output as it does
182 with Test::Harness */
191 * Note that there's no plan.
202 fprintf(stderr
, "You tried to plan twice!\n");
217 * Note that the plan is to skip all tests
220 plan_skip_all(const char *reason
)
232 printf(" # SKIP %s", reason
);
242 * Note the number of tests that will be run.
245 plan_tests(unsigned int tests
)
253 fprintf(stderr
, "You tried to plan twice!\n");
260 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
268 _expected_tests(tests
);
276 diag(const char *fmt
, ...)
285 vfprintf(stderr
, fmt
, ap
);
296 _expected_tests(unsigned int tests
)
301 printf("1..%d\n", tests
);
308 skip(unsigned int n
, const char *fmt
, ...)
316 if (vasprintf(&skip_msg
, fmt
, ap
) < 0)
324 printf("ok %d # skip %s\n", test_count
,
326 skip_msg
: "libtap():malloc() failed");
337 todo_start(const char *fmt
, ...)
344 if (vasprintf(&todo_msg
, fmt
, ap
) < 0)
374 /* If there's no plan, just return the number of failures */
375 if(no_plan
|| !have_plan
) {
380 /* Ran too many tests? Return the number of tests that were run
381 that shouldn't have been */
382 if(e_tests
< test_count
) {
383 r
= test_count
- e_tests
;
388 /* Return the number of tests that failed + the number of tests
390 r
= failures
+ e_tests
- test_count
;
397 * Cleanup at the end of the run, produce any final output that might be
406 /* If plan_no_plan() wasn't called, and we don't have a plan,
407 and we're not skipping everything, then something happened
408 before we could produce any output */
409 if(!no_plan
&& !have_plan
&& !skip_all
) {
410 diag("Looks like your test died before it could output anything.");
416 diag("Looks like your test exited with %d just after %d.", exit_die
, test_count
);
422 /* No plan provided, but now we know how many tests were run, and can
423 print the header at the end */
424 if(!skip_all
&& (no_plan
|| !have_plan
)) {
425 printf("1..%d\n", test_count
);
428 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
429 diag("Looks like you planned %d test%s but ran %d extra.",
430 e_tests
, e_tests
== 1 ? "":"s", test_count
- e_tests
);
435 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
436 diag("Looks like you planned %d test%s but ran %d.",
437 e_tests
, e_tests
== 1 ? "":"s", test_count
);
443 diag("Looks like you failed %d test%s of %d.",
444 failures
, failures
== 1 ? "":"s", test_count
);