public-api/Makefile at develop · RusticPotatoes/public-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
.PHONY: clean clean-test clean-pyc clean-build build help
.DEFAULT_GOAL := help

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

help:
	@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

clean-pyc: ## clean python cache files
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -fr {} +
	find . -name '.pytest_cache' -exec rm -fr {} +

clean-test: ## cleanup pytests leftovers
	rm -f .coverage
	rm -fr htmlcov/
	rm -fr test_results/
	rm -f *report.html
	rm -f log.html
	rm -f test-results.html
	rm -f output.xml

docker-clean:
	@read -p "Are you sure you want to prune all Docker data (y/n)? " -n 1 -r; \
	echo; \
	if [[ $$REPLY =~ ^[Yy]$$ ]]; then \
		docker system prune -a -f; \
	fi

test: clean-test ## Run pytest unit tests
	python3 -m pytest --verbosity=1 -s

test-report:
	python3 -m pytest --junit-xml=pytest_report.xml

test-debug: ## Run unit tests with debugging enabled
	python3 -m pytest --pdb

test-coverage: clean-test ## Run unit tests and check code coverage
	PYTHONPATH=src python3 -m pytest --cov=src tests/ --disable-warnings

docker-up: ## Startup docker
	docker-compose --verbose up

docker-build: ## Startup docker with build switch
	docker-compose --verbose up --build

docker-build-detached: ## Startup docker with build switch
	docker-compose up --build -d

docker-restart:
	docker compose down
	docker compose up --build -d

docker-test: docker-restart
	pytest -s

setup: test-setup requirements## setup requirements

setup-detached: test-setup docker-build-detached ## setup & run after downloaded repo detached

pre-commit-setup: ## Install pre-commit
	python3 -m pip install pre-commit
	pre-commit --version

test-setup: pre-commit-setup## installs pytest singular package for local testing
	python3 -m pip install pytest
	python3 -m pip install requests
	python3 -m pip install hypothesis

requirements: ## installs all requirements
	python3 -m pip install -r requirements.txt

docker-down: ## shutdown docker
	docker-compose down

docker-rebuild: docker-down ## shuts down docker then brings it up and rebuilds
	docker-compose --verbose up --build

docker-force-rebuild: docker-down ## shuts down docker than brings it up and force rebuilds
	docker-compose --verbose up --build --force-recreate

docs: # opens your browser to the webapps testing docs
	open http://localhost:5000/docs
	xdg-open http://localhost:5000/docs
	. http://localhost:5000/docs

venv-create: ## creates a venv in the folder .venv
	python3 -m venv .venv

venv-remove: ## removes the .venv folder
	rm -rf .venv

test-loud: ## runs pytest with verbose output
	python3 -m pytest --verbose -s

pre-commit:
	pre-commit run --all-files