cbe2952210223ce6dc46f9d42da2cb2f60263d1b
2 # Copyright (C) 2011-2013 Free Software Foundation, Inc.
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 2, or (at your option)
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # As a special exception to the GNU General Public License, if you
18 # distribute this file as part of a program that contains a
19 # configuration script generated by Autoconf, you may include it under
20 # the same distribution terms that you use for the rest of that program.
22 # This file is maintained in Automake, please report
23 # bugs to <bug-automake@gnu.org> or send patches to
24 # <automake-patches@gnu.org>.
26 scriptversion
=2013-12-23.17
; # UTC
28 # Make unconditional expansion of undefined variables an error. This
29 # helps a lot in preventing typo-related bugs.
36 echo "$me: fatal: $*" >&2
51 tap-driver.sh --test-name=NAME --log-file=PATH --trs-file=PATH
52 [--expect-failure={yes|no}] [--color-tests={yes|no}]
53 [--enable-hard-errors={yes|no}] [--ignore-exit]
54 [--diagnostic-string=STRING] [--merge|--no-merge]
55 [--comments|--no-comments] [--post-script] [--] TEST-COMMAND
56 The '--test-name', '-log-file' and '--trs-file' options are mandatory.
60 # TODO: better error handling in option parsing (in particular, ensure
61 # TODO: $log_file, $trs_file and $test_name are defined).
62 test_name
= # Used for reporting.
63 log_file
= # Where to save the result and output of the test script.
64 trs_file
= # Where to save the metadata of the test run.
65 post_script
= # Script to be run after the test.
72 while test $# -gt 0; do
74 --help) print_usage
; exit $?
;;
75 --version) echo "$me $scriptversion"; exit $?
;;
76 --test-name) test_name
=$2; shift;;
77 --log-file) log_file
=$2; shift;;
78 --trs-file) trs_file
=$2; shift;;
79 --color-tests) color_tests
=$2; shift;;
80 --expect-failure) expect_failure
=$2; shift;;
81 --enable-hard-errors) shift;; # No-op.
84 --ignore-exit) ignore_exit
=1;;
85 --comments) comments
=1;;
86 --no-comments) comments
=0;;
87 --diagnostic-string) diag_string
=$2; shift;;
88 --post-script) post_script
=$2; shift;;
90 -*) usage_error
"invalid option: '$1'";;
95 test $# -gt 0 || usage_error
"missing test command"
97 case $expect_failure in
98 yes) expect_failure
=1;;
102 if test $color_tests = yes; then
104 color_map["red"]="\e[0;31m" # Red.
105 color_map["grn"]="\e[0;32m" # Green.
106 color_map["lgn"]="\e[1;32m" # Light green.
107 color_map["blu"]="\e[1;34m" # Blue.
108 color_map["mgn"]="\e[0;35m" # Magenta.
109 color_map["std"]="\e[m" # No color.
110 color_for_result["ERROR"] = "mgn"
111 color_for_result["PASS"] = "grn"
112 color_for_result["XPASS"] = "red"
113 color_for_result["FAIL"] = "red"
114 color_for_result["XFAIL"] = "lgn"
115 color_for_result["SKIP"] = "blu"'
120 # :; is there to work around a bug in bash 3.2 (and earlier) which
121 # does not always set '$?' properly on redirection failure.
122 # See the Autoconf manual for more details.
125 # Ignore common signals (in this subshell only!), to avoid potential
126 # problems with Korn shells. Some Korn shells are known to propagate
127 # to themselves signals that have killed a child process they were
128 # waiting for; this is done at least for SIGINT (and usually only for
129 # it, in truth). Without the `trap' below, such a behaviour could
130 # cause a premature exit in the current subshell, e.g., in case the
131 # test command it runs gets terminated by a SIGINT. Thus, the awk
132 # script we are piping into would never seen the exit status it
133 # expects on its last input line (which is displayed below by the
134 # last `echo $?' statement), and would thus die reporting an internal
136 # For more information, see the Autoconf manual and the threads:
137 # <http://lists.gnu.org/archive/html/bug-autoconf/2011-09/msg00004.html>
138 # <http://mail.opensolaris.org/pipermail/ksh93-integration-discuss/2009-February/004121.html>
140 if test $merge -gt 0; then
147 ) | LC_ALL
=C
${AM_TAP_AWK-awk} \
149 -v test_script_name
="$test_name" \
150 -v log_file
="$log_file" \
151 -v trs_file
="$trs_file" \
152 -v expect_failure
="$expect_failure" \
154 -v ignore_exit
="$ignore_exit" \
155 -v comments
="$comments" \
156 -v diag_string
="$diag_string" \
158 # TODO: the usages of "cat >&3" below could be optimized when using
159 # GNU awk, and/on on systems that supports /dev/fd/.
161 # Implementation note: in what follows, `result_obj` will be an
162 # associative array that (partly) simulates a TAP result object
163 # from the `TAP::Parser` perl module.
171 print me ": " msg | "cat >&2"
175 function abort(where)
177 fatal("internal error " where)
180 # Convert a boolean to a "yes"/"no" string.
183 return bool ? "yes" : "no";
186 function add_test_result(result)
188 if (!test_results_index)
189 test_results_index = 0
190 test_results_list[test_results_index] = result
191 test_results_index += 1
192 test_results_seen[result] = 1;
195 # Whether the test script should be re-run by "make recheck".
196 function must_recheck()
198 for (k in test_results_seen)
199 if (k != "XFAIL" && k != "PASS" && k != "SKIP")
204 # Whether the content of the log file associated to this test should
205 # be copied into the "global" test-suite.log.
206 function copy_in_global_log()
208 for (k in test_results_seen)
214 function gettime_ns( r, cmd)
218 if (cmd | getline r) {
222 return sprintf("%f", r)
225 function get_global_test_result()
227 if ("ERROR" in test_results_seen)
229 if ("FAIL" in test_results_seen || "XPASS" in test_results_seen)
232 for (k in test_results_seen)
240 function stringify_result_obj(result_obj)
242 if (result_obj["is_unplanned"] || result_obj["number"] != testno)
245 if (plan_seen == LATE_PLAN)
248 if (result_obj["directive"] == "TODO")
249 return result_obj["is_ok"] ? "XPASS" : "XFAIL"
251 if (result_obj["directive"] == "SKIP")
252 return result_obj["is_ok"] ? "SKIP" : COOKED_FAIL;
254 if (length(result_obj["directive"]))
255 abort("in function stringify_result_obj()")
257 return result_obj["is_ok"] ? COOKED_PASS : COOKED_FAIL
260 function decorate_result(result)
262 color_name = color_for_result[result]
264 return color_map[color_name] "" result "" color_map["std"]
265 # If we are not using colorized output, or if we do not know how
266 # to colorize the given result, we should return it unchanged.
270 function report(result, details)
272 if (result ~ /^(X?(PASS|FAIL)|SKIP|ERROR)/)
274 msg = ": " test_script_name
275 add_test_result(result)
277 else if (result == "#")
279 msg = " " test_script_name ":"
283 abort("in function report()")
286 msg = msg " " details
287 # Output on console might be colorized.
288 print decorate_result(result) msg
289 # Flush stdout after each test result, this is useful when stdout
290 # is buffered, for example in a CI system.
292 # Log the result in the log file too, to help debugging (this is
293 # especially true when said result is a TAP error or "Bail out!").
294 print result msg | "cat >&3";
297 function testsuite_error(error_message)
299 report("ERROR", "- " error_message)
302 function handle_tap_result()
304 details = result_obj["number"];
305 if (length(result_obj["description"]))
306 details = details " " result_obj["description"]
308 if (plan_seen == LATE_PLAN)
310 details = details " # AFTER LATE PLAN";
312 else if (result_obj["is_unplanned"])
314 details = details " # UNPLANNED";
316 else if (result_obj["number"] != testno)
318 details = sprintf("%s # OUT-OF-ORDER (expecting %d)",
321 else if (result_obj["directive"])
323 details = details " # " result_obj["directive"];
324 if (length(result_obj["explanation"]))
325 details = details " " result_obj["explanation"]
328 report(stringify_result_obj(result_obj), details)
331 # `skip_reason` should be empty whenever planned > 0.
332 function handle_tap_plan(planned, skip_reason)
334 planned += 0 # Avoid getting confused if, say, `planned` is "00"
335 if (length(skip_reason) && planned > 0)
336 abort("in function handle_tap_plan()")
339 # Error, only one plan per stream is acceptable.
340 testsuite_error("multiple test plans")
343 planned_tests = planned
344 # The TAP plan can come before or after *all* the TAP results; we speak
345 # respectively of an "early" or a "late" plan. If we see the plan line
346 # after at least one TAP result has been seen, assume we have a late
347 # plan; in this case, any further test result seen after the plan will
348 # be flagged as an error.
349 plan_seen = (testno >= 1 ? LATE_PLAN : EARLY_PLAN)
350 # If testno > 0, we have an error ("too many tests run") that will be
351 # automatically dealt with later, so do not worry about it here. If
352 # $plan_seen is true, we have an error due to a repeated plan, and that
353 # has already been dealt with above. Otherwise, we have a valid "plan
354 # with SKIP" specification, and should report it as a particular kind
356 if (planned == 0 && testno == 0)
358 if (length(skip_reason))
359 skip_reason = "- " skip_reason;
360 report("SKIP", skip_reason);
364 function extract_tap_comment(line)
366 if (index(line, diag_string) == 1)
368 # Strip leading `diag_string` from `line`.
369 line = substr(line, length(diag_string) + 1)
370 # And strip any leading and trailing whitespace left.
371 sub("^[ \t]*", "", line)
372 sub("[ \t]*$", "", line)
373 # Return what is left (if any).
379 # When this function is called, we know that line is a TAP result line,
380 # so that it matches the (perl) RE "^(not )?ok\b".
381 function setup_result_obj(line)
383 # Get the result, and remove it from the line.
384 result_obj["is_ok"] = (substr(line, 1, 2) == "ok" ? 1 : 0)
385 sub("^(not )?ok[ \t]*", "", line)
387 # If the result has an explicit number, get it and strip it; otherwise,
388 # automatically assing the next progresive number to it.
389 if (line ~ /^[0-9]+$/ || line ~ /^[0-9]+[^a-zA-Z0-9_]/)
391 match(line, "^[0-9]+")
392 # The final `+ 0` is to normalize numbers with leading zeros.
393 result_obj["number"] = substr(line, 1, RLENGTH) + 0
394 line = substr(line, RLENGTH + 1)
398 result_obj["number"] = testno
401 if (plan_seen == LATE_PLAN)
402 # No further test results are acceptable after a "late" TAP plan
404 result_obj["is_unplanned"] = 1
405 else if (plan_seen && testno > planned_tests)
406 result_obj["is_unplanned"] = 1
408 result_obj["is_unplanned"] = 0
410 # Strip trailing and leading whitespace.
411 sub("^[ \t]*", "", line)
412 sub("[ \t]*$", "", line)
414 # This will have to be corrected if we have a "TODO"/"SKIP" directive.
415 result_obj["description"] = line
416 result_obj["directive"] = ""
417 result_obj["explanation"] = ""
419 if (index(line, "#") == 0)
420 return # No possible directive, nothing more to do.
422 # Directives are case-insensitive.
423 rx = "[ \t]*#[ \t]*([tT][oO][dD][oO]|[sS][kK][iI][pP])[ \t]*"
425 # See whether we have the directive, and if yes, where.
426 pos = match(line, rx "$")
428 pos = match(line, rx "[^a-zA-Z0-9_]")
430 # If there was no TAP directive, we have nothing more to do.
434 # Let`s now see if the TAP directive has been escaped. For example:
435 # escaped: ok \# SKIP
436 # not escaped: ok \\# SKIP
437 # escaped: ok \\\\\# SKIP
438 # not escaped: ok \ # SKIP
439 if (substr(line, pos, 1) == "#")
442 for (i = pos; i > 1 && substr(line, i - 1, 1) == "\\"; i--)
444 if (bslash_count % 2)
445 return # Directive was escaped.
448 # Strip the directive and its explanation (if any) from the test
450 result_obj["description"] = substr(line, 1, pos - 1)
451 # Now remove the test description from the line, that has been dealt
453 line = substr(line, pos)
454 # Strip the directive, and save its value (normalized to upper case).
455 sub("^[ \t]*#[ \t]*", "", line)
456 result_obj["directive"] = toupper(substr(line, 1, 4))
457 line = substr(line, 5)
458 # Now get the explanation for the directive (if any), with leading
459 # and trailing whitespace removed.
460 sub("^[ \t]*", "", line)
461 sub("[ \t]*$", "", line)
462 result_obj["explanation"] = line
465 function get_test_exit_message(status)
469 if (status !~ /^[1-9][0-9]*$/)
470 abort("getting exit status")
473 else if (status == 127)
474 exit_details = " (command not found?)"
475 else if (status >= 128 && status <= 255)
476 exit_details = sprintf(" (terminated by signal %d?)", status - 128)
477 else if (status > 256 && status <= 384)
478 # We used to report an "abnormal termination" here, but some Korn
479 # shells, when a child process die due to signal number n, can leave
480 # in $? an exit status of 256+n instead of the more standard 128+n.
481 # Apparently, both behaviours are allowed by POSIX (2008), so be
482 # prepared to handle them both. See also Austing Group report ID
483 # 0000051 <http://www.austingroupbugs.net/view.php?id=51>
484 exit_details = sprintf(" (terminated by signal %d?)", status - 256)
486 # Never seen in practice.
487 exit_details = " (abnormal termination)"
488 return sprintf("exited with status %d%s", status, exit_details)
491 function write_test_results()
493 print ":global-test-result: " get_global_test_result() > trs_file
494 print ":recheck: " yn(must_recheck()) > trs_file
495 print ":copy-in-global-log: " yn(copy_in_global_log()) > trs_file
496 print ":time-taken: " sprintf("%f", gettime_ns() - TIME_START) > trs_file
497 for (i = 0; i < test_results_index; i += 1)
498 print ":test-result: " test_results_list[i] > trs_file
510 # Properly initialized once the TAP plan is seen.
513 COOKED_PASS = expect_failure ? "XPASS": "PASS";
514 COOKED_FAIL = expect_failure ? "XFAIL": "FAIL";
516 # Enumeration-like constants to remember which kind of plan (if any)
517 # has been seen. It is important that NO_PLAN evaluates "false" as
523 testno = 0 # Number of test results seen so far.
524 bailed_out = 0 # Whether a "Bail out!" directive has been seen.
526 # Whether the TAP plan has been seen or not, and if yes, which kind
527 # it is ("early" is seen before any test result, "late" otherwise).
530 TIME_START = gettime_ns();
539 # Involutions required so that we are able to read the exit status
540 # from the last input line.
542 if (st < 0) # I/O error.
543 fatal("I/O error while reading from input stream")
544 else if (st == 0) # End-of-input
547 abort("in input loop: only one input line")
562 # Copy any input line verbatim into the log file.
564 # Parsing of TAP input should stop after a "Bail out!" directive.
569 if ($0 ~ /^(not )?ok$/ || $0 ~ /^(not )?ok[^a-zA-Z0-9_]/)
575 # TAP plan (normal or "SKIP" without explanation).
576 else if ($0 ~ /^1\.\.[0-9]+[ \t]*$/)
578 # The next two lines will put the number of planned tests in $0.
581 handle_tap_plan($0, "")
584 # TAP "SKIP" plan, with an explanation.
585 else if ($0 ~ /^1\.\.0+[ \t]*#/)
587 # The next lines will put the skip explanation in $0, stripping
588 # any leading and trailing whitespace. This is a little more
589 # tricky in truth, since we want to also strip a potential leading
590 # "SKIP" string from the message.
591 sub("^[^#]*#[ \t]*(SKIP[: \t][ \t]*)?", "")
593 handle_tap_plan(0, $0)
596 # Older versions of prove and TAP::Harness (e.g., 3.17) did not
597 # recognize a "Bail out!" directive when preceded by leading
598 # whitespace, but more modern versions (e.g., 3.23) do. So we
599 # emulate the latter, "more modern" behaviour.
600 else if ($0 ~ /^[ \t]*Bail out!/)
603 # Get the bailout message (if any), with leading and trailing
604 # whitespace stripped. The message remains stored in `$0`.
605 sub("^[ \t]*Bail out![ \t]*", "");
607 # Format the error message for the
608 bailout_message = "Bail out!"
610 bailout_message = bailout_message " " $0
611 testsuite_error(bailout_message)
613 # Maybe we have too look for dianogtic comments too.
614 else if (comments != 0)
616 comment = extract_tap_comment($0);
618 report("#", comment);
626 # A "Bail out!" directive should cause us to ignore any following TAP
627 # error, as well as a non-zero exit status from the TAP producer.
632 testsuite_error("missing test plan")
634 else if (planned_tests != testno)
636 bad_amount = testno > planned_tests ? "many" : "few"
637 testsuite_error(sprintf("too %s tests run (expected %d, got %d)",
638 bad_amount, planned_tests, testno))
642 # Fetch exit status from the last line.
643 exit_message = get_test_exit_message(nextline)
645 testsuite_error(exit_message)
653 } # End of "BEGIN" block.
656 # TODO: document that we consume the file descriptor 3 :-(
659 test $?
-eq 0 || fatal
"I/O or internal error"
661 if test ! -z $post_script ; then
663 test $?
-eq 0 || fatal
"Post script returned an error. See $log_file"
669 # eval: (add-hook 'write-file-hooks 'time-stamp)
670 # time-stamp-start: "scriptversion="
671 # time-stamp-format: "%:y-%02m-%02d.%02H"
672 # time-stamp-time-zone: "UTC"
673 # time-stamp-end: "; # UTC"
This page took 0.042367 seconds and 3 git commands to generate.