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)
58 _expected_tests(unsigned int tests)
61 printf("1..%d\n", tests);
66 diagv(char *fmt, va_list ap)
69 vfprintf(stderr, fmt, ap);
83 * Generate a test result.
85 * ok -- boolean, indicates whether or not the test passed.
86 * test_name -- the name of the test, may be NULL
87 * test_comment -- a comment to print afterwards, may be NULL
90 _gen_result(int ok, const char *func, char *file, unsigned int line,
94 char *local_test_name = NULL;
102 /* Start by taking the test name and performing any printf()
104 if(test_name != NULL) {
105 va_start(ap, test_name);
106 vasprintf(&local_test_name, test_name, ap);
109 /* Make sure the test name contains more than digits
110 and spaces. Emit an error message and exit if it
112 if(local_test_name) {
114 for(c = local_test_name; *c != '\0'; c++) {
115 if(!isdigit(*c) && !isspace(*c)) {
122 _diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name);
123 _diag(" Very confusing.");
133 printf("ok %d", test_count);
135 if(test_name != NULL) {
138 /* Print the test name, escaping any '#' characters it
140 if(local_test_name != NULL) {
142 for(c = local_test_name; *c != '\0'; c++) {
145 fputc((int)*c, stdout);
148 } else { /* vasprintf() failed, use a fixed message */
149 printf("%s", todo_msg_fixed);
153 /* If we're in a todo_start() block then flag the test as being
154 TODO. todo_msg should contain the message to print at this
155 point. If it's NULL then asprintf() failed, and we should
156 use the fixed message.
158 This is not counted as a failure, so decrement the counter if
161 printf(" # TODO %s", todo_msg ? todo_msg : todo_msg_fixed);
169 _diag(" Failed %stest (%s:%s() at line %d)",
170 todo ? "(TODO) " : "", file, func, line);
172 free(local_test_name);
176 /* We only care (when testing) that ok is positive, but here we
177 specifically only want to return 1 or 0 */
182 * Cleanup at the end of the run, produce any final output that might be
191 /* If plan_no_plan() wasn't called, and we don't have a plan,
192 and we're not skipping everything, then something happened
193 before we could produce any output */
194 if(!no_plan && !have_plan && !skip_all) {
195 _diag("Looks like your test died before it could output anything.");
201 _diag("Looks like your test died just after %d.", test_count);
207 /* No plan provided, but now we know how many tests were run, and can
208 print the header at the end */
209 if(!skip_all && (no_plan || !have_plan)) {
210 printf("1..%d\n", test_count);
213 if((have_plan && !no_plan) && e_tests < test_count) {
214 _diag("Looks like you planned %d tests but ran %d extra.",
215 e_tests, test_count - e_tests);
220 if((have_plan || !no_plan) && e_tests > test_count) {
221 _diag("Looks like you planned %d tests but only ran %d.",
222 e_tests, test_count);
224 _diag("Looks like you failed %d tests of %d run.",
225 failures, test_count);
232 _diag("Looks like you failed %d tests of %d.",
233 failures, test_count);
239 * Initialise the TAP library. Will only do so once, however many times it's
245 static int run_once = 0;
250 /* stdout needs to be unbuffered so that the output appears
251 in the same place relative to stderr output as it does
252 with Test::Harness */
259 * Note that there's no plan.
270 fprintf(stderr, "You tried to plan twice!\n");
283 * Note that the plan is to skip all tests
286 plan_skip_all(char *reason)
298 printf(" # Skip %s", reason);
306 * Note the number of tests that will be run.
309 plan_tests(unsigned int tests)
317 fprintf(stderr, "You tried to plan twice!\n");
324 fprintf(stderr, "You said to run 0 tests! You've got to run something.\n");
332 _expected_tests(tests);
352 skip(unsigned int n, char *fmt, ...)
360 vasprintf(&skip_msg, fmt, ap);
365 printf("ok %d # skip %s\n", test_count,
367 skip_msg : "libtap():malloc() failed");
376 todo_start(char *fmt, ...)
383 vasprintf(&todo_msg, fmt, ap);
410 /* If there's no plan, just return the number of failures */
411 if(no_plan || !have_plan) {
416 /* Ran too many tests? Return the number of tests that were run
417 that shouldn't have been */
418 if(e_tests < test_count) {
419 r = test_count - e_tests;
424 /* Return the number of tests that failed + the number of tests
426 r = failures + e_tests - test_count;