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