#! /bin/sh
# test-driver - basic driver script for the `parallel-tests' mode.

scriptversion=2011-06-21.19; # UTC

# Copyright (C) 2011 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 <http://www.gnu.org/licenses/>.

# 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 <bug-automake@gnu.org> or send patches to
# <automake-patches@gnu.org>.

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

fatal ()
{
  echo "$0: fatal: $*" >&2
  exit 1
}

usage_error ()
{
  echo "$0: $*" >&2
  print_usage >&2
  exit 2
}

print_usage ()
{
  cat <<END
Usage:
  test-driver [--help|--version] --test-name=NAME --log-file=PATH
              [--expect-failure={yes|no}] [--color-tests={yes|no}]
              [--enable-hard-errors={yes|no}] [--] TEST-SCRIPT
The \`--test-name' and \`--log-file' options are mandatory.
END
}

# Restructured Text section.
rst_section () { sed 'p;s/./=/g;p;g'; }

# TODO: better error handling in option parsing (in particular, ensure
# TODO: $logfile and $test_name are defined).
test_name= # Used for reporting.
logfile=   # Where to save the result and output of the test script.
expect_failure=no
color_tests=no
enable_hard_errors=yes
while test $# -gt 0; do
  case $1 in
  --help) print_usage; exit $?;;
  --version) echo "test-driver $scriptversion"; exit $?;;
  --test-name) test_name=$2; shift;;
  --log-file) logfile=$2; shift;;
  --color-tests) color_tests=$2; shift;;
  --expect-failure) expect_failure=$2; shift;;
  --enable-hard-errors) enable_hard_errors=$2; shift;;
  --) shift; break;;
  -*) usage_error "invalid option: '$1'";;
  esac
  shift
done

if test $color_tests = yes; then
  red='' # Red.
  grn='' # Green.
  lgn='' # Light green.
  blu='' # Blue.
  std=''     # No color.
else
  red= grn= lgn= blu= std=
fi

tmpfile=$logfile-t
do_exit='rm -f $tmpfile; (exit $st); exit $st'
trap "st=129; $do_exit" 1
trap "st=130; $do_exit" 2
trap "st=141; $do_exit" 13
trap "st=143; $do_exit" 15
rm -f $tmpfile

# Test script is run here.
"$@" >$tmpfile 2>&1
estatus=$?
if test $enable_hard_errors = no && test $estatus -eq 99; then
  estatus=1
fi

case $estatus:$expect_failure in
  0:yes) col=$red; res=XPASS;;
  0:*)   col=$grn; res=PASS ;;
  77:*)  col=$blu; res=SKIP ;;
  99:*)  col=$red; res=FAIL ;;
  *:yes) col=$lgn; res=XFAIL;;
  *:*)   col=$red; res=FAIL ;;
esac

# Report outcome to console.
echo "${col}${res}${std}: $test_name"

# Now write log file.
{
  echo "$res: $test_name (exit: $estatus)" | rst_section
  echo ":test-result: $res (exit status: $estatus)"
  # Use a reStructuredText transition to better separate the test
  # outcome report from its registered output.
  echo
  echo ------------
  echo
  cat $tmpfile
} > $logfile
rm -f $tmpfile

# Local Variables:
# mode: shell-script
# sh-indentation: 2
# eval: (add-hook 'write-file-hooks 'time-stamp)
# time-stamp-start: "scriptversion="
# time-stamp-format: "%:y-%02m-%02d.%02H"
# time-stamp-time-zone: "UTC"
# time-stamp-end: "; # UTC"
# End: