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 int tap_is_disabled
= 0;
47 /* Encapsulate the pthread code in a conditional. In the absence of
48 libpthread the code does nothing */
49 #ifdef HAVE_LIBPTHREAD
51 static pthread_mutex_t M
= PTHREAD_MUTEX_INITIALIZER
;
52 # define LOCK pthread_mutex_lock(&M);
53 # define UNLOCK pthread_mutex_unlock(&M);
59 static void _expected_tests(unsigned int);
60 static void _tap_init(void);
61 static void _cleanup(void);
64 * Generate a test result.
66 * ok -- boolean, indicates whether or not the test passed.
67 * test_name -- the name of the test, may be NULL
68 * test_comment -- a comment to print afterwards, may be NULL
71 _gen_result(int ok
, const char *func
, char *file
, unsigned int line
,
75 char *local_test_name
= NULL
;
83 /* Start by taking the test name and performing any printf()
85 if(test_name
!= NULL
) {
86 va_start(ap
, test_name
);
87 if (vasprintf(&local_test_name
, test_name
, ap
) == -1) {
88 local_test_name
= NULL
;
92 /* Make sure the test name contains more than digits
93 and spaces. Emit an error message and exit if it
97 for(c
= local_test_name
; *c
!= '\0'; c
++) {
98 if(!isdigit(*c
) && !isspace(*c
)) {
105 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
106 diag(" Very confusing.");
116 printf("ok %d", test_count
);
118 if(test_name
!= NULL
) {
121 /* Print the test name, escaping any '#' characters it
123 if(local_test_name
!= NULL
) {
125 for(c
= local_test_name
; *c
!= '\0'; c
++) {
128 fputc((int)*c
, stdout
);
131 } else { /* vasprintf() failed, use a fixed message */
132 printf("%s", todo_msg_fixed
);
136 /* If we're in a todo_start() block then flag the test as being
137 TODO. todo_msg should contain the message to print at this
138 point. If it's NULL then asprintf() failed, and we should
139 use the fixed message.
141 This is not counted as a failure, so decrement the counter if
144 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
152 if(getenv("HARNESS_ACTIVE") != NULL
)
155 diag(" Failed %stest (%s:%s() at line %d)",
156 todo
? "(TODO) " : "", file
, func
, line
);
158 free(local_test_name
);
162 /* We only care (when testing) that ok is positive, but here we
163 specifically only want to return 1 or 0 */
168 * Initialise the TAP library. Will only do so once, however many times it's
174 static int run_once
= 0;
179 /* stdout needs to be unbuffered so that the output appears
180 in the same place relative to stderr output as it does
181 with Test::Harness */
188 * Note that there's no plan.
199 fprintf(stderr
, "You tried to plan twice!\n");
214 * Note that the plan is to skip all tests
217 plan_skip_all(char *reason
)
229 printf(" # Skip %s", reason
);
239 * Note the number of tests that will be run.
242 plan_tests(unsigned int tests
)
250 fprintf(stderr
, "You tried to plan twice!\n");
257 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
265 _expected_tests(tests
);
280 vfprintf(stderr
, fmt
, ap
);
296 rdiag(char *fmt
, ...)
301 vfprintf(stderr
, fmt
, ap
);
315 _expected_tests(unsigned int tests
)
318 printf("1..%d\n", tests
);
323 skip(unsigned int n
, char *fmt
, ...)
326 char *skip_msg
= NULL
;
331 if (asprintf(&skip_msg
, fmt
, ap
) == -1) {
338 printf("ok %d # skip %s\n", test_count
,
340 skip_msg
: "libtap():malloc() failed");
351 todo_start(char *fmt
, ...)
358 if (vasprintf(&todo_msg
, fmt
, ap
) == -1) {
387 /* If there's no plan, just return the number of failures */
388 if(no_plan
|| !have_plan
) {
393 /* Ran too many tests? Return the number of tests that were run
394 that shouldn't have been */
395 if(e_tests
< test_count
) {
396 r
= test_count
- e_tests
;
401 /* Return the number of tests that failed + the number of tests
403 r
= failures
+ e_tests
- test_count
;
410 * Cleanup at the end of the run, produce any final output that might be
419 if (tap_is_disabled
) {
424 /* If plan_no_plan() wasn't called, and we don't have a plan,
425 and we're not skipping everything, then something happened
426 before we could produce any output */
427 if(!no_plan
&& !have_plan
&& !skip_all
) {
428 diag("Looks like your test died before it could output anything.");
434 diag("Looks like your test died just after %d.", test_count
);
440 /* No plan provided, but now we know how many tests were run, and can
441 print the header at the end */
442 if(!skip_all
&& (no_plan
|| !have_plan
)) {
443 printf("1..%d\n", test_count
);
446 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
447 diag("Looks like you planned %d %s but ran %d extra.",
448 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
- e_tests
);
453 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
454 diag("Looks like you planned %d %s but only ran %d.",
455 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
);
461 diag("Looks like you failed %d %s of %d.",
462 failures
, failures
== 1 ? "test" : "tests", test_count
);
467 /* Disable tap for this process. */