# The gates (gates/README.md), from the repository root. Their output root comes from the environment
# (FERROFIN_GATES_DIR). IMAGE, the Ferrofin image under test, defaults to the one gates/run names for the
# checked-out commit; PREVIOUS, the previous release's image, makes bench the release A/B gate (the latest
# release of the minor line before the release), and RELEASE names that release when the checkout is not
# its release/vX.Y.Z branch (a patch cut from main). All are taken from the command line only, never from the environment, where
# another tool may have set them:
#   make run-gates IMAGE=ferrofin:v1.4.0-rc PREVIOUS=ghcr.io/mangoleaf/ferrofin:v1.3.2
# There is deliberately no test, check or all target (they would read as the cargo workflow), and a bare
# `make` only lists the targets: a gates session is never started by habit.

.DEFAULT_GOAL := help
cli = $(if $(filter command line,$(origin $(1))),$($(1)))
GATES_RUN = $(strip gates/run $(if $(call cli,IMAGE),--image '$(IMAGE)') $(if $(call cli,PREVIOUS),--previous '$(PREVIOUS)') $(if $(call cli,RELEASE),--release '$(RELEASE)'))

.PHONY: help run-gates run-verify run-adoption run-parity run-bench test-gates-offline publish-results

help:
	@echo "make run-gates                 every gate against one image, as one session (gates/run all)"
	@echo "make run-verify|run-adoption|run-parity|run-bench   one gate, as a session"
	@echo "    IMAGE=<image>  the image under test; PREVIOUS=<image>  bench as the release A/B gate"
	@echo "    RELEASE=vX.Y.Z  the release that gate is for, when not on its release/vX.Y.Z branch (a patch cut from main)"
	@echo "make test-gates-offline        the gates' own tests: no docker, server or fixtures"
	@echo "make publish-results VERSION=vX.Y.Z SESSION=DIR BENCH=\"RUN RUN RUN\"   the release's summary, README Results and graphs"

run-gates:
	$(GATES_RUN) all

run-verify:
	$(GATES_RUN) verify

run-adoption:
	$(GATES_RUN) adoption

run-parity:
	$(GATES_RUN) parity

run-bench:
	$(GATES_RUN) bench

# A release's published results (gates/README.md, "Publishing the results"): docs/results/<VERSION>/summary.json
# from the local results named (the release's gates session, and three or more Jellyfin-comparison benchmark
# runs, and with AB=DIR the release A/B gate's session), then the README Results block and its graphs from every
# summary file. All are taken from the command line only.
publish-results:
	$(if $(call cli,VERSION),,$(error VERSION=vX.Y.Z is required))
	$(if $(call cli,SESSION),,$(error SESSION=DIR is required: the release's gates session, for its adoption and parity))
	$(if $(call cli,BENCH),,$(error BENCH="RUN RUN RUN" is required: three or more Jellyfin-comparison runs))
	python3 gates/publish.py summarise --version '$(VERSION)' --session '$(SESSION)' --bench $(BENCH) $(if $(call cli,AB),--ab '$(AB)') $(if $(call cli,MEASURED_BEFORE_TAG),--measured-before-tag)
	python3 gates/publish.py readme

# The gates' own tests, which need no docker, server or fixtures: shellcheck, the bats tests and the
# standard-library Python tests of every gate. CI's shell-tests job runs this target.
GATE_SCRIPTS = gates/lib.sh gates/run gates/verify/run.sh gates/verify/lib.sh gates/verify/scan-behaviour.sh gates/bench/run.sh \
	gates/adoption/lib.sh gates/adoption/run.sh gates/adoption/smoke.sh gates/adoption/build-fixtures.sh \
	gates/parity/lib.sh gates/parity/run.sh gates/parity/reset.sh gates/bench/testdata/build.sh
GATE_TESTS = gates/tests gates/verify/tests gates/adoption/tests gates/parity/tests

test-gates-offline:
	shellcheck -x $(GATE_SCRIPTS)
	shellcheck -x -s bash $(wildcard $(addsuffix /*.bats,$(GATE_TESTS)))
	bats $(GATE_TESTS)
	python3 -m unittest discover -s gates/tests
	python3 -m unittest discover -s gates/verify/tests
	python3 -m unittest discover -s gates/adoption/tests
	python3 -m unittest discover -s gates/parity/tests
	python3 -m unittest discover -s gates/bench -p 'test_*.py'