[Reporting my whole previous answer]
On Friday 17 June 2011, Stefano Lattarini wrote:
> On Friday 17 June 2011, Ralf Wildenhues wrote:
> > * Stefano Lattarini wrote on Thu, Jun 16, 2011 at 10:03:59AM CEST:
> > > With this change, we improve the code creating the `test-suite.log'
> > > global log and the console testsuite summary to make it able to
> > > grasp multiple results per test script. This is required in order
> > > to introduce the planned support for test protocols, like TAP and
> > > SubUnit, which can run multiple testcases per test script.
> > > The implementation makes use of a custom reStructuredText field
> > > `:am-testcase-result:'.
> >
> > Why an Automake-specific name here?
> >
> To make it harder for "generic" output from a test case to match it.
> Otherwise, we risk spurious test results.
>
> > This is user facing, it should be ':testcase-result:'.
> >
> OK, it seems pretty unlikely that it will be in generic test outputs
> either. It's also visually more pleasant, so let's go with it.
>
> > But 'testcase' is not a word, at least not
> > a good one. Please check what other test suite codes use, but I'd
> > just use ':test-result:' or ':result:' (if that is not ambiguous).
> >
> > Other third-party code might want to make use of this too.
> >
> > Actually, why not s/testcase/test/g globally in all your text.
> >
> Because I'm trying to make a distinction between test scripts and
> test cases. With the new interface, a single test script can contain
> multiple testcases, and thus have multiple test results. It is a
> simple concept, but not immediate to get for someone who was used
> the older Automake tests drivers (which obeyed the principle "one
> test script, one test result", so that you could call a test script
> also a "testcase", or simply a "test", without risk of confusion.
>
> > I haven't gone over this in detail yet, so just a few random remarks
> > below.
> >
> > And by the way, thanks for all your work on this so far!
> >
> > Cheers,
> > Ralf
> >
> > > * lib/check.am ($(TEST_SUITE_LOG)): When processing .log files,
> > > recognize a testcase result report only if it is declared with
> > > the custom `:am-testcase-result:' reStructuredText field placed
> > > at the beginning of a line. Extend and add explanatory comments.
> > > (recheck, recheck-html): Add explanatory comments.
> > > * lib/pt-driver: Write an appropriate `:am-testcase-result:'
> > > reStructuredText field in the generated log file. Use a
> > > reStructuredText transition to better separate the test outcome
> > > report from the test registered output. Improve comments.
> > > * tests/test-driver-custom-xfail-tests.test: Adapt.
> > > * tests/parallel-tests-empty-testlogs.test: New test.
> > > * tests/parallel-tests-recheck-override.test: Likewise.
> > > * tests/parallel-tests2.test: Extend and keep more in-sync with ...
> > > * tests/test-driver-custom-html.test: ... this new related test.
> > > * tests/test-driver-custom-no-html.test: New test.
> > > * tests/test-driver-custom-multitest.test: Likewise.
> > > * tests/test-driver-custom-multitest-recheck.test: Likewise.
> > > * tests/test-driver-custom-multitest-recheck2.test: Likewise.
> > > * tests/ostp-driver: New file, used by the last four tests above.
> >
> > tests/simple-driver, or maybe trivial-test-driver (as "simple driver" is
> > already used in the manual for something different) or something. ostp
> > is just confusing, and you've argued against 8+3 conventions all the
> > time. ;->
> >
> OK.
>
> > > * tests/Makefile.am (TESTS): Update.
> > > (EXTRA_DIST): Distribute `ostp-driver'.
> > > (test-driver-custom-multitest.log): Depend on `ostp-driver'.
> > > (test-driver-custom-multitest-recheck.log): Likewise.
> > > (test-driver-custom-multitest-recheck2.log): Likewise.
> > > (test-driver-custom-html.log): Likewise.
> > > * doc/automake.texi (API for Custom Test Drivers): Update (still
> > > in Texinfo comments only).
> >
> > I don't like TODO and comments stuff in finished patches documentation
> > if we can help it (and here, we surely can).
> >
> While I mostly agree, I'd like to point out that I had already rewritten
> and revesited the documentation several times, and after some point you
> risk more harm than good in tweaking and re-shaping the same text again;
> also, you're somewhat fed up with it, so that the risk of becoming sloppy
> or of producing confused text increases. I'll fix the TODOs in this patch
> if you insist, but honestly I'd rather to that in a follow-up patch if
> possible.
>
> > > --- a/doc/automake.texi
> > > +++ b/doc/automake.texi
> > > @@ -9052,8 +9052,9 @@ if the exact interpretation of the associated
> > > semantics can change
> > > between a test driver and another, and even be a no-op in some drivers).
> > >
> > > @b{TODO!} @i{Options and flags that the driver must handle. Generation
> > > -of ``.log'' files. Console output the driver is expected to produce.
> > > -Support for colored output, XFAIL_TESTS, and DISABLE_HARD_ERRORS}
> > > +of ``.log'' files, and format they must obey. Console output the driver
> >
> > @file{.log}
> >
> > You should almost never need to use ``...'' in texinfo, at least not for
> > any entity that has a meaning in code.
> >
> Note that this hunk is just temporary, and bounded to be removed by follow-up
> patches that will (or would have) completed the TODOs.
>
> > > +is expected to produce. Support for colored output, XFAIL_TESTS, and
> > > +DISABLE_HARD_ERRORS.}
> > >
> > > @c
> > > @c The driver script should follow a simple protocol in order to really
> > > @@ -9075,6 +9076,29 @@ Support for colored output, XFAIL_TESTS, and
> > > DISABLE_HARD_ERRORS}
> > > @c driver can use temporary files if it needs to, only it should clean
> > > @c them up properly).
> > > @c
> > > +@c * The result of each testcase run by a test script/program *must*
> > > +@c be registered in the test log using a custom reStructuredText
> > > +@c field ``am-testcase-result''. For example, if the test script
> >
> > See above.
> >
> > > +@c executes two test cases, one successful and one failing, and skip
> > > +@c another test case, the driver should end up writing the following
> > > +@c in the test log:
> > > +@c :am-testcase-result: PASS [passed testcase name or details]
> > > +@c :am-testcase-result: FAIL [failed testcase name or details]
> > > +@c :am-testcase-result: SKIP [skipped testcase name or details]
> >
> > is the [...] literal or metasyntactic?
> >
> Metasyntactic.
>
> > Please use proper notation here.
> >
> What would that be? Sorry if it's a stupid question, but my grasp of
> Texinfo is still pretty limited.
>
> > > +@c The above lines (each of which *must* be followed by a blank line
> > > +@c in order for the HTML output generation to work) are used only
> > > +@c when generating the `test-suite.log' from the individual test
> >
> > See above.
> >
> About what exactly?
>
> > > +@c logs, and can be placed in any order and position within the logs
> > > +@c itself.
> > > +@c
> > > +@c * The result of each testcase run by a test script/program *must*
> > > +@c be registered by the test driver in the *first* line of the test
> > > +@c log (FIXME: this seems too strict; maybe we could use another
> > > +@c custom reStructuredText directive instead?). This line is used by
> > > +@c the "recheck" target. A test will be considered failed by this
> > > +@c target, and thus to be re-run, if the first line in its log file
> > > +@c begins with either `FAIL' or `XPASS'.
> > > +@c
> > > @c * driver-specific options (AM_LOG_DRIVER_FLAGS and LOG_DRIVER_FLAGS)
> > > @c that get passed to the driver script by the Makefile.
> >
> > > --- a/lib/am/check.am
> > > +++ b/lib/am/check.am
> > > @@ -133,12 +133,25 @@ esac;
> > > \
> > > $(AM_TESTS_ENVIRONMENT) $(TESTS_ENVIRONMENT)
> > >
> > > $(TEST_SUITE_LOG): $(TEST_LOGS)
> > > - @$(am__sh_e_setup); \
> > > - list='$(TEST_LOGS)'; \
> > > - results=`for f in $$list; do \
> > > - test -r $$f && read line < $$f && echo "$$line" \
> > > - || echo FAIL; \
> > > - done`; \
> > > + @$(am__sh_e_setup); \
> > > +## The custom reStructuredText filed used to register the outcome of a
> > > test
> > > +## case (which is *not* the same thing as the outcome of the test
> > > script).
> > > +## This is for supporting test protocols that allow for more that one
> > > test
> > > +## case per test script.
> > > + rst_magic=":am-testcase-result:"; \
> > > +## All test logs.
> > > + list='$(TEST_LOGS)'; \
> > > +## Readable test logs.
> > > + list2=`for f in $$list; do test ! -r $$f || echo $$f; done`; \
> > > +## Each unreadable test log counts as a failed test.
> > > + results1=`for f in $$list; do test -r $$f || echo FAIL; done`; \
> > > +## Extract the outcome of all the testcases from the test logs.
> > > + results2=''; \
> > > + if test -n "$$list2"; then \
> > > + results2=`sed -n "s/^$$rst_magic[ ]*//p" $$list2`; \
> >
> > tab space
> >
> That's deliberate, we don't want to be too strict in parsing user's
> output (or in this case, third-party drivers output).
>
> > > + fi; \
> > > +## Prepare the test suite summary.
> > > + results=`echo "$$results1" && echo "$$results2"` \
> > > all=`echo "$$results" | sed '/^$$/d' | wc -l | sed -e 's/^[
> > > ]*//'`; \
> > > fail=`echo "$$results" | grep -c '^FAIL'`; \
> > > pass=`echo "$$results" | grep -c '^PASS'`; \
> > > @@ -178,6 +191,7 @@ $(TEST_SUITE_LOG): $(TEST_LOGS)
> > > msg="$$msg($$skip tests were not run). "; \
> > > fi; \
> > > fi; \
> > > +## Write "global" testsuite log.
> > > { \
> > > echo "$(PACKAGE_STRING): $(subdir)/$(TEST_SUITE_LOG)" | \
> > > $(am__rst_title); \
> > > @@ -185,6 +199,16 @@ $(TEST_SUITE_LOG): $(TEST_LOGS)
> > > echo; \
> > > echo ".. contents:: :depth: 2"; \
> > > echo; \
> > > +## Here we assume that the test driver writes a proper summary for the
> > > +## test script on the first line. Requiring this is not a limitation,
> > > +## but a feature, since this way a custom test driver is allowed to
> > > decide
> > > +## what the outcome is in case of conflicting testcase results in a test
> > > +## script. For example, if a test script reports 8 successful testcases
> > > +## and 2 skipped testcases, some drivers might report that globally as a
> > > +## SKIP, while others as a PASS.
> > > +## FIXME: This should be documented in the automake manual. The above
> > > +## FIXME: explanation is indeed more appropriate for the manual than for
> > > +## FIXME: comments in code.
> > > for f in $$list; do \
> > > test -r $$f && read line < $$f || line=; \
> > > case $$line in \
> > > @@ -201,6 +225,7 @@ $(TEST_SUITE_LOG): $(TEST_LOGS)
> > > fi; \
> > > fi; \
> > > test x"$$VERBOSE" = x || $$exit || cat $(TEST_SUITE_LOG); \
> > > +## Emit the test summary on the console, and exit.
> > > $(am__tty_colors); \
> > > if $$exit; then \
> > > echo $(ECHO_N) "$$grn$(ECHO_C)"; \
> > > @@ -283,6 +308,10 @@ recheck recheck-html:
> > > list=`for f in $$list; do \
> > > test -f $$f || continue; \
> > > if test -r $$f && read line < $$f; then \
> > > +## Here we assume that the test driver writes a proper summary for the
> > > +## test script on the first line. See the comments in the rules of
> > > +## $(TEST_SUITE_LOG) above for why we consider this acceptable and even
> > > +## advisable.
> > > case $$line in FAIL*|XPASS*) echo $$f;; esac; \
> > > else echo $$f; fi; \
> > > done | tr '\012\015' ' '`; \
> > > diff --git a/lib/pt-driver b/lib/pt-driver
> > > index 78b6d18..b1b281f 100755
> > > --- a/lib/pt-driver
> > > +++ b/lib/pt-driver
> > > @@ -113,9 +113,21 @@ case $estatus:$expect_failure in
> > > *:yes) col=$lgn; res=XFAIL;;
> > > *:*) col=$red; res=FAIL ;;
> > > esac
> > > +
> > > +# Report outcome to console.
> > > echo "${col}${res}${std}: $test_name"
> > > -echo "$res: $test_name (exit: $estatus)" | rst_section > $logfile
> > > -cat $tmpfile >> $logfile
> > > +
> > > +# Now write log file.
> > > +{
> > > + echo "$res: $test_name (exit: $estatus)" | rst_section
> > > + echo ":am-testcase-result: $res (exit status: $estatus)"
> >
> (here I should do s/am-testcase-result/testcase-result/)
>
> > > + # Use a reStructuredText transition to better separate the test
> > > + # outcome report from its registered output.
> > > + echo
> > > + printf '%s\n' '------------'
> >
> (below you say "echo --...." is portable, so I assume it's safe to use
> it here too).
>
> > > + echo
> > > + cat $tmpfile
> > > +} > $logfile
> > > rm -f $tmpfile
> > >
> > > # Local Variables:
> > > diff --git a/tests/Makefile.am b/tests/Makefile.am
> > > index 36445b5..93f678a 100644
> > > --- a/tests/Makefile.am
> > > +++ b/tests/Makefile.am
> > > @@ -718,10 +718,16 @@ parallel-tests-unreadable-log.test \
> > > parallel-tests-subdir.test \
> > > parallel-tests-interrupt.test \
> > > parallel-tests-reset-term.test \
> > > +parallel-tests-empty-testlogs.test \
> > > parallel-tests-pt-driver.test \
> > > test-driver-custom-no-pt-driver.test \
> > > test-driver-custom.test \
> > > test-driver-custom-xfail-tests.test \
> > > +test-driver-custom-multitest.test \
> > > +test-driver-custom-multitest-recheck.test \
> > > +test-driver-custom-multitest-recheck2.test \
> > > +test-driver-custom-html.test \
> > > +test-driver-custom-no-html.test \
> > > test-driver-fail.test \
> > > parse.test \
> > > percent.test \
> > > @@ -1058,6 +1064,11 @@ $(parallel_tests)
> > >
> > > EXTRA_DIST += $(TESTS)
> > >
> > > +test-driver-custom-multitest.log: ostp-driver
> > > +test-driver-custom-multitest-recheck.log: ostp-driver
> > > +test-driver-custom-multitest-recheck2.log: ostp-driver
> > > +test-driver-custom-html.log: ostp-driver
> > > +EXTRA_DIST += ostp-driver
> > >
> > > # Dependencies valid for each test case.
> > > $(TEST_LOGS): defs defs-static aclocal-$(APIVERSION)
> > > automake-$(APIVERSION)
> > > diff --git a/tests/Makefile.in b/tests/Makefile.in
> > > index df2a818..084b26d 100644
> > > --- a/tests/Makefile.in
> > > +++ b/tests/Makefile.in
> > > @@ -276,7 +276,7 @@ top_builddir = @top_builddir@
> > > top_srcdir = @top_srcdir@
> > > MAINTAINERCLEANFILES = $(parallel_tests) $(instspc_tests)
> > > EXTRA_DIST = ChangeLog-old gen-parallel-tests instspc-tests.sh \
> > > - $(TESTS)
> > > + $(TESTS) ostp-driver
> > > XFAIL_TESTS = all.test auxdir2.test cond17.test gcj6.test \
> > > override-conditional-2.test pr8365-remake-timing.test \
> > > yacc-dist-nobuild-subdir.test txinfo5.test \
> > > @@ -972,10 +972,16 @@ parallel-tests-unreadable-log.test \
> > > parallel-tests-subdir.test \
> > > parallel-tests-interrupt.test \
> > > parallel-tests-reset-term.test \
> > > +parallel-tests-empty-testlogs.test \
> > > parallel-tests-pt-driver.test \
> > > test-driver-custom-no-pt-driver.test \
> > > test-driver-custom.test \
> > > test-driver-custom-xfail-tests.test \
> > > +test-driver-custom-multitest.test \
> > > +test-driver-custom-multitest-recheck.test \
> > > +test-driver-custom-multitest-recheck2.test \
> > > +test-driver-custom-html.test \
> > > +test-driver-custom-no-html.test \
> > > test-driver-fail.test \
> > > parse.test \
> > > percent.test \
> > > @@ -1360,12 +1366,16 @@ cscope cscopelist:
> > >
> > >
> > > $(TEST_SUITE_LOG): $(TEST_LOGS)
> > > - @$(am__sh_e_setup); \
> > > - list='$(TEST_LOGS)'; \
> > > - results=`for f in $$list; do \
> > > - test -r $$f && read line < $$f && echo "$$line" \
> > > - || echo FAIL; \
> > > - done`; \
> > > + @$(am__sh_e_setup); \
> > > + rst_magic=":am-testcase-result:"; \
> > > + list='$(TEST_LOGS)'; \
> > > + list2=`for f in $$list; do test ! -r $$f || echo $$f; done`; \
> > > + results1=`for f in $$list; do test -r $$f || echo FAIL; done`; \
> > > + results2=''; \
> > > + if test -n "$$list2"; then \
> > > + results2=`sed -n "s/^$$rst_magic[ ]*//p" $$list2`; \
> > > + fi; \
> > > + results=`echo "$$results1" && echo "$$results2"` \
> > > all=`echo "$$results" | sed '/^$$/d' | wc -l | sed -e 's/^[
> > > ]*//'`; \
> > > fail=`echo "$$results" | grep -c '^FAIL'`; \
> > > pass=`echo "$$results" | grep -c '^PASS'`; \
> > > @@ -1718,6 +1728,11 @@ $(instspc_tests): Makefile.am
> > > instspc-data.log: instspc-tests.sh
> > > $(instspc_tests:.test=.log): instspc-tests.sh instspc-data.log
> > >
> > > +test-driver-custom-multitest.log: ostp-driver
> > > +test-driver-custom-multitest-recheck.log: ostp-driver
> > > +test-driver-custom-multitest-recheck2.log: ostp-driver
> > > +test-driver-custom-html.log: ostp-driver
> > > +
> > > # Dependencies valid for each test case.
> > > $(TEST_LOGS): defs defs-static aclocal-$(APIVERSION)
> > > automake-$(APIVERSION)
> > >
> > > diff --git a/tests/ostp-driver b/tests/ostp-driver
> > > new file mode 100644
> > > index 0000000..dced57a
> > > --- /dev/null
> > > +++ b/tests/ostp-driver
> > > @@ -0,0 +1,94 @@
> > > +#! /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/>.
> > > +
> > > +# Testsuite driver for OSTP, the Outrageously Simple Test Protocol :-)
> > > +# The exit status of the wrapped script is ignored. Lines in its stdout
> > > +# and stderr beginning with `PASS', `FAIL', `XFAIL', `XPASS' or `SKIP'
> > > +# count as a test case result with the obviously-corresponding outcome.
> > > +# Every other line is ignored for what concerns the testsuite outcome.
> > > +# This script is used at least by the `driver-custom-multitest*.test'
> > > +# tests.
> > > +
> > > +set -u
> > > +
> > > +## Option parsing.
> > > +
> > > +test_name=INVALID.NAME
> > > +log_file=BAD.LOG
> > > +while test $# -gt 0; do
> > > + case $1 in
> > > + --test-name) test_name=$2; shift;;
> > > + --log-file) log_file=$2; shift;;
> > > + # Ignored.
> > > + --expect-failure) shift;;
> > > + --color-tests) shift;;
> > > + --enable-hard-errors) shift;;
> > > + # Explicitly terminate option list.
> > > + --) shift; break;;
> > > + # Shouldn't happen
> > > + *) echo "$0: invalid option/argument: '$1'" >&2; exit 2;;
> > > + esac
> > > + shift
> > > +done
> > > +
> > > +## Run the test script, get test cases results, display them on console.
> > > +
> > > +tmp_out=$log_file-out.tmp
> > > +tmp_res=$log_file-res.tmp
> > > +
> > > +"$@" 2>&1 | tee $tmp_out | (
> > > + i=0 st=0
> > > + : > $tmp_res
> > > + while read line; do
> > > + case $line in
> > > + PASS:*|FAIL:*|XPASS:*|XFAIL:*|SKIP:*)
> > > + i=`expr $i + 1`
> > > + result=`LC_ALL=C expr "$line" : '\([A-Z]*\):.*'`
> >
> > This will be quite fork expensive, if done in real-world code.
> >
> But this is in a script used only for testing. I don't think
> it's worth optimizing it.
>
> > Might just want to use one single sed script replacing this
> > while while loop.
> >
> > But then again, measuring is king.
> >
> And BTW, "premature optimization is the root of all evil" ;-)
>
> I agree that we should improve my code for speed later (after all, we
> expect it to be used in so many place that developer's time invested
> into making it faster should be well invested). But first I say we
> should get the behaviour, interfaces and testsuite additions right.
>
> > > + case $result in FAIL|XPASS) st=1;; esac
> > > + # Output testcase result to console.
> > > + echo "$result: $test_name, testcase $i"
> > > + # Register testcase outcome for the log file.
> > > + echo ":am-testcase-result: $line" >> $tmp_res
> > > + echo >> $tmp_res
> > > + ;;
> > > + esac
> > > + done
> > > + exit $st
> > > +)
> > > +
> > > +if test $? -eq 0; then
> > > + global_result=PASS
> > > +else
> > > + global_result=FAIL
> > > +fi
> > > +
> > > +## Write the log file.
> > > +
> > > +{
> > > + echo "$global_result: $test_name"
> > > + echo "$global_result: $test_name" | sed 's/./=/g'
> > > + echo
> > > + cat $tmp_res
> > > + echo
> > > + printf '%s\n' '--------------------'
> >
> > echo? It copes with multiple dashes
> >
> And so echo be.
>
> > (don't believe autoconf.texi).
> >
> Heresy! :-)
>
> > > + echo
> > > + cat $tmp_out
> > > +} > $log_file
> > > +rm -f $tmp_out $tmp_res
> > > +
> > > +## And we're done.
> > > +
> > > +exit 0
> >
> >
>
And attached is what I've squashed in.
Regards,
Stefano
diff --git a/ChangeLog b/ChangeLog
index 6f34f12..0b0694d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -7,16 +7,16 @@
to introduce the planned support for test protocols, like TAP and
SubUnit, which can run multiple testcases per test script.
The implementation makes use of a custom reStructuredText field
- `:am-testcase-result:'.
+ `:test-result:'.
* lib/check.am ($(TEST_SUITE_LOG)): When processing .log files,
recognize a testcase result report only if it is declared with
- the custom `:am-testcase-result:' reStructuredText field placed
- at the beginning of a line. Extend and add explanatory comments.
+ the custom `:test-result:' reStructuredText field placed at the
+ beginning of a line. Extend and add explanatory comments.
(recheck, recheck-html): Add explanatory comments.
- * lib/pt-driver: Write an appropriate `:am-testcase-result:'
- reStructuredText field in the generated log file. Use a
- reStructuredText transition to better separate the test outcome
- report from the test registered output. Improve comments.
+ * lib/test-driver: Write an appropriate reStructuredText field
+ `:test-result:' in the generated log file. Use a reStructuredText
+ transition to better separate the test outcome report from the
+ test script's registered output. Improve comments.
* tests/test-driver-custom-xfail-tests.test: Adapt.
* tests/parallel-tests-empty-testlogs.test: New test.
* tests/parallel-tests-recheck-override.test: Likewise.
@@ -26,10 +26,11 @@
* tests/test-driver-custom-multitest.test: Likewise.
* tests/test-driver-custom-multitest-recheck.test: Likewise.
* tests/test-driver-custom-multitest-recheck2.test: Likewise.
- * tests/ostp-driver: New file, used by the last four tests above.
+ * tests/trivial-test-driver: New file, used by the last four tests
+ above.
* tests/Makefile.am (TESTS): Update.
- (EXTRA_DIST): Distribute `ostp-driver'.
- (test-driver-custom-multitest.log): Depend on `ostp-driver'.
+ (EXTRA_DIST): Distribute `trivial-test-driver'.
+ (test-driver-custom-multitest.log): Depend on `trivial-test-driver'.
(test-driver-custom-multitest-recheck.log): Likewise.
(test-driver-custom-multitest-recheck2.log): Likewise.
(test-driver-custom-html.log): Likewise.
diff --git a/doc/automake.texi b/doc/automake.texi
index af15d40..4c0a95c 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -9089,13 +9089,13 @@ DISABLE_HARD_ERRORS.}
@c
@c * The result of each testcase run by a test script/program *must*
@c be registered in the test log using a custom reStructuredText
-@c field ``am-testcase-result''. For example, if the test script
-@c executes two test cases, one successful and one failing, and skip
-@c another test case, the driver should end up writing the following
-@c in the test log:
-@c :am-testcase-result: PASS [passed testcase name or details]
-@c :am-testcase-result: FAIL [failed testcase name or details]
-@c :am-testcase-result: SKIP [skipped testcase name or details]
+@c field ``test-result''. For example, if the test script executes
+@c two test cases, one successful and one failing, and skip another
+@c test case, the driver should end up writing the following in the
+@c test log:
+@c :test-result: PASS [passed testcase name or details]
+@c :test-result: FAIL [failed testcase name or details]
+@c :test-result: SKIP [skipped testcase name or details]
@c The above lines (each of which *must* be followed by a blank line
@c in order for the HTML output generation to work) are used only
@c when generating the `test-suite.log' from the individual test
diff --git a/lib/Automake/tests/Makefile.in b/lib/Automake/tests/Makefile.in
index 1503045..cf8104f 100644
--- a/lib/Automake/tests/Makefile.in
+++ b/lib/Automake/tests/Makefile.in
@@ -338,7 +338,7 @@ cscope cscopelist:
$(TEST_SUITE_LOG): $(TEST_LOGS)
@$(am__sh_e_setup); \
- rst_magic=":am-testcase-result:"; \
+ rst_magic=":test-result:"; \
list='$(TEST_LOGS)'; \
list2=`for f in $$list; do test ! -r $$f || echo $$f; done`; \
results1=`for f in $$list; do test -r $$f || echo FAIL; done`; \
diff --git a/lib/am/check.am b/lib/am/check.am
index 014dbaf..46e8548 100644
--- a/lib/am/check.am
+++ b/lib/am/check.am
@@ -134,11 +134,11 @@ $(AM_TESTS_ENVIRONMENT) $(TESTS_ENVIRONMENT)
$(TEST_SUITE_LOG): $(TEST_LOGS)
@$(am__sh_e_setup); \
-## The custom reStructuredText filed used to register the outcome of a test
-## case (which is *not* the same thing as the outcome of the test script).
-## This is for supporting test protocols that allow for more that one test
-## case per test script.
- rst_magic=":am-testcase-result:"; \
+## The custom reStructuredText field used to register the outcome of
+## a test. This is for supporting test protocols, such as TAP and
+## SubUnit, where a single test script can run multiple tests, each
+## with its own outcome.
+ rst_magic=":test-result:"; \
## All test logs.
list='$(TEST_LOGS)'; \
## Readable test logs.
diff --git a/lib/test-driver b/lib/test-driver
index aaf4ba8..5f8e9c8 100755
--- a/lib/test-driver
+++ b/lib/test-driver
@@ -120,11 +120,11 @@ echo "${col}${res}${std}: $test_name"
# Now write log file.
{
echo "$res: $test_name (exit: $estatus)" | rst_section
- echo ":am-testcase-result: $res (exit status: $estatus)"
+ echo ":test-result: $res (exit status: $estatus)"
# Use a reStructuredText transition to better separate the test
# outcome report from its registered output.
echo
- printf '%s\n' '------------'
+ echo ------------
echo
cat $tmpfile
} > $logfile
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 29d7d00..90d1054 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -1074,11 +1074,11 @@ $(parallel_tests)
EXTRA_DIST += $(TESTS)
-test-driver-custom-multitest.log: ostp-driver
-test-driver-custom-multitest-recheck.log: ostp-driver
-test-driver-custom-multitest-recheck2.log: ostp-driver
-test-driver-custom-html.log: ostp-driver
-EXTRA_DIST += ostp-driver
+test-driver-custom-multitest.log: trivial-test-driver
+test-driver-custom-multitest-recheck.log: trivial-test-driver
+test-driver-custom-multitest-recheck2.log: trivial-test-driver
+test-driver-custom-html.log: trivial-test-driver
+EXTRA_DIST += trivial-test-driver
# Dependencies valid for each test case.
$(TEST_LOGS): defs defs-static aclocal-$(APIVERSION) automake-$(APIVERSION)
diff --git a/tests/Makefile.in b/tests/Makefile.in
index 60002a0..72c9278 100644
--- a/tests/Makefile.in
+++ b/tests/Makefile.in
@@ -276,7 +276,7 @@ top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
MAINTAINERCLEANFILES = $(parallel_tests) $(instspc_tests)
EXTRA_DIST = ChangeLog-old gen-parallel-tests instspc-tests.sh \
- $(TESTS) ostp-driver
+ $(TESTS) trivial-test-driver
XFAIL_TESTS = all.test auxdir2.test cond17.test gcj6.test \
override-conditional-2.test pr8365-remake-timing.test \
yacc-dist-nobuild-subdir.test txinfo5.test \
@@ -1377,7 +1377,7 @@ cscope cscopelist:
$(TEST_SUITE_LOG): $(TEST_LOGS)
@$(am__sh_e_setup); \
- rst_magic=":am-testcase-result:"; \
+ rst_magic=":test-result:"; \
list='$(TEST_LOGS)'; \
list2=`for f in $$list; do test ! -r $$f || echo $$f; done`; \
results1=`for f in $$list; do test -r $$f || echo FAIL; done`; \
@@ -1738,10 +1738,10 @@ $(instspc_tests): Makefile.am
instspc-data.log: instspc-tests.sh
$(instspc_tests:.test=.log): instspc-tests.sh instspc-data.log
-test-driver-custom-multitest.log: ostp-driver
-test-driver-custom-multitest-recheck.log: ostp-driver
-test-driver-custom-multitest-recheck2.log: ostp-driver
-test-driver-custom-html.log: ostp-driver
+test-driver-custom-multitest.log: trivial-test-driver
+test-driver-custom-multitest-recheck.log: trivial-test-driver
+test-driver-custom-multitest-recheck2.log: trivial-test-driver
+test-driver-custom-html.log: trivial-test-driver
# Dependencies valid for each test case.
$(TEST_LOGS): defs defs-static aclocal-$(APIVERSION) automake-$(APIVERSION)
diff --git a/tests/test-driver-custom-html.test b/tests/test-driver-custom-html.test
index e5a7a2a..5663ee6 100755
--- a/tests/test-driver-custom-html.test
+++ b/tests/test-driver-custom-html.test
@@ -23,15 +23,15 @@ parallel_tests=yes
required=rst2html
. ./defs || Exit 1
-cp "$testsrcdir"/ostp-driver . \
- || fatal_ "failed to fetch auxiliary script ostp-driver"
+cp "$testsrcdir"/trivial-test-driver . \
+ || fatal_ "failed to fetch auxiliary script trivial-test-driver"
cat >> configure.in << 'END'
AC_OUTPUT
END
cat > Makefile.am << 'END'
-TEST_LOG_DRIVER = $(SHELL) ./ostp-driver
+TEST_LOG_DRIVER = $(SHELL) ./trivial-test-driver
TEST_SUITE_LOG = mylog.log
TESTS = foo.test bar.test baz.test
check_SCRIPTS = bla
diff --git a/tests/test-driver-custom-multitest-recheck.test b/tests/test-driver-custom-multitest-recheck.test
index fa77140..e0f010f 100755
--- a/tests/test-driver-custom-multitest-recheck.test
+++ b/tests/test-driver-custom-multitest-recheck.test
@@ -24,15 +24,15 @@
parallel_tests=yes
. ./defs || Exit 1
-cp "$testsrcdir"/ostp-driver . \
- || fatal_ "failed to fetch auxiliary script ostp-driver"
+cp "$testsrcdir"/trivial-test-driver . \
+ || fatal_ "failed to fetch auxiliary script trivial-test-driver"
cat >> configure.in << 'END'
AC_OUTPUT
END
cat > Makefile.am << 'END'
-TEST_LOG_DRIVER = $(SHELL) $(srcdir)/ostp-driver
+TEST_LOG_DRIVER = $(SHELL) $(srcdir)/trivial-test-driver
TESTS = a.test b.test c.test d.test
END
diff --git a/tests/test-driver-custom-multitest-recheck2.test b/tests/test-driver-custom-multitest-recheck2.test
index d460098..a18bdd8 100755
--- a/tests/test-driver-custom-multitest-recheck2.test
+++ b/tests/test-driver-custom-multitest-recheck2.test
@@ -24,15 +24,15 @@
parallel_tests=yes
. ./defs || Exit 1
-cp "$testsrcdir"/ostp-driver . \
- || fatal_ "failed to fetch auxiliary script ostp-driver"
+cp "$testsrcdir"/trivial-test-driver . \
+ || fatal_ "failed to fetch auxiliary script trivial-test-driver"
cat >> configure.in << 'END'
AC_OUTPUT
END
cat > Makefile.am << 'END'
-TEST_LOG_DRIVER = $(SHELL) $(srcdir)/ostp-driver
+TEST_LOG_DRIVER = $(SHELL) $(srcdir)/trivial-test-driver
TESTS = a.test b.test c.test
END
diff --git a/tests/test-driver-custom-multitest.test b/tests/test-driver-custom-multitest.test
index 49e72bb..a1c1010 100755
--- a/tests/test-driver-custom-multitest.test
+++ b/tests/test-driver-custom-multitest.test
@@ -22,8 +22,8 @@
parallel_tests=yes
. ./defs || Exit 1
-cp "$testsrcdir"/ostp-driver . \
- || fatal_ "failed to fetch auxiliary script ostp-driver"
+cp "$testsrcdir"/trivial-test-driver . \
+ || fatal_ "failed to fetch auxiliary script trivial-test-driver"
cat >> configure.in << 'END'
AC_OUTPUT
@@ -31,7 +31,7 @@ END
cat > Makefile.am << 'END'
TEST_EXTENSIONS = .t
-T_LOG_DRIVER = $(SHELL) $(srcdir)/ostp-driver
+T_LOG_DRIVER = $(SHELL) $(srcdir)/trivial-test-driver
TESTS = \
pass.t \
@@ -129,7 +129,7 @@ for vpath in : false; do
cat stdout
cat test-suite.log
# Couple of sanity checks. These might need to be updated if the
- # `ostp-driver' script is changed.
+ # `trivial-test-driver' script is changed.
$FGREP INVALID.NAME stdout test-suite.log && Exit 1
test -f BAD.LOG && Exit 1
# These log files must all have been created by the testsuite.
diff --git a/tests/test-driver-custom-no-extra-driver.test b/tests/test-driver-custom-no-extra-driver.test
index f4c996e..28c9a19 100755
--- a/tests/test-driver-custom-no-extra-driver.test
+++ b/tests/test-driver-custom-no-extra-driver.test
@@ -14,7 +14,7 @@
# 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 that auxiliary script 'pt-driver' doesn't get needlessly
+# Check that auxiliary script 'test-driver' doesn't get needlessly
# installed or referenced if it's not used, i.e., if the user has
# defined his own `*LOG_DRIVER' variables.
@@ -56,8 +56,8 @@ $ACLOCAL
for opts in '' '--add-missing' '-a -c'; do
$AUTOMAKE $opts
- $FGREP pt-driver Makefile.in sub1/Makefile.in sub2/Makefile.in && Exit 1
- find . | $FGREP pt-driver && Exit 1
+ $FGREP test-driver Makefile.in sub[12]/Makefile.in && Exit 1
+ find . | $FGREP test-driver && Exit 1
done
:
diff --git a/tests/test-driver-custom-no-html.test b/tests/test-driver-custom-no-html.test
index 8d2cb05..9aceae6 100755
--- a/tests/test-driver-custom-no-html.test
+++ b/tests/test-driver-custom-no-html.test
@@ -41,7 +41,7 @@ cat > foo.log <<'EoL'
SKIP: FooBar
=============
-:am-testcase-result: SKIP
+:test-result: SKIP
--------------
dummy title
diff --git a/tests/test-driver-custom-xfail-tests.test b/tests/test-driver-custom-xfail-tests.test
index ec86f53..4f8bb83 100755
--- a/tests/test-driver-custom-xfail-tests.test
+++ b/tests/test-driver-custom-xfail-tests.test
@@ -113,19 +113,19 @@ rm -f "$log_file"
case $st,$expect_failure in
0,no)
echo "PASS: $test_name" | tee "$log_file"
- echo ":am-testcase-result: PASS" >> "$log_file"
+ echo ":test-result: PASS" >> "$log_file"
;;
1,no)
echo "FAIL: $test_name" | tee "$log_file"
- echo ":am-testcase-result: FAIL" >> "$log_file"
+ echo ":test-result: FAIL" >> "$log_file"
;;
0,yes)
echo "XPASS: $test_name" | tee "$log_file"
- echo ":am-testcase-result: XPASS" >> "$log_file"
+ echo ":test-result: XPASS" >> "$log_file"
;;
1,yes)
echo "XFAIL: $test_name" | tee "$log_file"
- echo ":am-testcase-result: XFAIL" >> "$log_file"
+ echo ":test-result: XFAIL" >> "$log_file"
;;
*)
echo "INTERNAL ERROR" >&2
diff --git a/tests/ostp-driver b/tests/trivial-test-driver
similarity index 89%
rename from tests/ostp-driver
rename to tests/trivial-test-driver
index dced57a..f06eb1c 100644
--- a/tests/ostp-driver
+++ b/tests/trivial-test-driver
@@ -14,14 +14,21 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-# Testsuite driver for OSTP, the Outrageously Simple Test Protocol :-)
+#
+# Test driver for a very simple test protocol used by the Automake
+# testsuite to check support for custom test drivers allowing for more
+# test results per test script.
+#
# The exit status of the wrapped script is ignored. Lines in its stdout
# and stderr beginning with `PASS', `FAIL', `XFAIL', `XPASS' or `SKIP'
# count as a test case result with the obviously-corresponding outcome.
# Every other line is ignored for what concerns the testsuite outcome.
+#
# This script is used at least by the `driver-custom-multitest*.test'
# tests.
+#
+# Help to avoid typo-related bugs.
set -u
## Option parsing.
@@ -61,7 +68,7 @@ tmp_res=$log_file-res.tmp
# Output testcase result to console.
echo "$result: $test_name, testcase $i"
# Register testcase outcome for the log file.
- echo ":am-testcase-result: $line" >> $tmp_res
+ echo ":test-result: $line" >> $tmp_res
echo >> $tmp_res
;;
esac
@@ -83,7 +90,7 @@ fi
echo
cat $tmp_res
echo
- printf '%s\n' '--------------------'
+ echo --------------------
echo
cat $tmp_out
} > $log_file
