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);
62 * Generate a test result.
64 * ok -- boolean, indicates whether or not the test passed.
65 * test_name -- the name of the test, may be NULL
66 * test_comment -- a comment to print afterwards, may be NULL
69 _gen_result(int ok
, const char *func
, char *file
, unsigned int line
,
73 char *local_test_name
= NULL
;
81 /* Start by taking the test name and performing any printf()
83 if(test_name
!= NULL
) {
84 va_start(ap
, test_name
);
85 vasprintf(&local_test_name
, test_name
, ap
);
88 /* Make sure the test name contains more than digits
89 and spaces. Emit an error message and exit if it
93 for(c
= local_test_name
; *c
!= '\0'; c
++) {
94 if(!isdigit(*c
) && !isspace(*c
)) {
101 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
102 diag(" Very confusing.");
112 printf("ok %d", test_count
);
114 if(test_name
!= NULL
) {
117 /* Print the test name, escaping any '#' characters it
119 if(local_test_name
!= NULL
) {
121 for(c
= local_test_name
; *c
!= '\0'; c
++) {
124 fputc((int)*c
, stdout
);
127 } else { /* vasprintf() failed, use a fixed message */
128 printf("%s", todo_msg_fixed
);
132 /* If we're in a todo_start() block then flag the test as being
133 TODO. todo_msg should contain the message to print at this
134 point. If it's NULL then asprintf() failed, and we should
135 use the fixed message.
137 This is not counted as a failure, so decrement the counter if
140 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
148 if(getenv("HARNESS_ACTIVE") != NULL
)
151 diag(" Failed %stest (%s:%s() at line %d)",
152 todo
? "(TODO) " : "", file
, func
, line
);
154 free(local_test_name
);
158 /* We only care (when testing) that ok is positive, but here we
159 specifically only want to return 1 or 0 */
164 * Initialise the TAP library. Will only do so once, however many times it's
170 static int run_once
= 0;
175 /* stdout needs to be unbuffered so that the output appears
176 in the same place relative to stderr output as it does
177 with Test::Harness */
184 * Note that there's no plan.
195 fprintf(stderr
, "You tried to plan twice!\n");
210 * Note that the plan is to skip all tests
213 plan_skip_all(char *reason
)
225 printf(" # Skip %s", reason
);
235 * Note the number of tests that will be run.
238 plan_tests(unsigned int tests
)
246 fprintf(stderr
, "You tried to plan twice!\n");
253 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
261 _expected_tests(tests
);
276 vfprintf(stderr
, fmt
, ap
);
285 _expected_tests(unsigned int tests
)
288 printf("1..%d\n", tests
);
293 skip(unsigned int n
, char *fmt
, ...)
301 asprintf(&skip_msg
, fmt
, ap
);
306 printf("ok %d # skip %s\n", test_count
,
308 skip_msg
: "libtap():malloc() failed");
319 todo_start(char *fmt
, ...)
326 vasprintf(&todo_msg
, fmt
, ap
);
353 /* If there's no plan, just return the number of failures */
354 if(no_plan
|| !have_plan
) {
359 /* Ran too many tests? Return the number of tests that were run
360 that shouldn't have been */
361 if(e_tests
< test_count
) {
362 r
= test_count
- e_tests
;
367 /* Return the number of tests that failed + the number of tests
369 r
= failures
+ e_tests
- test_count
;
376 * Cleanup at the end of the run, produce any final output that might be
385 /* If plan_no_plan() wasn't called, and we don't have a plan,
386 and we're not skipping everything, then something happened
387 before we could produce any output */
388 if(!no_plan
&& !have_plan
&& !skip_all
) {
389 diag("Looks like your test died before it could output anything.");
395 diag("Looks like your test died just after %d.", test_count
);
401 /* No plan provided, but now we know how many tests were run, and can
402 print the header at the end */
403 if(!skip_all
&& (no_plan
|| !have_plan
)) {
404 printf("1..%d\n", test_count
);
407 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
408 diag("Looks like you planned %d %s but ran %d extra.",
409 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
- e_tests
);
414 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
415 diag("Looks like you planned %d %s but only ran %d.",
416 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
);
422 diag("Looks like you failed %d %s of %d.",
423 failures
, failures
== 1 ? "test" : "tests", test_count
);