2 * SPDX-License-Identifier: BSD-2-Clause
3 * SPDX-FileCopyrightText: 2004 Nik Clayton
4 * SPDX-FileCopyrightText: 2017 Jérémie Galarneau
17 static int no_plan
= 0;
18 static int skip_all
= 0;
19 static int have_plan
= 0;
20 static unsigned int test_count
= 0; /* Number of tests that have been run */
21 static unsigned int e_tests
= 0; /* Expected number of tests to run */
22 static unsigned int failures
= 0; /* Number of tests that failed */
23 static char *todo_msg
= NULL
;
24 static const char *todo_msg_fixed
= "libtap malloc issue";
26 static int test_died
= 0;
28 /* Encapsulate the pthread code in a conditional. In the absence of
29 libpthread the code does nothing */
30 #ifdef HAVE_LIBPTHREAD
32 static pthread_mutex_t M
= PTHREAD_MUTEX_INITIALIZER
;
33 # define LOCK pthread_mutex_lock(&M);
34 # define UNLOCK pthread_mutex_unlock(&M);
40 static void _expected_tests(unsigned int);
41 static void _tap_init(void);
42 static void _cleanup(void);
46 void flockfile (FILE * filehandle
) {
51 void funlockfile(FILE * filehandle
) {
57 * Generate a test result.
59 * ok -- boolean, indicates whether or not the test passed.
60 * test_name -- the name of the test, may be NULL
61 * test_comment -- a comment to print afterwards, may be NULL
64 _gen_result(int ok
, const char *func
, const char *file
, unsigned int line
,
65 const char *test_name
, ...)
68 char *local_test_name
= NULL
;
76 /* Start by taking the test name and performing any printf()
78 if(test_name
!= NULL
) {
79 va_start(ap
, test_name
);
80 if (vasprintf(&local_test_name
, test_name
, ap
) == -1) {
81 local_test_name
= NULL
;
85 /* Make sure the test name contains more than digits
86 and spaces. Emit an error message and exit if it
90 for(c
= local_test_name
; *c
!= '\0'; c
++) {
91 if(!isdigit((unsigned char) *c
) && !isspace((unsigned char) *c
)) {
98 diag(" You named your test '%s'. You shouldn't use numbers for your test names.", local_test_name
);
99 diag(" Very confusing.");
109 printf("ok %d", test_count
);
111 if(test_name
!= NULL
) {
114 /* Print the test name, escaping any '#' characters it
116 if(local_test_name
!= NULL
) {
118 for(c
= local_test_name
; *c
!= '\0'; c
++) {
121 fputc((int)*c
, stdout
);
124 } else { /* vasprintf() failed, use a fixed message */
125 printf("%s", todo_msg_fixed
);
129 /* If we're in a todo_start() block then flag the test as being
130 TODO. todo_msg should contain the message to print at this
131 point. If it's NULL then asprintf() failed, and we should
132 use the fixed message.
134 This is not counted as a failure, so decrement the counter if
137 printf(" # TODO %s", todo_msg
? todo_msg
: todo_msg_fixed
);
145 if(getenv("HARNESS_ACTIVE") != NULL
)
148 diag(" Failed %stest (%s:%s() at line %d)",
149 todo
? "(TODO) " : "", file
, func
, line
);
151 free(local_test_name
);
155 /* We only care (when testing) that ok is positive, but here we
156 specifically only want to return 1 or 0 */
161 * Initialise the TAP library. Will only do so once, however many times it's
167 static int run_once
= 0;
172 /* stdout needs to be unbuffered so that the output appears
173 in the same place relative to stderr output as it does
174 with Test::Harness */
181 * Note that there's no plan.
192 fprintf(stderr
, "You tried to plan twice!\n");
207 * Note that the plan is to skip all tests
210 plan_skip_all(const char *reason
)
222 printf(" # Skip %s", reason
);
232 * Note the number of tests that will be run.
235 plan_tests(unsigned int tests
)
243 fprintf(stderr
, "You tried to plan twice!\n");
250 fprintf(stderr
, "You said to run 0 tests! You've got to run something.\n");
258 _expected_tests(tests
);
266 diag(const char *fmt
, ...)
273 vfprintf(stderr
, fmt
, ap
);
282 diag_multiline(const char *val
)
284 size_t len
, i
, line_start_idx
= 0;
289 for (i
= 0; i
< len
; i
++) {
292 if (val
[i
] != '\n') {
296 assert((i
- line_start_idx
+ 1) <= INT_MAX
);
297 line_length
= i
- line_start_idx
+ 1;
298 fprintf(stderr
, "# %.*s", line_length
, &val
[line_start_idx
]);
299 line_start_idx
= i
+ 1;
304 _expected_tests(unsigned int tests
)
307 printf("1..%d\n", tests
);
312 skip(unsigned int n
, const char *fmt
, ...)
315 char *skip_msg
= NULL
;
320 if (vasprintf(&skip_msg
, fmt
, ap
) == -1) {
327 printf("ok %d # skip %s\n", test_count
,
329 skip_msg
: "libtap():malloc() failed");
340 todo_start(const char *fmt
, ...)
347 if (vasprintf(&todo_msg
, fmt
, ap
) == -1) {
376 /* If there's no plan, just return the number of failures */
377 if(no_plan
|| !have_plan
) {
382 /* Ran too many tests? Return the number of tests that were run
383 that shouldn't have been */
384 if(e_tests
< test_count
) {
385 r
= test_count
- e_tests
;
390 /* Return the number of tests that failed + the number of tests
392 r
= failures
+ e_tests
- test_count
;
399 * Cleanup at the end of the run, produce any final output that might be
408 /* If plan_no_plan() wasn't called, and we don't have a plan,
409 and we're not skipping everything, then something happened
410 before we could produce any output */
411 if(!no_plan
&& !have_plan
&& !skip_all
) {
412 diag("Looks like your test died before it could output anything.");
418 diag("Looks like your test died just after %d.", test_count
);
424 /* No plan provided, but now we know how many tests were run, and can
425 print the header at the end */
426 if(!skip_all
&& (no_plan
|| !have_plan
)) {
427 printf("1..%d\n", test_count
);
430 if((have_plan
&& !no_plan
) && e_tests
< test_count
) {
431 diag("Looks like you planned %d %s but ran %d extra.",
432 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
- e_tests
);
437 if((have_plan
|| !no_plan
) && e_tests
> test_count
) {
438 diag("Looks like you planned %d %s but only ran %d.",
439 e_tests
, e_tests
== 1 ? "test" : "tests", test_count
);
445 diag("Looks like you failed %d %s of %d.",
446 failures
, failures
== 1 ? "test" : "tests", test_count
);