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 *~ adventure.text *.adv scratch.tmp
  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 savegames:
  51         @$(ECHO) "cheat: Generate save file with -900 deaths"
  52         @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
  53         @$(ECHO) "cheat: Generate save file with -1000 deaths"
  54         @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
  55         @$(ECHO) "cheat: Generate tamper-detection test"
  56         @$(PARDIR)/cheat -d 2000 -o cheat_savetamper.adv > /tmp/cheat_savetamper
  57         @$(ECHO) "cheat: Generate save file with version -1337"
  58         @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
  59         @$(ECHO) "cheat: Generate save file 1000 saves"
  60         @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
  61         @$(ECHO) "cheat: Generate save file 1000 turns"
  62         @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
  63         @$(ECHO) "cheat: Generate save file 1000 turns"
  64         @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
  65         @rm -f /tmp/cheat*
  66
  67 # Force coverage of cheat edgecases
  68 savecheck: savegames
  69         @$(ECHO) "TEST cheat: Bogus option for save file generation"
  70         @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
  71         @$(ECHO) "TEST cheat: No save file specified"
  72         @$(PARDIR)/cheat 2>/dev/null | true
  73         @$(ECHO) "TEST cheat: Fail to save because we omit -o"
  74         @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
  75         @$(ECHO) "TEST cheat: Fail to save to invalid path"
  76         @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
  77         @$(ECHO) "TEST advent: Start with invalid file with -r"
  78         @$(advent) -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  79         @$(ECHO) "TEST advent: Start with invalid file with -l"
  80         @$(advent) -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
  81         @$(ECHO) "TEST advent: Test -r with valid input"
  82         @$(advent) -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  83         @rm -f /tmp/coverage*
  84
  85 coverage: check
  86         lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
  87         genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
  88         ./coverage_dungeon.py
  89
  90 # Rebuild characterizing tests
  91 buildchecks: savegames
  92         $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
  93         @for file in $(TESTLOADS); do \
  94             echo "Remaking $${file}.chk"; \
  95             OPTS=`sed -n /#options:/s///p <$${file}.log`; \
  96             advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
  97         done; \
  98         echo "inven" | advent isofoo.log /dev/stdin >multifile.chk; \
  99         rm -f scratch.tmp
 100
 101 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
 102 $(RUN_TARGETS): run-regress-%: %.log
 103         @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
 104         OPTS=`sed -n /#options:/s///p $<`; \
 105         $(advent) $$OPTS <$< | tapdiffer "$<: $${legend}" "$${test}.chk")
 106
 107 multifile-regress:
 108         @(echo "inven" | advent isofoo.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
 109
 110 TEST_TARGETS = $(RUN_TARGETS) multifile-regress
 111
 112 tap: count $(TEST_TARGETS)
 113         rm -f scratch.tmp
 114 count:
 115         @echo 1..$(words $(TEST_TARGETS))
 116
 117 # end