1 # Test-suite makefile for opeb-adventure
3 # Use absolute path so tests that change working directory still use
4 # scripts from parent directory. Note that using $PWD seems to fail
5 # here under Gitlab's CI environment.
7 PATH := $(PARDIR):$(realpath .):${PATH}
10 # Make this overrideable so it's easier to test old versions
13 # Defeat annoying behavior under Mac OS X - builtin echo doesn't do -n
16 # The TAP filter. Only affects presentation of the test suite messages
19 # Fall back to safety if our declared TAP consumer does not exist.
20 # This is helpful in the CI environment, where it would be better for
21 # the logfiles to carry the raw TAP messages.
22 TAPFILTER=$(shell command -v $(TAPCONSUMER) || echo cat)
24 # Find all *.log entries to test
25 TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
27 .PHONY: check clean testlist listcheck savegames savecheck coverage
28 .PHONY: buildchecks multifile-regress tap count
32 @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
37 rm -fr *~ *.adv scratch.tmp *.ochk advent430 adventure.data
39 # Show summary lines for all tests.
44 if ( head -3 $$f | grep -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \
47 # Generate bogus savegames.
49 @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
50 @./outcheck.sh "cheat: Generate save file with -900 deaths"
52 @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
53 @./outcheck.sh "cheat: Generate save file with -1000 deaths"
55 @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
56 @./outcheck.sh "cheat: Generate tamper-detection test"
58 @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
59 @./outcheck.sh "cheat: Generate save file with version -1337"
61 @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
62 @./outcheck.sh "cheat: Generate save file 1000 saves"
64 @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
65 @./outcheck.sh "cheat: Generate save file 1000 turns"
67 @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
68 @./outcheck.sh "cheat: Generate save file 1000 turns"
69 SGAMES = sgame1 sgame2 sgame3 sgame4 sgame5 sgame6 sgame7
71 # Force coverage of cheat edgecases
73 @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
74 @./outcheck.sh "cheat: bogus option for save file generation"
76 @$(PARDIR)/cheat 2>/dev/null | true
77 @./outcheck.sh "cheat: No save file specified"
79 @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
80 @./outcheck.sh "cheat: doesn't save because we omit -o"
82 @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
83 @./outcheck.sh "cheat: doesn't save to invalid path"
85 @$(advent) -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
86 @./outcheck.sh "cheat: doesn't start with invalid file with -r"
88 @$(advent) -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
89 @./outcheck.sh "cheat: doesn't start with invalid file passed to -l"
91 @$(advent) -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
92 @./outcheck.sh "test -r with valid input"
93 SCHECKS = scheck1 scheck2 scheck3 scheck4 scheck5 scheck6 scheck7
95 # Don't run this from here, you'll get ctyptic warnings and no good result
96 # if the advent binary wasn't built with covrage flags. Do "make clean covetage"
97 # from the top-level directory.
99 lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
100 genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
101 ./coverage_dungeon.py
103 # Rebuild characterizing tests
104 buildchecks: savegames
105 $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
106 @for file in $(TESTLOADS); do \
107 echo "Remaking $${file}.chk"; \
108 OPTS=`sed -n /#options:/s///p <$${file}.log`; \
109 advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
111 echo "inven" | advent isofoo.log /dev/stdin >multifile.chk; \
114 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
115 $(RUN_TARGETS): run-regress-%: %.log
116 @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
117 OPTS=`sed -n /#options:/s///p $<`; \
118 $(advent) $$OPTS <$< | tapdiffer "$<: $${legend}" "$${test}.chk")
121 @(echo "inven" | advent isofoo.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
123 TEST_TARGETS = $(SGAMES) $(SCHECKS) $(RUN_TARGETS) multifile-regress
125 tap: count $(TEST_TARGETS)
126 @rm -f scratch.tmp /tmp/coverage* /tmp/cheat*
128 @echo 1..$(words $(TEST_TARGETS))
130 # The following machinery tests the game against a binary made from
131 # the advent430 branch To use it, switch to that branch, build the
132 # binary, run it once to generate adventure.data, then switch back to
133 # master leaving advent430 and adventure.data in place (make clean
134 # does not remove them).
136 # The diff file produced has corrected spellings in it. That's what oldfilter
137 # is for, to massage out the orioginal dpellings and avoid noise diffs.
138 # Diffs in amount of whitespace and trailing whitespace are ignored
140 # A magic comment of NOCOMPARE in a log file excludes it from this comparison.
141 # making it a skipped test in the TAP view. First use of this was to avoid a
142 # spurious mismatch on the news text. Other uses avoid spurios mismatches due
145 # When adding more tests, bear in mind that any game that continues after a
146 # resurrection will need a NOCOMPARE. At some point in the forward port,
147 # resurrection was accidentally changed in a way that messed wil the LCG chain.
151 @if [ -f ../advent430 ]; then cp ../advent430 ../adventure.data .; else echo "advent430 nonexistent"; exit 1; fi
152 @-(for x in *.log; do \
154 legend=$$(sed -n '/^## /s///p' <$$x 2>/dev/null || echo "(no description)"); \
155 if grep NOCOMPARE $$x >/dev/null; \
156 then echo "not ok - $${stem}.ochk: $${legend} # SKIP"; \
158 ./advent430 <$${stem}.log | oldfilter >$${stem}.ochk; \
159 ./newfilter <$${stem}.chk | tapdiffer -w "$${stem}: $${legend}" $${stem}.ochk; \
162 echo 1..$(words $(shell ls *.log))) | $(TAPFILTER)
163 @rm *.ochk advent430 adventure.data