-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathMakefile
More file actions
239 lines (204 loc) · 7.24 KB
/
Makefile
File metadata and controls
239 lines (204 loc) · 7.24 KB
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# Supported Python versions
PYTHON_VERSIONS = 3.10 3.11 3.12 3.13
DEFAULT_PYTHON = 3.10
# Install dependencies
.PHONY: install
install:
@uv sync
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Install dev dependencies
.PHONY: install-dev
install-dev:
@uv sync --extra dev
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Update dependencies
.PHONY: lock
lock:
@uv lock
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Upgrade dependencies
.PHONY: upgrade
upgrade:
@uv lock --upgrade
@uv sync --all-extras
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Start example-app
.PHONY: start-example
start-example:
@COMPOSE_BAKE=true PYTHON_VERSION=$(DEFAULT_PYTHON) docker compose up --build flaskapi-guard-example
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
.PHONY: run-example
run-example:
@COMPOSE_BAKE=true docker compose build flaskapi-guard-example
@docker compose up flaskapi-guard-example
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Stop
.PHONY: stop
stop:
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Restart
.PHONY: restart
restart: stop start-example
# Lint code
.PHONY: lint
lint:
@COMPOSE_BAKE=true docker compose run --rm --no-deps flaskapi-guard sh -c "echo 'Formatting w/ Ruff...' ; echo '' ; ruff format . ; echo '' ; echo '' ; echo 'Linting w/ Ruff...' ; echo '' ; ruff check . ; echo '' ; echo '' ; echo 'Type checking w/ Mypy...' ; echo '' ; mypy . ; echo '' ; echo '' ; echo 'Finding dead code w/ Vulture...' ; echo '' ; vulture"
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Fix code
.PHONY: fix
fix:
@echo "Fixing formatting w/ Ruff..."
@echo ''
@uv run ruff check --fix .
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Local test
.PHONY: local-test
local-test:
@REDIS_URL=$${REDIS_URL:-redis://localhost:6379} \
uv run pytest -v --cov=flaskapi_guard --cov-report=term-missing
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Find dead code with Vulture
.PHONY: vulture
vulture:
@echo "Finding dead code with Vulture..."
@echo ''
@uv run vulture vulture_whitelist.py
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Security scan with Bandit
.PHONY: bandit
bandit:
@echo "Running Bandit security scan..."
@echo ''
@uv run bandit -r flaskapi_guard -ll
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Check dependencies with Safety
.PHONY: safety
safety:
@echo "Checking dependencies with Safety..."
@echo ''
@uv run safety scan
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Audit dependencies with pip-audit
.PHONY: pip-audit
pip-audit:
@echo "Auditing dependencies with pip-audit..."
@echo ''
@uv run pip-audit
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Analyze code complexity with Radon
.PHONY: radon
radon:
@echo "Analyzing code complexity with Radon..."
@echo ''
@echo "Cyclomatic Complexity:"
@uv run radon cc flaskapi_guard -nc
@echo ''
@echo "Maintainability Index:"
@uv run radon mi flaskapi_guard -nc
@echo ''
@echo "Raw Metrics:"
@uv run radon raw flaskapi_guard
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Check complexity thresholds with Xenon
.PHONY: xenon
xenon:
@echo "Checking complexity thresholds with Xenon..."
@echo ''
@uv run xenon flaskapi_guard --max-absolute B --max-modules A --max-average A
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Analyze dependencies with Deptry
.PHONY: deptry
deptry:
@echo "Analyzing dependencies with Deptry..."
@echo ''
@uv run deptry .
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Run all security checks
.PHONY: security
security: bandit safety pip-audit
@echo "All security checks completed."
# Run all code quality checks
.PHONY: quality
quality: lint vulture radon xenon
@echo "All code quality checks completed."
# Run all analysis tools
.PHONY: analysis
analysis: deptry
@echo "All analysis tools completed."
# Run all checks (linting, security, quality, and analysis)
.PHONY: check-all
check-all: lint security quality analysis
@echo "All checks completed."
# Run tests (default Python version)
.PHONY: test
test:
@COMPOSE_BAKE=true PYTHON_VERSION=$(DEFAULT_PYTHON) docker compose run --rm --build flaskapi-guard pytest -v --cov=.
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Run All Python versions
.PHONY: test-all
test-all: test-3.10 test-3.11 test-3.12 test-3.13
# Python 3.10
.PHONY: test-3.10
test-3.10:
@docker compose down -v flaskapi-guard
@COMPOSE_BAKE=true PYTHON_VERSION=3.10 docker compose build flaskapi-guard
@PYTHON_VERSION=3.10 docker compose run --rm flaskapi-guard pytest -v --cov=.
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Python 3.11
.PHONY: test-3.11
test-3.11:
@docker compose down -v flaskapi-guard
@COMPOSE_BAKE=true PYTHON_VERSION=3.11 docker compose build flaskapi-guard
@PYTHON_VERSION=3.11 docker compose run --rm flaskapi-guard pytest -v --cov=.
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Python 3.12
.PHONY: test-3.12
test-3.12:
@docker compose down -v flaskapi-guard
@COMPOSE_BAKE=true PYTHON_VERSION=3.12 docker compose build flaskapi-guard
@PYTHON_VERSION=3.12 docker compose run --rm flaskapi-guard pytest -v --cov=.
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Python 3.13
.PHONY: test-3.13
test-3.13:
@docker compose down -v flaskapi-guard
@COMPOSE_BAKE=true PYTHON_VERSION=3.13 docker compose build flaskapi-guard
@PYTHON_VERSION=3.13 docker compose run --rm flaskapi-guard pytest -v --cov=.
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Serve docs
.PHONY: serve-docs
serve-docs:
@uv run mkdocs serve
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Prune
.PHONY: prune
prune:
@docker system prune -f
# Clean Cache Files
.PHONY: clean
clean:
@find . | grep -E "(__pycache__|\\.pyc|\\.pyo|\\.pytest_cache|\\.ruff_cache|\\.mypy_cache)" | xargs rm -rf
# Version Management
.PHONY: bump-version
bump-version:
@if [ -z "$(VERSION)" ]; then echo "Usage: make bump-version VERSION=x.y.z"; exit 1; fi
@uv run python .github/scripts/bump_version.py $(VERSION)
# Help
.PHONY: help
help: ## Show available commands
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
.DEFAULT_GOAL := help
# Python versions list
.PHONY: show-python-versions
show-python-versions:
@echo "Supported Python versions: $(PYTHON_VERSIONS)"
@echo "Default Python version: $(DEFAULT_PYTHON)"