tests/init.sh

   1 # source this file; set up for tests
   2
   3 # Copyright (C) 2009, 2010 Free Software Foundation, Inc.
   4
   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.
   9
  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.
  14
  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/>.
  17
  18 # Using this file in a test
  19 # =========================
  20 #
  21 # The typical skeleton of a test looks like this:
  22 #
  23 #   #!/bin/sh
  24 #   . "${srcdir=.}/init.sh"; path_prepend_ .
  25 #   Execute some commands.
  26 #   Note that these commands are executed in a subdirectory, therefore you
  27 #   need to prepend "../" to relative filenames in the build directory.
  28 #   Note that the "path_prepend_ ." is useful only if the body of your
  29 #   test invokes programs residing in the initial directory.
  30 #   For example, if the programs you want to test are in src/, and this test
  31 #   script is named tests/test-1, then you would use "path_prepend_ ../src",
  32 #   or perhaps export PATH='$(abs_top_builddir)/src$(PATH_SEPARATOR)'"$$PATH"
  33 #   to all tests via automake's TESTS_ENVIRONMENT.
  34 #   Set the exit code 0 for success, 77 for skipped, or 1 or other for failure.
  35 #   Use the skip_ and fail_ functions to print a diagnostic and then exit
  36 #   with the corresponding exit code.
  37 #   Exit $?
  38
  39 # Executing a test that uses this file
  40 # ====================================
  41 #
  42 # Running a single test:
  43 #   $ make check TESTS=test-foo.sh
  44 #
  45 # Running a single test, with verbose output:
  46 #   $ make check TESTS=test-foo.sh VERBOSE=yes
  47 #
  48 # Running a single test, with single-stepping:
  49 #   1. Go into a sub-shell:
  50 #   $ bash
  51 #   2. Set relevant environment variables from TESTS_ENVIRONMENT in the
  52 #      Makefile:
  53 #   $ export srcdir=../../tests # this is an example
  54 #   3. Execute the commands from the test, copy&pasting them one by one:
  55 #   $ . "$srcdir/init.sh"; path_prepend_ .
  56 #   ...
  57 #   4. Finally
  58 #   $ exit
  59
  60 ME_=`expr "./$0" : '.*/\(.*\)$'`
  61
  62 # We use a trap below for cleanup.  This requires us to go through
  63 # hoops to get the right exit status transported through the handler.
  64 # So use `Exit STATUS' instead of `exit STATUS' inside of the tests.
  65 # Turn off errexit here so that we don't trip the bug with OSF1/Tru64
  66 # sh inside this function.
  67 Exit () { set +e; (exit $1); exit $1; }
  68
  69 # Print warnings (e.g., about skipped and failed tests) to this file number.
  70 # Override by defining to say, 9, in init.cfg, and putting say,
  71 # "export ...ENVVAR_SETTINGS...; exec 9>&2; $(SHELL)" in the definition
  72 # of TESTS_ENVIRONMENT in your tests/Makefile.am file.
  73 # This is useful when using automake's parallel tests mode, to print
  74 # the reason for skip/failure to console, rather than to the .log files.
  75 : ${stderr_fileno_=2}
  76
  77 warn_() { echo "$@" 1>&$stderr_fileno_; }
  78 fail_() { warn_ "$ME_: failed test: $@"; Exit 1; }
  79 skip_() { warn_ "$ME_: skipped test: $@"; Exit 77; }
  80 framework_failure_() { warn_ "$ME_: set-up failure: $@"; Exit 99; }
  81
  82 # Sanitize this shell to POSIX mode, if possible.
  83 DUALCASE=1; export DUALCASE
  84 if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then
  85   emulate sh
  86   NULLCMD=:
  87   alias -g '${1+"$@"}'='"$@"'
  88   setopt NO_GLOB_SUBST
  89 else
  90   case `(set -o) 2>/dev/null` in
  91     *posix*) set -o posix ;;
  92   esac
  93 fi
  94
  95 # We require $(...) support unconditionally.
  96 # We require a few additional shell features only when $EXEEXT is nonempty,
  97 # in order to support automatic $EXEEXT emulation:
  98 # - hyphen-containing alias names
  99 # - we prefer to use ${var#...} substitution, rather than having
 100 #   to work around lack of support for that feature.
 101 # The following code attempts to find a shell with support for these features.
 102 # If the current shell passes the test, we're done.  Otherwise, test other
 103 # shells until we find one that passes.  If one is found, re-exec it.
 104 # If no acceptable shell is found, skip the current test.
 105 #
 106 # The "...set -x; P=1 true 2>err..." test is to disqualify any shell that
 107 # emits "P=1" into err, as /bin/sh from SunOS 5.11 and OpenBSD 4.7 do.
 108 #
 109 # Use "9" to indicate success (rather than 0), in case some shell acts
 110 # like Solaris 10's /bin/sh but exits successfully instead of with status 2.
 111
 112 # Eval this code in a subshell to determine a shell's suitability.
 113 # 10 - passes all tests; ok to use
 114 #  9 - ok, but enabling "set -x" corrupts application stderr; prefer higher score
 115 #  ? - not ok
 116 gl_shell_test_script_='
 117 test $(echo y) = y || exit 1
 118 score_=10
 119 if test "$VERBOSE" = yes; then
 120   test -n "$( (exec 3>&1; set -x; P=1 true 2>&3) 2> /dev/null)" && score_=9
 121 fi
 122 test -z "$EXEEXT" && exit $score_
 123 shopt -s expand_aliases
 124 alias a-b="echo zoo"
 125 v=abx
 126      test ${v%x} = ab \
 127   && test ${v#a} = bx \
 128   && test $(a-b) = zoo \
 129   && exit $score_
 130 '
 131
 132 if test "x$1" = "x--no-reexec"; then
 133   shift
 134 else
 135   # Assume a working shell.  Export to subshells (setup_ needs this).
 136   gl_set_x_corrupts_stderr_=false
 137   export gl_set_x_corrupts_stderr_
 138
 139   # Record the first marginally acceptable shell.
 140   marginal_=
 141
 142   # Search for a shell that meets our requirements.
 143   for re_shell_ in __current__ "${CONFIG_SHELL:-no_shell}" \
 144       /bin/sh bash dash zsh pdksh fail
 145   do
 146     test "$re_shell_" = no_shell && continue
 147
 148     # If we've made it all the way to the sentinel, "fail" without
 149     # finding even a marginal shell, skip this test.
 150     if test "$re_shell_" = fail; then
 151       test -z "$marginal_" && skip_ failed to find an adequate shell
 152       re_shell_=$marginal_
 153       break
 154     fi
 155
 156     # When testing the current shell, simply "eval" the test code.
 157     # Otherwise, run it via $re_shell_ -c ...
 158     if test "$re_shell_" = __current__; then
 159       # 'eval'ing this code makes Solaris 10's /bin/sh exit with
 160       # $? set to 2.  It does not evaluate any of the code after the
 161       # "unexpected" first `('.  Thus, we must run it in a subshell.
 162       ( eval "$gl_shell_test_script_" ) > /dev/null 2>&1
 163     else
 164       "$re_shell_" -c "$gl_shell_test_script_" 2>/dev/null
 165     fi
 166
 167     st_=$?
 168
 169     # $re_shell_ works just fine.  Use it.
 170     test $st_ = 10 && break
 171
 172     # If this is our first marginally acceptable shell, remember it.
 173     if test "$st_:$marginal_" = 9: ; then
 174       marginal_="$re_shell_"
 175       gl_set_x_corrupts_stderr_=true
 176     fi
 177   done
 178
 179   if test "$re_shell_" != __current__; then
 180     # Found a usable shell.  Preserve -v and -x.
 181     case $- in
 182       *v*x* | *x*v*) opts_=-vx ;;
 183       *v*) opts_=-v ;;
 184       *x*) opts_=-x ;;
 185       *) opts_= ;;
 186     esac
 187     exec "$re_shell_" $opts_ "$0" --no-reexec "$@"
 188     echo "$ME_: exec failed" 1>&2
 189     exit 127
 190   fi
 191 fi
 192
 193 test -n "$EXEEXT" && shopt -s expand_aliases
 194
 195 # Enable glibc's malloc-perturbing option.
 196 # This is cheap and useful for exposing code that depends on the fact that
 197 # malloc-related functions often return memory that is mostly zeroed.
 198 # If you have the time and cycles, use valgrind to do an even better job.
 199 : ${MALLOC_PERTURB_=87}
 200 export MALLOC_PERTURB_
 201
 202 # This is a stub function that is run upon trap (upon regular exit and
 203 # interrupt).  Override it with a per-test function, e.g., to unmount
 204 # a partition, or to undo any other global state changes.
 205 cleanup_() { :; }
 206
 207 if ( diff --version < /dev/null 2>&1 | grep GNU ) > /dev/null 2>&1; then
 208   compare() { diff -u "$@"; }
 209 elif ( cmp --version < /dev/null 2>&1 | grep GNU ) > /dev/null 2>&1; then
 210   compare() { cmp -s "$@"; }
 211 else
 212   compare() { cmp "$@"; }
 213 fi
 214
 215 # An arbitrary prefix to help distinguish test directories.
 216 testdir_prefix_() { printf gt; }
 217
 218 # Run the user-overridable cleanup_ function, remove the temporary
 219 # directory and exit with the incoming value of $?.
 220 remove_tmp_()
 221 {
 222   __st=$?
 223   cleanup_
 224   # cd out of the directory we're about to remove
 225   cd "$initial_cwd_" || cd / || cd /tmp
 226   chmod -R u+rwx "$test_dir_"
 227   # If removal fails and exit status was to be 0, then change it to 1.
 228   rm -rf "$test_dir_" || { test $__st = 0 && __st=1; }
 229   exit $__st
 230 }
 231
 232 # Given a directory name, DIR, if every entry in it that matches *.exe
 233 # contains only the specified bytes (see the case stmt below), then print
 234 # a space-separated list of those names and return 0.  Otherwise, don't
 235 # print anything and return 1.  Naming constraints apply also to DIR.
 236 find_exe_basenames_()
 237 {
 238   feb_dir_=$1
 239   feb_fail_=0
 240   feb_result_=
 241   feb_sp_=
 242   for feb_file_ in $feb_dir_/*.exe; do
 243     case $feb_file_ in
 244       *[!-a-zA-Z/0-9_.+]*) feb_fail_=1; break;;
 245       *) # Remove leading file name components as well as the .exe suffix.
 246          feb_file_=${feb_file_##*/}
 247          feb_file_=${feb_file_%.exe}
 248          feb_result_="$feb_result_$feb_sp_$feb_file_";;
 249     esac
 250     feb_sp_=' '
 251   done
 252   test $feb_fail_ = 0 && printf %s "$feb_result_"
 253   return $feb_fail_
 254 }
 255
 256 # Consider the files in directory, $1.
 257 # For each file name of the form PROG.exe, create an alias named
 258 # PROG that simply invokes PROG.exe, then return 0.  If any selected
 259 # file name or the directory name, $1, contains an unexpected character,
 260 # define no function and return 1.
 261 create_exe_shims_()
 262 {
 263   case $EXEEXT in
 264     '') return 0 ;;
 265     .exe) ;;
 266     *) echo "$0: unexpected \$EXEEXT value: $EXEEXT" 1>&2; return 1 ;;
 267   esac
 268
 269   base_names_=`find_exe_basenames_ $1` \
 270     || { echo "$0 (exe_shim): skipping directory: $1" 1>&2; return 1; }
 271
 272   if test -n "$base_names_"; then
 273     for base_ in $base_names_; do
 274       alias "$base_"="$base_$EXEEXT"
 275     done
 276   fi
 277
 278   return 0
 279 }
 280
 281 # Use this function to prepend to PATH an absolute name for each
 282 # specified, possibly-$initial_cwd_-relative, directory.
 283 path_prepend_()
 284 {
 285   while test $# != 0; do
 286     path_dir_=$1
 287     case $path_dir_ in
 288       '') fail_ "invalid path dir: '$1'";;
 289       /*) abs_path_dir_=$path_dir_;;
 290       *) abs_path_dir_=`cd "$initial_cwd_/$path_dir_" && echo "$PWD"` \
 291            || fail_ "invalid path dir: $path_dir_";;
 292     esac
 293     case $abs_path_dir_ in
 294       *:*) fail_ "invalid path dir: '$abs_path_dir_'";;
 295     esac
 296     PATH="$abs_path_dir_:$PATH"
 297
 298     # Create an alias, FOO, for each FOO.exe in this directory.
 299     create_exe_shims_ "$abs_path_dir_" \
 300       || fail_ "something failed (above): $abs_path_dir_"
 301     shift
 302   done
 303   export PATH
 304 }
 305
 306 setup_()
 307 {
 308   if test "$VERBOSE" = yes; then
 309     # Test whether set -x may cause the selected shell to corrupt an
 310     # application's stderr.  Many do, including zsh-4.3.10 and the /bin/sh
 311     # from SunOS 5.11, OpenBSD 4.7 and Irix 5.x and 6.5.
 312     # If enabling verbose output this way would cause trouble, simply
 313     # issue a warning and refrain.
 314     if $gl_set_x_corrupts_stderr_; then
 315       warn_ "using SHELL=$SHELL with 'set -x' corrupts stderr"
 316     else
 317       set -x
 318     fi
 319   fi
 320
 321   initial_cwd_=$PWD
 322
 323   pfx_=`testdir_prefix_`
 324   test_dir_=`mktempd_ "$initial_cwd_" "$pfx_-$ME_.XXXX"` \
 325     || fail_ "failed to create temporary directory in $initial_cwd_"
 326   cd "$test_dir_"
 327
 328   # This trap statement, along with a trap on 0 below, ensure that the
 329   # temporary directory, $test_dir_, is removed upon exit as well as
 330   # upon receipt of any of the listed signals.
 331   for sig_ in 1 2 3 13 15; do
 332     eval "trap 'Exit $(expr $sig_ + 128)' $sig_"
 333   done
 334 }
 335
 336 # Create a temporary directory, much like mktemp -d does.
 337 # Written by Jim Meyering.
 338 #
 339 # Usage: mktempd_ /tmp phoey.XXXXXXXXXX
 340 #
 341 # First, try to use the mktemp program.
 342 # Failing that, we'll roll our own mktemp-like function:
 343 #  - try to get random bytes from /dev/urandom
 344 #  - failing that, generate output from a combination of quickly-varying
 345 #      sources and gzip.  Ignore non-varying gzip header, and extract
 346 #      "random" bits from there.
 347 #  - given those bits, map to file-name bytes using tr, and try to create
 348 #      the desired directory.
 349 #  - make only $MAX_TRIES_ attempts
 350
 351 # Helper function.  Print $N pseudo-random bytes from a-zA-Z0-9.
 352 rand_bytes_()
 353 {
 354   n_=$1
 355
 356   # Maybe try openssl rand -base64 $n_prime_|tr '+/=\012' abcd first?
 357   # But if they have openssl, they probably have mktemp, too.
 358
 359   chars_=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
 360   dev_rand_=/dev/urandom
 361   if test -r "$dev_rand_"; then
 362     # Note: 256-length($chars_) == 194; 3 copies of $chars_ is 186 + 8 = 194.
 363     dd ibs=$n_ count=1 if=$dev_rand_ 2>/dev/null \
 364       | LC_ALL=C tr -c $chars_ 01234567$chars_$chars_$chars_
 365     return
 366   fi
 367
 368   n_plus_50_=`expr $n_ + 50`
 369   cmds_='date; date +%N; free; who -a; w; ps auxww; ps ef; netstat -n'
 370   data_=` (eval "$cmds_") 2>&1 | gzip `
 371
 372   # Ensure that $data_ has length at least 50+$n_
 373   while :; do
 374     len_=`echo "$data_"|wc -c`
 375     test $n_plus_50_ -le $len_ && break;
 376     data_=` (echo "$data_"; eval "$cmds_") 2>&1 | gzip `
 377   done
 378
 379   echo "$data_" \
 380     | dd bs=1 skip=50 count=$n_ 2>/dev/null \
 381     | LC_ALL=C tr -c $chars_ 01234567$chars_$chars_$chars_
 382 }
 383
 384 mktempd_()
 385 {
 386   case $# in
 387   2);;
 388   *) fail_ "Usage: $ME DIR TEMPLATE";;
 389   esac
 390
 391   destdir_=$1
 392   template_=$2
 393
 394   MAX_TRIES_=4
 395
 396   # Disallow any trailing slash on specified destdir:
 397   # it would subvert the post-mktemp "case"-based destdir test.
 398   case $destdir_ in
 399   /) ;;
 400   */) fail_ "invalid destination dir: remove trailing slash(es)";;
 401   esac
 402
 403   case $template_ in
 404   *XXXX) ;;
 405   *) fail_ "invalid template: $template_ (must have a suffix of at least 4 X's)";;
 406   esac
 407
 408   fail=0
 409
 410   # First, try to use mktemp.
 411   d=`unset TMPDIR; mktemp -d -t -p "$destdir_" "$template_" 2>/dev/null` \
 412     || fail=1
 413
 414   # The resulting name must be in the specified directory.
 415   case $d in "$destdir_"*);; *) fail=1;; esac
 416
 417   # It must have created the directory.
 418   test -d "$d" || fail=1
 419
 420   # It must have 0700 permissions.  Handle sticky "S" bits.
 421   perms=`ls -dgo "$d" 2>/dev/null|tr S -` || fail=1
 422   case $perms in drwx------*) ;; *) fail=1;; esac
 423
 424   test $fail = 0 && {
 425     echo "$d"
 426     return
 427   }
 428
 429   # If we reach this point, we'll have to create a directory manually.
 430
 431   # Get a copy of the template without its suffix of X's.
 432   base_template_=`echo "$template_"|sed 's/XX*$//'`
 433
 434   # Calculate how many X's we've just removed.
 435   template_length_=`echo "$template_" | wc -c`
 436   nx_=`echo "$base_template_" | wc -c`
 437   nx_=`expr $template_length_ - $nx_`
 438
 439   err_=
 440   i_=1
 441   while :; do
 442     X_=`rand_bytes_ $nx_`
 443     candidate_dir_="$destdir_/$base_template_$X_"
 444     err_=`mkdir -m 0700 "$candidate_dir_" 2>&1` \
 445       && { echo "$candidate_dir_"; return; }
 446     test $MAX_TRIES_ -le $i_ && break;
 447     i_=`expr $i_ + 1`
 448   done
 449   fail_ "$err_"
 450 }
 451
 452 # If you want to override the testdir_prefix_ function,
 453 # or to add more utility functions, use this file.
 454 test -f "$srcdir/init.cfg" \
 455   && . "$srcdir/init.cfg"
 456
 457 setup_ "$@"
 458 # This trap is here, rather than in the setup_ function, because some
 459 # shells run the exit trap at shell function exit, rather than script exit.
 460 trap remove_tmp_ 0