t/ax/am-test-lib.sh

   1 # -*- shell-script -*-
   2 #
   3 # Copyright (C) 1996-2013 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 2, or (at your option)
   8 # 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 ########################################################
  19 ###  IMPORTANT NOTE: keep this file 'set -e' clean.  ###
  20 ########################################################
  21
  22 # Do not source several times.
  23 test ${am_test_lib_sourced-no} = yes && return 0
  24 am_test_lib_sourced=yes
  25
  26 # A literal escape character.  Used by test checking colored output.
  27 esc='\e'
  28
  29 # This might be used in testcases checking distribution-related features.
  30 # Test scripts are free to override this if they need to.
  31 distdir=$me-1.0
  32
  33 ## ---------------------- ##
  34 ##  Environment cleanup.  ##
  35 ## ---------------------- ##
  36
  37 # Unset some make-related variables that may cause $MAKE to act like
  38 # a recursively invoked sub-make.  Any $MAKE invocation in a test is
  39 # conceptually an independent invocation, not part of the main
  40 # 'automake' build.
  41 unset MFLAGS MAKEFLAGS AM_MAKEFLAGS MAKELEVEL
  42 unset __MKLVL__ MAKE_JOBS_FIFO                     # For BSD make.
  43 unset DMAKE_CHILD DMAKE_DEF_PRINTED DMAKE_MAX_JOBS # For Solaris dmake.
  44 # Unset verbosity flag.
  45 unset V
  46 # Also unset variables that might influence "make install".
  47 unset DESTDIR
  48 unset prefix exec_prefix bindir datarootdir datadir docdir dvidir
  49 unset htmldir includedir infodir libdir libexecdir localedir mandir
  50 unset oldincludedir pdfdir psdir sbindir sharedstatedir sysconfdir
  51 # Unset variables that might influence "make distcheck".
  52 unset DISTCHECK_CONFIGURE_FLAGS AM_DISTCHECK_CONFIGURE_FLAGS
  53 # Used by install rules for info files.
  54 unset AM_UPDATE_INFO_DIR
  55 # We don't want to use the $srcdir value exported by the test driver.
  56 unset srcdir
  57 # Also unset variables that control our test driver.  While not
  58 # conceptually independent, they cause some changed semantics we
  59 # need to control (and test for) in some of the tests to ensure
  60 # backward-compatible behavior.
  61 unset TESTS_ENVIRONMENT AM_TESTS_ENVIRONMENT
  62 unset DISABLE_HARD_ERRORS
  63 unset AM_COLOR_TESTS
  64 unset TESTS
  65 unset XFAIL_TESTS
  66 unset TEST_LOGS
  67 unset TEST_SUITE_LOG
  68 unset RECHECK_LOGS
  69 unset VERBOSE
  70 for pfx in TEST_ SH_ TAP_ ''; do
  71   unset ${pfx}LOG_COMPILER
  72   unset ${pfx}LOG_COMPILE # Not a typo!
  73   unset ${pfx}LOG_FLAGS
  74   unset AM_${pfx}LOG_FLAGS
  75   unset ${pfx}LOG_DRIVER
  76   unset ${pfx}LOG_DRIVER_FLAGS
  77   unset AM_${pfx}LOG_DRIVER_FLAGS
  78 done
  79 unset pfx
  80
  81 # cross_compiling
  82 # ---------------
  83 # Tell whether we are cross-compiling.  This is especially useful to skip
  84 # tests (or portions of them) that requires a native compiler.
  85 cross_compiling ()
  86 {
  87   # Quoting from the autoconf manual:
  88   #   ... [$host_alias and $build both] default to the result of running
  89   #   config.guess, unless you specify either --build or --host.  In
  90   #   this case, the default becomes the system type you specified.
  91   #   If you specify both, *and they're different*, configure enters
  92   #   cross compilation mode (so it doesn't run any tests that require
  93   #   execution).
  94   test x"$host_alias" != x && test x"$build_alias" != x"$host_alias"
  95 }
  96
  97 # is_blocked_signal SIGNAL-NUMBER
  98 # --------------------------------
  99 # Return success if the given signal number is blocked in the shell,
 100 # return a non-zero exit status and print a proper diagnostic otherwise.
 101 is_blocked_signal ()
 102 {
 103   # Use perl, since trying to do this portably in the shell can be
 104   # very tricky, if not downright impossible.  For reference, see:
 105   # <http://lists.gnu.org/archive/html/bug-autoconf/2011-09/msg00004.html>
 106   if $PERL -w -e '
 107     use strict;
 108     use warnings FATAL => "all";
 109     use POSIX;
 110     my %oldsigaction = ();
 111     sigaction('"$1"', 0, \%oldsigaction);
 112     exit ($oldsigaction{"HANDLER"} eq "IGNORE" ? 0 : 77);
 113   '; then
 114     return 0
 115   elif test $? -eq 77; then
 116     return 1
 117   else
 118     fatal_ "couldn't determine whether signal $1 is blocked"
 119   fi
 120 }
 121
 122 # single_quote STRING
 123 # -------------------
 124 # Single-quote STRING for the shell, also dealing with embedded single
 125 # quotes. Place the result in the '$am_result', that is thus to be
 126 # considered public.
 127 single_quote ()
 128 {
 129   am_result=$1
 130   case $am_result in
 131     *\'*) am_result=$(printf '%s\n' "$*" | sed -e "s/'/'\\\\''/g");;
 132   esac
 133   am_result="'$am_result'"
 134 }
 135
 136 # append_single_quoted VARIABLE STRING
 137 # ------------------------------------
 138 append_single_quoted ()
 139 {
 140   am__var=$1; shift
 141   single_quote "$1" # Sets 'am_result'.
 142   eval "${am__var}=\${$am__var:+\"\${$am__var} \"}\$am_result"
 143   unset am__var am_result
 144 }
 145
 146 # is_valid_varname STRING
 147 # -----------------------
 148 # Tell whether STRING is a valid name for a shell variable.  Return 0
 149 # if yes, return 1 if not.
 150 is_valid_varname ()
 151 {
 152   # FIXME: is the below truly portable even for LC_COLLATE != "C" ?
 153   case $1 in
 154     [0-9]*) return 1;;
 155     *[!a-zA-Z0-9_]*) return 1;;
 156   esac
 157   return 0
 158 }
 159
 160 # run_make [-e STATUS] [-O] [-E] [-M] [--] [VAR=VAL ...] [MAKE-ARGS...]
 161 # ---------------------------------------------------------------------
 162 #
 163 # Run $MAKE with the given command-line, and fail if it doesn't exit with
 164 # STATUS (default: 0).  If STATUS is "FAIL", then any exit status > 0 is
 165 # acceptable.  If STATUS is "IGNORE", any exit value is acceptable.
 166 #
 167 # Other options:
 168 #
 169 #  -O   save the standard output from make on disk, in a regular file
 170 #       named 'stdout'.
 171 #
 172 #  -E   save the standard error from make on disk, in a regular file
 173 #       named 'stderr'.
 174 #
 175 #  -M   save both the standard output and standard error from make on
 176 #       disk, in a regular file named 'output'. This option supersedes
 177 #       both the '-O' and '-E' options.
 178 #
 179 # This function also handle command-line override of variable definition
 180 # in a smart way, using AM_MAKEFLAGS if a non-GNU make implementation
 181 # is in use.
 182 #
 183 run_make ()
 184 {
 185   am__make_redirect_stdout=no
 186   am__make_redirect_stderr=no
 187   am__make_redirect_stdall=no
 188   am__make_flags=
 189   am__make_rc_exp=0
 190   # Follow-up code might want to analyse this, so mark is as
 191   # publicly accessible (no double undesrscore).
 192   am_make_rc=0
 193   # Parse options for this function.
 194   while test $# -gt 0; do
 195     case $1 in
 196       -e) am__make_rc_exp=$2; shift;;
 197       -O) am__make_redirect_stdout=yes;;
 198       -E) am__make_redirect_stderr=yes;;
 199       -M) am__make_redirect_stdall=yes;;
 200       --) shift; break;;
 201        *) break;;
 202     esac
 203     shift
 204   done
 205
 206   # Use append mode here to avoid dropping output.  See automake bug#11413
 207   if using_gmake; then
 208     # We can trust GNU make to correctly pass macro definitions given
 209     # on the command line down to sub-make invocations, and this allow
 210     # us to have a vary simple implementation: delegate all the work
 211     # to GNU make.
 212     :
 213   else
 214     # We have to explicitly parse arguments passed to make.  Not 100%
 215     # safe w.r.t. options like '-I' that can have an argument, but
 216     # should be good enough for our usages so far.
 217     for am__x
 218     do
 219       case $am__x in
 220         *=*)
 221         am__maybe_var=${am__x%%=*}
 222         am__maybe_val=${am__x#*=}
 223         am__maybe_def="${am__maybe_var}=${am__maybe_val}"
 224         # Some variables should be portably overridable from the command
 225         # line, even when using non-GNU make.
 226         case $am__maybe_var in
 227           V|\
 228           DESTDIR|\
 229           SHELL|\
 230           VERBOSE|\
 231           DISABLE_HARD_ERRORS|\
 232           DISTCHECK_CONFIGURE_FLAGS)
 233             ;;
 234           *)
 235             if is_valid_varname "$am__maybe_var"; then
 236               append_single_quoted am__make_flags "$am__maybe_def"
 237             fi
 238         esac
 239         unset am__maybe_var am__maybe_val am__maybe_def
 240         ;;
 241       esac
 242     done
 243     unset am__x
 244   fi
 245
 246   if test x"$am__make_flags" != x; then
 247      set AM_MAKEFLAGS="$am__make_flags" ${1+"$@"}
 248      unset am__make_flags
 249   fi
 250
 251   # In redirecting make output below, use append mode, to avoid
 252   # dropping output.  See automake bug#11413 for details.
 253   # The exit status of 253 is a more-or-less random choice, to
 254   # help us catch possible errors in redirections and error out
 255   # accordingly.
 256   (
 257     : exec $MAKE ${1+"$@"} # Display traces for future command.
 258     set +x # We need to remove them now, not to pollute redirected stderr.
 259     if test $am__make_redirect_stdall = yes; then
 260       : > output && exec 1>>output 2>&1 || exit 253
 261     else
 262       if test $am__make_redirect_stdout = yes; then
 263         : > stdout && exec 1>>stdout || exit 253
 264       fi
 265       if test $am__make_redirect_stderr = yes; then
 266         : > stderr && exec 2>>stderr || exit 253
 267       fi
 268     fi
 269     exec $MAKE ${1+"$@"}
 270   ) || am_make_rc=$?
 271
 272   if test $am_make_rc -eq 253; then
 273     fatal_ "run_make: problems in redirecting make output"
 274   fi
 275
 276   if test $am__make_redirect_stdall = yes; then
 277     cat output || fatal_ "displaying make output"
 278   else
 279     if test $am__make_redirect_stdout = yes; then
 280       cat stdout || fatal_ "displaying make output"
 281     fi
 282     if test $am__make_redirect_stderr = yes; then
 283       cat stderr >&2 || fatal_ "displaying make output"
 284     fi
 285   fi
 286
 287   case $am__make_rc_exp in
 288     IGNORE)
 289       : Ignore exit status
 290       ;;
 291     FAIL)
 292       test $am_make_rc -gt 0 || return 1
 293       ;;
 294     *)
 295      test $am__make_rc_exp -ge 0 && test $am__make_rc_exp -le 255 \
 296        || fatal_ "invalid expected exit status: '$am__make_rc_exp'"
 297      test $am_make_rc -eq $am__make_rc_exp || return 1
 298      ;;
 299   esac
 300 }
 301
 302 # AUTOMAKE_run [-e STATUS] [-d DESCRIPTION] [--] [AUTOMAKE-ARGS...]
 303 # -----------------------------------------------------------------
 304 # Run automake with AUTOMAKE-ARGS, and fail if it doesn't exit with
 305 # STATUS.  Should be polymorphic for TAP and "plain" tests.  The
 306 # DESCRIPTION, when provided, is used for console reporting, only if
 307 # the TAP protocol is in use in the current test script.
 308 AUTOMAKE_run ()
 309 {
 310   am__desc=
 311   am__exp_rc=0
 312   while test $# -gt 0; do
 313     case $1 in
 314       -d) am__desc=$2; shift;;
 315       -e) am__exp_rc=$2; shift;;
 316       --) shift; break;;
 317        # Don't fail on unknown option: assume they (and the rest of the
 318        # command line) are to be passed verbatim to automake (so stop our
 319        # own option parsing).
 320        *) break;;
 321     esac
 322     shift
 323   done
 324   am__got_rc=0
 325   $AUTOMAKE ${1+"$@"} >stdout 2>stderr || am__got_rc=$?
 326   cat stderr >&2
 327   cat stdout
 328   if test $am_test_protocol = none; then
 329     test $am__got_rc -eq $am__exp_rc || exit 1
 330     return
 331   fi
 332   if test -z "$am__desc"; then
 333     if test $am__got_rc -eq $am__exp_rc; then
 334       am__desc="automake exited $am__got_rc"
 335     else
 336       am__desc="automake exited $am__got_rc, expecting $am__exp_rc"
 337     fi
 338   fi
 339   command_ok_ "$am__desc" test $am__got_rc -eq $am__exp_rc
 340 }
 341
 342 # AUTOMAKE_fails [-d DESCRIPTION] [OPTIONS...]
 343 # --------------------------------------------
 344 # Run automake with OPTIONS, and fail if doesn't exit with status 1.
 345 # Should be polymorphic for TAP and "plain" tests.  The DESCRIPTION,
 346 # when provided, is used for console reporting, only if the TAP
 347 # protocol is in use in the current test script.
 348 AUTOMAKE_fails ()
 349 {
 350   AUTOMAKE_run -e 1 ${1+"$@"}
 351 }
 352
 353 # extract_configure_help { --OPTION | VARIABLE-NAME } [FILES]
 354 # -----------------------------------------------------------
 355 # Use this to extract from the output of "./configure --help" (or similar)
 356 # the description or help message associated to the given --OPTION or
 357 # VARIABLE-NAME.
 358 extract_configure_help ()
 359 {
 360   am__opt_re='' am__var_re=''
 361   case $1 in
 362     --*'=')   am__opt_re="^  $1";;
 363     --*'[=]') am__opt_re='^  '$(printf '%s\n' "$1" | sed 's/...$//')'\[=';;
 364     --*)      am__opt_re="^  $1( .*|$)";;
 365       *)      am__var_re="^  $1( .*|$)";;
 366   esac
 367   shift
 368   if test x"$am__opt_re" != x; then
 369     LC_ALL=C awk '
 370       /'"$am__opt_re"'/        { print; do_print = 1; next; }
 371       /^$/                     { do_print = 0; next }
 372       /^  --/                  { do_print = 0; next }
 373       (do_print == 1)          { print }
 374     ' ${1+"$@"}
 375   else
 376     LC_ALL=C awk '
 377       /'"$am__var_re"'/        { print; do_print = 1; next; }
 378       /^$/                     { do_print = 0; next }
 379       /^  [A-Z][A-Z0-9_]* /    { do_print = 0; next }
 380       /^  [A-Z][A-Z0-9_]*$/    { do_print = 0; next }
 381       (do_print == 1)          { print }
 382     ' ${1+"$@"}
 383   fi
 384 }
 385
 386 # grep_configure_help { --OPTION | VARIABLE-NAME } REGEXP
 387 # -------------------------------------------------------
 388 # Grep the section of "./configure --help" output associated with either
 389 # --OPTION or VARIABLE-NAME for the given *extended* regular expression.
 390 grep_configure_help ()
 391 {
 392   ./configure --help > am--all-help \
 393     || { cat am--all-help; exit 1; }
 394   cat am--all-help
 395   extract_configure_help "$1" am--all-help > am--our-help \
 396     || { cat am--our-help; exit 1; }
 397   cat am--our-help
 398   $EGREP "$2" am--our-help || exit 1
 399 }
 400
 401
 402 # using_gmake
 403 # -----------
 404 # Return success if $MAKE is GNU make, return failure otherwise.
 405 # Caches the result for speed reasons.
 406 using_gmake ()
 407 {
 408   case $am__using_gmake in
 409     yes)
 410       return 0;;
 411     no)
 412       return 1;;
 413     '')
 414       # Use --version AND -v, because SGI Make doesn't fail on --version.
 415       # Also grep for GNU because newer versions of FreeBSD make do
 416       # not complain about --version (they seem to silently ignore it).
 417       if $MAKE --version -v | grep GNU; then
 418         am__using_gmake=yes
 419         return 0
 420       else
 421         am__using_gmake=no
 422         return 1
 423       fi;;
 424     *)
 425       fatal_ "invalid value for \$am__using_gmake: '$am__using_gmake'";;
 426   esac
 427 }
 428 am__using_gmake="" # Avoid interferences from the environment.
 429
 430 # make_can_chain_suffix_rules
 431 # ---------------------------
 432 # Return 0 if $MAKE is a make implementation that can chain suffix rules
 433 # automatically, return 1 otherwise.  Caches the result for speed reasons.
 434 make_can_chain_suffix_rules ()
 435 {
 436   if test -z "$am__can_chain_suffix_rules"; then
 437     if using_gmake; then
 438       am__can_chain_suffix_rules=yes
 439       return 0
 440     else
 441       mkdir am__chain.dir$$
 442       cd am__chain.dir$$
 443       unindent > Makefile << 'END'
 444         .SUFFIXES: .u .v .w
 445         .u.v: ; cp $< $@
 446         .v.w: ; cp $< $@
 447 END
 448       echo make can chain suffix rules > foo.u
 449       if $MAKE foo.w && diff foo.u foo.w; then
 450         am__can_chain_suffix_rules=yes
 451       else
 452         am__can_chain_suffix_rules=no
 453       fi
 454       cd ..
 455       rm -rf am__chain.dir$$
 456     fi
 457   fi
 458   case $am__can_chain_suffix_rules in
 459     yes) return 0;;
 460      no) return 1;;
 461       *) fatal_ "make_can_chain_suffix_rules: internal error";;
 462   esac
 463 }
 464 am__can_chain_suffix_rules="" # Avoid interferences from the environment.
 465
 466 # useless_vpath_rebuild
 467 # ---------------------
 468 # Tell whether $MAKE suffers of the bug triggering automake bug#7884.
 469 # For example, this happens with FreeBSD make, since in a VPATH build
 470 # it tends to rebuilt files for which there is an explicit or even just
 471 # a suffix rule, even if said files are already available in the VPATH
 472 # directory.
 473 useless_vpath_rebuild ()
 474 {
 475   if test -z "$am__useless_vpath_rebuild"; then
 476     if using_gmake; then
 477       am__useless_vpath_rebuild=no
 478       return 1
 479     fi
 480     mkdir am__vpath.dir$$
 481     cd am__vpath.dir$$
 482     touch foo.a foo.b bar baz
 483     mkdir build
 484     cd build
 485     unindent > Makefile << 'END'
 486         .SUFFIXES: .a .b
 487         VPATH = ..
 488         all: foo.b baz
 489         .PHONY: all
 490         .a.b: ; cp $< $@
 491         baz: bar ; cp ../baz bar
 492 END
 493     if run_make all && test ! -e foo.b && test ! -e bar; then
 494       am__useless_vpath_rebuild=no
 495     else
 496       am__useless_vpath_rebuild=yes
 497     fi
 498     cd ../..
 499     rm -rf am__vpath.dir$$
 500   fi
 501   case $am__useless_vpath_rebuild in
 502     yes) return 0;;
 503      no) return 1;;
 504      "") ;;
 505       *) fatal_ "useless_vpath_rebuild: internal error";;
 506   esac
 507 }
 508 am__useless_vpath_rebuild=""
 509
 510 yl_distcheck () { useless_vpath_rebuild || run_make distcheck ${1+"$@"}; }
 511
 512
 513 null_install ()
 514 {
 515   for am__v in nulldirs destdir instdir; do
 516     if ! eval 'test -n "$'$am__v'"'; then
 517       fatal_ "null_install() invoked with \$$am__v unset"
 518     fi
 519   done
 520   unset am__v
 521   case $#,$1 in
 522     0,)
 523       am__inst='install';;
 524     1,-t|1,--texi)
 525       am__inst='install install-html install-dvi install-ps install-pdf';;
 526     *)
 527       fatal_ "null_install(): invalid usage";;
 528   esac
 529   run_make $nulldirs $am__inst
 530   test ! -e "$instdir"
 531   run_make $nulldirs $am__inst DESTDIR="$destdir"
 532   test ! -e "$instdir"
 533   test ! -e "$destdir"
 534   run_make -M $nulldirs uninstall
 535   # Creative quoting below to please maintainer-check.
 536   grep 'rm'' ' output && exit 1
 537   run_make -M $nulldirs uninstall DESTDIR="$destdir"
 538   # Creative quoting below to please maintainer-check.
 539   grep 'rm'' ' output && exit 1
 540   : # For 'set -e'.
 541 }
 542
 543 # count_test_results total=N pass=N fail=N xpass=N xfail=N skip=N error=N
 544 # -----------------------------------------------------------------------
 545 # Check that a testsuite run driven by the parallel-tests harness has
 546 # had the specified numbers of test results (specified by kind).
 547 # This function assumes that the output of "make check" or "make recheck"
 548 # has been saved in the 'stdout' file in the current directory, and its
 549 # log in the 'test-suite.log' file.
 550 count_test_results ()
 551 {
 552   # Use a subshell so that we won't pollute the script namespace.
 553   (
 554     # TODO: Do proper checks on the arguments?
 555     total=ERR pass=ERR fail=ERR xpass=ERR xfail=ERR skip=ERR error=ERR
 556     eval "$@"
 557     # For debugging.
 558     $EGREP -i '(total|x?pass|x?fail|skip|error)' stdout || :
 559     rc=0
 560     # Avoid spurious failures with shells with "overly sensible"
 561     # errexit shell flag, such as e.g., Solaris /bin/sh.
 562     set +e
 563     test $(grep -c '^PASS:'  stdout) -eq $pass  || rc=1
 564     test $(grep -c '^XFAIL:' stdout) -eq $xfail || rc=1
 565     test $(grep -c '^SKIP:'  stdout) -eq $skip  || rc=1
 566     test $(grep -c '^FAIL:'  stdout) -eq $fail  || rc=1
 567     test $(grep -c '^XPASS:' stdout) -eq $xpass || rc=1
 568     test $(grep -c '^ERROR:' stdout) -eq $error || rc=1
 569     grep "^# TOTAL:  *$total$" stdout || rc=1
 570     grep "^# PASS:  *$pass$"   stdout || rc=1
 571     grep "^# XFAIL:  *$xfail$" stdout || rc=1
 572     grep "^# SKIP:  *$skip$"   stdout || rc=1
 573     grep "^# FAIL:  *$fail$"   stdout || rc=1
 574     grep "^# XPASS:  *$xpass$" stdout || rc=1
 575     grep "^# ERROR:  *$error$" stdout || rc=1
 576     test $rc -eq 0
 577   )
 578 }
 579
 580 # get_shell_script SCRIPT-NAME
 581 # -----------------------------
 582 # Fetch an Automake-provided shell script from the 'lib/' directory into
 583 # the current directory, and, if the '$am_test_prefer_config_shell'
 584 # variable is set to "yes", modify its shebang line to use $SHELL instead
 585 # of /bin/sh.
 586 get_shell_script ()
 587 {
 588   test ! -f "$1" || rm -f "$1" || return 99
 589   if test x"$am_test_prefer_config_shell" = x"yes"; then
 590     sed "1s|#!.*|#! $SHELL|" "$am_scriptdir/$1" > "$1" \
 591      && chmod a+x "$1" \
 592      || return 99
 593   else
 594     cp -f "$am_scriptdir/$1" . || return 99
 595   fi
 596   sed 10q "$1" # For debugging.
 597 }
 598
 599 # require_xsi SHELL
 600 # -----------------
 601 # Skip the test if the given shell fails to support common XSI constructs.
 602 require_xsi ()
 603 {
 604   test $# -eq 1 || fatal_ "require_xsi needs exactly one argument"
 605   echo "$me: trying some XSI constructs with $1"
 606   $1 -c "$xsi_shell_code" || skip_all_ "$1 lacks XSI features"
 607 }
 608 # Shell code supposed to work only with XSI shells.  Keep this in sync
 609 # with libtool.m4:_LT_CHECK_SHELL_FEATURES.
 610 xsi_shell_code='
 611   _lt_dummy="a/b/c"
 612   test "${_lt_dummy##*/},${_lt_dummy%/*},${_lt_dummy#??}"${_lt_dummy%"$_lt_dummy"}, \
 613       = c,a/b,b/c, \
 614     && eval '\''test $(( 1 + 1 )) -eq 2 \
 615     && test "${#_lt_dummy}" -eq 5'\'
 616
 617 # fetch_tap_driver
 618 # ----------------
 619 # Fetch the Automake-provided TAP driver from the 'lib/' directory into
 620 # the current directory, and edit its shebang line so that it will be
 621 # run with the perl interpreter determined at configure time.
 622 fetch_tap_driver ()
 623 {
 624   # TODO: we should devise a way to make the shell TAP driver tested also
 625   # TODO: with /bin/sh, for better coverage.
 626   case $am_tap_implementation in
 627     # Extra quoting required to avoid maintainer-check spurious failures.
 628    'perl')
 629       $PERL -MTAP::Parser -e 1 \
 630         || skip_all_ "cannot import TAP::Parser perl module"
 631       sed "1s|#!.*|#! $PERL -w|" "$am_scriptdir"/tap-driver.pl >tap-driver
 632       ;;
 633     shell)
 634       AM_TAP_AWK=$AWK; export AM_TAP_AWK
 635       sed "1s|#!.*|#! $SHELL|" "$am_scriptdir"/tap-driver.sh >tap-driver
 636       ;;
 637     *)
 638       fatal_ "invalid \$am_tap_implementation '$am_tap_implementation'" ;;
 639   esac \
 640     && chmod a+x tap-driver \
 641     || framework_failure_ "couldn't fetch $am_tap_implementation TAP driver"
 642   sed 10q tap-driver # For debugging.
 643 }
 644 am_tap_implementation=${am_tap_implementation-shell}
 645
 646 # $PYTHON and support for PEP-3147.  Needed to check our python-related
 647 # install rules.
 648 python_has_pep3147 ()
 649 {
 650   if test -z "$am_pep3147_tag"; then
 651     am_pep3147_tag=$($PYTHON -c 'import imp; print(imp.get_tag())') \
 652       || am_pep3147_tag=none
 653   fi
 654   test $am_pep3147_tag != none
 655 }
 656 am_pep3147_tag=
 657
 658 # pyc_location [-p] [FILE]
 659 # ------------------------
 660 # Determine what the actual location of the given '.pyc' or '.pyo'
 661 # byte-compiled file should be, taking into account PEP-3147.  Save
 662 # the location in the '$am_pyc_file' variable.  If the '-p' option
 663 # is given, print the location on the standard output as well.
 664 pyc_location ()
 665 {
 666   case $#,$1 in
 667     2,-p) am_pyc_print=yes; shift;;
 668      1,*) am_pyc_print=no;;
 669        *) fatal_ "pyc_location: invalid usage";;
 670   esac
 671   if python_has_pep3147; then
 672     case $1 in
 673       */*) am_pyc_dir=${1%/*} am_pyc_base=${1##*/};;
 674         *) am_pyc_dir=. am_pyc_base=$1;;
 675     esac
 676     am_pyc_ext=${am_pyc_base##*.}
 677     am_pyc_base=${am_pyc_base%.py?}
 678     am_pyc_file=$am_pyc_dir/__pycache__/$am_pyc_base.$am_pep3147_tag.$am_pyc_ext
 679   else
 680     am_pyc_file=$1
 681   fi
 682   test $am_pyc_print = no || printf '%s\n' "$am_pyc_file"
 683 }
 684
 685 # py_installed [--not] FILE
 686 # --------------------------
 687 # Check that the given python FILE has been installed (resp. *not*
 688 # installed, if the '--not' option is specified).  If FILE is a
 689 # byte-compiled '.pyc' file, the new installation layout specified
 690 # by PEP-3147 will be taken into account.
 691 py_installed ()
 692 {
 693   case $#,$1 in
 694         1,*) am_test_py_file='test -f';;
 695     2,--not) am_test_py_file='test ! -e'; shift;;
 696           *) fatal_ "pyc_installed: invalid usage";;
 697   esac
 698   case $1 in
 699     *.py[co]) pyc_location "$1"; am_target_py_file=$am_pyc_file;;
 700            *) am_target_py_file=$1;;
 701   esac
 702   $am_test_py_file "$am_target_py_file"
 703 }
 704
 705 # Usage: require_compiler_ {cc|c++|fortran|fortran77}
 706 require_compiler_ ()
 707 {
 708   case $# in
 709     0) fatal_ "require_compiler_: missing argument";;
 710     1) ;;
 711     *) fatal_ "require_compiler_: too many arguments";;
 712   esac
 713   case $1 in
 714     cc)
 715       am__comp_lang="C"
 716       am__comp_var=CC
 717       am__comp_flag_vars='CFLAGS CPPFLAGS'
 718       ;;
 719     c++)
 720       am__comp_lang="C++"
 721       am__comp_var=CXX
 722       am__comp_flag_vars='CXXFLAGS CPPFLAGS'
 723       ;;
 724     fortran)
 725       am__comp_lang="Fortran"
 726       am__comp_var=FC
 727       am__comp_flag_vars='FCFLAGS'
 728       ;;
 729     fortran77)
 730       am__comp_lang="Fortran 77"
 731       am__comp_var=F77
 732       am__comp_flag_vars='FFLAGS'
 733       ;;
 734   esac
 735   shift
 736   eval "am__comp_prog=\${$am__comp_var}" \
 737     || fatal_ "expanding \${$am__comp_var} in require_compiler_"
 738   case $am__comp_prog in
 739     "")
 740       fatal_ "botched configuration: \$$am__comp_var is empty";;
 741     false)
 742       skip_all_ "no $am__comp_lang compiler available";;
 743     autodetect|autodetected)
 744       # Let the ./configure commands in the test script try to determine
 745       # these automatically.
 746       unset $am__comp_var $am__comp_flag_vars;;
 747     *)
 748       # Pre-set these for the ./configure commands in the test script.
 749       export $am__comp_var $am__comp_flag_vars;;
 750   esac
 751   # Delete private variables.
 752   unset am__comp_lang am__comp_prog am__comp_var am__comp_flag_vars
 753 }
 754
 755 ## ----------------------------------------------------------- ##
 756 ##  Checks for required tools, and additional setups (if any)  ##
 757 ##  required by them.                                          ##
 758 ## ----------------------------------------------------------- ##
 759
 760 require_tool ()
 761 {
 762   am_tool=$1
 763   case $1 in
 764     cc|c++|fortran|fortran77)
 765       require_compiler_ $1;;
 766     -c-o)
 767       if test x"$AM_TESTSUITE_SIMULATING_NO_CC_C_O" = x"yes"; then
 768         skip_all_ "need a C compiler that grasps -c and -o together"
 769       fi
 770       ;;
 771     xsi-lib-shell)
 772       if test x"$am_test_prefer_config_shell" = x"yes"; then
 773         require_xsi "$SHELL"
 774       else
 775         require_xsi "/bin/sh"
 776       fi
 777       ;;
 778     bzip2)
 779       # Do not use --version, older versions bzip2 still tries to compress
 780       # stdin.
 781       echo "$me: running bzip2 --help"
 782       bzip2 --help \
 783         || skip_all_ "required program 'bzip2' not available"
 784       ;;
 785     cl)
 786       CC=cl
 787       # Don't export CFLAGS, as that could have been initialized to only
 788       # work with the C compiler detected at configure time.  If the user
 789       # wants CFLAGS to also influence 'cl', he can still export CFLAGS
 790       # in the environment "by hand" before calling the testsuite.
 791       export CC CPPFLAGS
 792       echo "$me: running $CC -?"
 793       $CC -? || skip_all_ "Microsoft C compiler '$CC' not available"
 794       ;;
 795     etags)
 796       # Exuberant Ctags will create a TAGS file even
 797       # when asked for --help or --version.  (Emacs's etags
 798       # does not have such problem.)  Use -o /dev/null
 799       # to make sure we do not pollute the build directory.
 800       echo "$me: running etags --version -o /dev/null"
 801       etags --version -o /dev/null \
 802         || skip_all_ "required program 'etags' not available"
 803       ;;
 804     GNUmake)
 805       for am_make in "$MAKE" gmake gnumake :; do
 806         MAKE=$am_make
 807         am__using_gmake= # Invalidate cache used by 'using_gmake()'.
 808         test "$MAKE" = : && break
 809         echo "$me: determine whether $MAKE is GNU make"
 810         using_gmake && break
 811         : For shells with busted 'set -e'.
 812       done
 813       test "$MAKE" = : && skip_all_ "this test requires GNU make"
 814       export MAKE
 815       unset am_make
 816       ;;
 817     gcj)
 818       GCJ=$GNU_GCJ GCJFLAGS=$GNU_GCJFLAGS; export GCJ GCJFLAGS
 819       test "$GCJ" = false && skip_all_ "GNU Java compiler unavailable"
 820       : For shells with busted 'set -e'.
 821       ;;
 822     gcc)
 823       CC=$GNU_CC CFLAGS=$GNU_CFLAGS; export CC CFLAGS CPPFLAGS
 824       test "$CC" = false && skip_all_ "GNU C compiler unavailable"
 825       : For shells with busted 'set -e'.
 826       ;;
 827     g++)
 828       CXX=$GNU_CXX CXXFLAGS=$GNU_CXXFLAGS; export CXX CXXFLAGS CPPFLAGS
 829       test "$CXX" = false && skip_all_ "GNU C++ compiler unavailable"
 830       : For shells with busted 'set -e'.
 831       ;;
 832     gfortran)
 833       FC=$GNU_FC FCFLAGS=$GNU_FCFLAGS; export FC FCFLAGS
 834       test "$FC" = false && skip_all_ "GNU Fortran compiler unavailable"
 835       case " $required " in
 836         *\ g77\ *) ;;
 837         *) F77=$FC FFLAGS=$FCFLAGS; export F77 FFLAGS;;
 838       esac
 839       ;;
 840     g77)
 841       F77=$GNU_F77 FFLAGS=$GNU_FFLAGS; export F77 FFLAGS
 842       test "$F77" = false && skip_all_ "GNU Fortran 77 compiler unavailable"
 843       case " $required " in
 844         *\ gfortran\ *) ;;
 845         *) FC=$F77 FCFLAGS=$FFLAGS; export FC FCFLAGS;;
 846       esac
 847       ;;
 848     grep-nonprint)
 849       # Check that grep can parse nonprinting characters correctly.
 850       # BSD 'grep' works from a pipe, but not a seekable file.
 851       # GNU or BSD 'grep -a' works on files, but is not portable.
 852       case $(echo "$esc" | grep .)$(echo "$esc" | grep "$esc") in
 853         "$esc$esc") ;;
 854         *) skip_ "grep can't handle nonprinting characters correctly";;
 855       esac
 856       ;;
 857     javac)
 858       # The Java compiler from JDK 1.5 (and presumably earlier versions)
 859       # cannot handle the '-version' option by itself: it bails out
 860       # telling that source files are missing.  Adding also the '-help'
 861       # option seems to solve the problem.
 862       echo "$me: running javac -version -help"
 863       javac -version -help || skip_all_ "Sun Java compiler not available"
 864       ;;
 865     java)
 866       # See the comments above about 'javac' for why we use also '-help'.
 867       echo "$me: running java -version -help"
 868       java -version -help || skip_all_ "Sun Java interpreter not found"
 869       ;;
 870     lib)
 871       AR=lib; export AR
 872       # Attempting to create an empty archive will actually not
 873       # create the archive, but lib will output its version.
 874       echo "$me: running $AR -out:defstest.lib"
 875       $AR -out:defstest.lib \
 876         || skip_all_ "Microsoft 'lib' utility not available"
 877       ;;
 878     makedepend)
 879       echo "$me: running makedepend -f-"
 880       makedepend -f- \
 881         || skip_all_ "required program 'makedepend' not available"
 882       ;;
 883     mingw)
 884       uname_s=$(uname -s || echo UNKNOWN)
 885       echo "$me: system name: $uname_s"
 886       case $uname_s in
 887         MINGW*) ;;
 888         *) skip_all_ "this test requires MSYS in MinGW mode" ;;
 889       esac
 890       unset uname_s
 891       ;;
 892     non-root)
 893       # Skip this test case if the user is root.
 894       # We try to append to a read-only file to detect this.
 895       priv_check_temp=am--priv-check.$$
 896       touch $priv_check_temp && chmod a-w $priv_check_temp \
 897         || framework_failure_ "creating unwritable file $priv_check_temp"
 898       # Not a useless use of subshell: lesser shells might bail
 899       # out if a builtin fails.
 900       overwrite_status=0
 901       (echo foo >> $priv_check_temp) || overwrite_status=$?
 902       rm -f $priv_check_temp
 903       if test $overwrite_status -eq 0; then
 904         skip_all_ "cannot drop file write permissions"
 905       fi
 906       unset priv_check_temp overwrite_status
 907       ;;
 908     # Extra quoting required to avoid maintainer-check spurious failures.
 909     'perl-threads')
 910       if test "$WANT_NO_THREADS" = "yes"; then
 911         skip_all_ "Devel::Cover cannot cope with threads"
 912       fi
 913       ;;
 914     native)
 915       # Don't use "&&" here, to avoid a bug of 'set -e' present in
 916       # some (even relatively recent) versions of the BSD shell.
 917       # We add the dummy "else" branch for extra safety.
 918       ! cross_compiling || skip_all_ "doesn't work in cross-compile mode"
 919       ;;
 920     python)
 921       PYTHON=${PYTHON-python}
 922       # Older python versions don't support --version, they have -V.
 923       echo "$me: running $PYTHON -V"
 924       $PYTHON -V || skip_all_ "python interpreter not available"
 925       ;;
 926     ro-dir)
 927       # Skip this test case if read-only directories aren't supported
 928       # (e.g., under DOS.)
 929       ro_dir_temp=ro_dir.$$
 930       mkdir $ro_dir_temp && chmod a-w $ro_dir_temp \
 931         || framework_failure_ "creating unwritable directory $ro_dir_temp"
 932       # Not a useless use of subshell: lesser shells might bail
 933       # out if a builtin fails.
 934       create_status=0
 935       (: > $ro_dir_temp/probe) || create_status=$?
 936       rm -rf $ro_dir_temp
 937       if test $create_status -eq 0; then
 938         skip_all_ "cannot drop directory write permissions"
 939       fi
 940       unset ro_dir_temp create_status
 941       ;;
 942     runtest)
 943       # DejaGnu's runtest program. We rely on being able to specify
 944       # the program on the runtest command-line. This requires
 945       # DejaGnu 1.4.3 or later.
 946       echo "$me: running runtest SOMEPROGRAM=someprogram --version"
 947       runtest SOMEPROGRAM=someprogram --version \
 948         || skip_all_ "DejaGnu is not available"
 949       ;;
 950     tex)
 951       # No all versions of Tex support '--version', so we use
 952       # a configure check.
 953       if test -z "$TEX"; then
 954         skip_all_ "TeX is required, but it wasn't found by configure"
 955       fi
 956       ;;
 957     lex)
 958       test x"$LEX" = x"false" && skip_all_ "lex not found or disabled"
 959       export LEX
 960       ;;
 961     yacc)
 962       test x"$YACC" = x"false" && skip_all_ "yacc not found or disabled"
 963       export YACC
 964       ;;
 965     flex)
 966       LEX=flex; export LEX
 967       echo "$me: running flex --version"
 968       flex --version || skip_all_ "required program 'flex' not available"
 969       ;;
 970     bison)
 971       YACC='bison -y'; export YACC
 972       echo "$me: running bison --version"
 973       bison --version || skip_all_ "required program 'bison' not available"
 974       ;;
 975     valac)
 976       echo "$me: running valac --version"
 977       if ! valac --version; then
 978         skip_all_ "required program 'valac' not available"
 979       elif cross_compiling; then
 980         skip_all_ "cross-compiling valac-generated C files is brittle"
 981       fi
 982       # TODO: We also know we need GNU make, the C compiler, and pkg-config
 983       # here, but there is no easy way to express this with the current
 984       # code organization.  We should improve the situation, sooner or
 985       # later.  At which point the tests requiring 'valac' can drop the
 986       # explicit requirements for those tools.
 987       ;;
 988     *)
 989       # Generic case: the tool must support --version.
 990       echo "$me: running $1 --version"
 991       # It is not likely but possible that the required tool is a special
 992       # builtin, in which case the shell is allowed to exit after an error.
 993       # So we need the subshell here.  Also, some tools, like Sun cscope,
 994       # can be interactive without redirection.
 995       ($1 --version) </dev/null \
 996         || skip_all_ "required program '$1' not available"
 997       ;;
 998   esac
 999 }
