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;
46 void (*tap_fail_callback)(void) = NULL;
48 /* Encapsulate the pthread code in a conditional. In the absence of
49 libpthread the code does nothing.
51 If you have multiple threads calling ok() etc. at the same time you would
52 need this, but in that case your test numbers will be random and I'm not
53 sure it makes sense. --RR
57 static pthread_mutex_t M = PTHREAD_MUTEX_INITIALIZER;
58 # define LOCK pthread_mutex_lock(&M)
59 # define UNLOCK pthread_mutex_unlock(&M)
66 _expected_tests(unsigned int tests)
69 printf("1..%d\n", tests);
74 diagv(const char *fmt, va_list ap)
77 vfprintf(stdout, fmt, ap);
82 _diag(const char *fmt, ...)
91 * Generate a test result.
93 * ok -- boolean, indicates whether or not the test passed.
94 * test_name -- the name of the test, may be NULL
95 * test_comment -- a comment to print afterwards, may be NULL
98 _gen_result(int ok, const char *func, const char *file, unsigned int line,
99 const char *test_name, ...)
102 char *local_test_name = NULL;
110 /* Start by taking the test name and performing any printf()
112 if(test_name != NULL) {
113 va_start(ap, test_name);
114 if (vasprintf(&local_test_name, test_name, ap) < 0)
115 local_test_name = NULL;
118 /* Make sure the test name contains more than digits
119 and spaces. Emit an error message and exit if it
121 if(local_test_name) {
123 for(c = local_test_name; *c != '\0'; c++) {
124 if(!isdigit((unsigned char)*c)
125 && !isspace((unsigned char)*c)) {
132 _diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name);
133 _diag(" Very confusing.");
143 printf("ok %d", test_count);
145 if(test_name != NULL) {
148 /* Print the test name, escaping any '#' characters it
150 if(local_test_name != NULL) {
152 for(c = local_test_name; *c != '\0'; c++) {
155 fputc((int)*c, stdout);
158 } else { /* vasprintf() failed, use a fixed message */
159 printf("%s", todo_msg_fixed);
163 /* If we're in a todo_start() block then flag the test as being
164 TODO. todo_msg should contain the message to print at this
165 point. If it's NULL then asprintf() failed, and we should
166 use the fixed message.
168 This is not counted as a failure, so decrement the counter if
171 printf(" # TODO %s", todo_msg ? todo_msg : todo_msg_fixed);
179 _diag(" Failed %stest (%s:%s() at line %d)",
180 todo ? "(TODO) " : "", file, func, line);
182 free(local_test_name);
186 if (!ok && tap_fail_callback)
189 /* We only care (when testing) that ok is positive, but here we
190 specifically only want to return 1 or 0 */
195 * Cleanup at the end of the run, produce any final output that might be
201 /* If we forked, don't do cleanup in child! */
202 if (getpid() != test_pid)
207 /* If plan_no_plan() wasn't called, and we don't have a plan,
208 and we're not skipping everything, then something happened
209 before we could produce any output */
210 if(!no_plan && !have_plan && !skip_all) {
211 _diag("Looks like your test died before it could output anything.");
217 _diag("Looks like your test died just after %d.", test_count);
223 /* No plan provided, but now we know how many tests were run, and can
224 print the header at the end */
225 if(!skip_all && (no_plan || !have_plan)) {
226 printf("1..%d\n", test_count);
229 if((have_plan && !no_plan) && e_tests < test_count) {
230 _diag("Looks like you planned %d tests but ran %d extra.",
231 e_tests, test_count - e_tests);
236 if((have_plan || !no_plan) && e_tests > test_count) {
237 _diag("Looks like you planned %d tests but only ran %d.",
238 e_tests, test_count);
240 _diag("Looks like you failed %d tests of %d run.",
241 failures, test_count);
248 _diag("Looks like you failed %d tests of %d.",
249 failures, test_count);
255 * Initialise the TAP library. Will only do so once, however many times it's
261 static int run_once = 0;
267 /* stdout needs to be unbuffered so that the output appears
268 in the same place relative to stderr output as it does
269 with Test::Harness */
270 // setbuf(stdout, 0);
276 * Note that there's no plan.
287 fprintf(stderr, "You tried to plan twice!\n");
300 * Note that the plan is to skip all tests
303 plan_skip_all(const char *reason)
315 printf(" # Skip %s", reason);
323 * Note the number of tests that will be run.
326 plan_tests(unsigned int tests)
334 fprintf(stderr, "You tried to plan twice!\n");
341 fprintf(stderr, "You said to run 0 tests! You've got to run something.\n");
349 _expected_tests(tests);
355 diag(const char *fmt, ...)
369 skip(unsigned int n, const char *fmt, ...)
377 if (vasprintf(&skip_msg, fmt, ap) < 0)
383 printf("ok %d # skip %s\n", test_count,
385 skip_msg : "libtap():malloc() failed");
394 todo_start(const char *fmt, ...)
401 if (vasprintf(&todo_msg, fmt, ap) < 0)
429 /* If there's no plan, just return the number of failures */
430 if(no_plan || !have_plan) {
435 /* Ran too many tests? Return the number of tests that were run
436 that shouldn't have been */
437 if(e_tests < test_count) {
438 r = test_count - e_tests;
443 /* Return the number of tests that failed + the number of tests
445 r = failures + e_tests - test_count;
454 int r = exit_status_();