|
| 1 | +#! /bin/sh |
| 2 | +# test-driver - basic testsuite driver script. |
| 3 | + |
| 4 | +scriptversion=2018-03-07.03; # UTC |
| 5 | + |
| 6 | +# Copyright (C) 2011-2018 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. |
| 32 | +set -u |
| 33 | + |
| 34 | +usage_error () |
| 35 | +{ |
| 36 | + echo "$0: $*" >&2 |
| 37 | + print_usage >&2 |
| 38 | + exit 2 |
| 39 | +} |
| 40 | + |
| 41 | +print_usage () |
| 42 | +{ |
| 43 | + cat <<END |
| 44 | +Usage: |
| 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 | +The '--test-name', '--log-file' and '--trs-file' options are mandatory. |
| 50 | +END |
| 51 | +} |
| 52 | + |
| 53 | +test_name= # Used for reporting. |
| 54 | +log_file= # Where to save the output of the test script. |
| 55 | +trs_file= # Where to save the metadata of the test run. |
| 56 | +expect_failure=no |
| 57 | +color_tests=no |
| 58 | +enable_hard_errors=yes |
| 59 | +while test $# -gt 0; do |
| 60 | + case $1 in |
| 61 | + --help) print_usage; exit $?;; |
| 62 | + --version) echo "test-driver $scriptversion"; exit $?;; |
| 63 | + --test-name) test_name=$2; shift;; |
| 64 | + --log-file) log_file=$2; shift;; |
| 65 | + --trs-file) trs_file=$2; shift;; |
| 66 | + --color-tests) color_tests=$2; shift;; |
| 67 | + --expect-failure) expect_failure=$2; shift;; |
| 68 | + --enable-hard-errors) enable_hard_errors=$2; shift;; |
| 69 | + --) shift; break;; |
| 70 | + -*) usage_error "invalid option: '$1'";; |
| 71 | + *) break;; |
| 72 | + esac |
| 73 | + shift |
| 74 | +done |
| 75 | + |
| 76 | +missing_opts= |
| 77 | +test x"$test_name" = x && missing_opts="$missing_opts --test-name" |
| 78 | +test x"$log_file" = x && missing_opts="$missing_opts --log-file" |
| 79 | +test x"$trs_file" = x && missing_opts="$missing_opts --trs-file" |
| 80 | +if test x"$missing_opts" != x; then |
| 81 | + usage_error "the following mandatory options are missing:$missing_opts" |
| 82 | +fi |
| 83 | + |
| 84 | +if test $# -eq 0; then |
| 85 | + usage_error "missing argument" |
| 86 | +fi |
| 87 | + |
| 88 | +if test $color_tests = yes; then |
| 89 | + # Keep this in sync with 'lib/am/check.am:$(am__tty_colors)'. |
| 90 | + red='[0;31m' # Red. |
| 91 | + grn='[0;32m' # Green. |
| 92 | + lgn='[1;32m' # Light green. |
| 93 | + blu='[1;34m' # Blue. |
| 94 | + mgn='[0;35m' # Magenta. |
| 95 | + std='[m' # No color. |
| 96 | +else |
| 97 | + red= grn= lgn= blu= mgn= std= |
| 98 | +fi |
| 99 | + |
| 100 | +do_exit='rm -f $log_file $trs_file; (exit $st); exit $st' |
| 101 | +trap "st=129; $do_exit" 1 |
| 102 | +trap "st=130; $do_exit" 2 |
| 103 | +trap "st=141; $do_exit" 13 |
| 104 | +trap "st=143; $do_exit" 15 |
| 105 | + |
| 106 | +# Test script is run here. |
| 107 | +"$@" >$log_file 2>&1 |
| 108 | +estatus=$? |
| 109 | + |
| 110 | +if test $enable_hard_errors = no && test $estatus -eq 99; then |
| 111 | + tweaked_estatus=1 |
| 112 | +else |
| 113 | + tweaked_estatus=$estatus |
| 114 | +fi |
| 115 | + |
| 116 | +case $tweaked_estatus:$expect_failure in |
| 117 | + 0:yes) col=$red res=XPASS recheck=yes gcopy=yes;; |
| 118 | + 0:*) col=$grn res=PASS recheck=no gcopy=no;; |
| 119 | + 77:*) col=$blu res=SKIP recheck=no gcopy=yes;; |
| 120 | + 99:*) col=$mgn res=ERROR recheck=yes gcopy=yes;; |
| 121 | + *:yes) col=$lgn res=XFAIL recheck=no gcopy=yes;; |
| 122 | + *:*) col=$red res=FAIL recheck=yes gcopy=yes;; |
| 123 | +esac |
| 124 | + |
| 125 | +# Report the test outcome and exit status in the logs, so that one can |
| 126 | +# know whether the test passed or failed simply by looking at the '.log' |
| 127 | +# file, without the need of also peaking into the corresponding '.trs' |
| 128 | +# file (automake bug#11814). |
| 129 | +echo "$res $test_name (exit status: $estatus)" >>$log_file |
| 130 | + |
| 131 | +# Report outcome to console. |
| 132 | +echo "${col}${res}${std}: $test_name" |
| 133 | + |
| 134 | +# Register the test result, and other relevant metadata. |
| 135 | +echo ":test-result: $res" > $trs_file |
| 136 | +echo ":global-test-result: $res" >> $trs_file |
| 137 | +echo ":recheck: $recheck" >> $trs_file |
| 138 | +echo ":copy-in-global-log: $gcopy" >> $trs_file |
| 139 | + |
| 140 | +# Local Variables: |
| 141 | +# mode: shell-script |
| 142 | +# sh-indentation: 2 |
| 143 | +# eval: (add-hook 'before-save-hook 'time-stamp) |
| 144 | +# time-stamp-start: "scriptversion=" |
| 145 | +# time-stamp-format: "%:y-%02m-%02d.%02H" |
| 146 | +# time-stamp-time-zone: "UTC0" |
| 147 | +# time-stamp-end: "; # UTC" |
| 148 | +# End: |
0 commit comments