Debian Codegraph @

build-aux/test-driver

raw
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 <[email protected]> or send patches to
28 # <[email protected]>.
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 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
81 done
82
83 missing_opts=
84 test x"$test_name" = x && missing_opts="$missing_opts --test-name"
85 test x"$log_file" = x && missing_opts="$missing_opts --log-file"
86 test x"$trs_file" = x && missing_opts="$missing_opts --trs-file"
87 if test x"$missing_opts" != x; then
88 usage_error "the following mandatory options are missing:$missing_opts"
89 fi
90
91 if test $# -eq 0; then
92 usage_error "missing argument"
93 fi
94
95 if 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.
103 else
104 red= grn= lgn= blu= mgn= std=
105 fi
106
107 do_exit='rm -f $log_file $trs_file; (exit $st); exit $st'
108 trap "st=129; $do_exit" 1
109 trap "st=130; $do_exit" 2
110 trap "st=141; $do_exit" 13
111 trap "st=143; $do_exit" 15
112
113 # Test script is run here. We create the file first, then append to it,
114 # to ameliorate tests themselves also writing to the log file. Our tests
115 # don't, but others can (automake bug#35762).
116 : >"$log_file"
117 "$@" >>"$log_file" 2>&1
118 estatus=$?
119
120 if test $enable_hard_errors = no && test $estatus -eq 99; then
121 tweaked_estatus=1
122 else
123 tweaked_estatus=$estatus
124 fi
125
126 case $tweaked_estatus:$expect_failure in
127 0:yes) col=$red res=XPASS recheck=yes gcopy=yes;;
128 0:*) col=$grn res=PASS recheck=no gcopy=no;;
129 77:*) col=$blu res=SKIP recheck=no gcopy=yes;;
130 99:*) col=$mgn res=ERROR recheck=yes gcopy=yes;;
131 *:yes) col=$lgn res=XFAIL recheck=no gcopy=yes;;
132 *:*) col=$red res=FAIL recheck=yes gcopy=yes;;
133 esac
134
135 # Report the test outcome and exit status in the logs, so that one can
136 # know whether the test passed or failed simply by looking at the '.log'
137 # file, without the need of also peaking into the corresponding '.trs'
138 # file (automake bug#11814).
139 echo "$res $test_name (exit status: $estatus)" >>"$log_file"
140
141 # Report outcome to console.
142 echo "${col}${res}${std}: $test_name"
143
144 # Register the test result, and other relevant metadata.
145 echo ":test-result: $res" > $trs_file
146 echo ":global-test-result: $res" >> $trs_file
147 echo ":recheck: $recheck" >> $trs_file
148 echo ":copy-in-global-log: $gcopy" >> $trs_file
149
150 # Local Variables:
151 # mode: shell-script
152 # sh-indentation: 2
153 # eval: (add-hook 'before-save-hook 'time-stamp)
154 # time-stamp-start: "scriptversion="
155 # time-stamp-format: "%:y-%02m-%02d.%02H"
156 # time-stamp-time-zone: "UTC0"
157 # time-stamp-end: "; # UTC"
158 # End: