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