test-metadata-results.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-results.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/>.

# Parallel testsuite harness: check APIs for the registering of test
# results in `*.trs' files, as documented in the automake manual.

parallel_tests=yes
. ./defs || Exit 1

cat >> configure.in << 'END'
AC_OUTPUT
END

cat > Makefile.am << 'END'
TEST_LOG_DRIVER = ./dummy-driver
TESTS = foo.test bar.test
END

cat > dummy-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
: > $log_file
cp $1 $trs_file
END
chmod a+x dummy-driver

mk_check ()
{
  st=0
  $MAKE check >stdout || st=$?
  cat stdout
  # Our dummy driver make no testsuite progress report.
  grep ': .*\.test' stdout && Exit 1
  # Nor it writes to the log files.
  test -s foo.log && Exit 1
  test -s bar.log && Exit 1
  return $st
}

# This must be different from the one defined in `test/defs', as that
# assumes that the driver does proper testsuite progress reporting.
count_test_results ()
{
  total=ERR pass=ERR fail=ERR xpass=ERR xfail=ERR skip=ERR error=ERR
  eval "$@"
  st=0
  grep "^# TOTAL:  *$total$" stdout || rc=1
  grep "^# PASS:  *$pass$"   stdout || rc=1
  grep "^# XFAIL:  *$xfail$" stdout || rc=1
  grep "^# SKIP:  *$skip$"   stdout || rc=1
  grep "^# FAIL:  *$fail$"   stdout || rc=1
  grep "^# XPASS:  *$xpass$" stdout || rc=1
  grep "^# ERROR:  *$error$" stdout || rc=1
  test $st -eq 0 || Exit 1
}

$ACLOCAL
$AUTOCONF
$AUTOMAKE

./configure

# Basic checks.  Also that that "old-style" directives with format
# "RESULT: test-name" are be ignored now.

cat > foo.test <<END
FAIL: foo.test
:test-result: PASS
END
echo ERROR: bar.test > bar.test
mk_check
count_test_results total=1 pass=1 fail=0 xpass=0 xfail=0 skip=0 error=0

cat > foo.test <<END
PASS: foo.test
:test-result: FAIL
END
echo SKIP: bar.test > bar.test
: > bar.test
mk_check && Exit 1
count_test_results total=1 pass=0 fail=1 xpass=0 xfail=0 skip=0 error=0

cat > foo.test <<END
PASS: foo.test
:test-result: FAIL
END
cat > bar.test <<END
ERROR: foo.test
:test-result: SKIP
END
mk_check && Exit 1
count_test_results total=2 pass=0 fail=1 xpass=0 xfail=0 skip=1 error=0

cat > foo.test <<END
:test-result: XFAIL
:test-result: PASS
:test-result: SKIP
END
cat > bar.test <<END
:test-result: SKIP
:test-result: PASS
:test-result: SKIP
:test-result: PASS
:test-result: PASS
END
mk_check
count_test_results total=8 pass=4 fail=0 xpass=0 xfail=1 skip=3 error=0

# Check that all results expected to be supported are *really* supported.

cat > foo.test <<END
:test-result: PASS
:test-result: SKIP
:test-result: XFAIL
:test-result: FAIL
:test-result: XPASS
:test-result: ERROR
END
: > bar.test
mk_check && Exit 1
count_test_results total=6 pass=1 fail=1 xpass=1 xfail=1 skip=1 error=1

cp foo.test bar.test
mk_check && Exit 1
count_test_results total=12 pass=2 fail=2 xpass=2 xfail=2 skip=2 error=2

# Check that we are liberal w.r.t. whitespace use.

: > foo.test
: > bar.test
for RESULT in PASS FAIL XPASS XFAIL SKIP ERROR; do
  sed -e 's/^ *//' -e 's/|//g' >> foo.test <<END
    |:test-result:$RESULT|
    |:test-result: $tab  $RESULT|
    |:test-result:$RESULT  $tab|
    |:test-result:$tab$tab  $RESULT$tab  $tab |
END
  echo "  $tab $tab$tab   :test-result: $RESULT" >> bar.test
done
cat foo.test # For debugging.
cat bar.test # Likewise.
mk_check && Exit 1
count_test_results total=30 pass=5 fail=5 xpass=5 xfail=5 skip=5 error=5

:

Download

kc3-lang/automake/tests/test-metadata-results.test

Commit

tests/test-metadata-results.test