tests/Makefile

   1 # Test-suite makefile for open-adventure
   2
   3 # SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
   4 # SPDX-License-Identifier: BSD-2-Clause
   5
   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.
   9 PARDIR=$(realpath ..)
  10 PATH := $(PARDIR):$(realpath .):${PATH}
  11 GCOV?=gcov
  12
  13 # Make this overrideable so it's easier to test old versions
  14 advent?=advent
  15
  16 # Defeat annoying behavior under Mac OS X - builtin echo doesn't do -n
  17 ECHO := /bin/echo
  18
  19 # The TAP filter. Only affects presentation of the test suite messages
  20 TAPCONSUMER=tapview
  21
  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)
  26
  27 # Find all *.log entries to test
  28 TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
  29
  30 .PHONY: check clean testlist listcheck savegames savecheck coverage
  31 .PHONY: buildchecks multifile-regress tap count
  32
  33 check: savecheck
  34         @make tap | tapview
  35         @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
  36
  37 .SUFFIXES: .chk
  38
  39 clean:
  40         rm -fr *~ *.adv scratch.tmp *.ochk advent430 adventure.data
  41
  42 # Show summary lines for all tests.
  43 testlist:
  44         @grep '^##' *.log
  45 listcheck:
  46         @for f in *.log; do \
  47             if ( head -3 $$f | grep -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \
  48         done
  49
  50 # Generate bogus savegames.
  51 cheat_numdie.adv:
  52         @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
  53         @./outcheck.sh "cheat: Generate save file with -900 deaths"
  54 cheat_numdie1000.adv:
  55         @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
  56         @./outcheck.sh "cheat: Generate save file with -1000 deaths"
  57 cheat_savetamper.adv:
  58         @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
  59         @./outcheck.sh "cheat: Generate tamper-detection test"
  60 resume_badversion.adv:
  61         @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
  62         @./outcheck.sh "cheat: Generate save file with version -1337"
  63 thousand_saves.adv:
  64         @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
  65         @./outcheck.sh "cheat: Generate save file 1000 saves"
  66 thousand_turns.adv:
  67         @$(PARDIR)/cheat -t -1000 -o thousand_turns.adv > /tmp/cheat_1000turns
  68         @./outcheck.sh "cheat: Generate save file 1000 turns"
  69 thousand_limit.adv:
  70         @$(PARDIR)/cheat -l -1000 -o thousand_limit.adv > /tmp/cheat_1000limit
  71         @./outcheck.sh "cheat: Generate save file with game limot 1000"
  72 SGAMES = cheat_numdie.adv cheat_numdie1000.adv cheat_savetamper.adv resume_badversion.adv \
  73         thousand_saves.adv thousand_turns.adv thousand_limit.adv
  74
  75 # Force coverage of cheat edgecases
  76 scheck1:
  77         @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
  78         @./outcheck.sh "cheat: bogus option for save file generation"
  79 scheck2:
  80         @$(PARDIR)/cheat 2>/dev/null | true
  81         @./outcheck.sh "cheat: No save file specified"
  82 scheck3:
  83         @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
  84         @./outcheck.sh "cheat: doesn't save because we omit -o"
  85 scheck4:
  86         @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
  87         @./outcheck.sh "cheat: doesn't save to invalid path"
  88 scheck5:
  89         @$(advent) -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  90         @./outcheck.sh "cheat: doesn't start with invalid file with -r"
  91 scheck6:
  92         @$(advent) -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
  93         @./outcheck.sh "cheat: doesn't start with invalid file passed to -l"
  94 scheck7:
  95         @$(advent) -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  96         @./outcheck.sh "test -r with valid input"
  97 SCHECKS = scheck1 scheck2 scheck3 scheck4 scheck5 scheck6 scheck7
  98
  99 # Don't run this from here, you'll get cryptic warnings and no good result
 100 # if the advent binary wasn't built with coverage flags.  Do "make clean coverage"
 101 # from the top-level directory.
 102 coverage: check
 103         lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
 104         genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
 105         ./coverage_dungeon.py
 106
 107 # Rebuild characterizing tests
 108 buildchecks: savegames
 109         $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
 110         @for file in $(TESTLOADS); do \
 111             echo "Remaking $${file}.chk"; \
 112             OPTS=`sed -n /#options:/s///p <$${file}.log`; \
 113             advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
 114         done; \
 115         echo "inven" | advent issue36.log /dev/stdin >multifile.chk; \
 116         rm -f scratch.tmp
 117
 118 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
 119 $(RUN_TARGETS): run-regress-%: %.log
 120         @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
 121         OPTS=`sed -n /#options:/s///p $<`; \
 122         $(advent) $$OPTS <$< | tapdiffer "$${test}: $${legend}" "$${test}.chk")
 123
 124 multifile-regress:
 125         @(echo "inven" | advent issue36.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
 126
 127 TEST_TARGETS = $(SCHECKS) $(RUN_TARGETS) multifile-regress
 128
 129 tap: count $(SGAMES) $(TEST_TARGETS)
 130         @rm -f scratch.tmp /tmp/coverage* /tmp/cheat*
 131 count:
 132         @echo 1..$(words $(TEST_TARGETS))
 133
 134 foobar:
 135         exit 1
 136
 137
 138 # The following machinery tests the game against a binary made from
 139 # the advent430 branch To use it, switch to that branch, build the
 140 # binary, run it once to generate adventure.data, then switch back to
 141 # master leaving advent430 and adventure.data in place (make clean
 142 # does not remove them).
 143 #
 144 # make clean                 # Clean up object files, laving a bare source tree
 145 # git checkout advent430     # Check out the advent430 branch
 146 # make                       # Build the advent430 binary
 147 # advent430                  # Run it.  Answer the novice question and quit
 148 # make clean                 # Remove .o files
 149 # git checkout master        # Go back to master branch
 150 # make                       # Rebuild advent.
 151 #
 152 # The diff file produced has corrected spellings in it. That's what oldfilter
 153 # is for, to massage out the original spellings and avoid noise diffs.
 154 # Diffs in amount of whitespace and trailing whitespace are ignored
 155 #
 156 # A magic comment of NOCOMPARE in a log file excludes it from this comparison.
 157 # making it a skipped test in the TAP view. First use of this was to avoid a
 158 # spurious mismatch on the news text. Other uses avoid spurious mismatches due
 159 # to bug fixes.
 160 #
 161 # When adding more tests, bear in mind that any game that continues after a
 162 # resurrection will need a NOCOMPARE. At some point in the forward port,
 163 # resurrection was accidentally changed in a way that messed wil the LCG chain.
 164 #
 165 # The *.chk files need not be up-to-date for this to work.
 166 #
 167 TAPFILTER=tapview
 168 oldcompare:
 169         @if [ -f ../advent430 ]; then cp ../advent430 ../adventure.data .; else echo "advent430 nonexistent"; exit 1; fi
 170         @-(for x in *.log; do \
 171                 stem=$${x%.log}; \
 172                 legend=$$(sed -n '/^## /s///p' <$$x 2>/dev/null || echo "(no description)"); \
 173                 if grep NOCOMPARE $$x >/dev/null; \
 174                         then echo "not ok - $${stem}.ochk: $${legend} # SKIP"; \
 175                         else \
 176                                 ./advent430 <$${stem}.log | oldfilter >$${stem}.ochk; \
 177                                 ../advent <$${stem}.log >$${stem}.log-new; \
 178                                 ./newfilter <$${stem}.log-new | tapdiffer -b "$${stem}: $${legend}" $${stem}.ochk; \
 179                         fi; \
 180         done; \
 181         echo 1..$(words $(shell ls *.log))) | $(TAPFILTER)
 182         @rm *.ochk *-new advent430 adventure.data
 183
 184 # List all NOMPARE tests.
 185 residuals:
 186         @grep -n NOCOMPARE *.log
 187
 188 # end