Real test coverage dor SAVE_TAMPERING.
[open-adventure.git] / tests / Makefile
index f3ee2d6dba1c5ade2d8ed153e568a67b1d5b3e63..e33e684b1c4fcd0d855e5a24de630fb1c054d6ab 100644 (file)
@@ -1,17 +1,37 @@
-# 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
+# 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
        @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
+       @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
+       @-advent -l /dev/null <pitfall.log >/dev/null
 
 .SUFFIXES: .chk
 
@@ -26,48 +46,72 @@ 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:
-       $(ECHO) "Generate save file with -1000 deaths: "
-       ../cheat -d -1000 -o cheat_numdie.adv
-       $(ECHO) "Generate save file with version -1337: "
-       ../cheat -v -1337 -o resume_badversion.adv
-       $(ECHO) "TEST cheat: Generate save file 1000 saves"
-       ../cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
+# Generate bogus savegames.
+savegames:
+       @$(ECHO) "cheat: Generate save file with -900 deaths"
+       @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
+       @$(ECHO) "cheat: Generate save file with -1000 deaths"
+       @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
+       @$(ECHO) "cheat: Generate tamper-detection test"
+       @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
+       @$(ECHO) "cheat: Generate save file with version -1337"
+       @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
+       @$(ECHO) "cheat: Generate save file 1000 saves"
+       @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
+       @$(ECHO) "cheat: Generate save file 1000 turns"
+       @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
+       @$(ECHO) "cheat: Generate save file 1000 turns"
+       @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
+       @rm -f /tmp/cheat*
+
+# Force coverage of cheat edgecases
+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*
+
+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:
-       $(ECHO) "TEST cheat: Generate save file with -1000 deaths"
-       ../cheat -d -1000 -o cheat_numdie.adv > /tmp/regressdumdie
-       $(ECHO) "TEST cheat: Generate save file with version -1337"
-       ../cheat -v -1337 -o resume_badversion.adv > /tmp/regressbadversion
-       $(ECHO) "TEST cheat: Generate save file 1000 saves"
-       ../cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
-       $(ECHO) "TEST cheat: Bogus option for save file generation"
-       ../cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
-       $(ECHO) "TEST cheat: Fail to save because we omit -o"
-       ../cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
-       $(ECHO) "TEST cheat: Fail to save to invalid path"
-       ../cheat -o / 2> /tmp/coverage_cheat_badoutput | true
-       $(ECHO) "TEST advent: Start with invalid file with -r"
-       advent -r /badfilename < quit.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
-       $(ECHO) "TEST advent: Start with invalid file with -r"
-       advent -l / < quit.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
-       $(ECHO) "TEST advent: Test -r with valid input"
-       advent -r thousand_saves.adv < quit.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
-       @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$$$$ /tmp/coverage*
+
+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 = $(RUN_TARGETS) multifile-regress
+
+tap: count $(TEST_TARGETS)
+       rm -f scratch.tmp
+count:
+       @echo 1..$(words $(TEST_TARGETS))
 
 # end