Makefile

# SYSTEM DEPENENDENCIES #######################################################

.PHONY: bootstrap
bootstrap: ## Attempt to install system dependencies
	asdf plugin add python || asdf plugin update python
	asdf plugin add poetry || asdf plugin update poetry
	asdf install

.PHONY: doctor
doctor: ## System | Check for the required system dependencies
	bin/verchew --exit-code

.PHONY: .envrc
.envrc:
	echo "export PORT=8000" >> $@
	echo "export PYTHONBREAKPOINT=ipdb.set_trace" >> $@
	echo >> $@
	echo "export REDIS_URL=redis://localhost:6379" >> $@

# PROJECT DEPENDENCIES ########################################################

.PHONY: install
install: .venv/flag ## Project | Install project dependencies
.venv/flag: poetry.lock
	@ rm -rf ~/Library/Preferences/pypoetry
	@ poetry config virtualenvs.in-project true
	poetry install
	@ mkdir -p staticfiles
	@ touch $@

ifndef CI
poetry.lock: pyproject.toml
	poetry lock --no-update
	@ touch $@
endif

.PHONY: clean
clean:
	rm -rf .venv

# LOCAL COMMANDS ##############################################################

.PHONY: run
run: install migrate ## Project | Run the development server
	@ echo
	poetry run python manage.py runserver $(PORT)

.PHONY: shell
shell: install migrate  ## Project | Open the Django shell
	@ echo
	poetry run python manage.py shell_plus

# VALIDATION COMMANDS #########################################################

PACKAGES := config elections tests

.PHONY: all
all: check test ## CI | Run all validation targets

.PHONY: format
format: install ## CI | Format the code
	poetry run isort $(PACKAGES)
	poetry run black $(PACKAGES)

.PHONY: check
check: format ## CI | Run static analysis
	@ echo
ifdef CI
	git diff --exit-code
endif
	poetry run mypy $(PACKAGES)
	poetry run pylint $(PACKAGES) --rcfile=.pylint.ini

.PHONY: test
test: install ## CI | Run all tests
	poetry run pytest elections tests
	poetry run coveragespace update overall --exit-code
ifdef COVERALLS_REPO_TOKEN
	poetry run coveralls
endif

.PHONY: dev
dev: install
	@ rm -f .cache/v/cache/lastfailed
	poetry run ptw

.PHONY: notebook
notebook: install
	poetry run jupyter notebook --notebook-dir=notebooks --browser=safari

# DATA COMMANDS ###############################################################

.PHONY: migrations
migrations: install  ## Data | Generate database migrations
	poetry run python manage.py makemigrations

.PHONY: migrate
migrate: install ## Data | Run database migrations
ifndef DATABASE_URL
	poetry run python manage.py migrate
	@ echo
	poetry run python manage.py migrate_data
endif

.PHONY: data
data: migrate ## Data | Seed data for manual testing
	@ echo
	poetry run python manage.py seed_data
	@ echo
	poetry run python manage.py scrape_data --ballot-limit=3
	@ echo
	poetry run python manage.py parse_data

.PHONY: data/crawl
data/crawl: install ## Data | Run crawler to scrape and parse all ballots
	@ echo
	poetry run python manage.py scrape_data
	@ echo
	poetry run python manage.py parse_data

.PHONY: data/reset
data/reset: install ## Data | Create a new database, migrate, and seed it
	- dropdb elections_dev
	createdb elections_dev
	@ echo
	@ make data

.PHONY: data/production
data/production: install ## Data | Pull data as it exists on production
	- dropdb elections_dev
	heroku pg:pull DATABASE_URL elections_dev
	psql elections_dev -c 'TRUNCATE auth_user CASCADE'
	poetry run python manage.py seed_data

.PHONY: uml
uml: install
	poetry install --extras uml
	@ echo
	poetry run pyreverse elections -p elections -a 1 -f ALL -o png --ignore admin.py,migrations,management,tests
	mv -f classes_elections.png docs/classes.png
	mv -f packages_elections.png docs/packages.png
	poetry run python manage.py graph_models elections --output=docs/tables.png --exclude-models=TimeStampedModel

# DELIVERY TASKS ##############################################################

.PHONY: promote
promote: install
	@ echo
	SITE=https://staging.michiganelections.io poetry run pytest tests/test_deployment.py --verbose --no-cov
	@ echo
	heroku pipelines:promote --app mi-elections-staging --to mi-elections
	@ echo
	SITE=https://michiganelections.io poetry run pytest tests/test_deployment.py --verbose --no-cov

.PHONY: crawl
crawl:
	heroku run bin/crawl

# HELP ########################################################################

.PHONY: help
help: install
	@ grep -E '^[a-zA-Z/_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

.DEFAULT_GOAL := help