The oldcompare production no longer requires savefiles.
[open-adventure.git] / tests / Makefile
index c0a9b0ccc07077d9fe6151bc3c40e39ebc1d23b2..80768024cf6febf4b51e921063040304e74f5e8d 100644 (file)
@@ -1,4 +1,4 @@
-# Test-suite makefile for opeb-adventure
+# Test-suite makefile for open-adventure
 
 # Use absolute path so tests that change working directory still use
 # scripts from parent directory.  Note that using $PWD seems to fail
@@ -29,14 +29,12 @@ TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
 
 check: savecheck
        @make tap | tapview
-       @echo "=== No diff output is good news."
        @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
-       @-advent -l /dev/null <pitfall.log >/dev/null
 
 .SUFFIXES: .chk
 
 clean:
-       rm -fr *~ *.adv scratch.tmp *.ochk
+       rm -fr *~ *.adv scratch.tmp *.ochk advent430 adventure.data
 
 # Show summary lines for all tests.
 testlist:
@@ -94,6 +92,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
@@ -126,12 +127,46 @@ tap: count $(TEST_TARGETS)
 count:
        @echo 1..$(words $(TEST_TARGETS))
 
-# The following machinery tests the gane against a binary made from the advent430 branch
-# The diff file produced has new spellings in it.
+# The following machinery tests the game against a binary made from
+# the advent430 branch To use it, switch to that branch, build the
+# 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 original spellings and avoid noise diffs.
+# Diffs in amount of whitespace and trailing whitespace are ignored
+#
+# 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}; \
+               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 -w "$${stem}: $${legend}" $${stem}.ochk; \
+                       fi; \
+       done; \
+       echo 1..$(words $(shell ls *.log))) | $(TAPFILTER)
+       @rm *.ochk *-new advent430 adventure.data
 
-ancient:
-       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}; diff -u $${stem}.chk $${stem}.log; done
-       rm *.ochk
+# List all NOMPARE tests.
+residuals:
+       @grep -n NOCOMPARE *.log
 
 # end