-
Notifications
You must be signed in to change notification settings - Fork 25
/
Makefile
408 lines (349 loc) · 14 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
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# ------------------------------------------------------------------------------
# Makefile for zhmcclient project
#
# Basic prerequisites for running this Makefile, to be provided manually:
# One of these OS platforms:
# Windows with CygWin
# Linux (any)
# OS-X
# These commands on all OS platforms:
# make (GNU make)
# bash
# rm, mv, find, tee, which
# These commands on all OS platforms in the active Python environment:
# python (or python3 on OS-X)
# twine
# These commands on Linux and OS-X:
# uname
# Environment variables:
# PYTHON_CMD: Python command to use (OS-X needs to distinguish Python 2/3)
# PIP_CMD: Pip command to use (OS-X needs to distinguish Python 2/3)
# PACKAGE_LEVEL: minimum/latest - Level of Python dependent packages to use
# Additional prerequisites for running this Makefile are installed by running:
# make develop
# ------------------------------------------------------------------------------
# Python / Pip commands
ifndef PYTHON_CMD
PYTHON_CMD := python
endif
ifndef PIP_CMD
PIP_CMD := pip
endif
# Package level
ifndef PACKAGE_LEVEL
PACKAGE_LEVEL := latest
endif
ifeq ($(PACKAGE_LEVEL),minimum)
pip_level_opts := -c minimum-constraints.txt
pip_level_opts_new :=
else
ifeq ($(PACKAGE_LEVEL),latest)
pip_level_opts := --upgrade
pip_level_opts_new := --upgrade-strategy eager
else
$(error Error: Invalid value for PACKAGE_LEVEL variable: $(PACKAGE_LEVEL))
endif
endif
# Determine OS platform make runs on
ifeq ($(OS),Windows_NT)
PLATFORM := Windows
else
# Values: Linux, Darwin
PLATFORM := $(shell uname -s)
endif
# Name of this Python package (top-level Python namespace + Pypi package name)
package_name := zhmcclient
mock_package_name := zhmcclient_mock
# Package version (full version, including any pre-release suffixes, e.g. "0.1.0-alpha1")
# May end up being empty, if pbr cannot determine the version.
package_version := $(shell $(PYTHON_CMD) -c "$$(printf 'try:\n from pbr.version import VersionInfo\nexcept ImportError:\n pass\nelse:\n print(VersionInfo(\042$(package_name)\042).release_string())\n')")
# Python major version
python_major_version := $(shell $(PYTHON_CMD) -c "import sys; sys.stdout.write('%s'%sys.version_info[0])")
# Python major+minor version for use in file names
python_version_fn := $(shell $(PYTHON_CMD) -c "import sys; sys.stdout.write('%s%s'%(sys.version_info[0],sys.version_info[1]))")
# Directory for the generated distribution files
dist_dir := dist
# Distribution archives (as built by setup.py)
bdist_file := $(dist_dir)/$(package_name)-$(package_version)-py2.py3-none-any.whl
sdist_file := $(dist_dir)/$(package_name)-$(package_version).tar.gz
# Windows installable (as built by setup.py)
win64_dist_file := $(dist_dir)/$(package_name)-$(package_version).win-amd64.exe
# dist_files := $(bdist_file) $(sdist_file) $(win64_dist_file)
dist_files := $(bdist_file) $(sdist_file)
# Source files in the packages
package_py_files := \
$(wildcard $(package_name)/*.py) \
$(wildcard $(package_name)/*/*.py) \
$(wildcard $(mock_package_name)/*.py) \
$(wildcard $(mock_package_name)/*/*.py) \
# Directory for generated API documentation
doc_build_dir := build_doc
# Directory where Sphinx conf.py is located
doc_conf_dir := docs
# Documentation generator command
doc_cmd := sphinx-build
doc_opts := -v -d $(doc_build_dir)/doctrees -c $(doc_conf_dir) .
# Dependents for Sphinx documentation build
doc_dependent_files := \
$(doc_conf_dir)/conf.py \
$(wildcard $(doc_conf_dir)/*.rst) \
$(wildcard $(doc_conf_dir)/notebooks/*.ipynb) \
$(package_py_files) \
# Directory with test source files
test_dir := tests
# Test log
test_unit_log_file := test_unit_$(python_version_fn).log
test_end2end_log_file := test_end2end_$(python_version_fn).log
# Source files with test code
test_unit_py_files := \
$(wildcard $(test_dir)/unit/*.py) \
$(wildcard $(test_dir)/unit/*/*.py) \
$(wildcard $(test_dir)/unit/*/*/*.py) \
test_end2end_py_files := \
$(wildcard $(test_dir)/end2end/*.py) \
$(wildcard $(test_dir)/end2end/*/*.py) \
$(wildcard $(test_dir)/end2end/*/*/*.py) \
test_common_py_files := \
$(wildcard $(test_dir)/common/*.py) \
$(wildcard $(test_dir)/common/*/*.py) \
$(wildcard $(test_dir)/common/*/*/*.py) \
# Determine whether py.test has the --no-print-logs option.
pytest_no_log_opt := $(shell py.test --help 2>/dev/null |grep '\--no-print-logs' >/dev/null; if [ $$? -eq 0 ]; then echo '--no-print-logs'; else echo ''; fi)
# Flake8 config file
flake8_rc_file := setup.cfg
# PyLint config file
pylint_rc_file := .pylintrc
# Source files for check (with PyLint and Flake8)
check_py_files := \
setup.py \
$(package_py_files) \
$(test_unit_py_files) \
$(test_end2end_py_files) \
$(test_common_py_files) \
$(doc_conf_dir)/conf.py \
$(wildcard docs/notebooks/*.py) \
$(wildcard tools/cpcinfo) \
$(wildcard tools/cpcdata) \
ifdef TESTCASES
pytest_opts := -k $(TESTCASES)
else
pytest_opts :=
endif
# Files to be built
ifeq ($(PLATFORM),Windows)
build_files := $(win64_dist_file)
else
build_files := $(bdist_file) $(sdist_file)
endif
# Files the distribution archive depends upon.
dist_dependent_files := \
setup.py setup.cfg \
README.rst \
requirements.txt \
$(wildcard *.py) \
$(package_py_files) \
# No built-in rules needed:
.SUFFIXES:
.PHONY: help
help:
@echo 'Makefile for $(package_name) project'
@echo 'Package version will be: $(package_version)'
@echo 'Uses the currently active Python environment: Python $(python_version_fn)'
@echo 'Valid targets are (they do just what is stated, i.e. no automatic prereq targets):'
@echo ' install - Install package in active Python environment'
@echo ' develop - Prepare the development environment by installing prerequisites'
@echo ' check - Run Flake8 on sources and save results in: flake8.log'
@echo ' pylint - Run PyLint on sources and save results in: pylint.log'
@echo ' test - Run unit tests (and test coverage) and save results in: $(test_unit_log_file)'
@echo ' Does not include install but depends on it, so make sure install is current.'
@echo ' Env.var TESTCASES can be used to specify a py.test expression for its -k option'
@echo ' end2end - Run end2end tests and save results in: $(test_end2end_log_file)'
@echo ' Env.var TESTCPC can be used to specify the name of a real CPC (default: mocked CPC)'
@echo ' Env.var TESTCASES can be used to specify a py.test expression for its -k option'
@echo ' build - Build the distribution files in: $(dist_dir)'
@echo ' On Windows, builds: $(win64_dist_file)'
@echo ' On Linux + OSX, builds: $(bdist_file) $(sdist_file)'
@echo ' builddoc - Build documentation in: $(doc_build_dir)'
@echo ' all - Do all of the above'
@echo ' uninstall - Uninstall package from active Python environment'
@echo ' upload - Upload the distribution files to PyPI (includes uninstall+build)'
@echo ' clean - Remove any temporary files'
@echo ' clobber - Remove any build products (includes uninstall+clean)'
@echo ' pyshow - Show location and version of the python and pip commands'
@echo 'Environment variables:'
@echo ' PACKAGE_LEVEL="minimum" - Install minimum version of dependent Python packages'
@echo ' PACKAGE_LEVEL="latest" - Default: Install latest version of dependent Python packages'
@echo ' PYTHON_CMD=... - Name of python command. Default: python'
@echo ' PIP_CMD=... - Name of pip command. Default: pip'
.PHONY: _check_version
_check_version:
ifeq (,$(package_version))
@echo 'Error: Package version could not be determine: (requires pbr; run "make develop")'
@false
else
@true
endif
.PHONY: _pip
_pip:
$(PYTHON_CMD) remove_duplicate_setuptools.py
@echo 'Installing/upgrading pip, setuptools, wheel and pbr with PACKAGE_LEVEL=$(PACKAGE_LEVEL)'
$(PYTHON_CMD) -m pip install $(pip_level_opts) pip setuptools wheel pbr
.PHONY: develop
develop: _pip dev-requirements.txt requirements.txt
@echo 'Installing runtime and development requirements with PACKAGE_LEVEL=$(PACKAGE_LEVEL)'
$(PIP_CMD) install $(pip_level_opts) $(pip_level_opts_new) -r dev-requirements.txt
@echo '$@ done.'
.PHONY: build
build: $(build_files)
@echo '$@ done.'
.PHONY: builddoc
builddoc: html
@echo '$@ done.'
.PHONY: html
html: $(doc_build_dir)/html/docs/index.html
@echo '$@ done.'
$(doc_build_dir)/html/docs/index.html: Makefile $(doc_dependent_files)
rm -fv $@
$(doc_cmd) -b html $(doc_opts) $(doc_build_dir)/html
@echo "Done: Created the HTML pages with top level file: $@"
.PHONY: pdf
pdf: Makefile $(doc_dependent_files)
rm -fv $@
$(doc_cmd) -b latex $(doc_opts) $(doc_build_dir)/pdf
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(doc_build_dir)/pdf all-pdf
@echo "Done: Created the PDF files in: $(doc_build_dir)/pdf/"
@echo '$@ done.'
.PHONY: man
man: Makefile $(doc_dependent_files)
rm -fv $@
$(doc_cmd) -b man $(doc_opts) $(doc_build_dir)/man
@echo "Done: Created the manual pages in: $(doc_build_dir)/man/"
@echo '$@ done.'
.PHONY: docchanges
docchanges:
$(doc_cmd) -b changes $(doc_opts) $(doc_build_dir)/changes
@echo
@echo "Done: Created the doc changes overview file in: $(doc_build_dir)/changes/"
@echo '$@ done.'
.PHONY: doclinkcheck
doclinkcheck:
$(doc_cmd) -b linkcheck $(doc_opts) $(doc_build_dir)/linkcheck
@echo
@echo "Done: Look for any errors in the above output or in: $(doc_build_dir)/linkcheck/output.txt"
@echo '$@ done.'
.PHONY: doccoverage
doccoverage:
$(doc_cmd) -b coverage $(doc_opts) $(doc_build_dir)/coverage
@echo "Done: Created the doc coverage results in: $(doc_build_dir)/coverage/python.txt"
@echo '$@ done.'
.PHONY: pyshow
pyshow:
which $(PYTHON_CMD)
$(PYTHON_CMD) --version
which $(PIP_CMD)
$(PIP_CMD) --version
@echo '$@ done.'
.PHONY: check
check: flake8.log
@echo '$@ done.'
.PHONY: pylint
pylint: pylint.log
@echo '$@ done.'
.PHONY: install
install: _pip requirements.txt setup.py setup.cfg $(package_py_files)
@echo 'Installing $(package_name) (editable) with PACKAGE_LEVEL=$(PACKAGE_LEVEL)'
$(PIP_CMD) install $(pip_level_opts) $(pip_level_opts_new) -r requirements.txt
$(PIP_CMD) install -e .
$(PYTHON_CMD) -c "import $(package_name); print('ok, version=%r'%$(package_name).__version__)"
$(PYTHON_CMD) -c "import $(mock_package_name); print('ok')"
@echo 'Done: Installed $(package_name)'
@echo '$@ done.'
.PHONY: uninstall
uninstall:
bash -c '$(PIP_CMD) show $(package_name) >/dev/null; if [ $$? -eq 0 ]; then $(PIP_CMD) uninstall -y $(package_name); fi'
@echo '$@ done.'
.PHONY: test
test: $(test_unit_log_file)
@echo '$@ done.'
.PHONY: clobber
clobber: uninstall clean
rm -Rf $(doc_build_dir) htmlcov .tox
rm -f pylint.log flake8.log test_*.log $(bdist_file) $(sdist_file) $(win64_dist_file)
@echo 'Done: Removed all build products to get to a fresh state.'
@echo '$@ done.'
.PHONY: clean
clean:
rm -Rf build .cache $(package_name).egg-info .eggs
rm -f MANIFEST MANIFEST.in AUTHORS ChangeLog .coverage
find . -name "*.pyc" -delete -o -name "__pycache__" -delete -o -name "*.tmp" -delete -o -name "tmp_*" -delete
@echo 'Done: Cleaned out all temporary files.'
@echo '$@ done.'
.PHONY: all
all: develop install check pylint test build builddoc
@echo '$@ done.'
.PHONY: upload
upload: _check_version uninstall $(dist_files)
ifeq (,$(findstring .dev,$(package_version)))
@echo '==> This will upload $(package_name) version $(package_version) to PyPI!'
@echo -n '==> Continue? [yN] '
@bash -c 'read answer; if [ "$$answer" != "y" ]; then echo "Aborted."; false; fi'
twine upload $(dist_files)
@echo 'Done: Uploaded $(package_name) version to PyPI: $(package_version)'
@echo '$@ done.'
else
@echo 'Error: A development version $(package_version) of $(package_name) cannot be uploaded to PyPI!'
@false
endif
# Distribution archives.
$(bdist_file): _check_version Makefile $(dist_dependent_files)
ifneq ($(PLATFORM),Windows)
rm -Rfv $(package_name).egg-info .eggs build
$(PYTHON_CMD) setup.py bdist_wheel -d $(dist_dir) --universal
@echo 'Done: Created binary distribution archive: $@'
else
@echo 'Error: Creating binary distribution archive requires to run on Linux or OSX'
@false
endif
$(sdist_file): _check_version Makefile $(dist_dependent_files)
ifneq ($(PLATFORM),Windows)
rm -Rfv $(package_name).egg-info .eggs build
$(PYTHON_CMD) setup.py sdist -d $(dist_dir)
@echo 'Done: Created source distribution archive: $@'
else
@echo 'Error: Creating source distribution archive requires to run on Linux or OSX'
@false
endif
$(win64_dist_file): _check_version Makefile $(dist_dependent_files)
ifeq ($(PLATFORM),Windows)
rm -Rfv $(package_name).egg-info .eggs build
$(PYTHON_CMD) setup.py bdist_wininst -d $(dist_dir) -o -t "$(package_name) v$(package_version)"
@echo 'Done: Created Windows installable: $@'
else
@echo 'Error: Creating Windows installable requires to run on Windows'
@false
endif
# TODO: Once PyLint has no more errors, remove the dash "-"
pylint.log: Makefile $(pylint_rc_file) $(check_py_files)
ifeq ($(python_major_version), 2)
rm -fv $@
-bash -c 'set -o pipefail; pylint --rcfile=$(pylint_rc_file) --output-format=text $(check_py_files) 2>&1 |tee $@.tmp'
mv -f $@.tmp $@
@echo 'Done: Created PyLint log file: $@'
else
@echo 'Info: PyLint requires Python 2; skipping this step on Python $(python_major_version)'
endif
flake8.log: Makefile $(flake8_rc_file) $(check_py_files)
rm -fv $@
bash -c 'set -o pipefail; flake8 $(check_py_files) 2>&1 |tee $@.tmp'
mv -f $@.tmp $@
@echo 'Done: Created Flake8 log file: $@'
$(test_unit_log_file): Makefile $(package_py_files) $(test_unit_py_files) $(test_common_py_files) .coveragerc
rm -fv $@
bash -c 'set -o pipefail; PYTHONWARNINGS=default py.test --color=yes $(pytest_no_log_opt) -s $(test_dir)/unit --cov $(package_name) --cov $(mock_package_name) --cov-config .coveragerc --cov-report=html $(pytest_opts) 2>&1 |tee $@.tmp'
mv -f $@.tmp $@
@echo 'Done: Created unit test log file: $@'
.PHONY: end2end
end2end: Makefile $(package_py_files) $(test_end2end_py_files) $(test_common_py_files)
py.test $(pytest_no_log_opt) -s $(test_dir)/end2end $(pytest_opts)
@echo '$@ done.'