1#! /bin/sh
2# test-driver - basic testsuite driver script.
3
4scriptversion=2018-03-07.03; # UTC
5
6# Copyright (C) 2011-2020 Free Software Foundation, Inc.
7#
8# This program is free software; you can redistribute it and/or modify
9# it under the terms of the GNU General Public License as published by
10# the Free Software Foundation; either version 2, or (at your option)
11# any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program.  If not, see <https://www.gnu.org/licenses/>.
20
21# As a special exception to the GNU General Public License, if you
22# distribute this file as part of a program that contains a
23# configuration script generated by Autoconf, you may include it under
24# the same distribution terms that you use for the rest of that program.
25
26# This file is maintained in Automake, please report
27# bugs to <bug-automake@gnu.org> or send patches to
28# <automake-patches@gnu.org>.
29
30# Make unconditional expansion of undefined variables an error.  This
31# helps a lot in preventing typo-related bugs.
32set -u
33
34usage_error ()
35{
36  echo "$0: $*" >&2
37  print_usage >&2
38  exit 2
39}
40
41print_usage ()
42{
43  cat <<END
44Usage:
45  test-driver --test-name NAME --log-file PATH --trs-file PATH
46              [--expect-failure {yes|no}] [--color-tests {yes|no}]
47              [--enable-hard-errors {yes|no}] [--]
48              TEST-SCRIPT [TEST-SCRIPT-ARGUMENTS]
49
50The '--test-name', '--log-file' and '--trs-file' options are mandatory.
51See the GNU Automake documentation for information.
52END
53}
54
55test_name= # Used for reporting.
56log_file=  # Where to save the output of the test script.
57trs_file=  # Where to save the metadata of the test run.
58expect_failure=no
59color_tests=no
60enable_hard_errors=yes
61while test $# -gt 1; do
62 arg=${1%=*}
63 val=${1#*=}
64 if [ $arg = $val ]; then
65   val=$2
66   shift
67 fi
68 case $arg in
69  --help) print_usage; exit $?;;
70  --version) echo "test-driver $scriptversion"; exit $?;;
71  --test-name) test_name=$val;;
72  --log-file) log_file=$val;;
73  --trs-file) trs_file=$val;;
74  --color-tests) color_tests=$val;;
75  --expect-failure) expect_failure=$val;;
76  --enable-hard-errors) enable_hard_errors=$val;;
77  --) break;;
78  -*) usage_error "invalid option: '$1'";;
79  esac
80  [ $arg != $val ] && shift
81done
82
83missing_opts=
84test x"$test_name" = x && missing_opts="$missing_opts --test-name"
85test x"$log_file"  = x && missing_opts="$missing_opts --log-file"
86test x"$trs_file"  = x && missing_opts="$missing_opts --trs-file"
87if test x"$missing_opts" != x; then
88  usage_error "the following mandatory options are missing:$missing_opts"
89fi
90
91if test $# -eq 0; then
92  usage_error "missing argument"
93fi
94
95if test $color_tests = yes; then
96  # Keep this in sync with 'lib/am/check.am:$(am__tty_colors)'.
97  red='' # Red.
98  grn='' # Green.
99  lgn='' # Light green.
100  blu='' # Blue.
101  mgn='' # Magenta.
102  std=''     # No color.
103else
104  red= grn= lgn= blu= mgn= std=
105fi
106
107do_exit='rm -f $log_file $trs_file; (exit $st); exit $st'
108trap "st=129; $do_exit" 1
109trap "st=130; $do_exit" 2
110trap "st=141; $do_exit" 13
111trap "st=143; $do_exit" 15
112
113# Test script is run here.
114"$@" >$log_file 2>&1
115estatus=$?
116
117if test $enable_hard_errors = no && test $estatus -eq 99; then
118  tweaked_estatus=1
119else
120  tweaked_estatus=$estatus
121fi
122
123case $tweaked_estatus:$expect_failure in
124  0:yes) col=$red res=XPASS recheck=yes gcopy=yes;;
125  0:*)   col=$grn res=PASS  recheck=no  gcopy=no;;
126  77:*)  col=$blu res=SKIP  recheck=no  gcopy=yes;;
127  99:*)  col=$mgn res=ERROR recheck=yes gcopy=yes;;
128  *:yes) col=$lgn res=XFAIL recheck=no  gcopy=yes;;
129  *:*)   col=$red res=FAIL  recheck=yes gcopy=yes;;
130esac
131
132# Report the test outcome and exit status in the logs, so that one can
133# know whether the test passed or failed simply by looking at the '.log'
134# file, without the need of also peaking into the corresponding '.trs'
135# file (automake bug#11814).
136echo "$res $test_name (exit status: $estatus)" >>$log_file
137
138# Report outcome to console.
139echo "${col}${res}${std}: $test_name"
140
141# Register the test result, and other relevant metadata.
142echo ":test-result: $res" > $trs_file
143echo ":global-test-result: $res" >> $trs_file
144echo ":recheck: $recheck" >> $trs_file
145echo ":copy-in-global-log: $gcopy" >> $trs_file
146
147# Local Variables:
148# mode: shell-script
149# sh-indentation: 2
150# eval: (add-hook 'before-save-hook 'time-stamp)
151# time-stamp-start: "scriptversion="
152# time-stamp-format: "%:y-%02m-%02d.%02H"
153# time-stamp-time-zone: "UTC0"
154# time-stamp-end: "; # UTC"
155# End:
156