kc3-lang/automake/tests/test-metadata-global-log.test

• Show log

  Commit

• Hash : 0c81b43f
  Author :
  Date : 2011-07-28T12:25:22
  

  test harness: use new `.trs' files to hold test metadata
  
  With this change, the test harness will keep test metadata in
  dedicated `.trs' files, instead of having them embedded into the
  `.log' files.  This allows for easier forward-compatibility and
  extension of test metadata, and for more flexibility in the
  format of the `.log' files.  Note that this change makes the
  `:end-metadata:' field obsolete.
  
  * doc/automake.texi (Parallel Test Harness, Log files generation
  and test results recording): Document the new APIs and behaviour;
  some related minor rewordings and fixlets.
  * NEWS: Update.
  * automake.in (handle_tests): When bringing in the content of
  `check2.am', substitute %BASE% with the basename of the `.log'
  file being created by a rule.  Add the generated `.trs' files
  to the list of files to be cleaned by "make mostlyclean".
  * lib/am/check.am (am__test_driver_flags): Rename ...
  (am__common_driver_flags): ... to this, and remove the flags
  `--test-name' and `--log-file' from it: they are now define in
  the proper rules in `check2.am'.
  (am__TEST_BASES): New internal variable, holding the names of
  the tests, with any registered extension removed.
  (am__stealth_MAKE): New internal variable, can be used instead of
  $(MAKE) in recipes requiring a recursive call to make, but which
  are not intended to be executed by "make -n".
  (.log.trs): New suffix rule, to recover from deletion of `.trs'
  files.
  ($(TEST_SUITE_LOG)): Almost completely rewritten to follow the
  new API of "test logs in `.log' files, test metadata in `.trs'
  files".  It goes to some length to work correctly in face of
  unreadable or missing `.log' and `.trs' files, and to error out
  with proper error messages when this is not possible.
  [%?PARALLEL_TESTS%] (check-TESTS): Also remove relevant "stale"
  `.trs' files (in addition to `.log files) before remaking the
  $(TEST_SUITE_LOG).
  (recheck, recheck-html): Look for the `:recheck:' field in the
  `.trs' files, not in the `.log' files.
  * lib/am/check2.am (?GENERIC?%EXT%.log, ?!GENERIC?%OBJ%): Adjust
  the call to the test driver, in particularly passing the new
  option `--trs-file'.
  [%am__EXEEXT%] (?GENERIC?%EXT%$(EXEEXT).log): Likewise.
  * lib/tap-driver ($USAGE): Adjust the help screen.
  (Getopt::Long::GetOptions): Handle the `--trs-file' option,
  through the use of ...
  ($trs_file): ... this new global variable.
  (finish): Write metadata for the test run to `$trs_file' rather
  then to `$log_file', through the use of ...
  (write_test_results): ... this new function.
  * lib/test-driver (print_usage): Update the help screen.
  (Option parsing): Handle the `--trs-file' option, through the
  use of ...
  ($resfile): ... this new global variable.
  (Main code): Write metadata for the test run to `$trsfile' rather
  than to `$logfile'.
  Minor related adjustments to comments.
  * tests/.gitignore: Ignore `*.trs' files.
  * tests/parallel-tests-unreadable-log.test: Moved ...
  * tests/parallel-tests-unreadable.test: ... to this, and extended
  to also check the semantics for unreadable `.trs' files.
  * tests/test-driver-end-metadata.test: Deleted as obsolete.
  * tests/test-driver-metadata-no-leading-space.test: Likewise.
  * tests/test-driver-global-log.test: Renamed ...
  * tests/test-metadata-global-log.test: ... to this, and modified
  as to verify the new APIs and semantics.
  * tests/test-driver-recheck: Renamed ...
  * tests/test-metadata-recheck.test: ... to this, and modified
  likewise.
  * tests/parallel-tests-once.test: New test.
  * tests/parallel-tests-make-n.test: Likewise.
  * test-metadata-results.test: Likewise.
  * test-missing.test: Likewise.
  * test-missing2.test: Likewise.
  * test-trs-basic.test: Likewise.
  * test-trs-recover.test: Likewise.
  * test-trs-recover2.test: Likewise.
  * tests/Makefile.am (TESTS): Update.
  

Download

• tests/test-metadata-global-log.test

• #! /bin/sh
  # Copyright (C) 2011 Free Software Foundation, Inc.
  #
  # This program is free software; you can redistribute it and/or modify
  # it under the terms of the GNU General Public License as published by
  # the Free Software Foundation; either version 2, or (at your option)
  # any later version.
  #
  # This program is distributed in the hope that it will be useful,
  # but WITHOUT ANY WARRANTY; without even the implied warranty of
  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  # GNU General Public License for more details.
  #
  # You should have received a copy of the GNU General Public License
  # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  
  # Custom test drivers and parallel-tests harness: check the documented
  # semantics for deciding when the content of a test log file should be
  # copied in the global test-suite.log file.  Currently, this is done
  # with the use of the reStructuredText field `:copy-in-global-log:' in
  # the associated `.trs' files.
  
  parallel_tests=yes
  . ./defs || Exit 1
  
  cat >> configure.in << 'END'
  AC_OUTPUT
  END
  
  cat > Makefile.am << 'END'
  TEST_LOG_DRIVER = ./passthrough-driver
  TEST_LOG_COMPILER = $(SHELL) -e
  END
  
  cat > passthrough-driver <<'END'
  #!/bin/sh
  set -e; set -u;
  while test $# -gt 0; do
    case $1 in
      --log-file) log_file=$2; shift;;
      --trs-file) trs_file=$2; shift;;
      --test-name) test_name=$2; shift;;
      --expect-failure|--color-tests|--enable-hard-errors) shift;;
      --) shift; break;;
       *) echo "$0: invalid option/argument: '$1'" >&2; exit 2;;
    esac
    shift
  done
  echo "$test_name: RUN"
  "$@" >$log_file 2>&1 5>$trs_file
  END
  chmod a+x passthrough-driver
  
  # The `:test-result:' and `:recheck:' fields and the first line of the
  # log file should be be irrelevant for the decision of whether a test
  # output is to be copied in the `test-suite.log'.
  
  cat > no-1.test <<END
  echo :test-result: SKIP >&5
  echo :copy-in-global-log: no >&5
  echo :test-result: FAIL >&5
  echo :test-result: XPASS >&5
  echo not seen 1
  END
  
  # In the last line, with leading and trailing whitespace in the value.
  cat > no-2.test <<END
  echo ":test-result: FAIL" >&5
  echo "not seen 2"
  echo ":recheck: yes" >&5
  echo ":copy-in-global-log:$tab $tab no   $tab" >&5
  END
  
  for RES in XPASS FAIL XFAIL SKIP ERROR UNKNOWN; do
    unindent > $RES.test <<END
      echo :test-result: $RES >&5
      echo :copy-in-global-log: no >&5
      echo not seen $RES
  END
  done
  
  # In the first line, with no whitespace.
  cat > no-3.test <<END
  echo :copy-in-global-log:no >&5
  echo ":test-result: FAIL" >&5
  echo "not seen 3"
  END
  
  # Leading whitespace before the field.
  cat > no-4.test <<END
  echo ":test-result: FAIL" >&5
  echo "  $tab $tab$tab   :copy-in-global-log: no" >&5
  echo "not seen 4"
  END
  
  cat > yes-1.test <<END
  echo :test-result: PASS >&5
  echo :copy-in-global-log: yes >&5
  echo seen yes 1
  END
  
  # A lacking `:copy-in-global-log:' implies that the content of
  # the log file should be copied.
  cat > yes-2.test <<END
  echo :test-result: PASS >&5
  echo seen yes 2
  END
  
  # Three corner cases.
  
  cat > corn-1.test <<END
  echo seen corn 1
  echo ':copy-in-global-log:' >&5
  END
  
  cat > corn-2.test <<END
  echo seen corn 2
  echo '$tab $tab$tab' >&5
  END
  
  cat > corn-3.test <<'END'
  echo seen corn 31
  echo ':copy-in-global-log:#@%!' >&5
  echo seen corn 32
  END
  
  echo TESTS = *.test >> Makefile.am
  
  $ACLOCAL
  $AUTOCONF
  $AUTOMAKE
  
  ./configure
  
  # We don't care about the exit status of "make check" here, that
  # should be checked in other tests.
  $MAKE check || :
  cat test-suite.log
  grep '^seen yes 1$' test-suite.log
  grep '^seen yes 2$' test-suite.log
  grep '^seen corn 1$' test-suite.log
  grep '^seen corn 2$' test-suite.log
  grep '^seen corn 31$' test-suite.log
  grep '^seen corn 32$' test-suite.log
  $FGREP 'not seen' test-suite.log && Exit 1
  
  :
  

Download