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 # Find all *.log entries to test
  17 TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort)
  18
  19 .PHONY: check coverage clean testlist listcheck savegames buildregress
  20 .PHONY: savecheck regress tap count multifile-regress
  21
  22 check: savegames
  23         @make tap | $(TAPFILTER)
  24
  25 coverage: check
  26         lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV)
  27         genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info
  28         @-advent -x 2>/dev/null # Get usage message into coverage tests
  29         @-advent -l /dev/null <pitfall.log >/dev/null
  30         make savecheck
  31         ./coverage_dungeon.py
  32
  33 .SUFFIXES: .chk
  34
  35 clean:
  36         rm -fr *~ adventure.text *.adv scratch.tmp
  37
  38 # Show summary lines for all tests.
  39 testlist:
  40         @grep '^##' *.log
  41 listcheck:
  42         @for f in *.log; do \
  43             if ( head -3 $$f | grep -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \
  44         done
  45
  46 # Rebuild characterizing tests
  47 buildregress: savegames
  48         $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves
  49         @for file in $(TESTLOADS); do \
  50             echo "Remaking $${file}.chk"; \
  51             OPTS=`sed -n /#options:/s///p <$${file}.log`; \
  52             advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \
  53         done; \
  54         echo "inven" | advent isofoo.log /dev/stdin >multifile.chk
  55         rm -f scratch.tmp
  56
  57 # Generate bogus savegames for coverage testing.  Needed for one test log as well
  58 savegames:
  59         @# Generate save file with -900 deaths
  60         @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie
  61         @# Generate save file with -1000 deaths
  62         @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000
  63         @# cheat: Generate save file with version -1337
  64         @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion
  65         @# cheat: Generate save file 1000 saves
  66         @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves
  67         @# Generate save file 1000 turns
  68         @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns
  69         @# cheat: Generate save file 1000 turns
  70         @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp
  71         @rm -f /tmp/cheat*
  72
  73 # Force coverage of various edge cases
  74 savecheck: savegames
  75         @$(ECHO) "TEST cheat: Bogus option for save file generation"
  76         @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true
  77         @$(ECHO) "TEST cheat: No save file specified"
  78         @$(PARDIR)/cheat 2>/dev/null | true
  79         @$(ECHO) "TEST cheat: Fail to save because we omit -o"
  80         @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true
  81         @$(ECHO) "TEST cheat: Fail to save to invalid path"
  82         @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true
  83         @$(ECHO) "TEST advent: Start with invalid file with -r"
  84         @advent -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  85         @$(ECHO) "TEST advent: Start with invalid file with -l"
  86         @advent -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1
  87         @$(ECHO) "TEST advent: Test -r with valid input"
  88         @advent -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1
  89         @rm -f /tmp/coverage*
  90
  91 # The TAP filter. Only affects presentation of the test suite messages
  92 TAPCONSUMER=tapview
  93
  94 # Fall back to safety if our declared TAP consumer does not exist.
  95 # This is helpful in the CI environment, where it would be better for
  96 # the logfiles to carry the raw TAP messages.
  97 TAPFILTER=$(shell command -v $(TAPCONSUMER) || echo cat)
  98
  99 RUN_TARGETS=$(TESTLOADS:%=run-regress-%)
 100 $(RUN_TARGETS): run-regress-%: %.log
 101         @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \
 102         OPTS=`sed -n /#options:/s///p $<`; \
 103         $(advent) $$OPTS <$< | tapdiffer "$<: $${legend}" "$${test}.chk")
 104
 105 multifile-regress:
 106         @(echo "inven" | advent isofoo.log /dev/stdin) | tapdiffer "multifile: multiple-file test" multifile.chk
 107
 108 TEST_TARGETS = $(RUN_TARGETS) multifile-regress
 109
 110 tap: count $(TEST_TARGETS)
 111 count:
 112         @echo 1..$(words $(TEST_TARGETS))
 113
 114 # end