Move in the direction of being able to do ancient regression tests.
[open-adventure.git] / tests / Makefile
index cffab9a73391d093f3beb58bff8319936b1e45e4..347b0f9b31a22fb479212cb110673a437027e4ac 100644 (file)
@@ -1,22 +1,40 @@
-# Test-suite makefile for reposurgeon
+# Test-suite makefile for opeb-adventure
 
-# Use absolute path so tests that change working directory still use 
+# Use absolute path so tests that change working directory still use
 # scripts from parent directory.  Note that using $PWD seems to fail
 # here under Gitlab's CI environment.
-PATH := $(realpath ..):$(realpath .):${PATH}
+PARDIR=$(realpath ..)
+PATH := $(PARDIR):$(realpath .):${PATH}
+GCOV?=gcov
+
+# Make this overrideable so it's easier to test old versions
+advent?=advent
 
 # Defeat annoying behavior under Mac OS X - builtin echo doesn't do -n
 ECHO := /bin/echo
 
-check: regress
-       @echo "=== No diff output is good news."
-       @-advent -x 2>/dev/null # Get usage message into coverage tests
-       @-advent -l /dev/null <quit.log >/dev/null
+# The TAP filter. Only affects presentation of the test suite messages
+TAPCONSUMER=tapview
+
+# Fall back to safety if our declared TAP consumer does not exist.
+# This is helpful in the CI environment, where it would be better for
+# the logfiles to carry the raw TAP messages. 
+TAPFILTER=$(shell command -v $(TAPCONSUMER) || echo cat)
+
+# Find all *.log entries to test
+TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
+
+.PHONY: check clean testlist listcheck savegames savecheck coverage
+.PHONY: buildchecks multifile-regress tap count
+
+check: savecheck
+       @make tap | tapview
+       @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
 
 .SUFFIXES: .chk
 
 clean:
-       rm -fr *~ adventure.text *.adv scratch.tmp
+       rm -fr *~ *.adv scratch.tmp *.ochk advent430 adventure.data
 
 # Show summary lines for all tests.
 testlist:
@@ -26,24 +44,100 @@ listcheck:
            if ( head -3 $$f | grep -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \
        done
 
-# General regression testing of commands and output; look at the *.log and
-# corresponding *.chk files to see which tests this runs.
-TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
-buildregress:
+# Generate bogus savegames.
+sgame1:
+       @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
+       @./outcheck.sh "cheat: Generate save file with -900 deaths"
+sgame2:
+       @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
+       @./outcheck.sh "cheat: Generate save file with -1000 deaths"
+sgame3:
+       @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
+       @./outcheck.sh "cheat: Generate tamper-detection test"
+sgame4:
+       @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
+       @./outcheck.sh "cheat: Generate save file with version -1337"
+sgame5:
+       @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
+       @./outcheck.sh "cheat: Generate save file 1000 saves"
+sgame6:
+       @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
+       @./outcheck.sh "cheat: Generate save file 1000 turns"
+sgame7:
+       @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
+       @./outcheck.sh "cheat: Generate save file 1000 turns"
+SGAMES = sgame1 sgame2 sgame3 sgame4 sgame5 sgame6 sgame7
+
+# Force coverage of cheat edgecases
+scheck1:
+       @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
+       @./outcheck.sh "cheat: bogus option for save file generation"
+scheck2:
+       @$(PARDIR)/cheat 2>/dev/null | true
+       @./outcheck.sh "cheat: No save file specified"
+scheck3:
+       @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
+       @./outcheck.sh "cheat: doesn't save because we omit -o"
+scheck4:
+       @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
+       @./outcheck.sh "cheat: doesn't save to invalid path"
+scheck5:
+       @$(advent) -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
+       @./outcheck.sh "cheat: doesn't start with invalid file with -r"
+scheck6:
+       @$(advent) -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
+       @./outcheck.sh "cheat: doesn't start with invalid file passed to -l"
+scheck7:
+       @$(advent) -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
+       @./outcheck.sh "test -r with valid input"
+SCHECKS = scheck1 scheck2 scheck3 scheck4 scheck5 scheck6 scheck7
+
+coverage: check
+       lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
+       genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
+       ./coverage_dungeon.py
+
+# Rebuild characterizing tests
+buildchecks: savegames
+       $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
        @for file in $(TESTLOADS); do \
            echo "Remaking $${file}.chk"; \
            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; \
        rm -f scratch.tmp
-regress:
-       @for file in $(TESTLOADS); do \
-           $(ECHO) -n "  $${file} "; grep '##' $${file}.log  || echo ' ## (no description)'; \
-           OPTS=`sed -n /#options:/s///p <$${file}.log`; \
-           if advent $$OPTS < $${file}.log >/tmp/regress$$$$ 2>&1; \
-           then diff --text -u $${file}.chk /tmp/regress$$$$ || exit 1; \
-           else echo "*** Nonzero return status on $${file}!"; exit 1; fi \
-       done; \
-       rm -f scratch.tmp /tmp/regress$$$$
+
+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")
+
+multifile-regress:
+       @(echo "inven" | advent isofoo.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
+
+TEST_TARGETS = $(SGAMES) $(SCHECKS) $(RUN_TARGETS) multifile-regress
+
+tap: count $(TEST_TARGETS)
+       @rm -f scratch.tmp /tmp/coverage* /tmp/cheat*
+count:
+       @echo 1..$(words $(TEST_TARGETS))
+
+# The following machinery tests the gane 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).
+#
+# 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.
+# Diffs in amount of whitespace and trailing whitespace are ignored
+
+ancient: $(SGAMES)
+       @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}; ./newfilter <$${stem}.chk | diff -ubZ $${stem}.ochk -; done
+       @rm *.ochk advent430 adventure.data
 
 # end