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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
#! /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/>.
# Check parallel harness features:
# - creation and removal of `.trs' auxiliary files
# - check some internals regarding the use of `.trs' files.
parallel_tests=yes
. ./defs || Exit 1
cat >> configure.in <<END
AC_OUTPUT
END
cat > Makefile.am << 'END'
TEST_EXTENSIONS = .sh .test
TESTS = foo.test bar.sh sub/zardoz.test
TEST_LOG_COMPILER = $(SHELL)
SH_LOG_COMPILER = $(SHELL)
## Used to check some internal details.
tb:
echo $(am__TEST_BASES) > $@
END
mkdir sub
echo 'exit $FOO_STATUS' > foo.test
: > bar.sh
: > sub/zardoz.test
FOO_STATUS=0; export FOO_STATUS
$ACLOCAL
$AUTOCONF
$AUTOMAKE -a
./configure
#
# Check some internal details first.
#
$MAKE tb
test x"`cat tb`" = x"foo bar sub/zardoz"
rm -f tb
TESTS='foo.test foo2.sh foo3.exe foo4' $MAKE -e tb
test x"`cat tb`" = x"foo foo2 foo3.exe foo4"
rm -f tb
#
# The `test-suite.stamp' file and the `.trs' files get created by
# "make check" and removed by "make clean" and "make mostlyclean".
#
: > unrelated.trs
: > sub/foo.trs
$MAKE check
test -f foo.trs
test -f bar.trs
test -f sub/zardoz.trs
$MAKE clean
test ! -f foo.trs
test ! -f bar.trs
test ! -f sub/zardoz.trs
# Unrelated `.trs' files shouldn't be removed.
test -f unrelated.trs
test -f sub/foo.trs
# The files should be properly created in case of testsuite failure too.
FOO_STATUS=1 $MAKE check && Exit 1
test -f foo.trs
test -f bar.trs
test -f sub/zardoz.trs
$MAKE mostlyclean
test ! -f foo.trs
test ! -f bar.trs
test ! -f sub/zardoz.trs
# Unrelated `.trs' files shouldn't be removed.
test -f unrelated.trs
test -f sub/foo.trs
#
# Try with a subset of TESTS.
#
TESTS=foo.test $MAKE -e check
test -f foo.trs
test ! -f bar.trs
test ! -f sub/zardoz.trs
$MAKE clean
test ! -f foo.trs
TESTS='foo.test bar.sh' $MAKE -e check
test -f foo.trs
test -f bar.trs
test ! -f sub/zardoz.trs
# "make clean" shouldn't remove `.trs' files for tests not in $(TESTS).
TESTS=bar.sh $MAKE -e clean
test -f foo.trs
test ! -f bar.trs
$MAKE clean
#
# Try with a subset of TEST_LOGS.
#
TEST_LOGS=sub/zardoz.log $MAKE -e check
test ! -f foo.trs
test ! -f bar.trs
test -f sub/zardoz.trs
$MAKE clean
test ! -f sub/zardoz.trs
TEST_LOGS='foo.log bar.log' $MAKE -e check
test -f foo.trs
test -f bar.trs
test ! -f sub/zardoz.trs
# "make clean" shouldn't remove `.trs' files for tests whose log
# is not in $(TEST_LOGS).
TEST_LOGS=foo.log $MAKE -e clean
test ! -f foo.trs
test -f bar.trs
test ! -f sub/zardoz.trs
: