lib/tap-driver.sh

   1 #! /bin/sh
   2 # Copyright (C) 2011-2024 Free Software Foundation, Inc.
   3 #
   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)
   7 # any later version.
   8 #
   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.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  16
  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.
  21
  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>.
  25
  26 scriptversion=2024-06-19.01; # UTC
  27
  28 # Make unconditional expansion of undefined variables an error.  This
  29 # helps a lot in preventing typo-related bugs.
  30 set -u
  31
  32 me=tap-driver.sh
  33
  34 fatal ()
  35 {
  36   echo "$me: fatal: $*" >&2
  37   exit 1
  38 }
  39
  40 usage_error ()
  41 {
  42   echo "$me: $*" >&2
  43   print_usage >&2
  44   exit 2
  45 }
  46
  47 print_usage ()
  48 {
  49   cat <<END
  50 Usage:
  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] [--] TEST-COMMAND
  56 The '--test-name', '-log-file' and '--trs-file' options are mandatory.
  57
  58 Report bugs to <bug-automake@gnu.org>.
  59 GNU Automake home page: <https://www.gnu.org/software/automake/>.
  60 General help using GNU software: <https://www.gnu.org/gethelp/>.
  61 END
  62 }
  63
  64 # TODO: better error handling in option parsing (in particular, ensure
  65 # TODO: $log_file, $trs_file and $test_name are defined).
  66 test_name= # Used for reporting.
  67 log_file=  # Where to save the result and output of the test script.
  68 trs_file=  # Where to save the metadata of the test run.
  69 expect_failure=0
  70 color_tests=0
  71 merge=0
  72 ignore_exit=0
  73 comments=0
  74 diag_string='#'
  75 while test $# -gt 0; do
  76   case $1 in
  77   --help) print_usage; exit $?;;
  78   --version) echo "$me (GNU Automake) $scriptversion"; exit $?;;
  79   --test-name) test_name=$2; shift;;
  80   --log-file) log_file=$2; shift;;
  81   --trs-file) trs_file=$2; shift;;
  82   --color-tests) color_tests=$2; shift;;
  83   --expect-failure) expect_failure=$2; shift;;
  84   --enable-hard-errors) shift;; # No-op.
  85   --merge) merge=1;;
  86   --no-merge) merge=0;;
  87   --ignore-exit) ignore_exit=1;;
  88   --comments) comments=1;;
  89   --no-comments) comments=0;;
  90   --diagnostic-string) diag_string=$2; shift;;
  91   --) shift; break;;
  92   -*) usage_error "invalid option: '$1'";;
  93   esac
  94   shift
  95 done
  96
  97 test $# -gt 0 || usage_error "missing test command"
  98
  99 case $expect_failure in
 100   yes) expect_failure=1;;
 101     *) expect_failure=0;;
 102 esac
 103
 104 if test $color_tests = yes; then
 105   init_colors='
 106     color_map["red"]="\e[0;31m" # Red.
 107     color_map["grn"]="\e[0;32m" # Green.
 108     color_map["lgn"]="\e[1;32m" # Light green.
 109     color_map["blu"]="\e[1;34m" # Blue.
 110     color_map["mgn"]="\e[0;35m" # Magenta.
 111     color_map["std"]="\e[m"     # No color.
 112     color_for_result["ERROR"] = "mgn"
 113     color_for_result["PASS"]  = "grn"
 114     color_for_result["XPASS"] = "red"
 115     color_for_result["FAIL"]  = "red"
 116     color_for_result["XFAIL"] = "lgn"
 117     color_for_result["SKIP"]  = "blu"'
 118 else
 119   init_colors=''
 120 fi
 121
 122 # :; is there to work around a bug in bash 3.2 (and earlier) which
 123 # does not always set '$?' properly on redirection failure.
 124 # See the Autoconf manual for more details.
 125 :;{
 126   (
 127     # Ignore common signals (in this subshell only!), to avoid potential
 128     # problems with Korn shells.  Some Korn shells are known to propagate
 129     # to themselves signals that have killed a child process they were
 130     # waiting for; this is done at least for SIGINT (and usually only for
 131     # it, in truth).  Without the `trap' below, such a behavior could
 132     # cause a premature exit in the current subshell, e.g., in case the
 133     # test command it runs gets terminated by a SIGINT.  Thus, the awk
 134     # script we are piping into would never seen the exit status it
 135     # expects on its last input line (which is displayed below by the
 136     # last `echo $?' statement), and would thus die reporting an internal
 137     # error.
 138     # For more information, see the Autoconf manual and the threads:
 139     # <https://lists.gnu.org/archive/html/bug-autoconf/2011-09/msg00004.html>
 140     # <http://mail.opensolaris.org/pipermail/ksh93-integration-discuss/2009-February/004121.html>
 141     trap : 1 3 2 13 15
 142     if test $merge -gt 0; then
 143       exec 2>&1
 144     else
 145       exec 2>&3
 146     fi
 147     "$@"
 148     echo $?
 149   ) | LC_ALL=C ${AM_TAP_AWK-awk} \
 150         -v me="$me" \
 151         -v test_script_name="$test_name" \
 152         -v log_file="$log_file" \
 153         -v trs_file="$trs_file" \
 154         -v expect_failure="$expect_failure" \
 155         -v merge="$merge" \
 156         -v ignore_exit="$ignore_exit" \
 157         -v comments="$comments" \
 158         -v diag_string="$diag_string" \
 159 '
 160 # TODO: the usages of "cat >&3" below could be optimized when using
 161 #       GNU awk, and/on on systems that supports /dev/fd/.
 162
 163 # Implementation note: in what follows, `result_obj` will be an
 164 # associative array that (partly) simulates a TAP result object
 165 # from the `TAP::Parser` perl module.
 166
 167 ## ----------- ##
 168 ##  FUNCTIONS  ##
 169 ## ----------- ##
 170
 171 function fatal(msg)
 172 {
 173   print me ": " msg | "cat >&2"
 174   exit 1
 175 }
 176
 177 function abort(where)
 178 {
 179   fatal("internal error " where)
 180 }
 181
 182 # Convert a boolean to a "yes"/"no" string.
 183 function yn(bool)
 184 {
 185   return bool ? "yes" : "no";
 186 }
 187
 188 function add_test_result(result)
 189 {
 190   if (!test_results_index)
 191     test_results_index = 0
 192   test_results_list[test_results_index] = result
 193   test_results_index += 1
 194   test_results_seen[result] = 1;
 195 }
 196
 197 # Whether the test script should be re-run by "make recheck".
 198 function must_recheck()
 199 {
 200   for (k in test_results_seen)
 201     if (k != "XFAIL" && k != "PASS" && k != "SKIP")
 202       return 1
 203   return 0
 204 }
 205
 206 # Whether the content of the log file associated to this test should
 207 # be copied into the "global" test-suite.log.
 208 function copy_in_global_log()
 209 {
 210   for (k in test_results_seen)
 211     if (k != "PASS")
 212       return 1
 213   return 0
 214 }
 215
 216 function get_global_test_result()
 217 {
 218     if ("ERROR" in test_results_seen)
 219       return "ERROR"
 220     if ("FAIL" in test_results_seen || "XPASS" in test_results_seen)
 221       return "FAIL"
 222     all_skipped = 1
 223     for (k in test_results_seen)
 224       if (k != "SKIP")
 225         all_skipped = 0
 226     if (all_skipped)
 227       return "SKIP"
 228     return "PASS";
 229 }
 230
 231 function stringify_result_obj(result_obj)
 232 {
 233   if (result_obj["is_unplanned"] || result_obj["number"] != testno)
 234     return "ERROR"
 235
 236   if (plan_seen == LATE_PLAN)
 237     return "ERROR"
 238
 239   if (result_obj["directive"] == "TODO")
 240     return result_obj["is_ok"] ? "XPASS" : "XFAIL"
 241
 242   if (result_obj["directive"] == "SKIP")
 243     return result_obj["is_ok"] ? "SKIP" : COOKED_FAIL;
 244
 245   if (length(result_obj["directive"]))
 246       abort("in function stringify_result_obj()")
 247
 248   return result_obj["is_ok"] ? COOKED_PASS : COOKED_FAIL
 249 }
 250
 251 function decorate_result(result)
 252 {
 253   color_name = color_for_result[result]
 254   if (color_name)
 255     return color_map[color_name] "" result "" color_map["std"]
 256   # If we are not using colorized output, or if we do not know how
 257   # to colorize the given result, we should return it unchanged.
 258   return result
 259 }
 260
 261 function report(result, details)
 262 {
 263   if (result ~ /^(X?(PASS|FAIL)|SKIP|ERROR)/)
 264     {
 265       msg = ": " test_script_name
 266       add_test_result(result)
 267     }
 268   else if (result == "#")
 269     {
 270       msg = " " test_script_name ":"
 271     }
 272   else
 273     {
 274       abort("in function report()")
 275     }
 276   if (length(details))
 277     msg = msg " " details
 278   # Output on console might be colorized.
 279   print decorate_result(result) msg
 280   # Log the result in the log file too, to help debugging (this is
 281   # especially true when said result is a TAP error or "Bail out!").
 282   print result msg | "cat >&3";
 283 }
 284
 285 function testsuite_error(error_message)
 286 {
 287   report("ERROR", "- " error_message)
 288 }
 289
 290 function handle_tap_result()
 291 {
 292   details = result_obj["number"];
 293   if (length(result_obj["description"]))
 294     details = details " " result_obj["description"]
 295
 296   if (plan_seen == LATE_PLAN)
 297     {
 298       details = details " # AFTER LATE PLAN";
 299     }
 300   else if (result_obj["is_unplanned"])
 301     {
 302        details = details " # UNPLANNED";
 303     }
 304   else if (result_obj["number"] != testno)
 305     {
 306        details = sprintf("%s # OUT-OF-ORDER (expecting %d)",
 307                          details, testno);
 308     }
 309   else if (result_obj["directive"])
 310     {
 311       details = details " # " result_obj["directive"];
 312       if (length(result_obj["explanation"]))
 313         details = details " " result_obj["explanation"]
 314     }
 315
 316   report(stringify_result_obj(result_obj), details)
 317 }
 318
 319 # `skip_reason` should be empty whenever planned > 0.
 320 function handle_tap_plan(planned, skip_reason)
 321 {
 322   planned += 0 # Avoid getting confused if, say, `planned` is "00"
 323   if (length(skip_reason) && planned > 0)
 324     abort("in function handle_tap_plan()")
 325   if (plan_seen)
 326     {
 327       # Error, only one plan per stream is acceptable.
 328       testsuite_error("multiple test plans")
 329       return;
 330     }
 331   planned_tests = planned
 332   # The TAP plan can come before or after *all* the TAP results; we speak
 333   # respectively of an "early" or a "late" plan.  If we see the plan line
 334   # after at least one TAP result has been seen, assume we have a late
 335   # plan; in this case, any further test result seen after the plan will
 336   # be flagged as an error.
 337   plan_seen = (testno >= 1 ? LATE_PLAN : EARLY_PLAN)
 338   # If testno > 0, we have an error ("too many tests run") that will be
 339   # automatically dealt with later, so do not worry about it here.  If
 340   # $plan_seen is true, we have an error due to a repeated plan, and that
 341   # has already been dealt with above.  Otherwise, we have a valid "plan
 342   # with SKIP" specification, and should report it as a particular kind
 343   # of SKIP result.
 344   if (planned == 0 && testno == 0)
 345     {
 346       if (length(skip_reason))
 347         skip_reason = "- "  skip_reason;
 348       report("SKIP", skip_reason);
 349     }
 350 }
 351
 352 function extract_tap_comment(line)
 353 {
 354   if (index(line, diag_string) == 1)
 355     {
 356       # Strip leading `diag_string` from `line`.
 357       line = substr(line, length(diag_string) + 1)
 358       # And strip any leading and trailing whitespace left.
 359       sub("^[ \t]*", "", line)
 360       sub("[ \t]*$", "", line)
 361       # Return what is left (if any).
 362       return line;
 363     }
 364   return "";
 365 }
 366
 367 # When this function is called, we know that line is a TAP result line,
 368 # so that it matches the (perl) RE "^(not )?ok\b".
 369 function setup_result_obj(line)
 370 {
 371   # Get the result, and remove it from the line.
 372   result_obj["is_ok"] = (substr(line, 1, 2) == "ok" ? 1 : 0)
 373   sub("^(not )?ok[ \t]*", "", line)
 374
 375   # If the result has an explicit number, get it and strip it; otherwise,
 376   # automatically assign the next test number to it.
 377   if (line ~ /^[0-9]+$/ || line ~ /^[0-9]+[^a-zA-Z0-9_]/)
 378     {
 379       match(line, "^[0-9]+")
 380       # The final `+ 0` is to normalize numbers with leading zeros.
 381       result_obj["number"] = substr(line, 1, RLENGTH) + 0
 382       line = substr(line, RLENGTH + 1)
 383     }
 384   else
 385     {
 386       result_obj["number"] = testno
 387     }
 388
 389   if (plan_seen == LATE_PLAN)
 390     # No further test results are acceptable after a "late" TAP plan
 391     # has been seen.
 392     result_obj["is_unplanned"] = 1
 393   else if (plan_seen && testno > planned_tests)
 394     result_obj["is_unplanned"] = 1
 395   else
 396     result_obj["is_unplanned"] = 0
 397
 398   # Strip trailing and leading whitespace.
 399   sub("^[ \t]*", "", line)
 400   sub("[ \t]*$", "", line)
 401
 402   # This will have to be corrected if we have a "TODO"/"SKIP" directive.
 403   result_obj["description"] = line
 404   result_obj["directive"] = ""
 405   result_obj["explanation"] = ""
 406
 407   if (index(line, "#") == 0)
 408     return # No possible directive, nothing more to do.
 409
 410   # Directives are case-insensitive.
 411   rx = "[ \t]*#[ \t]*([tT][oO][dD][oO]|[sS][kK][iI][pP])[ \t]*"
 412
 413   # See whether we have the directive, and if yes, where.
 414   pos = match(line, rx "$")
 415   if (!pos)
 416     pos = match(line, rx "[^a-zA-Z0-9_]")
 417
 418   # If there was no TAP directive, we have nothing more to do.
 419   if (!pos)
 420     return
 421
 422   # Let`s now see if the TAP directive has been escaped.  For example:
 423   #  escaped:     ok \# SKIP
 424   #  not escaped: ok \\# SKIP
 425   #  escaped:     ok \\\\\# SKIP
 426   #  not escaped: ok \ # SKIP
 427   if (substr(line, pos, 1) == "#")
 428     {
 429       bslash_count = 0
 430       for (i = pos; i > 1 && substr(line, i - 1, 1) == "\\"; i--)
 431         bslash_count += 1
 432       if (bslash_count % 2)
 433         return # Directive was escaped.
 434     }
 435
 436   # Strip the directive and its explanation (if any) from the test
 437   # description.
 438   result_obj["description"] = substr(line, 1, pos - 1)
 439   # Now remove the test description from the line, that has been dealt
 440   # with already.
 441   line = substr(line, pos)
 442   # Strip the directive, and save its value (normalized to upper case).
 443   sub("^[ \t]*#[ \t]*", "", line)
 444   result_obj["directive"] = toupper(substr(line, 1, 4))
 445   line = substr(line, 5)
 446   # Now get the explanation for the directive (if any), with leading
 447   # and trailing whitespace removed.
 448   sub("^[ \t]*", "", line)
 449   sub("[ \t]*$", "", line)
 450   result_obj["explanation"] = line
 451 }
 452
 453 function get_test_exit_message(status)
 454 {
 455   if (status == 0)
 456     return ""
 457   if (status !~ /^[1-9][0-9]*$/)
 458     abort("getting exit status")
 459   if (status < 127)
 460     exit_details = ""
 461   else if (status == 127)
 462     exit_details = " (command not found?)"
 463   else if (status >= 128 && status <= 255)
 464     exit_details = sprintf(" (terminated by signal %d?)", status - 128)
 465   else if (status > 256 && status <= 384)
 466     # We used to report an "abnormal termination" here, but some Korn
 467     # shells, when a child process die due to signal number n, can leave
 468     # in $? an exit status of 256+n instead of the more standard 128+n.
 469     # Apparently, both behaviors are allowed by POSIX (2008), so be
 470     # prepared to handle them both.  See also Austin Group report ID
 471     # 0000051 <http://www.austingroupbugs.net/view.php?id=51>
 472     exit_details = sprintf(" (terminated by signal %d?)", status - 256)
 473   else
 474     # Never seen in practice.
 475     exit_details = " (abnormal termination)"
 476   return sprintf("exited with status %d%s", status, exit_details)
 477 }
 478
 479 function write_test_results()
 480 {
 481   print ":global-test-result: " get_global_test_result() > trs_file
 482   print ":recheck: "  yn(must_recheck()) > trs_file
 483   print ":copy-in-global-log: " yn(copy_in_global_log()) > trs_file
 484   for (i = 0; i < test_results_index; i += 1)
 485     print ":test-result: " test_results_list[i] > trs_file
 486   close(trs_file);
 487 }
 488
 489 BEGIN {
 490
 491 ## ------- ##
 492 ##  SETUP  ##
 493 ## ------- ##
 494
 495 '"$init_colors"'
 496
 497 # Properly initialized once the TAP plan is seen.
 498 planned_tests = 0
 499
 500 COOKED_PASS = expect_failure ? "XPASS": "PASS";
 501 COOKED_FAIL = expect_failure ? "XFAIL": "FAIL";
 502
 503 # Enumeration-like constants to remember which kind of plan (if any)
 504 # has been seen.  It is important that NO_PLAN evaluates "false" as
 505 # a boolean.
 506 NO_PLAN = 0
 507 EARLY_PLAN = 1
 508 LATE_PLAN = 2
 509
 510 testno = 0     # Number of test results seen so far.
 511 bailed_out = 0 # Whether a "Bail out!" directive has been seen.
 512
 513 # Whether the TAP plan has been seen or not, and if yes, which kind
 514 # it is ("early" is seen before any test result, "late" otherwise).
 515 plan_seen = NO_PLAN
 516
 517 ## --------- ##
 518 ##  PARSING  ##
 519 ## --------- ##
 520
 521 is_first_read = 1
 522
 523 while (1)
 524   {
 525     # Involutions required so that we are able to read the exit status
 526     # from the last input line.
 527     st = getline
 528     if (st < 0) # I/O error.
 529       fatal("I/O error while reading from input stream")
 530     else if (st == 0) # End-of-input
 531       {
 532         if (is_first_read)
 533           abort("in input loop: only one input line")
 534         break
 535       }
 536     if (is_first_read)
 537       {
 538         is_first_read = 0
 539         nextline = $0
 540         continue
 541       }
 542     else
 543       {
 544         curline = nextline
 545         nextline = $0
 546         $0 = curline
 547       }
 548     # Copy any input line verbatim into the log file.
 549     print | "cat >&3"
 550     # Parsing of TAP input should stop after a "Bail out!" directive.
 551     if (bailed_out)
 552       continue
 553
 554     # TAP test result.
 555     if ($0 ~ /^(not )?ok$/ || $0 ~ /^(not )?ok[^a-zA-Z0-9_]/)
 556       {
 557         testno += 1
 558         setup_result_obj($0)
 559         handle_tap_result()
 560       }
 561     # TAP plan (normal or "SKIP" without explanation).
 562     else if ($0 ~ /^1\.\.[0-9]+[ \t]*$/)
 563       {
 564         # The next two lines will put the number of planned tests in $0.
 565         sub("^1\\.\\.", "")
 566         sub("[^0-9]*$", "")
 567         handle_tap_plan($0, "")
 568         continue
 569       }
 570     # TAP "SKIP" plan, with an explanation.
 571     else if ($0 ~ /^1\.\.0+[ \t]*#/)
 572       {
 573         # The next lines will put the skip explanation in $0, stripping
 574         # any leading and trailing whitespace.  This is a little more
 575         # tricky in truth, since we want to also strip a potential leading
 576         # "SKIP" string from the message.
 577         sub("^[^#]*#[ \t]*(SKIP[: \t][ \t]*)?", "")
 578         sub("[ \t]*$", "");
 579         handle_tap_plan(0, $0)
 580       }
 581     # "Bail out!" magic.
 582     # Older versions of prove and TAP::Harness (e.g., 3.17) did not
 583     # recognize a "Bail out!" directive when preceded by leading
 584     # whitespace, but more modern versions (e.g., 3.23) do.  So we
 585     # emulate the latter, "more modern" behavior.
 586     else if ($0 ~ /^[ \t]*Bail out!/)
 587       {
 588         bailed_out = 1
 589         # Get the bailout message (if any), with leading and trailing
 590         # whitespace stripped.  The message remains stored in `$0`.
 591         sub("^[ \t]*Bail out![ \t]*", "");
 592         sub("[ \t]*$", "");
 593         # Format the error message for the
 594         bailout_message = "Bail out!"
 595         if (length($0))
 596           bailout_message = bailout_message " " $0
 597         testsuite_error(bailout_message)
 598       }
 599     # Maybe we have to look for diagnostic comments too.
 600     else if (comments != 0)
 601       {
 602         comment = extract_tap_comment($0);
 603         if (length(comment))
 604           report("#", comment);
 605       }
 606   }
 607
 608 ## -------- ##
 609 ##  FINISH  ##
 610 ## -------- ##
 611
 612 # A "Bail out!" directive should cause us to ignore any following TAP
 613 # error, as well as a non-zero exit status from the TAP producer.
 614 if (!bailed_out)
 615   {
 616     if (!plan_seen)
 617       {
 618         testsuite_error("missing test plan")
 619       }
 620     else if (planned_tests != testno)
 621       {
 622         bad_amount = testno > planned_tests ? "many" : "few"
 623         testsuite_error(sprintf("too %s tests run (expected %d, got %d)",
 624                                 bad_amount, planned_tests, testno))
 625       }
 626     if (!ignore_exit)
 627       {
 628         # Fetch exit status from the last line.
 629         exit_message = get_test_exit_message(nextline)
 630         if (exit_message)
 631           testsuite_error(exit_message)
 632       }
 633   }
 634
 635 write_test_results()
 636
 637 exit 0
 638
 639 } # End of "BEGIN" block.
 640 '
 641
 642 # TODO: document that we consume the file descriptor 3 :-(
 643 } 3>"$log_file"
 644
 645 test $? -eq 0 || fatal "I/O or internal error"
 646
 647 # Local Variables:
 648 # mode: shell-script
 649 # sh-indentation: 2
 650 # eval: (add-hook 'before-save-hook 'time-stamp)
 651 # time-stamp-start: "scriptversion="
 652 # time-stamp-format: "%:y-%02m-%02d.%02H"
 653 # time-stamp-time-zone: "UTC0"
 654 # time-stamp-end: "; # UTC"
 655 # End: