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