1 # source this file; set up for tests
3 # Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Using this file in a test
19 # =========================
21 # The typical skeleton of a test looks like this:
25 # . "$srcdir/init.sh"; path_prepend_ .
26 # Execute some commands.
27 # Note that these commands are executed in a subdirectory, therefore you
28 # need to prepend "../" to relative filenames in the build directory.
29 # Set the exit code 0 for success, 77 for skipped, or 1 or other for failure.
30 # Use the skip_ and fail_ functions to print a diagnostic and then exit
31 # with the corresponding exit code.
34 # Executing a test that uses this file
35 # ====================================
37 # Running a single test:
38 # $ make check TESTS=test-foo.sh
40 # Running a single test, with verbose output:
41 # $ make check TESTS=test-foo.sh VERBOSE=yes
43 # Running a single test, with single-stepping:
44 # 1. Go into a sub-shell:
46 # 2. Set relevant environment variables from TESTS_ENVIRONMENT in the
48 # $ export srcdir=../../tests # this is an example
49 # 3. Execute the commands from the test, copy&pasting them one by one:
50 # $ . "$srcdir/init.sh"; path_prepend_ .
55 # We use a trap below for cleanup. This requires us to go through
56 # hoops to get the right exit status transported through the handler.
57 # So use `Exit STATUS' instead of `exit STATUS' inside of the tests.
58 # Turn off errexit here so that we don't trip the bug with OSF1/Tru64
59 # sh inside this function.
60 Exit () { set +e; (exit $1); exit $1; }
62 fail_() { echo "$ME_: failed test: $@" 1>&2; Exit 1; }
63 skip_() { echo "$ME_: skipped test: $@" 1>&2; Exit 77; }
65 # This is a stub function that is run upon trap (upon regular exit and
66 # interrupt). Override it with a per-test function, e.g., to unmount
67 # a partition, or to undo any other global state changes.
70 if ( diff --version < /dev/null 2>&1 | grep GNU ) 2>&1 > /dev/null; then
71 compare() { diff -u "$@"; }
72 elif ( cmp --version < /dev/null 2>&1 | grep GNU ) 2>&1 > /dev/null; then
73 compare() { cmp -s "$@"; }
75 compare() { cmp "$@"; }
78 # An arbitrary prefix to help distinguish test directories.
79 testdir_prefix_() { printf gt; }
81 # Run the user-overridable cleanup_ function, remove the temporary
82 # directory and exit with the incoming value of $?.
87 # cd out of the directory we're about to remove
88 cd "$initial_cwd_" || cd / || cd /tmp
89 chmod -R u+rwx "$test_dir_"
90 # If removal fails and exit status was to be 0, then change it to 1.
91 rm -rf "$test_dir_" || { test $__st = 0 && __st=1; }
95 # Use this function to prepend to PATH an absolute name for each
96 # specified, possibly-$initial_cwd_relative, directory.
99 while test $# != 0; do
102 '') fail_ "invalid path dir: '$1'";;
103 /*) abs_path_dir_=$path_dir_;;
104 *) abs_path_dir_=`cd "$initial_cwd_/$path_dir_" && echo "$PWD"` \
105 || fail_ "invalid path dir: $path_dir_";;
107 case $abs_path_dir_ in
108 *:*) fail_ "invalid path dir: '$abs_path_dir_'";;
110 PATH="$abs_path_dir_:$PATH"
118 test "$VERBOSE" = yes && set -x
121 ME_=`expr "./$0" : '.*/\(.*\)$'`
123 pfx_=`testdir_prefix_`
124 test_dir_=`mktempd_ "$initial_cwd_" "$pfx_-$ME_.XXXX"` \
125 || fail_ "failed to create temporary directory in $initial_cwd_"
128 # This pair of trap statements ensures that the temporary directory,
129 # $test_dir_, is removed upon exit as well as upon catchable signal.
131 trap 'Exit $?' 1 2 13 15
134 # Create a temporary directory, much like mktemp -d does.
135 # Written by Jim Meyering.
137 # Usage: mktempd_ /tmp phoey.XXXXXXXXXX
139 # First, try to use the mktemp program.
140 # Failing that, we'll roll our own mktemp-like function:
141 # - try to get random bytes from /dev/urandom
142 # - failing that, generate output from a combination of quickly-varying
143 # sources and gzip. Ignore non-varying gzip header, and extract
144 # "random" bits from there.
145 # - given those bits, map to file-name bytes using tr, and try to create
146 # the desired directory.
147 # - make only $MAX_TRIES_ attempts
149 # Helper function. Print $N pseudo-random bytes from a-zA-Z0-9.
154 # Maybe try openssl rand -base64 $n_prime_|tr '+/=\012' abcd first?
155 # But if they have openssl, they probably have mktemp, too.
157 chars_=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
158 dev_rand_=/dev/urandom
159 if test -r "$dev_rand_"; then
160 # Note: 256-length($chars_) == 194; 3 copies of $chars_ is 186 + 8 = 194.
161 dd ibs=$n_ count=1 if=$dev_rand_ 2>/dev/null \
162 | tr -c $chars_ 01234567$chars_$chars_$chars_
166 n_plus_50_=`expr $n_ + 50`
167 cmds_='date; date +%N; free; who -a; w; ps auxww; ps ef; netstat -n'
168 data_=` (eval "$cmds_") 2>&1 | gzip `
170 # Ensure that $data_ has length at least 50+$n_
172 len_=`echo "$data_"|wc -c`
173 test $n_plus_50_ -le $len_ && break;
174 data_=` (echo "$data_"; eval "$cmds_") 2>&1 | gzip `
178 | dd bs=1 skip=50 count=$n_ 2>/dev/null \
179 | tr -c $chars_ 01234567$chars_$chars_$chars_
186 *) fail_ "Usage: $ME DIR TEMPLATE";;
194 # Disallow any trailing slash on specified destdir:
195 # it would subvert the post-mktemp "case"-based destdir test.
198 */) fail_ "invalid destination dir: remove trailing slash(es)";;
203 *) fail_ "invalid template: $template_ (must have a suffix of at least 4 X's)";;
208 # First, try to use mktemp.
209 d=`env -u TMPDIR mktemp -d -t -p "$destdir_" "$template_" 2>/dev/null` \
212 # The resulting name must be in the specified directory.
213 case $d in "$destdir_"*);; *) fail=1;; esac
215 # It must have created the directory.
216 test -d "$d" || fail=1
218 # It must have 0700 permissions. Handle sticky "S" bits.
219 perms=`ls -dgo "$d" 2>/dev/null|tr S -` || fail=1
220 case $perms in drwx------*) ;; *) fail=1;; esac
227 # If we reach this point, we'll have to create a directory manually.
229 # Get a copy of the template without its suffix of X's.
230 base_template_=`echo "$template_"|sed 's/XX*$//'`
232 # Calculate how many X's we've just removed.
233 template_length_=`echo "$template_" | wc -c`
234 nx_=`echo "$base_template_" | wc -c`
235 nx_=`expr $template_length_ - $nx_`
240 X_=`rand_bytes_ $nx_`
241 candidate_dir_="$destdir_/$base_template_$X_"
242 err_=`mkdir -m 0700 "$candidate_dir_" 2>&1` \
243 && { echo "$candidate_dir_"; return; }
244 test $MAX_TRIES_ -le $i_ && break;
250 # If you want to override the testdir_prefix_ function,
251 # or to add more utility functions, use this file.
252 test -f "$srcdir/init.cfg" \
253 && . "$srcdir/init.cfg"