Makefile

##
# This Makefile provides the main development interface for working with Otto,
# and helps organize the various tasks for preparation, compilation, and
# testing.
#
# Execute `make` to get help for the various targets
################################################################################

################################################################################
## Phony targets
.PHONY: apispecs clean clean-db diagram help steps release run
SQLITE_DB=otto.db

# Cute hack thanks to:
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
help: ## Display this help text
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

run: ## Convenience target for running services
	./scripts/shoreman

release: ## Build release binaries of everything
	cargo build --release
	# Strip all the executables for size, does impact debug symbols
	find target/release -type f -executable -exec strip {} \;

steps: release ## Package up all the stdlib steps as tarballs with osp
	for dir in $$(find stdlib -maxdepth 1 -type d | tail -n +2); do \
		echo ">> Packaging $$dir"; \
		./target/release/osp $$dir; \
	done;

apispecs: ## Run the OpenAPI-based specification tests, requires servers to be running already
	schemathesis run ./services/local-orchestrator/apispec.yml --base-url=http://localhost:7673 --checks all --hypothesis-suppress-health-check too_slow
	schemathesis run ./services/parser/apispec.yml --base-url=http://localhost:7672 --checks all --hypothesis-suppress-health-check too_slow

test: contrib/shunit2/shunit2 ## Run the acceptance tests for steps
	set -e
	@for t in $$(find $(PWD)/stdlib -iname "tests" -type d); do \
		echo ">> Running acceptance tests for $$t"; \
		for f in $$(find $$t -iname "*.sh" -type f); do \
			DIR="$(PWD)/tmp/test-run-$${RANDOM}"; \
			echo ">> Using $${DIR} for $$f"; \
			mkdir -p $$DIR; \
			(cd $$DIR && \
			PATH="$(PWD)/target/debug:$(PATH)" "$$f"); \
		done; \
	done;

migrate: $(SQLITE_DB) ## Run the local SQLite migrations
	sqlx migrate --source migrations/sqlite run

$(SQLITE_DB): ## Create an empty SQLite database
	sqlx database create

clean-db: ## Remove the SQLite database for local development
	rm -f $(SQLITE_DB)

clean: clean-db ## Clean all temporary/working files

diagram: system.png system.dot ## Generate the diagrams describing otto
	dot -Tpng -o system.png system.dot

################################################################################


################################################################################
contrib/shunit2/shunit2:
	git submodule update --init

################################################################################