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;
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)
60 _expected_tests(unsigned int tests)
63 printf("1..%d\n", tests);
68 diagv(char *fmt, va_list ap)
71 vfprintf(stderr, fmt, ap);
85 * Generate a test result.
87 * ok -- boolean, indicates whether or not the test passed.
88 * test_name -- the name of the test, may be NULL
89 * test_comment -- a comment to print afterwards, may be NULL
92 _gen_result(int ok, const char *func, char *file, unsigned int line,
96 char *local_test_name = NULL;
104 /* Start by taking the test name and performing any printf()
106 if(test_name != NULL) {
107 va_start(ap, test_name);
108 vasprintf(&local_test_name, test_name, ap);
111 /* Make sure the test name contains more than digits
112 and spaces. Emit an error message and exit if it
114 if(local_test_name) {
116 for(c = local_test_name; *c != '\0'; c++) {
117 if(!isdigit(*c) && !isspace(*c)) {
124 _diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name);
125 _diag(" Very confusing.");
135 printf("ok %d", test_count);
137 if(test_name != NULL) {
140 /* Print the test name, escaping any '#' characters it
142 if(local_test_name != NULL) {
144 for(c = local_test_name; *c != '\0'; c++) {
147 fputc((int)*c, stdout);
150 } else { /* vasprintf() failed, use a fixed message */
151 printf("%s", todo_msg_fixed);
155 /* If we're in a todo_start() block then flag the test as being
156 TODO. todo_msg should contain the message to print at this
157 point. If it's NULL then asprintf() failed, and we should
158 use the fixed message.
160 This is not counted as a failure, so decrement the counter if
163 printf(" # TODO %s", todo_msg ? todo_msg : todo_msg_fixed);
171 _diag(" Failed %stest (%s:%s() at line %d)",
172 todo ? "(TODO) " : "", file, func, line);
174 free(local_test_name);
178 /* We only care (when testing) that ok is positive, but here we
179 specifically only want to return 1 or 0 */
184 * Cleanup at the end of the run, produce any final output that might be
190 /* If we forked, don't do cleanup in child! */
191 if (getpid() != test_pid)
196 /* If plan_no_plan() wasn't called, and we don't have a plan,
197 and we're not skipping everything, then something happened
198 before we could produce any output */
199 if(!no_plan && !have_plan && !skip_all) {
200 _diag("Looks like your test died before it could output anything.");
206 _diag("Looks like your test died just after %d.", test_count);
212 /* No plan provided, but now we know how many tests were run, and can
213 print the header at the end */
214 if(!skip_all && (no_plan || !have_plan)) {
215 printf("1..%d\n", test_count);
218 if((have_plan && !no_plan) && e_tests < test_count) {
219 _diag("Looks like you planned %d tests but ran %d extra.",
220 e_tests, test_count - e_tests);
225 if((have_plan || !no_plan) && e_tests > test_count) {
226 _diag("Looks like you planned %d tests but only ran %d.",
227 e_tests, test_count);
229 _diag("Looks like you failed %d tests of %d run.",
230 failures, test_count);
237 _diag("Looks like you failed %d tests of %d.",
238 failures, test_count);
244 * Initialise the TAP library. Will only do so once, however many times it's
250 static int run_once = 0;
256 /* stdout needs to be unbuffered so that the output appears
257 in the same place relative to stderr output as it does
258 with Test::Harness */
265 * Note that there's no plan.
276 fprintf(stderr, "You tried to plan twice!\n");
289 * Note that the plan is to skip all tests
292 plan_skip_all(char *reason)
304 printf(" # Skip %s", reason);
312 * Note the number of tests that will be run.
315 plan_tests(unsigned int tests)
323 fprintf(stderr, "You tried to plan twice!\n");
330 fprintf(stderr, "You said to run 0 tests! You've got to run something.\n");
338 _expected_tests(tests);
358 skip(unsigned int n, char *fmt, ...)
366 vasprintf(&skip_msg, fmt, ap);
371 printf("ok %d # skip %s\n", test_count,
373 skip_msg : "libtap():malloc() failed");
382 todo_start(char *fmt, ...)
389 vasprintf(&todo_msg, fmt, ap);
416 /* If there's no plan, just return the number of failures */
417 if(no_plan || !have_plan) {
422 /* Ran too many tests? Return the number of tests that were run
423 that shouldn't have been */
424 if(e_tests < test_count) {
425 r = test_count - e_tests;
430 /* Return the number of tests that failed + the number of tests
432 r = failures + e_tests - test_count;