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 # We require $(...) support unconditionally.
  61 # We require a few additional shell features only when $EXEEXT is nonempty,
  62 # in order to support automatic $EXEEXT emulation:
  63 # - hyphen-containing alias names
  64 # - we prefer to use ${var#...} substitution, rather than having
  65 #   to work around lack of support for that feature.
  66 # The following code attempts to find a shell with support for these features.
  67 # If the current shell passes the test, we're done.  Otherwise, test other
  68 # shells until we find one that passes.  If one is found, re-exec it.
  69 # If no acceptable shell is found, skip the current test.
  70 #
  71 # Use "9" to indicate success (rather than 0), in case some shell acts
  72 # like Solaris 10's /bin/sh but exits successfully instead of with status 2.
  73
  74 gl_shell_test_script_='
  75 test $(echo y) = y || exit 1
  76 test -z "$EXEEXT" && exit 9
  77 shopt -s expand_aliases
  78 alias a-b="echo zoo"
  79 v=abx
  80      test ${v%x} = ab \
  81   && test ${v#a} = bx \
  82   && test $(a-b) = zoo \
  83   && exit 9
  84 '
  85
  86 if test "x$1" = "x--no-reexec"; then
  87   shift
  88 else
  89   # 'eval'ing the above code makes Solaris 10's /bin/sh exit with $? set to 2.
  90   # It does not evaluate any of the code after the "unexpected" `('.  Thus,
  91   # we must run it in a subshell.
  92   ( eval "$gl_shell_test_script_" ) > /dev/null 2>&1
  93   if test $? = 9; then
  94     : # The current shell is adequate.  No re-exec required.
  95   else
  96     # Search for a shell that meets our requirements.
  97     for re_shell_ in "${CONFIG_SHELL:-no_shell}" /bin/sh bash dash zsh pdksh fail
  98     do
  99       test "$re_shell_" = no_shell && continue
 100       test "$re_shell_" = fail && skip_ failed to find an adequate shell
 101       "$re_shell_" -c "$gl_shell_test_script_" 2>/dev/null
 102       if test $? = 9; then
 103         # Found an acceptable shell.
 104         exec "$re_shell_" "$0" --no-reexec "$@"
 105         echo "$ME_: exec failed" 1>&2
 106         exit 127
 107       fi
 108     done
 109   fi
 110 fi
 111
 112 test -n "$EXEEXT" && shopt -s expand_aliases
 113
 114 # Enable glibc's malloc-perturbing option.
 115 # This is cheap and useful for exposing code that depends on the fact that
 116 # malloc-related functions often return memory that is mostly zeroed.
 117 # If you have the time and cycles, use valgrind to do an even better job.
 118 : ${MALLOC_PERTURB_=87}
 119 export MALLOC_PERTURB_
 120
 121 # We use a trap below for cleanup.  This requires us to go through
 122 # hoops to get the right exit status transported through the handler.
 123 # So use `Exit STATUS' instead of `exit STATUS' inside of the tests.
 124 # Turn off errexit here so that we don't trip the bug with OSF1/Tru64
 125 # sh inside this function.
 126 Exit () { set +e; (exit $1); exit $1; }
 127
 128 # Print warnings (e.g., about skipped and failed tests) to this file number.
 129 # Override by defining to say, 9, in init.cfg, and putting say,
 130 # "export ...ENVVAR_SETTINGS...; exec 9>&2; $(SHELL)" in the definition
 131 # of TESTS_ENVIRONMENT in your tests/Makefile.am file.
 132 # This is useful when using automake's parallel tests mode, to print
 133 # the reason for skip/failure to console, rather than to the .log files.
 134 : ${stderr_fileno_=2}
 135
 136 warn_() { echo "$@" 1>&$stderr_fileno_; }
 137 fail_() { warn_ "$ME_: failed test: $@"; Exit 1; }
 138 skip_() { warn_ "$ME_: skipped test: $@"; Exit 77; }
 139 framework_failure_() { warn_ "$ME_: set-up failure: $@"; Exit 1; }
 140
 141 # This is a stub function that is run upon trap (upon regular exit and
 142 # interrupt).  Override it with a per-test function, e.g., to unmount
 143 # a partition, or to undo any other global state changes.
 144 cleanup_() { :; }
 145
 146 if ( diff --version < /dev/null 2>&1 | grep GNU ) 2>&1 > /dev/null; then
 147   compare() { diff -u "$@"; }
 148 elif ( cmp --version < /dev/null 2>&1 | grep GNU ) 2>&1 > /dev/null; then
 149   compare() { cmp -s "$@"; }
 150 else
 151   compare() { cmp "$@"; }
 152 fi
 153
 154 # An arbitrary prefix to help distinguish test directories.
 155 testdir_prefix_() { printf gt; }
 156
 157 # Run the user-overridable cleanup_ function, remove the temporary
 158 # directory and exit with the incoming value of $?.
 159 remove_tmp_()
 160 {
 161   __st=$?
 162   cleanup_
 163   # cd out of the directory we're about to remove
 164   cd "$initial_cwd_" || cd / || cd /tmp
 165   chmod -R u+rwx "$test_dir_"
 166   # If removal fails and exit status was to be 0, then change it to 1.
 167   rm -rf "$test_dir_" || { test $__st = 0 && __st=1; }
 168   exit $__st
 169 }
 170
 171 # Given a directory name, DIR, if every entry in it that matches *.exe
 172 # contains only the specified bytes (see the case stmt below), then print
 173 # a space-separated list of those names and return 0.  Otherwise, don't
 174 # print anything and return 1.  Naming constraints apply also to DIR.
 175 find_exe_basenames_()
 176 {
 177   feb_dir_=$1
 178   feb_fail_=0
 179   feb_result_=
 180   feb_sp_=
 181   for feb_file_ in $feb_dir_/*.exe; do
 182     case $feb_file_ in
 183       *[!-a-zA-Z/0-9_.+]*) feb_fail_=1; break;;
 184       *) # Remove leading file name components as well as the .exe suffix.
 185          feb_file_=${feb_file_##*/}
 186          feb_file_=${feb_file_%.exe}
 187          feb_result_="$feb_result_$feb_sp_$feb_file_";;
 188     esac
 189     feb_sp_=' '
 190   done
 191   test $feb_fail_ = 0 && printf %s "$feb_result_"
 192   return $feb_fail_
 193 }
 194
 195 # Consider the files in directory, $1.
 196 # For each file name of the form PROG.exe, create an alias named
 197 # PROG that simply invokes PROG.exe, then return 0.  If any selected
 198 # file name or the directory name, $1, contains an unexpected character,
 199 # define no function and return 1.
 200 create_exe_shims_()
 201 {
 202   case $EXEEXT in
 203     '') return 0 ;;
 204     .exe) ;;
 205     *) echo "$0: unexpected \$EXEEXT value: $EXEEXT" 1>&2; return 1 ;;
 206   esac
 207
 208   base_names_=`find_exe_basenames_ $1` \
 209     || { echo "$0 (exe_shim): skipping directory: $1" 1>&2; return 1; }
 210
 211   if test -n "$base_names_"; then
 212     for base_ in $base_names_; do
 213       alias "$base_"="$base_$EXEEXT"
 214     done
 215   fi
 216
 217   return 0
 218 }
 219
 220 # Use this function to prepend to PATH an absolute name for each
 221 # specified, possibly-$initial_cwd_-relative, directory.
 222 path_prepend_()
 223 {
 224   while test $# != 0; do
 225     path_dir_=$1
 226     case $path_dir_ in
 227       '') fail_ "invalid path dir: '$1'";;
 228       /*) abs_path_dir_=$path_dir_;;
 229       *) abs_path_dir_=`cd "$initial_cwd_/$path_dir_" && echo "$PWD"` \
 230            || fail_ "invalid path dir: $path_dir_";;
 231     esac
 232     case $abs_path_dir_ in
 233       *:*) fail_ "invalid path dir: '$abs_path_dir_'";;
 234     esac
 235     PATH="$abs_path_dir_:$PATH"
 236
 237     # Create an alias, FOO, for each FOO.exe in this directory.
 238     create_exe_shims_ "$abs_path_dir_" \
 239       || fail_ "something failed (above): $abs_path_dir_"
 240     shift
 241   done
 242   export PATH
 243 }
 244
 245 setup_()
 246 {
 247   test "$VERBOSE" = yes && set -x
 248
 249   initial_cwd_=$PWD
 250   ME_=`expr "./$0" : '.*/\(.*\)$'`
 251
 252   pfx_=`testdir_prefix_`
 253   test_dir_=`mktempd_ "$initial_cwd_" "$pfx_-$ME_.XXXX"` \
 254     || fail_ "failed to create temporary directory in $initial_cwd_"
 255   cd "$test_dir_"
 256
 257   # These trap statements ensure that the temporary directory, $test_dir_,
 258   # is removed upon exit as well as upon receipt of any of the listed signals.
 259   trap remove_tmp_ 0
 260   for sig_ in 1 2 3 13 15; do
 261     eval "trap 'Exit $(expr $sig_ + 128)' $sig_"
 262   done
 263 }
 264
 265 # Create a temporary directory, much like mktemp -d does.
 266 # Written by Jim Meyering.
 267 #
 268 # Usage: mktempd_ /tmp phoey.XXXXXXXXXX
 269 #
 270 # First, try to use the mktemp program.
 271 # Failing that, we'll roll our own mktemp-like function:
 272 #  - try to get random bytes from /dev/urandom
 273 #  - failing that, generate output from a combination of quickly-varying
 274 #      sources and gzip.  Ignore non-varying gzip header, and extract
 275 #      "random" bits from there.
 276 #  - given those bits, map to file-name bytes using tr, and try to create
 277 #      the desired directory.
 278 #  - make only $MAX_TRIES_ attempts
 279
 280 # Helper function.  Print $N pseudo-random bytes from a-zA-Z0-9.
 281 rand_bytes_()
 282 {
 283   n_=$1
 284
 285   # Maybe try openssl rand -base64 $n_prime_|tr '+/=\012' abcd first?
 286   # But if they have openssl, they probably have mktemp, too.
 287
 288   chars_=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
 289   dev_rand_=/dev/urandom
 290   if test -r "$dev_rand_"; then
 291     # Note: 256-length($chars_) == 194; 3 copies of $chars_ is 186 + 8 = 194.
 292     dd ibs=$n_ count=1 if=$dev_rand_ 2>/dev/null \
 293       | LC_ALL=C tr -c $chars_ 01234567$chars_$chars_$chars_
 294     return
 295   fi
 296
 297   n_plus_50_=`expr $n_ + 50`
 298   cmds_='date; date +%N; free; who -a; w; ps auxww; ps ef; netstat -n'
 299   data_=` (eval "$cmds_") 2>&1 | gzip `
 300
 301   # Ensure that $data_ has length at least 50+$n_
 302   while :; do
 303     len_=`echo "$data_"|wc -c`
 304     test $n_plus_50_ -le $len_ && break;
 305     data_=` (echo "$data_"; eval "$cmds_") 2>&1 | gzip `
 306   done
 307
 308   echo "$data_" \
 309     | dd bs=1 skip=50 count=$n_ 2>/dev/null \
 310     | LC_ALL=C tr -c $chars_ 01234567$chars_$chars_$chars_
 311 }
 312
 313 mktempd_()
 314 {
 315   case $# in
 316   2);;
 317   *) fail_ "Usage: $ME DIR TEMPLATE";;
 318   esac
 319
 320   destdir_=$1
 321   template_=$2
 322
 323   MAX_TRIES_=4
 324
 325   # Disallow any trailing slash on specified destdir:
 326   # it would subvert the post-mktemp "case"-based destdir test.
 327   case $destdir_ in
 328   /) ;;
 329   */) fail_ "invalid destination dir: remove trailing slash(es)";;
 330   esac
 331
 332   case $template_ in
 333   *XXXX) ;;
 334   *) fail_ "invalid template: $template_ (must have a suffix of at least 4 X's)";;
 335   esac
 336
 337   fail=0
 338
 339   # First, try to use mktemp.
 340   d=`unset TMPDIR; mktemp -d -t -p "$destdir_" "$template_" 2>/dev/null` \
 341     || fail=1
 342
 343   # The resulting name must be in the specified directory.
 344   case $d in "$destdir_"*);; *) fail=1;; esac
 345
 346   # It must have created the directory.
 347   test -d "$d" || fail=1
 348
 349   # It must have 0700 permissions.  Handle sticky "S" bits.
 350   perms=`ls -dgo "$d" 2>/dev/null|tr S -` || fail=1
 351   case $perms in drwx------*) ;; *) fail=1;; esac
 352
 353   test $fail = 0 && {
 354     echo "$d"
 355     return
 356   }
 357
 358   # If we reach this point, we'll have to create a directory manually.
 359
 360   # Get a copy of the template without its suffix of X's.
 361   base_template_=`echo "$template_"|sed 's/XX*$//'`
 362
 363   # Calculate how many X's we've just removed.
 364   template_length_=`echo "$template_" | wc -c`
 365   nx_=`echo "$base_template_" | wc -c`
 366   nx_=`expr $template_length_ - $nx_`
 367
 368   err_=
 369   i_=1
 370   while :; do
 371     X_=`rand_bytes_ $nx_`
 372     candidate_dir_="$destdir_/$base_template_$X_"
 373     err_=`mkdir -m 0700 "$candidate_dir_" 2>&1` \
 374       && { echo "$candidate_dir_"; return; }
 375     test $MAX_TRIES_ -le $i_ && break;
 376     i_=`expr $i_ + 1`
 377   done
 378   fail_ "$err_"
 379 }
 380
 381 # If you want to override the testdir_prefix_ function,
 382 # or to add more utility functions, use this file.
 383 test -f "$srcdir/init.cfg" \
 384   && . "$srcdir/init.cfg"
 385
 386 setup_ "$@"