1000
1001 process_requirements ()
1002 {
1003   # Look for (and maybe set up) required tools and/or system features;
1004   # skip the current test if they are not found.
1005   for am_tool in $*; do
1006     require_tool $am_tool
1007   done
1008   # We might need extra m4 macros, e.g., for Libtool or Gettext.
1009   for am_tool in gettext libtool pkg-config; do
1010     case " $required " in
1011       # The lack of whitespace after $am_tool is intended.
1012       *" $am_tool"*) . ./t/$am_tool-macros.dir/get.sh;;
1013     esac
1014   done
1015   unset am_tool
1016 }
1017
1018 ## ---------------------------------------------------------------- ##
1019 ##  Create and set up of the temporary directory used by the test.  ##
1020 ## ---------------------------------------------------------------- ##
1021
1022 am_setup_testdir ()
1023 {
1024   # The subdirectory where the current test script will run and write its
1025   # temporary/data files.  This will be created shortly, and will be removed
1026   # by the cleanup trap below if the test passes.  If the test doesn't pass,
1027   # this directory will be kept, to facilitate debugging.
1028   am_test_subdir=${argv0#$am_rel_srcdir/}
1029   case $am_test_subdir in
1030     */*) am_test_subdir=${am_test_subdir%/*}/$me.dir;;
1031       *) am_test_subdir=$me.dir;;
1032   esac
1033   test ! -e $am_test_subdir || rm_rf_ $am_test_subdir \
1034     || framework_failure_ "removing old test subdirectory"
1035   $MKDIR_P $am_test_subdir \
1036     || framework_failure_ "creating test subdirectory"
1037   cd $am_test_subdir \
1038     || framework_failure_ "cannot chdir into test subdirectory"
1039   if test x"$am_create_testdir" != x"empty"; then
1040     cp "$am_scriptdir"/install-sh "$am_scriptdir"/missing \
1041        "$am_scriptdir"/compile "$am_scriptdir"/depcomp . \
1042       || framework_failure_ "fetching common files from $am_scriptdir"
1043     # Build appropriate environment in test directory.  E.g., create
1044     # configure.ac, touch all necessary files, etc.  Don't use AC_OUTPUT,
1045     # but AC_CONFIG_FILES so that appending still produces a valid
1046     # configure.ac.  But then, tests running config.status really need
1047     # to append AC_OUTPUT.
1048     {
1049       echo "AC_INIT([$me], [1.0])"
1050       if test x"$am_serial_tests" = x"yes"; then
1051         echo "AM_INIT_AUTOMAKE([serial-tests])"
1052       else
1053         echo "AM_INIT_AUTOMAKE"
1054       fi
1055       echo "AC_CONFIG_FILES([Makefile])"
1056     } >configure.ac || framework_failure_ "creating configure.ac skeleton"
1057   fi
1058 }
1059
1060 am_extra_info ()
1061 {
1062   echo "Running from installcheck: $am_running_installcheck"
1063   echo "Test Protocol: $am_test_protocol"
1064   echo "PATH = $PATH"
1065 }