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;
46 /* Encapsulate the pthread code in a conditional. In the absence of
47 libpthread the code does nothing */
48 #ifdef HAVE_LIBPTHREAD
50 static pthread_mutex_t M
= PTHREAD_MUTEX_INITIALIZER
;
51 # define LOCK pthread_mutex_lock(&M);
52 # define UNLOCK pthread_mutex_unlock(&M);
58 static void _expected_tests(unsigned int);
59 static void _tap_init(void);
60 static void _cleanup(void);
63 * Generate a test result.
65 * ok -- boolean, indicates whether or not the test passed.
66 * test_name -- the name of the test, may be NULL
67 * test_comment -- a comment to print afterwards, may be NULL
70 _gen_result(int ok
, const char *func
, char *file
, unsigned int line
,
74 char *local_test_name
= NULL
;
82 /* Start by taking the test name and performing any printf()
84 if(test_name
!= NULL
) {
85 va_start(ap
, test_name
);
86 vasprintf(&local_test_name
, test_name
, ap
);
89 /* Make sure the test name contains more than digits
90 and spaces. Emit an error message and exit if it
94 for(c
= local_test_name
; *c
!= '\0'; c
++) {
95 if(!isdigit(*c
) && !isspace(*c
)) {
102 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
103 diag(" Very confusing.");
113 printf("ok %d", test_count
);
115 if(test_name
!= NULL
) {
118 /* Print the test name, escaping any '#' characters it
120 if(local_test_name
!= NULL
) {
122 for(c
= local_test_name
; *c
!= '\0'; c
++) {
125 fputc((int)*c
, stdout
);
128 } else { /* vasprintf() failed, use a fixed message */
129 printf("%s", todo_msg_fixed
);
133 /* If we're in a todo_start() block then flag the test as being
134 TODO. todo_msg should contain the message to print at this
135 point. If it's NULL then asprintf() failed, and we should
136 use the fixed message.
138 This is not counted as a failure, so decrement the counter if
141 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
149 if(getenv("HARNESS_ACTIVE") != NULL
)
152 diag(" Failed %stest (%s:%s() at line %d)",
153 todo
? "(TODO) " : "", file
, func
, line
);
155 free(local_test_name
);
159 /* We only care (when testing) that ok is positive, but here we
160 specifically only want to return 1 or 0 */
165 * Initialise the TAP library. Will only do so once, however many times it's
171 static int run_once
= 0;
176 /* stdout needs to be unbuffered so that the output appears
177 in the same place relative to stderr output as it does
178 with Test::Harness */
185 * Note that there's no plan.
196 fprintf(stderr
, "You tried to plan twice!\n");
211 * Note that the plan is to skip all tests
214 plan_skip_all(char *reason
)
226 printf(" # Skip %s", reason
);
236 * Note the number of tests that will be run.
239 plan_tests(unsigned int tests
)
247 fprintf(stderr
, "You tried to plan twice!\n");
254 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
262 _expected_tests(tests
);
277 vfprintf(stderr
, fmt
, ap
);
286 _expected_tests(unsigned int tests
)
289 printf("1..%d\n", tests
);
294 skip(unsigned int n
, char *fmt
, ...)
302 asprintf(&skip_msg
, fmt
, ap
);
307 printf("ok %d # skip %s\n", test_count
,
309 skip_msg
: "libtap():malloc() failed");
320 todo_start(char *fmt
, ...)
327 vasprintf(&todo_msg
, fmt
, ap
);
354 /* If there's no plan, just return the number of failures */
355 if(no_plan
|| !have_plan
) {
360 /* Ran too many tests? Return the number of tests that were run
361 that shouldn't have been */
362 if(e_tests
< test_count
) {
363 r
= test_count
- e_tests
;
368 /* Return the number of tests that failed + the number of tests
370 r
= failures
+ e_tests
- test_count
;
377 * Cleanup at the end of the run, produce any final output that might be
386 /* If plan_no_plan() wasn't called, and we don't have a plan,
387 and we're not skipping everything, then something happened
388 before we could produce any output */
389 if(!no_plan
&& !have_plan
&& !skip_all
) {
390 diag("Looks like your test died before it could output anything.");
396 diag("Looks like your test died just after %d.", test_count
);
402 /* No plan provided, but now we know how many tests were run, and can
403 print the header at the end */
404 if(!skip_all
&& (no_plan
|| !have_plan
)) {
405 printf("1..%d\n", test_count
);
408 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
409 diag("Looks like you planned %d %s but ran %d extra.",
410 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
- e_tests
);
415 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
416 diag("Looks like you planned %d %s but only ran %d.",
417 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
);
423 diag("Looks like you failed %d %s of %d.",
424 failures
, failures
== 1 ? "test" : "tests", test_count
);