More TAPification.
[open-adventure.git] / tests / Makefile
index 498dbb80a4293e1ffb0c9a604e9b14f5a2103742..c0a9b0ccc07077d9fe6151bc3c40e39ebc1d23b2 100644 (file)
@@ -13,26 +13,30 @@ advent?=advent
 # Defeat annoying behavior under Mac OS X - builtin echo doesn't do -n
 ECHO := /bin/echo
 
+# 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 coverage clean testlist listcheck savegames buildregress
-.PHONY: savecheck regress
+.PHONY: check clean testlist listcheck savegames savecheck coverage
+.PHONY: buildchecks multifile-regress tap count
 
-check: savecheck regress
+check: savecheck
+       @make tap | tapview
        @echo "=== No diff output is good news."
-       @-advent -x 2>/dev/null # Get usage message into coverage tests
+       @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
        @-advent -l /dev/null <pitfall.log >/dev/null
 
-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
-
 .SUFFIXES: .chk
 
 clean:
-       rm -fr *~ adventure.text *.adv scratch.tmp
+       rm -fr *~ *.adv scratch.tmp *.ochk
 
 # Show summary lines for all tests.
 testlist:
@@ -43,90 +47,91 @@ listcheck:
        done
 
 # Generate bogus savegames.
-savegames:
-       @$(ECHO) "cheat: Generate save file with -900 deaths"
+sgame1:
        @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
-       @$(ECHO) "cheat: Generate save file with -1000 deaths"
+       @./outcheck.sh "cheat: Generate save file with -900 deaths"
+sgame2:
        @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
-       @$(ECHO) "cheat: Generate save file with version -1337"
+       @./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
-       @$(ECHO) "cheat: Generate save file 1000 saves"
+       @./outcheck.sh "cheat: Generate save file with version -1337"
+sgame5:
        @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
-       @$(ECHO) "cheat: Generate save file 1000 turns"
+       @./outcheck.sh "cheat: Generate save file 1000 saves"
+sgame6:
        @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
-       @$(ECHO) "cheat: Generate save file 1000 turns"
+       @./outcheck.sh "cheat: Generate save file 1000 turns"
+sgame7:
        @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
-       @rm -f /tmp/cheat*
+       @./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
-buildregress: savegames
+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
+       echo "inven" | advent isofoo.log /dev/stdin >multifile.chk; \
        rm -f scratch.tmp
 
-savecheck: savegames
-       @$(ECHO) "TEST cheat: Bogus option for save file generation"
-       @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
-       @$(ECHO) "TEST cheat: No save file specified"
-       @$(PARDIR)/cheat 2>/dev/null | true
-       @$(ECHO) "TEST cheat: Fail to save because we omit -o"
-       @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
-       @$(ECHO) "TEST cheat: Fail to save to invalid path"
-       @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
-       @$(ECHO) "TEST advent: Start with invalid file with -r"
-       @advent -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
-       @$(ECHO) "TEST advent: Start with invalid file with -l"
-       @advent -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
-       @$(ECHO) "TEST advent: Test -r with valid input"
-       @advent -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
-       @rm -f /tmp/coverage*
-
-# General regression testing of commands and output; look at the *.log and
-# corresponding *.chk files to see which tests this runs.
-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; \
-       $(ECHO) "  multifile ## Test multiple file arguments"
-       @(echo "inven" | advent isofoo.log /dev/stdin | diff --text -u multifile.chk -) || exit 1
-       rm -f scratch.tmp /tmp/regress$$$$
-
-# Steps towards TAP. savecheck and the isofoo test are not yet integrated.
-
-# 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)
-
-# Parallel make doesn't return a fail status when a single subprocess fails,
-# so we need to log the failures and check the log for nonemptiness in order
-# to hand a real status back. This is important for CI/CD.  
-FAILLOG=/tmp/advent-test.log
-
-TEST_TARGETS=$(TESTLOADS:%=run-regress-%)
-$(TEST_TARGETS): run-regress-%: %.log
+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") >>$(FAILLOG)
+       $(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)) >$(FAILLOG)
+       @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.
 
-tapcheck:
-       @make --no-print-directory tap; tapview <$(FAILLOG)
+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
 
 # end