Improve TAP messages slightly.

[open-adventure.git] / tests / Makefile

diff --git a/tests/Makefile b/tests/Makefile
index f2addb991dbc0e1fa6dfb1407417227c9aa04705..efa5332eef220f9ef7d16806f25eb03f7c28d761 100644 (file)
--- a/tests/Makefile
+++ b/tests/Makefile
@@ -1,4 +1,7 @@
-# Test-suite makefile for opeb-adventure
+# Test-suite makefile for open-adventure
+
+# SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
 
 # Use absolute path so tests that change working directory still use
 # scripts from parent directory.  Note that using $PWD seems to fail
@@ -92,6 +95,9 @@ scheck7:
        @./outcheck.sh "test -r with valid input"
 SCHECKS = scheck1 scheck2 scheck3 scheck4 scheck5 scheck6 scheck7
 
+# Don't run this from here, you'll get cryptic warnings and no good result
+# if the advent binary wasn't built with coverage flags.  Do "make clean coverage"
+# from the top-level directory.
 coverage: check
        lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
        genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
@@ -105,17 +111,17 @@ buildchecks: savegames
            OPTS=`sed -n /#options:/s///p <$${file}.log`; \
            advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
        done; \
-       echo "inven" | advent isofoo.log /dev/stdin >multifile.chk; \
+       echo "inven" | advent issue36.log /dev/stdin >multifile.chk; \
        rm -f scratch.tmp
 
 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
 $(RUN_TARGETS): run-regress-%: %.log
        @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
        OPTS=`sed -n /#options:/s///p $<`; \
-       $(advent) $$OPTS <$< | tapdiffer "$<: $${legend}" "$${test}.chk")
+       $(advent) $$OPTS <$< | tapdiffer "$${test}: $${legend}" "$${test}.chk")
 
 multifile-regress:
-       @(echo "inven" | advent isofoo.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
+       @(echo "inven" | advent issue36.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
 
 TEST_TARGETS = $(SGAMES) $(SCHECKS) $(RUN_TARGETS) multifile-regress
 
@@ -124,20 +130,46 @@ tap: count $(TEST_TARGETS)
 count:
        @echo 1..$(words $(TEST_TARGETS))
 
-# The following machinery tests the gane against a binary made from
+# The following machinery tests the game against a binary made from
 # the advent430 branch To use it, switch to that branch, build the
-# binary, sand run it once to generate adventure.data, then switch
-# back to master leaving advent430 and adventure.data in place (make
-# clean does not remove them).
+# binary, run it once to generate adventure.data, then switch back to
+# master leaving advent430 and adventure.data in place (make clean
+# does not remove them).
 #
 # The diff file produced has corrected spellings in it. That's what oldfilter
-# is for, to massage out the orioginal dpellings and avoid noise diffs.
+# is for, to massage out the original spellings and avoid noise diffs.
 # Diffs in amount of whitespace and trailing whitespace are ignored
-
-ancient: $(SGAMES)
+#
+# A magic comment of NOCOMPARE in a log file excludes it from this comparison.
+# making it a skipped test in the TAP view. First use of this was to avoid a
+# spurious mismatch on the news text. Other uses avoid spurious mismatches due
+# to bug fixes.
+#
+# When adding more tests, bear in mind that any game that continues after a
+# resurrection will need a NOCOMPARE. At some point in the forward port,
+# resurrection was accidentally changed in a way that messed wil the LCG chain.
+#
+# The *.chk files need not be up-to-date for this to work.
+#
+TAPFILTER=tapview
+oldcompare:
        @if [ -f ../advent430 ]; then cp ../advent430 ../adventure.data .; else echo "advent430 nonexistent"; exit 1; fi
-       @-for x in *.log; do stem=$${x%.log}; echo $${stem}; ./advent430 <$${stem}.log | ./oldfilter >$${stem}.ochk; done
-       @-(for x in *.log; do stem=$${x%.log}; legend=$$(sed -n '/^## /s///p' <$$x 2>/dev/null || echo "(no description)"); ./newfilter <$${stem}.chk | tapdiffer -w "$${legend}" $${stem}.ochk; done; echo 1..$(words $(shell ls *.log))) | tapview
-       @rm *.ochk advent430 adventure.data
+       @-(for x in *.log; do \
+               stem=$${x%.log}; \
+               legend=$$(sed -n '/^## /s///p' <$$x 2>/dev/null || echo "(no description)"); \
+               if grep NOCOMPARE $$x >/dev/null; \
+                       then echo "not ok - $${stem}.ochk: $${legend} # SKIP"; \
+                       else \
+                               ./advent430 <$${stem}.log | oldfilter >$${stem}.ochk; \
+                               ../advent <$${stem}.log >$${stem}.log-new; \
+                               ./newfilter <$${stem}.log-new | tapdiffer -b "$${stem}: $${legend}" $${stem}.ochk; \
+                       fi; \
+       done; \
+       echo 1..$(words $(shell ls *.log))) | $(TAPFILTER)
+       @rm *.ochk *-new advent430 adventure.data
+
+# List all NOMPARE tests.
+residuals:
+       @grep -n NOCOMPARE *.log
 
 # end