Makefile

NAME := telescope
COMMIT_HOOK := .git/hooks/pre-commit
INSTALL_STAMP := .install.stamp
POETRY := $(shell command -v poetry 2> /dev/null)

CONFIG_FILE := $(shell echo $${CONFIG_FILE-config.toml})
VERSION_FILE := $(shell echo $${VERSION_FILE-version.json})
SOURCE := $(shell git config remote.origin.url | sed -e 's|git@|https://|g' | sed -e 's|github.com:|github.com/|g')
VERSION := $(shell git describe --always --tag)
COMMIT := $(shell git log --pretty=format:'%H' -n 1)

.PHONY: clean lint format tests check

install: $(INSTALL_STAMP) $(COMMIT_HOOK)
$(INSTALL_STAMP): pyproject.toml poetry.lock
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install --extras=remotesettings --extras=taskcluster
	touch $(INSTALL_STAMP)

$(COMMIT_HOOK):
	echo "make format" > $(COMMIT_HOOK)
	chmod +x $(COMMIT_HOOK)

clean:
	find . -type d -name "__pycache__" | xargs rm -rf {};
	rm -rf .install.stamp .coverage .mypy_cache $(VERSION_FILE)

lint: $(INSTALL_STAMP)
	$(POETRY) run isort --profile=black --lines-after-imports=2 --check-only checks tests $(NAME)
	$(POETRY) run black --check checks tests $(NAME) --diff
	$(POETRY) run flake8 --ignore=W503,E501 checks tests $(NAME)
	$(POETRY) run mypy checks tests $(NAME) --ignore-missing-imports
	$(POETRY) run bandit -r $(NAME) -s B608

format: $(INSTALL_STAMP)
	$(POETRY) run isort --profile=black --lines-after-imports=2 checks tests $(NAME)
	$(POETRY) run black checks tests $(NAME)

test: tests
tests: $(INSTALL_STAMP) $(VERSION_FILE)
	$(POETRY) run pytest tests --cov-report term-missing --cov-fail-under 100 --cov $(NAME) --cov checks

$(CONFIG_FILE):
	cp config.toml.sample $(CONFIG_FILE)

$(VERSION_FILE):
	echo '{"name":"$(NAME)","version":"$(VERSION)","source":"$(SOURCE)","commit":"$(COMMIT)"}' > $(VERSION_FILE)

serve: $(INSTALL_STAMP) $(VERSION_FILE) $(CONFIG_FILE)
	LOG_LEVEL=DEBUG LOG_FORMAT=text $(POETRY) run python -m $(NAME)

check: $(INSTALL_STAMP) $(CONFIG_FILE)
	LOG_LEVEL=DEBUG LOG_FORMAT=text $(POETRY) run python -m $(NAME) check $(project) $(check)