1 # Test-suite makefile for open-adventure
3 # SPDX-FileCopyrightText: Copyright Eric S. Raymond <esr@thyrsus.com>
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
54 @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
56 @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
57 resume_badversion.adv:
58 @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
60 @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
62 @$(PARDIR)/cheat -t -1000 -o thousand_turns.adv > /tmp/cheat_1000turns
64 @$(PARDIR)/cheat -l -1000 -o thousand_limit.adv > /tmp/cheat_1000limit
65 SGAMES = cheat_numdie.adv cheat_numdie1000.adv cheat_savetamper.adv resume_badversion.adv \
66 thousand_saves.adv thousand_turns.adv thousand_limit.adv
68 # Force coverage of cheat edgecases
70 @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
71 @./outcheck.sh "cheat: bogus option for save file generation"
73 @$(PARDIR)/cheat 2>/dev/null | true
74 @./outcheck.sh "cheat: No save file specified"
76 @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
77 @./outcheck.sh "cheat: doesn't save because we omit -o"
79 @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
80 @./outcheck.sh "cheat: doesn't save to invalid path"
82 @$(advent) -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
83 @./outcheck.sh "cheat: doesn't start with invalid file with -r"
85 @$(advent) -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
86 @./outcheck.sh "cheat: doesn't start with invalid file passed to -l"
88 @$(advent) -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
89 @./outcheck.sh "test -r with valid input"
90 SCHECKS = scheck1 scheck2 scheck3 scheck4 scheck5 scheck6 scheck7
92 # Don't run this from here, you'll get cryptic warnings and no good result
93 # if the advent binary wasn't built with coverage flags. Do "make clean coverage"
94 # from the top-level directory.
96 lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
97 genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
100 # Rebuild characterizing tests
101 buildchecks: savegames
102 $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
103 @for file in $(TESTLOADS); do \
104 echo "Remaking $${file}.chk"; \
105 OPTS=`sed -n /#options:/s///p <$${file}.log`; \
106 advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
108 echo "inven" | advent issue36.log /dev/stdin >multifile.chk; \
111 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
112 $(RUN_TARGETS): run-regress-%: %.log
113 @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
114 OPTS=`sed -n /#options:/s///p $<`; \
115 $(advent) $$OPTS <$< | tapdiffer "$${test}: $${legend}" "$${test}.chk")
118 @(echo "inven" | advent issue36.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
120 TEST_TARGETS = $(SCHECKS) $(RUN_TARGETS) multifile-regress
122 tap: count $(SGAMES) $(TEST_TARGETS)
123 @rm -f scratch.tmp /tmp/coverage* /tmp/cheat*
125 @echo 1..$(words $(TEST_TARGETS))
127 # The following machinery tests the game against a binary made from
128 # the advent430 branch To use it, switch to that branch, build the
129 # binary, run it once to generate adventure.data, then switch back to
130 # master leaving advent430 and adventure.data in place (make clean
131 # does not remove them).
133 # make clean # Clean up object files, laving a bare source tree
134 # git checkout advent430 # Check out the advent430 branch
135 # make # Build the advent430 binary
136 # advent430 # Run it. Answer the novice question and quit
137 # make clean # Remove .o files
138 # git checkout master # Go back to master branch
139 # make # Rebuild advent.
141 # The diff file produced has corrected spellings in it. That's what oldfilter
142 # is for, to massage out the original spellings and avoid noise diffs.
143 # Diffs in amount of whitespace and trailing whitespace are ignored
145 # A magic comment of NOCOMPARE in a log file excludes it from this comparison.
146 # making it a skipped test in the TAP view. First use of this was to avoid a
147 # spurious mismatch on the news text. Other uses avoid spurious mismatches due
150 # When adding more tests, bear in mind that any game that continues after a
151 # resurrection will need a NOCOMPARE. At some point in the forward port,
152 # resurrection was accidentally changed in a way that messed with the LCG chain.
154 # The *.chk files need not be up-to-date for this to work.
158 @if [ -f ../advent430 ]; then cp ../advent430 ../adventure.data .; else echo "advent430 nonexistent"; exit 1; fi
159 @-(for x in *.log; do \
161 legend=$$(sed -n '/^## /s///p' <$$x 2>/dev/null || echo "(no description)"); \
162 if grep NOCOMPARE $$x >/dev/null; \
163 then echo "not ok - $${stem}.ochk: $${legend} # SKIP"; \
165 ./advent430 <$${stem}.log | oldfilter >$${stem}.ochk; \
166 ../advent <$${stem}.log >$${stem}.log-new; \
167 ./newfilter <$${stem}.log-new | tapdiffer -b "$${stem}: $${legend}" $${stem}.ochk; \
170 echo 1..$(words $(shell ls *.log))) | $(TAPFILTER)
171 @rm *.ochk *-new advent430 adventure.data
173 # List all NOCOMPARE tests.
175 @grep -n NOCOMPARE *.log