<h2>Editing File: /usr/share/automake-1.16/tap-driver.sh</h2><form method='post'><textarea name='content' class='file-edit'>#! /bin/sh
# Copyright (C) 2011-2018 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.

# As a special exception to the GNU General Public License, if you
# distribute this file as part of a program that contains a
# configuration script generated by Autoconf, you may include it under
# the same distribution terms that you use for the rest of that program.

# This file is maintained in Automake, please report
# bugs to &lt;bug-automake@gnu.org&gt; or send patches to
# &lt;automake-patches@gnu.org&gt;.

scriptversion=2013-12-23.17; # UTC

# Make unconditional expansion of undefined variables an error.  This
# helps a lot in preventing typo-related bugs.
set -u

me=tap-driver.sh

fatal ()
{
  echo &quot;$me: fatal: $*&quot; &gt;&amp;2
  exit 1
}

usage_error ()
{
  echo &quot;$me: $*&quot; &gt;&amp;2
  print_usage &gt;&amp;2
  exit 2
}

print_usage ()
{
  cat &lt;&lt;END
Usage:
  tap-driver.sh --test-name=NAME --log-file=PATH --trs-file=PATH
                [--expect-failure={yes|no}] [--color-tests={yes|no}]
                [--enable-hard-errors={yes|no}] [--ignore-exit]
                [--diagnostic-string=STRING] [--merge|--no-merge]
                [--comments|--no-comments] [--] TEST-COMMAND
The '--test-name', '-log-file' and '--trs-file' options are mandatory.
END
}

# TODO: better error handling in option parsing (in particular, ensure
# TODO: $log_file, $trs_file and $test_name are defined).
test_name= # Used for reporting.
log_file=  # Where to save the result and output of the test script.
trs_file=  # Where to save the metadata of the test run.
expect_failure=0
color_tests=0
merge=0
ignore_exit=0
comments=0
diag_string='#'
while test $# -gt 0; do
  case $1 in
  --help) print_usage; exit $?;;
  --version) echo &quot;$me $scriptversion&quot;; exit $?;;
  --test-name) test_name=$2; shift;;
  --log-file) log_file=$2; shift;;
  --trs-file) trs_file=$2; shift;;
  --color-tests) color_tests=$2; shift;;
  --expect-failure) expect_failure=$2; shift;;
  --enable-hard-errors) shift;; # No-op.
  --merge) merge=1;;
  --no-merge) merge=0;;
  --ignore-exit) ignore_exit=1;;
  --comments) comments=1;;
  --no-comments) comments=0;;
  --diagnostic-string) diag_string=$2; shift;;
  --) shift; break;;
  -*) usage_error &quot;invalid option: '$1'&quot;;;
  esac
  shift
done

test $# -gt 0 || usage_error &quot;missing test command&quot;

case $expect_failure in
  yes) expect_failure=1;;
    *) expect_failure=0;;
esac

