Makefile

.PHONY: clean clean-test clean-pyc clean-build docs help lint checktypes checkstyle sast checklicenses test test-all coverage release
.DEFAULT_GOAL := help

define BROWSER_PYSCRIPT
import os, webbrowser, sys

from urllib.request import pathname2url

webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT

define PRINT_HELP_PYSCRIPT
import re, sys

for line in sys.stdin:
	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
	if match:
		target, help = match.groups()
		print("%-20s %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT

BROWSER := python -c "$$BROWSER_PYSCRIPT"

help:
	@poetry run python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

clean: clean-build clean-pyc clean-test clean-venv ## remove all build, test, coverage and Python artifacts

clean-build: ## remove build artifacts
	rm -fr build/
	rm -fr dist/
	rm -fr .eggs/
	find . -name '*.egg-info' -exec rm -fr {} +
	find . -name '*.egg' -exec rm -f {} +

clean-pyc: ## remove Python file artifacts
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -fr {} +

clean-test: ## remove test and coverage artifacts (including legacy .tox directory from older versions)
	rm -fr .tox/
	rm -f .coverage
	rm -fr htmlcov/
	rm -fr .pytest_cache

clean-venv:  ## remove .venv artifacts
	rm -fr .venv/

## run all static checks
lint: checktypes checkstyle sast checklicenses

checktypes: .venv ## check types with mypy
	poetry run mypy --ignore-missing-imports gsfpy tests

checkstyle: .venv ## check style with flake8 and black
	## Ignore flake8 F401, F403 and F405 errors as we want to be able to use star (*) imports
	## Ignore flake8 F811, 821 and W503 errors as enforcement changed between python 3.7 and 3.8
	poetry run flake8 --ignore F401,F403,F405,F811,F821,W503 gsfpy tests
	poetry run isort --check-only --profile black gsfpy tests
	poetry run black --check --diff gsfpy tests

fixstyle: .venv ## fix black and isort style violations
	poetry run isort --profile black gsfpy tests
	poetry run black gsfpy tests

sast: .venv ## run static application security testing
	poetry run bandit -r gsfpy

checklicenses: .venv requirements.txt ## check dependencies meet licence rules
	poetry run liccheck -s liccheck.ini

## run unit and component tests quickly with the default Python
test: .venv
	poetry run pytest --ignore-glob=tests/gsfpy3_08/* --ignore-glob=tests/gsfpy3_09/* --ignore-glob=tests/gsfpy/test_gsffile_with_*.py --verbose --capture=no
	poetry run pytest --ignore-glob=tests/gsfpy3_08/* --ignore-glob=tests/gsfpy3_09/* --ignore-glob=tests/gsfpy/test_gsffile.py --verbose --capture=no
	poetry run pytest tests/gsfpy3_08/test_libgsf_load_valid.py --verbose --capture=no
	poetry run pytest tests/gsfpy3_08/test_libgsf_load_invalid.py --verbose --capture=no
	poetry run pytest tests/gsfpy3_08/test_libgsf_load_default.py --verbose --capture=no
	poetry run pytest --ignore-glob=tests/gsfpy3_08/test_libgsf_load_*.py --ignore-glob=tests/gsfpy3_09/* --verbose --capture=no --cov=gsfpy3_08
	poetry run pytest tests/gsfpy3_09/test_libgsf_load_valid.py --verbose --capture=no
	poetry run pytest tests/gsfpy3_09/test_libgsf_load_invalid.py --verbose --capture=no
	poetry run pytest tests/gsfpy3_09/test_libgsf_load_default.py --verbose --capture=no
	poetry run pytest --ignore-glob=tests/gsfpy3_09/test_libgsf_load_*.py --ignore-glob=tests/gsfpy3_08/* --verbose --capture=no --cov=gsfpy3_09

## run all static checks and tests
test-all: .venv lint test

coverage: ## check code coverage quickly with the default Python
	poetry run coverage run --source gsfpy -m pytest
	poetry run coverage report -m
	poetry run coverage html
	poetry run $(BROWSER) htmlcov/index.html

release: dist ## package and upload a release
	poetry publish

dist: clean ## builds source and wheel package
	poetry build

requirements.txt: poetry.lock
	poetry export --format requirements.txt --output requirements.txt
	@touch requirements.txt # when there are no dependencies

.venv: poetry.lock
	poetry config virtualenvs.in-project true
	poetry install
	@touch -c .venv

poetry.lock:
	poetry lock -vvv
	@touch -c poetry.lock

## end Makefile