2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (C) 2004 Nik Clayton
5 * Copyright (C) 2017 Jérémie Galarneau
18 static int no_plan
= 0;
19 static int skip_all
= 0;
20 static int have_plan
= 0;
21 static unsigned int test_count
= 0; /* Number of tests that have been run */
22 static unsigned int e_tests
= 0; /* Expected number of tests to run */
23 static unsigned int failures
= 0; /* Number of tests that failed */
24 static char *todo_msg
= NULL
;
25 static const char *todo_msg_fixed
= "libtap malloc issue";
27 static int test_died
= 0;
28 static int tap_is_disabled
= 0;
30 /* Encapsulate the pthread code in a conditional. In the absence of
31 libpthread the code does nothing */
32 #ifdef HAVE_LIBPTHREAD
34 static pthread_mutex_t M
= PTHREAD_MUTEX_INITIALIZER
;
35 # define LOCK pthread_mutex_lock(&M);
36 # define UNLOCK pthread_mutex_unlock(&M);
42 static void _expected_tests(unsigned int);
43 static void _tap_init(void);
44 static void _cleanup(void);
48 void flockfile (FILE * filehandle
) {
53 void funlockfile(FILE * filehandle
) {
59 * Generate a test result.
61 * ok -- boolean, indicates whether or not the test passed.
62 * test_name -- the name of the test, may be NULL
63 * test_comment -- a comment to print afterwards, may be NULL
66 _gen_result(int ok
, const char *func
, const char *file
, unsigned int line
,
67 const char *test_name
, ...)
70 char *local_test_name
= NULL
;
78 /* Start by taking the test name and performing any printf()
80 if(test_name
!= NULL
) {
81 va_start(ap
, test_name
);
82 if (vasprintf(&local_test_name
, test_name
, ap
) == -1) {
83 local_test_name
= NULL
;
87 /* Make sure the test name contains more than digits
88 and spaces. Emit an error message and exit if it
92 for(c
= local_test_name
; *c
!= '\0'; c
++) {
93 if(!isdigit((unsigned char) *c
) && !isspace((unsigned char) *c
)) {
100 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
101 diag(" Very confusing.");
111 printf("ok %d", test_count
);
113 if(test_name
!= NULL
) {
116 /* Print the test name, escaping any '#' characters it
118 if(local_test_name
!= NULL
) {
120 for(c
= local_test_name
; *c
!= '\0'; c
++) {
123 fputc((int)*c
, stdout
);
126 } else { /* vasprintf() failed, use a fixed message */
127 printf("%s", todo_msg_fixed
);
131 /* If we're in a todo_start() block then flag the test as being
132 TODO. todo_msg should contain the message to print at this
133 point. If it's NULL then asprintf() failed, and we should
134 use the fixed message.
136 This is not counted as a failure, so decrement the counter if
139 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
147 if(getenv("HARNESS_ACTIVE") != NULL
)
150 diag(" Failed %stest (%s:%s() at line %d)",
151 todo
? "(TODO) " : "", file
, func
, line
);
153 free(local_test_name
);
157 /* We only care (when testing) that ok is positive, but here we
158 specifically only want to return 1 or 0 */
163 * Initialise the TAP library. Will only do so once, however many times it's
169 static int run_once
= 0;
174 /* stdout needs to be unbuffered so that the output appears
175 in the same place relative to stderr output as it does
176 with Test::Harness */
183 * Note that there's no plan.
194 fprintf(stderr
, "You tried to plan twice!\n");
209 * Note that the plan is to skip all tests
212 plan_skip_all(const char *reason
)
224 printf(" # Skip %s", reason
);
234 * Note the number of tests that will be run.
237 plan_tests(unsigned int tests
)
245 fprintf(stderr
, "You tried to plan twice!\n");
252 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
260 _expected_tests(tests
);
268 diag(const char *fmt
, ...)
275 vfprintf(stderr
, fmt
, ap
);
291 rdiag(const char *fmt
, ...)
296 vfprintf(stderr
, fmt
, ap
);
310 diag_multiline(const char *val
)
312 size_t len
, i
, line_start_idx
= 0;
317 for (i
= 0; i
< len
; i
++) {
320 if (val
[i
] != '\n') {
324 assert((i
- line_start_idx
+ 1) <= INT_MAX
);
325 line_length
= i
- line_start_idx
+ 1;
326 fprintf(stderr
, "# %.*s", line_length
, &val
[line_start_idx
]);
327 line_start_idx
= i
+ 1;
332 _expected_tests(unsigned int tests
)
335 printf("1..%d\n", tests
);
340 skip(unsigned int n
, const char *fmt
, ...)
343 char *skip_msg
= NULL
;
348 if (vasprintf(&skip_msg
, fmt
, ap
) == -1) {
355 printf("ok %d # skip %s\n", test_count
,
357 skip_msg
: "libtap():malloc() failed");
368 todo_start(const char *fmt
, ...)
375 if (vasprintf(&todo_msg
, fmt
, ap
) == -1) {
404 /* If there's no plan, just return the number of failures */
405 if(no_plan
|| !have_plan
) {
410 /* Ran too many tests? Return the number of tests that were run
411 that shouldn't have been */
412 if(e_tests
< test_count
) {
413 r
= test_count
- e_tests
;
418 /* Return the number of tests that failed + the number of tests
420 r
= failures
+ e_tests
- test_count
;
427 * Cleanup at the end of the run, produce any final output that might be
436 if (tap_is_disabled
) {
441 /* If plan_no_plan() wasn't called, and we don't have a plan,
442 and we're not skipping everything, then something happened
443 before we could produce any output */
444 if(!no_plan
&& !have_plan
&& !skip_all
) {
445 diag("Looks like your test died before it could output anything.");
451 diag("Looks like your test died just after %d.", test_count
);
457 /* No plan provided, but now we know how many tests were run, and can
458 print the header at the end */
459 if(!skip_all
&& (no_plan
|| !have_plan
)) {
460 printf("1..%d\n", test_count
);
463 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
464 diag("Looks like you planned %d %s but ran %d extra.",
465 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
- e_tests
);
470 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
471 diag("Looks like you planned %d %s but only ran %d.",
472 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
);
478 diag("Looks like you failed %d %s of %d.",
479 failures
, failures
== 1 ? "test" : "tests", test_count
);
484 /* Disable tap for this process. */