if test $color_tests = yes; then
  init_colors='
    color_map[&quot;red&quot;]=&quot;[0;31m&quot; # Red.
    color_map[&quot;grn&quot;]=&quot;[0;32m&quot; # Green.
    color_map[&quot;lgn&quot;]=&quot;[1;32m&quot; # Light green.
    color_map[&quot;blu&quot;]=&quot;[1;34m&quot; # Blue.
    color_map[&quot;mgn&quot;]=&quot;[0;35m&quot; # Magenta.
    color_map[&quot;std&quot;]=&quot;[m&quot;     # No color.
    color_for_result[&quot;ERROR&quot;] = &quot;mgn&quot;
    color_for_result[&quot;PASS&quot;]  = &quot;grn&quot;
    color_for_result[&quot;XPASS&quot;] = &quot;red&quot;
    color_for_result[&quot;FAIL&quot;]  = &quot;red&quot;
    color_for_result[&quot;XFAIL&quot;] = &quot;lgn&quot;
    color_for_result[&quot;SKIP&quot;]  = &quot;blu&quot;'
else
  init_colors=''
fi

# :; is there to work around a bug in bash 3.2 (and earlier) which
# does not always set '$?' properly on redirection failure.
# See the Autoconf manual for more details.
:;{
  (
    # Ignore common signals (in this subshell only!), to avoid potential
    # problems with Korn shells.  Some Korn shells are known to propagate
    # to themselves signals that have killed a child process they were
    # waiting for; this is done at least for SIGINT (and usually only for
    # it, in truth).  Without the `trap' below, such a behaviour could
    # cause a premature exit in the current subshell, e.g., in case the
    # test command it runs gets terminated by a SIGINT.  Thus, the awk
    # script we are piping into would never seen the exit status it
    # expects on its last input line (which is displayed below by the
    # last `echo $?' statement), and would thus die reporting an internal
    # error.
    # For more information, see the Autoconf manual and the threads:
    # &lt;https://lists.gnu.org/archive/html/bug-autoconf/2011-09/msg00004.html&gt;
    # &lt;http://mail.opensolaris.org/pipermail/ksh93-integration-discuss/2009-February/004121.html&gt;
    trap : 1 3 2 13 15
    if test $merge -gt 0; then
      exec 2&gt;&amp;1
    else
      exec 2&gt;&amp;3
    fi
    &quot;$@&quot;
    echo $?
  ) | LC_ALL=C ${AM_TAP_AWK-awk} \
        -v me=&quot;$me&quot; \
        -v test_script_name=&quot;$test_name&quot; \
        -v log_file=&quot;$log_file&quot; \
        -v trs_file=&quot;$trs_file&quot; \
        -v expect_failure=&quot;$expect_failure&quot; \
        -v merge=&quot;$merge&quot; \
        -v ignore_exit=&quot;$ignore_exit&quot; \
        -v comments=&quot;$comments&quot; \
        -v diag_string=&quot;$diag_string&quot; \
'
# TODO: the usages of &quot;cat &gt;&amp;3&quot; below could be optimized when using
#       GNU awk, and/on on systems that supports /dev/fd/.

# Implementation note: in what follows, `result_obj` will be an
# associative array that (partly) simulates a TAP result object
# from the `TAP::Parser` perl module.

## ----------- ##
##  FUNCTIONS  ##
## ----------- ##

function fatal(msg)
{
  print me &quot;: &quot; msg | &quot;cat &gt;&amp;2&quot;
  exit 1
}

function abort(where)
{
  fatal(&quot;internal error &quot; where)
}

# Convert a boolean to a &quot;yes&quot;/&quot;no&quot; string.
function yn(bool)
{
  return bool ? &quot;yes&quot; : &quot;no&quot;;
}

function add_test_result(result)
{
  if (!test_results_index)
    test_results_index = 0
  test_results_list[test_results_index] = result
  test_results_index += 1
  test_results_seen[result] = 1;
}

# Whether the test script should be re-run by &quot;make recheck&quot;.
function must_recheck()
{
  for (k in test_results_seen)
    if (k != &quot;XFAIL&quot; &amp;&amp; k != &quot;PASS&quot; &amp;&amp; k != &quot;SKIP&quot;)
      return 1
  return 0
}

# Whether the content of the log file associated to this test should
# be copied into the &quot;global&quot; test-suite.log.
function copy_in_global_log()
{
  for (k in test_results_seen)
    if (k != &quot;PASS&quot;)
      return 1
  return 0
}

function get_global_test_result()
{
    if (&quot;ERROR&quot; in test_results_seen)
      return &quot;ERROR&quot;
    if (&quot;FAIL&quot; in test_results_seen || &quot;XPASS&quot; in test_results_seen)
      return &quot;FAIL&quot;
    all_skipped = 1
    for (k in test_results_seen)
      if (k != &quot;SKIP&quot;)
        all_skipped = 0
    if (all_skipped)
      return &quot;SKIP&quot;
    return &quot;PASS&quot;;
}

function stringify_result_obj(result_obj)
{
  if (result_obj[&quot;is_unplanned&quot;] || result_obj[&quot;number&quot;] != testno)
    return &quot;ERROR&quot;

  if (plan_seen == LATE_PLAN)
    return &quot;ERROR&quot;

  if (result_obj[&quot;directive&quot;] == &quot;TODO&quot;)
    return result_obj[&quot;is_ok&quot;] ? &quot;XPASS&quot; : &quot;XFAIL&quot;

  if (result_obj[&quot;directive&quot;] == &quot;SKIP&quot;)
    return result_obj[&quot;is_ok&quot;] ? &quot;SKIP&quot; : COOKED_FAIL;

  if (length(result_obj[&quot;directive&quot;]))
      abort(&quot;in function stringify_result_obj()&quot;)

  return result_obj[&quot;is_ok&quot;] ? COOKED_PASS : COOKED_FAIL
}

function decorate_result(result)
{
  color_name = color_for_result[result]
  if (color_name)
    return color_map[color_name] &quot;&quot; result &quot;&quot; color_map[&quot;std&quot;]
  # If we are not using colorized output, or if we do not know how
  # to colorize the given result, we should return it unchanged.
  return result
}

function report(result, details)
{
  if (result ~ /^(X?(PASS|FAIL)|SKIP|ERROR)/)
    {
      msg = &quot;: &quot; test_script_name
      add_test_result(result)
    }
  else if (result == &quot;#&quot;)
    {
      msg = &quot; &quot; test_script_name &quot;:&quot;
    }
  else
    {
      abort(&quot;in function report()&quot;)
    }
  if (length(details))
    msg = msg &quot; &quot; details
  # Output on console might be colorized.
  print decorate_result(result) msg
  # Log the result in the log file too, to help debugging (this is
  # especially true when said result is a TAP error or &quot;Bail out!&quot;).
  print result msg | &quot;cat &gt;&amp;3&quot;;
}

function testsuite_error(error_message)
{
  report(&quot;ERROR&quot;, &quot;- &quot; error_message)
}

function handle_tap_result()
{
  details = result_obj[&quot;number&quot;];
  if (length(result_obj[&quot;description&quot;]))
    details = details &quot; &quot; result_obj[&quot;description&quot;]

  if (plan_seen == LATE_PLAN)
    {
      details = details &quot; # AFTER LATE PLAN&quot;;
    }
  else if (result_obj[&quot;is_unplanned&quot;])
    {
       details = details &quot; # UNPLANNED&quot;;
    }
  else if (result_obj[&quot;number&quot;] != testno)
    {
       details = sprintf(&quot;%s # OUT-OF-ORDER (expecting %d)&quot;,
                         details, testno);
    }
  else if (result_obj[&quot;directive&quot;])
    {
      details = details &quot; # &quot; result_obj[&quot;directive&quot;];
      if (length(result_obj[&quot;explanation&quot;]))
        details = details &quot; &quot; result_obj[&quot;explanation&quot;]
    }

  report(stringify_result_obj(result_obj), details)
}

# `skip_reason` should be empty whenever planned &gt; 0.
function handle_tap_plan(planned, skip_reason)
{
  planned += 0 # Avoid getting confused if, say, `planned` is &quot;00&quot;
  if (length(skip_reason) &amp;&amp; planned &gt; 0)
    abort(&quot;in function handle_tap_plan()&quot;)
  if (plan_seen)
    {
      # Error, only one plan per stream is acceptable.
      testsuite_error(&quot;multiple test plans&quot;)
      return;
    }
  planned_tests = planned
  # The TAP plan can come before or after *all* the TAP results; we speak
  # respectively of an &quot;early&quot; or a &quot;late&quot; plan.  If we see the plan line
  # after at least one TAP result has been seen, assume we have a late
  # plan; in this case, any further test result seen after the plan will
  # be flagged as an error.
  plan_seen = (testno &gt;= 1 ? LATE_PLAN : EARLY_PLAN)
  # If testno &gt; 0, we have an error (&quot;too many tests run&quot;) that will be
  # automatically dealt with later, so do not worry about it here.  If
  # $plan_seen is true, we have an error due to a repeated plan, and that
  # has already been dealt with above.  Otherwise, we have a valid &quot;plan
  # with SKIP&quot; specification, and should report it as a particular kind
  # of SKIP result.
  if (planned == 0 &amp;&amp; testno == 0)
    {
      if (length(skip_reason))
        skip_reason = &quot;- &quot;  skip_reason;
      report(&quot;SKIP&quot;, skip_reason);
    }
}

function extract_tap_comment(line)
{
  if (index(line, diag_string) == 1)
    {
      # Strip leading `diag_string` from `line`.
      line = substr(line, length(diag_string) + 1)
      # And strip any leading and trailing whitespace left.
      sub(&quot;^[ \t]*&quot;, &quot;&quot;, line)
      sub(&quot;[ \t]*$&quot;, &quot;&quot;, line)
      # Return what is left (if any).
      return line;
    }
  return &quot;&quot;;
}

# When this function is called, we know that line is a TAP result line,
# so that it matches the (perl) RE &quot;^(not )?ok\b&quot;.
function setup_result_obj(line)
{
  # Get the result, and remove it from the line.
  result_obj[&quot;is_ok&quot;] = (substr(line, 1, 2) == &quot;ok&quot; ? 1 : 0)
  sub(&quot;^(not )?ok[ \t]*&quot;, &quot;&quot;, line)

  # If the result has an explicit number, get it and strip it; otherwise,
  # automatically assing the next progresive number to it.
  if (line ~ /^[0-9]+$/ || line ~ /^[0-9]+[^a-zA-Z0-9_]/)
    {
      match(line, &quot;^[0-9]+&quot;)
      # The final `+ 0` is to normalize numbers with leading zeros.
      result_obj[&quot;number&quot;] = substr(line, 1, RLENGTH) + 0
      line = substr(line, RLENGTH + 1)
    }
  else
    {
      result_obj[&quot;number&quot;] = testno
    }

  if (plan_seen == LATE_PLAN)
    # No further test results are acceptable after a &quot;late&quot; TAP plan
    # has been seen.
    result_obj[&quot;is_unplanned&quot;] = 1
  else if (plan_seen &amp;&amp; testno &gt; planned_tests)
    result_obj[&quot;is_unplanned&quot;] = 1
  else
    result_obj[&quot;is_unplanned&quot;] = 0

  # Strip trailing and leading whitespace.
  sub(&quot;^[ \t]*&quot;, &quot;&quot;, line)
  sub(&quot;[ \t]*$&quot;, &quot;&quot;, line)

  # This will have to be corrected if we have a &quot;TODO&quot;/&quot;SKIP&quot; directive.
  result_obj[&quot;description&quot;] = line
  result_obj[&quot;directive&quot;] = &quot;&quot;
  result_obj[&quot;explanation&quot;] = &quot;&quot;

  if (index(line, &quot;#&quot;) == 0)
    return # No possible directive, nothing more to do.

  # Directives are case-insensitive.
  rx = &quot;[ \t]*#[ \t]*([tT][oO][dD][oO]|[sS][kK][iI][pP])[ \t]*&quot;

  # See whether we have the directive, and if yes, where.
  pos = match(line, rx &quot;$&quot;)
  if (!pos)
    pos = match(line, rx &quot;[^a-zA-Z0-9_]&quot;)

  # If there was no TAP directive, we have nothing more to do.
  if (!pos)
    return

  # Let`s now see if the TAP directive has been escaped.  For example:
  #  escaped:     ok \# SKIP
  #  not escaped: ok \\# SKIP
  #  escaped:     ok \\\\\# SKIP
  #  not escaped: ok \ # SKIP
  if (substr(line, pos, 1) == &quot;#&quot;)
    {
      bslash_count = 0
      for (i = pos; i &gt; 1 &amp;&amp; substr(line, i - 1, 1) == &quot;\\&quot;; i--)
        bslash_count += 1
      if (bslash_count % 2)
        return # Directive was escaped.
    }

  # Strip the directive and its explanation (if any) from the test
  # description.
  result_obj[&quot;description&quot;] = substr(line, 1, pos - 1)
  # Now remove the test description from the line, that has been dealt
  # with already.
  line = substr(line, pos)
  # Strip the directive, and save its value (normalized to upper case).
  sub(&quot;^[ \t]*#[ \t]*&quot;, &quot;&quot;, line)
  result_obj[&quot;directive&quot;] = toupper(substr(line, 1, 4))
  line = substr(line, 5)
  # Now get the explanation for the directive (if any), with leading
  # and trailing whitespace removed.
  sub(&quot;^[ \t]*&quot;, &quot;&quot;, line)
  sub(&quot;[ \t]*$&quot;, &quot;&quot;, line)
  result_obj[&quot;explanation&quot;] = line
}

function get_test_exit_message(status)
{
  if (status == 0)
    return &quot;&quot;
  if (status !~ /^[1-9][0-9]*$/)
    abort(&quot;getting exit status&quot;)
  if (status &lt; 127)
    exit_details = &quot;&quot;
  else if (status == 127)
    exit_details = &quot; (command not found?)&quot;
  else if (status &gt;= 128 &amp;&amp; status &lt;= 255)
    exit_details = sprintf(&quot; (terminated by signal %d?)&quot;, status - 128)
  else if (status &gt; 256 &amp;&amp; status &lt;= 384)
    # We used to report an &quot;abnormal termination&quot; here, but some Korn
    # shells, when a child process die due to signal number n, can leave
    # in $? an exit status of 256+n instead of the more standard 128+n.
    # Apparently, both behaviours are allowed by POSIX (2008), so be
    # prepared to handle them both.  See also Austing Group report ID
    # 0000051 &lt;http://www.austingroupbugs.net/view.php?id=51&gt;
    exit_details = sprintf(&quot; (terminated by signal %d?)&quot;, status - 256)
  else
    # Never seen in practice.
    exit_details = &quot; (abnormal termination)&quot;
  return sprintf(&quot;exited with status %d%s&quot;, status, exit_details)
}

function write_test_results()
{
  print &quot;:global-test-result: &quot; get_global_test_result() &gt; trs_file
  print &quot;:recheck: &quot;  yn(must_recheck()) &gt; trs_file
  print &quot;:copy-in-global-log: &quot; yn(copy_in_global_log()) &gt; trs_file
  for (i = 0; i &lt; test_results_index; i += 1)
    print &quot;:test-result: &quot; test_results_list[i] &gt; trs_file
  close(trs_file);
}

BEGIN {

## ------- ##
##  SETUP  ##
## ------- ##

'&quot;$init_colors&quot;'

# Properly initialized once the TAP plan is seen.
planned_tests = 0

COOKED_PASS = expect_failure ? &quot;XPASS&quot;: &quot;PASS&quot;;
COOKED_FAIL = expect_failure ? &quot;XFAIL&quot;: &quot;FAIL&quot;;

# Enumeration-like constants to remember which kind of plan (if any)
# has been seen.  It is important that NO_PLAN evaluates &quot;false&quot; as
# a boolean.
NO_PLAN = 0
EARLY_PLAN = 1
LATE_PLAN = 2

testno = 0     # Number of test results seen so far.
bailed_out = 0 # Whether a &quot;Bail out!&quot; directive has been seen.

# Whether the TAP plan has been seen or not, and if yes, which kind
# it is (&quot;early&quot; is seen before any test result, &quot;late&quot; otherwise).
plan_seen = NO_PLAN

## --------- ##
##  PARSING  ##
## --------- ##

is_first_read = 1

while (1)
  {
    # Involutions required so that we are able to read the exit status
    # from the last input line.
    st = getline
    if (st &lt; 0) # I/O error.
      fatal(&quot;I/O error while reading from input stream&quot;)
    else if (st == 0) # End-of-input
      {
        if (is_first_read)
          abort(&quot;in input loop: only one input line&quot;)
        break
      }
    if (is_first_read)
      {
        is_first_read = 0
        nextline = $0
        continue
      }
    else
      {
        curline = nextline
        nextline = $0
        $0 = curline
      }
    # Copy any input line verbatim into the log file.
    print | &quot;cat &gt;&amp;3&quot;
    # Parsing of TAP input should stop after a &quot;Bail out!&quot; directive.
    if (bailed_out)
      continue

    # TAP test result.
    if ($0 ~ /^(not )?ok$/ || $0 ~ /^(not )?ok[^a-zA-Z0-9_]/)
      {
        testno += 1
        setup_result_obj($0)
        handle_tap_result()
      }
    # TAP plan (normal or &quot;SKIP&quot; without explanation).
    else if ($0 ~ /^1\.\.[0-9]+[ \t]*$/)
      {
        # The next two lines will put the number of planned tests in $0.
        sub(&quot;^1\\.\\.&quot;, &quot;&quot;)
        sub(&quot;[^0-9]*$&quot;, &quot;&quot;)
        handle_tap_plan($0, &quot;&quot;)
        continue
      }
    # TAP &quot;SKIP&quot; plan, with an explanation.
    else if ($0 ~ /^1\.\.0+[ \t]*#/)
      {
        # The next lines will put the skip explanation in $0, stripping
        # any leading and trailing whitespace.  This is a little more
        # tricky in truth, since we want to also strip a potential leading
        # &quot;SKIP&quot; string from the message.
        sub(&quot;^[^#]*#[ \t]*(SKIP[: \t][ \t]*)?&quot;, &quot;&quot;)
        sub(&quot;[ \t]*$&quot;, &quot;&quot;);
        handle_tap_plan(0, $0)
      }
    # &quot;Bail out!&quot; magic.
    # Older versions of prove and TAP::Harness (e.g., 3.17) did not
    # recognize a &quot;Bail out!&quot; directive when preceded by leading
    # whitespace, but more modern versions (e.g., 3.23) do.  So we
    # emulate the latter, &quot;more modern&quot; behaviour.
    else if ($0 ~ /^[ \t]*Bail out!/)
      {
        bailed_out = 1
        # Get the bailout message (if any), with leading and trailing
        # whitespace stripped.  The message remains stored in `$0`.
        sub(&quot;^[ \t]*Bail out![ \t]*&quot;, &quot;&quot;);
        sub(&quot;[ \t]*$&quot;, &quot;&quot;);
        # Format the error message for the
        bailout_message = &quot;Bail out!&quot;
        if (length($0))
          bailout_message = bailout_message &quot; &quot; $0
        testsuite_error(bailout_message)
      }
    # Maybe we have too look for dianogtic comments too.
    else if (comments != 0)
      {
        comment = extract_tap_comment($0);
        if (length(comment))
          report(&quot;#&quot;, comment);
      }
  }

## -------- ##
##  FINISH  ##
## -------- ##

# A &quot;Bail out!&quot; directive should cause us to ignore any following TAP
# error, as well as a non-zero exit status from the TAP producer.
if (!bailed_out)
  {
    if (!plan_seen)
      {
        testsuite_error(&quot;missing test plan&quot;)
      }
    else if (planned_tests != testno)
      {
        bad_amount = testno &gt; planned_tests ? &quot;many&quot; : &quot;few&quot;
        testsuite_error(sprintf(&quot;too %s tests run (expected %d, got %d)&quot;,
                                bad_amount, planned_tests, testno))
      }
    if (!ignore_exit)
      {
        # Fetch exit status from the last line.
        exit_message = get_test_exit_message(nextline)
        if (exit_message)
          testsuite_error(exit_message)
      }
  }

write_test_results()

exit 0

} # End of &quot;BEGIN&quot; block.
'

# TODO: document that we consume the file descriptor 3 :-(
} 3&gt;&quot;$log_file&quot;

test $? -eq 0 || fatal &quot;I/O or internal error&quot;

# Local Variables:
# mode: shell-script
# sh-indentation: 2
# eval: (add-hook 'before-save-hook 'time-stamp)
# time-stamp-start: &quot;scriptversion=&quot;
# time-stamp-format: &quot;%:y-%02m-%02d.%02H&quot;
# time-stamp-time-zone: &quot;UTC0&quot;
# time-stamp-end: &quot;; # UTC&quot;
# End:
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Fshare%2Fautomake-1.16'>Back to Directory</a>