-
Notifications
You must be signed in to change notification settings - Fork 7
/
Makefile
201 lines (148 loc) · 5.07 KB
/
Makefile
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
# Project settings
PROJECT := jsonmask
PACKAGE := jsonmask
REPOSITORY := zapier/jsonmask
# Project paths
PACKAGES := $(PACKAGE) tests
CONFIG := $(wildcard *.py)
MODULES := $(wildcard $(PACKAGE)/*.py)
# Virtual environment paths
VIRTUAL_ENV ?= .venv
RUN := poetry run
# MAIN TASKS ##################################################################
SNIFFER := $(RUN) sniffer
.PHONY: all
all: install
.PHONY: ci
ci: check test ## Run all tasks that determine CI status
.PHONY: watch
watch: install .clean-test ## Continuously run all CI tasks when files chanage
$(SNIFFER)
.PHONY: run ## Start the program
run: install
$(RUN) python $(PACKAGE)/__main__.py
# SYSTEM DEPENDENCIES #########################################################
.PHONY: doctor
doctor: ## Confirm system dependencies are available
bin/verchew
# PROJECT DEPENDENCIES ########################################################
DEPENDENCIES := $(VIRTUAL_ENV)/.poetry-$(shell bin/checksum pyproject.*)
.PHONY: install
install: $(DEPENDENCIES)
$(DEPENDENCIES):
@ poetry config settings.virtualenvs.in-project true
poetry install
@ touch $@
# CHECKS ######################################################################
ISORT := $(RUN) isort
PYLINT := $(RUN) pylint
PYCODESTYLE := $(RUN) pycodestyle
PYDOCSTYLE := $(RUN) pydocstyle
.PHONY: check
check: isort pylint pycodestyle pydocstyle ## Run linters and static analysis
.PHONY: isort
isort: install
$(ISORT) $(PACKAGES) $(CONFIG) --recursive --apply
.PHONY: pylint
pylint: install
$(PYLINT) $(PACKAGES) $(CONFIG) --rcfile=.pylint.ini
.PHONY: pycodestyle
pycodestyle: install
$(PYCODESTYLE) $(PACKAGES) $(CONFIG) --config=.pycodestyle.ini
.PHONY: pydocstyle
pydocstyle: install
$(PYDOCSTYLE) $(PACKAGES) $(CONFIG)
# TESTS #######################################################################
PYTEST := $(RUN) pytest
COVERAGE := $(RUN) coverage
COVERAGESPACE := $(RUN) coveragespace
RANDOM_SEED ?= $(shell date +%s)
FAILURES := .cache/v/cache/lastfailed
PYTEST_OPTIONS := --random --random-seed=$(RANDOM_SEED)
ifdef DISABLE_COVERAGE
PYTEST_OPTIONS += --no-cov --disable-warnings
endif
PYTEST_RERUN_OPTIONS := --last-failed --exitfirst
.PHONY: test
test: test-all ## Run unit and integration tests
.PHONY: test-unit
test-unit: install
@ ( mv $(FAILURES) $(FAILURES).bak || true ) > /dev/null 2>&1
$(PYTEST) $(PACKAGE) $(PYTEST_OPTIONS)
@ ( mv $(FAILURES).bak $(FAILURES) || true ) > /dev/null 2>&1
$(COVERAGESPACE) $(REPOSITORY) unit
.PHONY: test-int
test-int: install
@ if test -e $(FAILURES); then $(PYTEST) tests $(PYTEST_RERUN_OPTIONS); fi
@ rm -rf $(FAILURES)
$(PYTEST) tests $(PYTEST_OPTIONS)
$(COVERAGESPACE) $(REPOSITORY) integration
.PHONY: test-all
test-all: install
@ if test -e $(FAILURES); then $(PYTEST) $(PACKAGES) $(PYTEST_RERUN_OPTIONS); fi
@ rm -rf $(FAILURES)
$(PYTEST) $(PACKAGES) $(PYTEST_OPTIONS)
$(COVERAGESPACE) $(REPOSITORY) overall
.PHONY: read-coverage
read-coverage:
bin/open htmlcov/index.html
# DOCUMENTATION ###############################################################
PYREVERSE := $(RUN) pyreverse
.PHONY: docs
docs: uml ## Generate documentation
.PHONY: uml
uml: install docs/*.png
docs/*.png: $(MODULES)
$(PYREVERSE) $(PACKAGE) -p $(PACKAGE) -a 1 -f ALL -o png --ignore tests
- mv -f classes_$(PACKAGE).png docs/classes.png
- mv -f packages_$(PACKAGE).png docs/packages.png
# BUILD #######################################################################
PYINSTALLER := $(RUN) pyinstaller
PYINSTALLER_MAKESPEC := $(RUN) pyi-makespec
DIST_FILES := dist/*.tar.gz dist/*.whl
EXE_FILES := dist/$(PROJECT).*
.PHONY: build
build: dist
.PHONY: dist
dist: install $(DIST_FILES)
$(DIST_FILES): $(MODULES)
rm -f $(DIST_FILES)
poetry build
.PHONY: exe
exe: install $(EXE_FILES)
$(EXE_FILES): $(MODULES) $(PROJECT).spec
# For framework/shared support: https://github.com/yyuu/pyenv/wiki
$(PYINSTALLER) $(PROJECT).spec --noconfirm --clean
$(PROJECT).spec:
$(PYINSTALLER_MAKESPEC) $(PACKAGE)/__main__.py --onefile --windowed --name=$(PROJECT)
# RELEASE #####################################################################
.PHONY: upload
upload: dist ## Upload the current version to PyPI
git diff --name-only --exit-code
poetry publish
bin/open https://pypi.org/project/$(PROJECT)
# CLEANUP #####################################################################
.PHONY: clean
clean: .clean-build .clean-docs .clean-test .clean-install ## Delete all generated and temporary files
.PHONY: clean-all
clean-all: clean
rm -rf $(VIRTUAL_ENV)
.PHONY: .clean-install
.clean-install:
find $(PACKAGES) -name '*.pyc' -delete
find $(PACKAGES) -name '__pycache__' -delete
rm -rf *.egg-info
.PHONY: .clean-test
.clean-test:
rm -rf .cache .pytest .coverage htmlcov xmlreport
.PHONY: .clean-docs
.clean-docs:
rm -rf *.rst docs/apidocs *.html docs/*.png site
.PHONY: .clean-build
.clean-build:
rm -rf *.spec dist build
# HELP ########################################################################
.PHONY: help
help: all
@ grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
.DEFAULT_GOAL := help