X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=tests%2FMakefile;h=919a701d5d573c8274d3033b28e72d5243cd6c3e;hb=c78845e05a2040d260fa63f891fbb52f8f3ce575;hp=fd802f60fc9301081b0ebf364ffcb4eeb6b175d6;hpb=894724d1c844f769a4a7a67047adf82bcbd8ad75;p=open-adventure.git diff --git a/tests/Makefile b/tests/Makefile index fd802f6..919a701 100644 --- a/tests/Makefile +++ b/tests/Makefile @@ -1,51 +1,151 @@ -# Test-suite makefile for reposurgeon +# Test-suite makefile for opeb-adventure -# By setting the REPOSURGEON environment variable and using -e -# a different implementation can be plugged in to the tests. - -# Use absolute path so tests that change working directory still use +# Use absolute path so tests that change working directory still use # scripts from parent directory. Note that using $PWD seems to fail # here under Gitlab's CI environment. -PATH := $(realpath ..):$(realpath .):${PATH} +PARDIR=$(realpath ..) +PATH := $(PARDIR):$(realpath .):${PATH} +GCOV?=gcov + +# Make this overrideable so it's easier to test old versions +advent?=advent # Defeat annoying behavior under Mac OS X - builtin echo doesn't do -n ECHO := /bin/echo -default: - make -e --quiet all +# Find all *.log entries to test +TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///' | sort) -all: listcheck regress +.PHONY: check coverage clean testlist listcheck savegames buildregress +.PHONY: savecheck regress + +check: savecheck regress @echo "=== No diff output is good news." + @-advent -x 2>/dev/null # Get usage message into coverage tests + @-advent -l /dev/null /dev/null + +coverage: check + lcov -t "advent" -o $(PARDIR)/advent.info -c -d $(PARDIR) --gcov-tool=$(GCOV) + genhtml -o $(PARDIR)/coverage/ $(PARDIR)/advent.info + ./coverage_dungeon.py .SUFFIXES: .chk clean: - rm -fr *~ + rm -fr *~ adventure.text *.adv scratch.tmp # Show summary lines for all tests. testlist: - @grep --text '^##' *.log + @grep '^##' *.log listcheck: @for f in *.log; do \ - if ( head -3 $$f | grep --text -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \ + if ( head -3 $$f | grep -q '^ *##' ); then :; else echo "$$f needs a description"; fi; \ done -# General regression testing of commands and output; look at the *.log and -# corresponding *.chk files to see which tests this runs. -TESTLOADS := $(shell ls -1 *.log | sed '/.log/s///') -buildregress: +# Generate bogus savegames. +savegames: + @$(ECHO) "cheat: Generate save file with -900 deaths" + @$(PARDIR)/cheat -d -900 -o cheat_numdie.adv > /tmp/cheat_numdie + @$(ECHO) "cheat: Generate save file with -1000 deaths" + @$(PARDIR)/cheat -d -1000 -o cheat_numdie1000.adv > /tmp/cheat_numdie1000 + @$(ECHO) "cheat: Generate save file with version -1337" + @$(PARDIR)/cheat -v -1337 -o resume_badversion.adv > /tmp/cheat_badversion + @$(ECHO) "cheat: Generate save file 1000 saves" + @$(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/cheat_1000saves + @$(ECHO) "cheat: Generate save file 1000 turns" + @$(PARDIR)/cheat -t -1000 -o thousand_saves.adv > /tmp/cheat_1000turns + @$(ECHO) "cheat: Generate save file 1000 turns" + @$(PARDIR)/cheat -l -1000 -o thousand_lamp.adv > /tmp/cheat_1000lamp + @rm -f /tmp/cheat* + + +# Rebuild characterizing tests +buildregress: savegames + $(PARDIR)/cheat -s -1000 -o thousand_saves.adv > /tmp/regress1000saves @for file in $(TESTLOADS); do \ echo "Remaking $${file}.chk"; \ - $(REPOSURGEON) advent <$${file}.log >$${file}.chk \ - 2>&1 || exit 1; \ - done + OPTS=`sed -n /#options:/s///p <$${file}.log`; \ + advent $$OPTS <$${file}.log >$${file}.chk 2>&1 || exit 1; \ + done; \ + echo "inven" | advent isofoo.log /dev/stdin >multifile.chk + rm -f scratch.tmp + +savecheck: savegames + @$(ECHO) "TEST cheat: Bogus option for save file generation" + @$(PARDIR)/cheat -QqQ 2> /tmp/coverage_cheat_batopt | true + @$(ECHO) "TEST cheat: No save file specified" + @$(PARDIR)/cheat 2>/dev/null | true + @$(ECHO) "TEST cheat: Fail to save because we omit -o" + @$(PARDIR)/cheat -d 1 2> /tmp/coverage_cheat_nooutput | true + @$(ECHO) "TEST cheat: Fail to save to invalid path" + @$(PARDIR)/cheat -o / 2> /tmp/coverage_cheat_badoutput | true + @$(ECHO) "TEST advent: Start with invalid file with -r" + @advent -r /badfilename < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1 + @$(ECHO) "TEST advent: Start with invalid file with -l" + @advent -l / < pitfall.log > /tmp/coverage_advent_logfail 2>&1 || exit 1 + @$(ECHO) "TEST advent: Test -r with valid input" + @advent -r thousand_saves.adv < pitfall.log > /tmp/coverage_advent_readfail 2>&1 || exit 1 + @rm -f /tmp/coverage* + +# General regression testing of commands and output; look at the *.log and +# corresponding *.chk files to see which tests this runs. regress: @for file in $(TESTLOADS); do \ - $(ECHO) -n " $${file} "; grep --text '##' $${file}.log || echo ' ## (no description)'; \ - if advent $${file}.log >/tmp/regress$$$$ 2>&1; \ + $(ECHO) -n " $${file} "; grep '##' $${file}.log || echo ' ## (no description)'; \ + OPTS=`sed -n /#options:/s///p <$${file}.log`; \ + if $(advent) $$OPTS < $${file}.log >/tmp/regress$$$$ 2>&1; \ then diff --text -u $${file}.chk /tmp/regress$$$$ || exit 1; \ else echo "*** Nonzero return status on $${file}!"; exit 1; fi \ - done - @rm -f /tmp/regress$$$$ + done; \ + $(ECHO) " multifile ## Test multiple file arguments" + @(echo "inven" | advent isofoo.log /dev/stdin | diff --text -u multifile.chk -) || exit 1 + rm -f scratch.tmp /tmp/regress$$$$ + +# Steps towards TAP and parallelization. +# There's a blocker in that the log tests can't be run concurrently +# due to issues with colliding save files. + +# See https://stackoverflow.com/questions/6481005/how-to-obtain-the-number-of-cpus-cores-in-linux-from-the-command-line +CONCURRENT_JOBS=$(shell getconf _NPROCESSORS_ONLN || getconf NPROCESSORS_ONLN || echo 4) + +# The TAP filter. Only affects presentation of the test suite messages +TAPCONSUMER=tapview + +# Fall back to safety if our declared TAP consumer does not exist. +# This is helpful in the CI environment, where it would be better for +# the logfiles to carry the raw TAP messages. +TAPFILTER=$(shell command -v $(TAPCONSUMER) || echo cat) + +# Run specified tests in parallel and ship their output to our TAP consumer after a plan header +TAPOUT = (echo "1..$(words $(1))"; $(MAKE) --output-sync --no-print-directory -j $(CONCURRENT_JOBS) $(1)) | $(TAPFILTER) + +# Parallel make doesn't return a fail status when a single subprocess fails, +# so we need to log the failures and check the log for nonemptiness in order +# to hand a real status back. This is important for CI/CD. +FAILLOG=/tmp/reposurgeon-make.log + +TEST_TARGETS=$(TESTLOADS:%=run-regress-%) +$(TEST_TARGETS): run-regress-%: %.log + @(test=$(<:.log=); legend=$$(sed -n '/^## /s///p' <"$<" 2>/dev/null || echo "(no description)"); \ + OPTS=`sed -n /#options:/s///p $<`; \ + $(advent) $$OPTS <$< | tapdiffer "$<: $${legend}" "$${test}.chk") >>$(FAILLOG); + +# parallel-tap must not be run in parallel. +parallel-check: + @$(MAKE) -j1 --no-print-directory parallel-tap + +# This is the normal way to run the tests interactively, +# using a TAP consumer. +parallel-tap: clean disclose + @rm -f $(FAILLOG) + @$(call TAPOUT,$(TEST_TARGETS)); if [ -s $(FAILLOG) ]; then ( echo "Tests failed:"; cat $(FAILLOG); exit 1); fi; + +disclose: + @echo "Running with $(CONCURRENT_JOBS) threads." + +tap: savecheck count $(TEST_TARGETS) + @echo "# Tests complete" +count: + @echo 1..$(words $(TEST_TARGETS)) # end