cannam@154: #! /bin/sh
cannam@154: # test-driver - basic testsuite driver script.
cannam@154: 
cannam@154: scriptversion=2016-01-11.22; # UTC
cannam@154: 
cannam@154: # Copyright (C) 2011-2017 Free Software Foundation, Inc.
cannam@154: #
cannam@154: # This program is free software; you can redistribute it and/or modify
cannam@154: # it under the terms of the GNU General Public License as published by
cannam@154: # the Free Software Foundation; either version 2, or (at your option)
cannam@154: # any later version.
cannam@154: #
cannam@154: # This program is distributed in the hope that it will be useful,
cannam@154: # but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@154: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@154: # GNU General Public License for more details.
cannam@154: #
cannam@154: # You should have received a copy of the GNU General Public License
cannam@154: # along with this program.  If not, see <http://www.gnu.org/licenses/>.
cannam@154: 
cannam@154: # As a special exception to the GNU General Public License, if you
cannam@154: # distribute this file as part of a program that contains a
cannam@154: # configuration script generated by Autoconf, you may include it under
cannam@154: # the same distribution terms that you use for the rest of that program.
cannam@154: 
cannam@154: # This file is maintained in Automake, please report
cannam@154: # bugs to <bug-automake@gnu.org> or send patches to
cannam@154: # <automake-patches@gnu.org>.
cannam@154: 
cannam@154: # Make unconditional expansion of undefined variables an error.  This
cannam@154: # helps a lot in preventing typo-related bugs.
cannam@154: set -u
cannam@154: 
cannam@154: usage_error ()
cannam@154: {
cannam@154:   echo "$0: $*" >&2
cannam@154:   print_usage >&2
cannam@154:   exit 2
cannam@154: }
cannam@154: 
cannam@154: print_usage ()
cannam@154: {
cannam@154:   cat <<END
cannam@154: Usage:
cannam@154:   test-driver --test-name=NAME --log-file=PATH --trs-file=PATH
cannam@154:               [--expect-failure={yes|no}] [--color-tests={yes|no}]
cannam@154:               [--enable-hard-errors={yes|no}] [--]
cannam@154:               TEST-SCRIPT [TEST-SCRIPT-ARGUMENTS]
cannam@154: The '--test-name', '--log-file' and '--trs-file' options are mandatory.
cannam@154: END
cannam@154: }
cannam@154: 
cannam@154: test_name= # Used for reporting.
cannam@154: log_file=  # Where to save the output of the test script.
cannam@154: trs_file=  # Where to save the metadata of the test run.
cannam@154: expect_failure=no
cannam@154: color_tests=no
cannam@154: enable_hard_errors=yes
cannam@154: while test $# -gt 0; do
cannam@154:   case $1 in
cannam@154:   --help) print_usage; exit $?;;
cannam@154:   --version) echo "test-driver $scriptversion"; exit $?;;
cannam@154:   --test-name) test_name=$2; shift;;
cannam@154:   --log-file) log_file=$2; shift;;
cannam@154:   --trs-file) trs_file=$2; shift;;
cannam@154:   --color-tests) color_tests=$2; shift;;
cannam@154:   --expect-failure) expect_failure=$2; shift;;
cannam@154:   --enable-hard-errors) enable_hard_errors=$2; shift;;
cannam@154:   --) shift; break;;
cannam@154:   -*) usage_error "invalid option: '$1'";;
cannam@154:    *) break;;
cannam@154:   esac
cannam@154:   shift
cannam@154: done
cannam@154: 
cannam@154: missing_opts=
cannam@154: test x"$test_name" = x && missing_opts="$missing_opts --test-name"
cannam@154: test x"$log_file"  = x && missing_opts="$missing_opts --log-file"
cannam@154: test x"$trs_file"  = x && missing_opts="$missing_opts --trs-file"
cannam@154: if test x"$missing_opts" != x; then
cannam@154:   usage_error "the following mandatory options are missing:$missing_opts"
cannam@154: fi
cannam@154: 
cannam@154: if test $# -eq 0; then
cannam@154:   usage_error "missing argument"
cannam@154: fi
cannam@154: 
cannam@154: if test $color_tests = yes; then
cannam@154:   # Keep this in sync with 'lib/am/check.am:$(am__tty_colors)'.
cannam@154:   red='' # Red.
cannam@154:   grn='' # Green.
cannam@154:   lgn='' # Light green.
cannam@154:   blu='' # Blue.
cannam@154:   mgn='' # Magenta.
cannam@154:   std=''     # No color.
cannam@154: else
cannam@154:   red= grn= lgn= blu= mgn= std=
cannam@154: fi
cannam@154: 
cannam@154: do_exit='rm -f $log_file $trs_file; (exit $st); exit $st'
cannam@154: trap "st=129; $do_exit" 1
cannam@154: trap "st=130; $do_exit" 2
cannam@154: trap "st=141; $do_exit" 13
cannam@154: trap "st=143; $do_exit" 15
cannam@154: 
cannam@154: # Test script is run here.
cannam@154: "$@" >$log_file 2>&1
cannam@154: estatus=$?
cannam@154: 
cannam@154: if test $enable_hard_errors = no && test $estatus -eq 99; then
cannam@154:   tweaked_estatus=1
cannam@154: else
cannam@154:   tweaked_estatus=$estatus
cannam@154: fi
cannam@154: 
cannam@154: case $tweaked_estatus:$expect_failure in
cannam@154:   0:yes) col=$red res=XPASS recheck=yes gcopy=yes;;
cannam@154:   0:*)   col=$grn res=PASS  recheck=no  gcopy=no;;
cannam@154:   77:*)  col=$blu res=SKIP  recheck=no  gcopy=yes;;
cannam@154:   99:*)  col=$mgn res=ERROR recheck=yes gcopy=yes;;
cannam@154:   *:yes) col=$lgn res=XFAIL recheck=no  gcopy=yes;;
cannam@154:   *:*)   col=$red res=FAIL  recheck=yes gcopy=yes;;
cannam@154: esac
cannam@154: 
cannam@154: # Report the test outcome and exit status in the logs, so that one can
cannam@154: # know whether the test passed or failed simply by looking at the '.log'
cannam@154: # file, without the need of also peaking into the corresponding '.trs'
cannam@154: # file (automake bug#11814).
cannam@154: echo "$res $test_name (exit status: $estatus)" >>$log_file
cannam@154: 
cannam@154: # Report outcome to console.
cannam@154: echo "${col}${res}${std}: $test_name"
cannam@154: 
cannam@154: # Register the test result, and other relevant metadata.
cannam@154: echo ":test-result: $res" > $trs_file
cannam@154: echo ":global-test-result: $res" >> $trs_file
cannam@154: echo ":recheck: $recheck" >> $trs_file
cannam@154: echo ":copy-in-global-log: $gcopy" >> $trs_file
cannam@154: 
cannam@154: # Local Variables:
cannam@154: # mode: shell-script
cannam@154: # sh-indentation: 2
cannam@154: # eval: (add-hook 'write-file-hooks 'time-stamp)
cannam@154: # time-stamp-start: "scriptversion="
cannam@154: # time-stamp-format: "%:y-%02m-%02d.%02H"
cannam@154: # time-stamp-time-zone: "UTC0"
cannam@154: # time-stamp-end: "; # UTC"
cannam@154: # End: