tests/Makefile

   1 # Test-suite makefile for opeb-adventure
   2
   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.
   6 PARDIR=$(realpath ..)
   7 PATH := $(PARDIR):$(realpath .):${PATH}
   8 GCOV?=gcov
   9
  10 # Make this overrideable so it's easier to test old versions
  11 advent?=advent
  12
  13 # Defeat annoying behavior under Mac OS X - builtin echo doesn't do -n
  14 ECHO := /bin/echo
  15
  16 # The TAP filter. Only affects presentation of the test suite messages
  17 TAPCONSUMER=tapview
  18
  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)
  23
  24 # Find all *.log entries to test
  25 TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
  26
  27 .PHONY: check clean testlist listcheck savegames savecheck coverage
  28 .PHONY: buildchecks multifile-regress tap count
  29
  30 check: savecheck
  31         @make tap | tapview
  32         @echo "=== No diff output is good news."
  33         @-advent -x 2>/dev/null || exit 0 # Get usage message into coverage tests
  34         @-advent -l /dev/null <pitfall.log >/dev/null
  35
  36 .SUFFIXES: .chk
  37
  38 clean:
  39         rm -fr *~ *.adv scratch.tmp *.ochk
  40
  41 # Show summary lines for all tests.
  42 testlist:
  43         @grep '^##' *.log
  44 listcheck:
  45         @for f in *.log; do \
  46             if ( head -3 $$f | grep -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \
  47         done
  48
  49 # Generate bogus savegames.
  50 sgame1:
  51         @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
  52         @./outcheck.sh "cheat: Generate save file with -900 deaths"
  53 sgame2:
  54         @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
  55         @./outcheck.sh "cheat: Generate save file with -1000 deaths"
  56 sgame3:
  57         @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
  58         @./outcheck.sh "cheat: Generate tamper-detection test"
  59 sgame4:
  60         @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
  61         @./outcheck.sh "cheat: Generate save file with version -1337"
  62 sgame5:
  63         @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
  64         @./outcheck.sh "cheat: Generate save file 1000 saves"
  65 sgame6:
  66         @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
  67         @./outcheck.sh "cheat: Generate save file 1000 turns"
  68 sgame7:
  69         @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
  70         @./outcheck.sh "cheat: Generate save file 1000 turns"
  71 SGAMES = sgame1 sgame2 sgame3 sgame4 sgame5 sgame6 sgame7
  72
  73 # Force coverage of cheat edgecases
  74 scheck1:
  75         @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
  76         @./outcheck.sh "cheat: bogus option for save file generation"
  77 scheck2:
  78         @$(PARDIR)/cheat 2>/dev/null | true
  79         @./outcheck.sh "cheat: No save file specified"
  80 scheck3:
  81         @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
  82         @./outcheck.sh "cheat: doesn't save because we omit -o"
  83 scheck4:
  84         @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
  85         @./outcheck.sh "cheat: doesn't save to invalid path"
  86 scheck5:
  87         @$(advent) -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  88         @./outcheck.sh "cheat: doesn't start with invalid file with -r"
  89 scheck6:
  90         @$(advent) -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
  91         @./outcheck.sh "cheat: doesn't start with invalid file passed to -l"
  92 scheck7:
  93         @$(advent) -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  94         @./outcheck.sh "test -r with valid input"
  95 SCHECKS = scheck1 scheck2 scheck3 scheck4 scheck5 scheck6 scheck7
  96
  97 coverage: check
  98         lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
  99         genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
 100         ./coverage_dungeon.py
 101
 102 # Rebuild characterizing tests
 103 buildchecks: savegames
 104         $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
 105         @for file in $(TESTLOADS); do \
 106             echo "Remaking $${file}.chk"; \
 107             OPTS=`sed -n /#options:/s///p <$${file}.log`; \
 108             advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
 109         done; \
 110         echo "inven" | advent isofoo.log /dev/stdin >multifile.chk; \
 111         rm -f scratch.tmp
 112
 113 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
 114 $(RUN_TARGETS): run-regress-%: %.log
 115         @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
 116         OPTS=`sed -n /#options:/s///p $<`; \
 117         $(advent) $$OPTS <$< | tapdiffer "$<: $${legend}" "$${test}.chk")
 118
 119 multifile-regress:
 120         @(echo "inven" | advent isofoo.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
 121
 122 TEST_TARGETS = $(SGAMES) $(SCHECKS) $(RUN_TARGETS) multifile-regress
 123
 124 tap: count $(TEST_TARGETS)
 125         @rm -f scratch.tmp /tmp/coverage* /tmp/cheat*
 126 count:
 127         @echo 1..$(words $(TEST_TARGETS))
 128
 129 # The following machinery tests the gane against a binary made from the advent430 branch
 130 # The diff file produced has new spellings in it.
 131
 132 ancient:
 133         for x in *.log; do stem=$${x%.log}; echo $${stem}; ./advent430 <$${stem}.log | ./oldfilter >$${stem}.ochk; done
 134         for x in *.log; do stem=$${x%.log}; diff -u $${stem}.chk $${stem}.log; done
 135         rm *.ochk
 136
 137 # end