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 const 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.
50 If you have multiple threads calling ok() etc. at the same time you would
51 need this, but in that case your test numbers will be random and I'm not
52 sure it makes sense. --RR
56 static pthread_mutex_t M = PTHREAD_MUTEX_INITIALIZER;
57 # define LOCK pthread_mutex_lock(&M)
58 # define UNLOCK pthread_mutex_unlock(&M)
65 _expected_tests(unsigned int tests)
68 printf("1..%d\n", tests);
73 diagv(const char *fmt, va_list ap)
76 vfprintf(stdout, fmt, ap);
81 _diag(const char *fmt, ...)
90 * Generate a test result.
92 * ok -- boolean, indicates whether or not the test passed.
93 * test_name -- the name of the test, may be NULL
94 * test_comment -- a comment to print afterwards, may be NULL
97 _gen_result(int ok, const char *func, const char *file, unsigned int line,
98 const char *test_name, ...)
101 char *local_test_name = NULL;
109 /* Start by taking the test name and performing any printf()
111 if(test_name != NULL) {
112 va_start(ap, test_name);
113 if (vasprintf(&local_test_name, test_name, ap) < 0)
114 local_test_name = NULL;
117 /* Make sure the test name contains more than digits
118 and spaces. Emit an error message and exit if it
120 if(local_test_name) {
122 for(c = local_test_name; *c != '\0'; c++) {
123 if(!isdigit((unsigned char)*c)
124 && !isspace((unsigned char)*c)) {
131 _diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name);
132 _diag(" Very confusing.");
142 printf("ok %d", test_count);
144 if(test_name != NULL) {
147 /* Print the test name, escaping any '#' characters it
149 if(local_test_name != NULL) {
151 for(c = local_test_name; *c != '\0'; c++) {
154 fputc((int)*c, stdout);
157 } else { /* vasprintf() failed, use a fixed message */
158 printf("%s", todo_msg_fixed);
162 /* If we're in a todo_start() block then flag the test as being
163 TODO. todo_msg should contain the message to print at this
164 point. If it's NULL then asprintf() failed, and we should
165 use the fixed message.
167 This is not counted as a failure, so decrement the counter if
170 printf(" # TODO %s", todo_msg ? todo_msg : todo_msg_fixed);
178 _diag(" Failed %stest (%s:%s() at line %d)",
179 todo ? "(TODO) " : "", file, func, line);
181 free(local_test_name);
185 if (!ok && tap_fail_callback)
188 /* We only care (when testing) that ok is positive, but here we
189 specifically only want to return 1 or 0 */
194 * Cleanup at the end of the run, produce any final output that might be
200 /* If we forked, don't do cleanup in child! */
201 if (getpid() != test_pid)
206 /* If plan_no_plan() wasn't called, and we don't have a plan,
207 and we're not skipping everything, then something happened
208 before we could produce any output */
209 if(!no_plan && !have_plan && !skip_all) {
210 _diag("Looks like your test died before it could output anything.");
216 _diag("Looks like your test died just after %d.", test_count);
222 /* No plan provided, but now we know how many tests were run, and can
223 print the header at the end */
224 if(!skip_all && (no_plan || !have_plan)) {
225 printf("1..%d\n", test_count);
228 if((have_plan && !no_plan) && e_tests < test_count) {
229 _diag("Looks like you planned %d tests but ran %d extra.",
230 e_tests, test_count - e_tests);
235 if((have_plan || !no_plan) && e_tests > test_count) {
236 _diag("Looks like you planned %d tests but only ran %d.",
237 e_tests, test_count);
239 _diag("Looks like you failed %d tests of %d run.",
240 failures, test_count);
247 _diag("Looks like you failed %d tests of %d.",
248 failures, test_count);
254 * Initialise the TAP library. Will only do so once, however many times it's
260 static int run_once = 0;
266 /* stdout needs to be unbuffered so that the output appears
267 in the same place relative to stderr output as it does
268 with Test::Harness */
269 // setbuf(stdout, 0);
275 * Note that there's no plan.
286 fprintf(stderr, "You tried to plan twice!\n");
299 * Note that the plan is to skip all tests
302 plan_skip_all(const char *reason)
314 printf(" # Skip %s", reason);
322 * Note the number of tests that will be run.
325 plan_tests(unsigned int tests)
333 fprintf(stderr, "You tried to plan twice!\n");
340 fprintf(stderr, "You said to run 0 tests! You've got to run something.\n");
348 _expected_tests(tests);
354 diag(const char *fmt, ...)
368 skip(unsigned int n, const char *fmt, ...)
376 if (vasprintf(&skip_msg, fmt, ap) < 0)
382 printf("ok %d # skip %s\n", test_count,
384 skip_msg : "libtap():malloc() failed");
393 todo_start(const char *fmt, ...)
400 if (vasprintf(&todo_msg, fmt, ap) < 0)
428 /* If there's no plan, just return the number of failures */
429 if(no_plan || !have_plan) {
434 /* Ran too many tests? Return the number of tests that were run
435 that shouldn't have been */
436 if(e_tests < test_count) {
437 r = test_count - e_tests;
442 /* Return the number of tests that failed + the number of tests
444 r = failures + e_tests - test_count;
453 int r = exit_status_();