forked from LLNL/merlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
244 lines (184 loc) · 7.93 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
###############################################################################
# Copyright (c) 2023, Lawrence Livermore National Security, LLC.
# Produced at the Lawrence Livermore National Laboratory
# Written by the Merlin dev team, listed in the CONTRIBUTORS file.
#
# LLNL-CODE-797170
# All rights reserved.
# This file is part of Merlin, Version: 1.12.2b1.
#
# For details, see https://github.com/LLNL/merlin.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
###############################################################################
include config.mk
.PHONY : virtualenv
.PHONY : install-merlin
.PHONY : install-workflow-deps
.PHONY : install-dev
.PHONY : unit-tests
.PHONY : e2e-tests
.PHONY : e2e-tests-diagnostic
.PHONY : e2e-tests-local
.PHONY : e2e-tests-local-diagnostic
.PHONY : e2e-tests-distributed
.PHONY : e2e-tests-distributed-diagnostic
.PHONY : tests
.PHONY : check-flake8
.PHONY : check-black
.PHONY : check-isort
.PHONY : check-pylint
.PHONY : check-style
.PHONY : fix-style
.PHONY : check-push
.PHONY : check-camel-case
.PHONY : checks
.PHONY : reqlist
.PHONY : release
.PHONY : clean-release
.PHONY : clean-output
.PHONY : clean-docs
.PHONY : clean-py
.PHONY : clean
# this only works outside the venv - if run from inside a custom venv, or any target that depends on this,
# you will break your venv.
virtualenv:
$(PYTHON) -m venv $(VENV) --prompt $(PENV) --system-site-packages; \
$(PIP) install --upgrade pip; \
$(PIP) install -r requirements/release.txt; \
# install merlin into the virtual environment
install-merlin: virtualenv
$(PIP) install -e .; \
. $(VENV)/bin/activate; \
merlin config; \
# install the example workflow to enable integrated testing
install-workflow-deps: virtualenv install-merlin
$(PIP) install -r $(WKFW)feature_demo/requirements.txt; \
# install requirements
install-dev: virtualenv install-merlin install-workflow-deps
$(PIP) install -r requirements/dev.txt; \
# tests require a valid dev install of merlin
unit-tests:
. $(VENV)/bin/activate; \
$(PYTHON) -m pytest -v --order-scope=module $(UNIT); \
# run CLI tests - these require an active install of merlin in a venv
e2e-tests:
. $(VENV)/bin/activate; \
$(PYTHON) $(TEST)/integration/run_tests.py; \
e2e-tests-diagnostic:
. $(VENV)/bin/activate; \
$(PYTHON) $(TEST)/integration/run_tests.py --verbose
e2e-tests-local:
. $(VENV)/bin/activate; \
$(PYTHON) $(TEST)/integration/run_tests.py --local; \
e2e-tests-local-diagnostic:
. $(VENV)/bin/activate; \
$(PYTHON) $(TEST)/integration/run_tests.py --local --verbose
e2e-tests-distributed:
. $(VENV)/bin/activate; \
$(PYTHON) $(TEST)/integration/run_tests.py --distributed; \
e2e-tests-distributed-diagnostic:
. $(VENV)/bin/activate; \
$(PYTHON) $(TEST)/integration/run_tests.py --distributed --verbose
# run unit and CLI tests
tests: unit-tests e2e-tests
check-flake8:
. $(VENV)/bin/activate; \
echo "Flake8 linting for invalid source (bad syntax, undefined variables)..."; \
$(PYTHON) -m flake8 --count --select=E9,F63,F7,F82 --show-source --statistics; \
echo "Flake8 linting failure for CI..."; \
$(PYTHON) -m flake8 . --count --max-complexity=15 --statistics --max-line-length=127; \
check-black:
. $(VENV)/bin/activate; \
$(PYTHON) -m black --check --line-length $(MAX_LINE_LENGTH) --target-version py38 $(MRLN); \
$(PYTHON) -m black --check --line-length $(MAX_LINE_LENGTH) --target-version py38 $(TEST); \
$(PYTHON) -m black --check --line-length $(MAX_LINE_LENGTH) --target-version py38 *.py; \
check-isort:
. $(VENV)/bin/activate; \
$(PYTHON) -m isort --check --line-length $(MAX_LINE_LENGTH) $(MRLN); \
$(PYTHON) -m isort --check --line-length $(MAX_LINE_LENGTH) $(TEST); \
$(PYTHON) -m isort --check --line-length $(MAX_LINE_LENGTH) *.py; \
check-pylint:
. $(VENV)/bin/activate; \
echo "PyLinting merlin source..."; \
$(PYTHON) -m pylint merlin --rcfile=setup.cfg --ignore-patterns="$(VENV)/" --disable=logging-fstring-interpolation; \
echo "PyLinting merlin tests..."; \
$(PYTHON) -m pylint tests --rcfile=setup.cfg; \
# run code style checks
check-style: check-flake8 check-black check-isort check-pylint
check-push: tests check-style
# finds all strings in project that begin with a lowercase letter,
# contain only letters and numbers, and contain at least one lowercase
# letter and at least one uppercase letter.
check-camel-case: clean-py
grep -rnw --exclude=lbann_pb2.py $(MRLN) -e "[a-z]\([A-Z0-9]*[a-z][a-z0-9]*[A-Z]\|[a-z0-9]*[A-Z][A-Z0-9]*[a-z]\)[A-Za-z0-9]*"
# run all checks
checks: check-style check-camel-case
# automatically make python files pep 8-compliant
fix-style:
. $(VENV)/bin/activate; \
$(PYTHON) -m isort -w $(MAX_LINE_LENGTH) $(MRLN); \
$(PYTHON) -m isort -w $(MAX_LINE_LENGTH) $(TEST); \
$(PYTHON) -m isort -w $(MAX_LINE_LENGTH) *.py; \
$(PYTHON) -m black --target-version py38 -l $(MAX_LINE_LENGTH) $(MRLN); \
$(PYTHON) -m black --target-version py38 -l $(MAX_LINE_LENGTH) $(TEST); \
$(PYTHON) -m black --target-version py38 -l $(MAX_LINE_LENGTH) *.py; \
# Increment the Merlin version. USE ONLY ON DEVELOP BEFORE MERGING TO MASTER.
# Use like this: make VER=?.?.? version
version:
# do merlin/__init__.py
sed -i 's/__version__ = "$(VSTRING)"/__version__ = "$(VER)"/g' merlin/__init__.py
# do CHANGELOG.md
sed -i 's/## \[Unreleased\]/## [$(VER)]/g' CHANGELOG.md
# do all file headers (works on linux)
find merlin/ -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'
find *.py -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'
find tests/ -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'
find Makefile -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'
# Increment copyright year
year:
# do LICENSE (no comma after year)
sed -i 's/$(YEAR) Lawrence Livermore/$(NEW_YEAR) Lawrence Livermore/g' LICENSE
# do all file headers (works on linux)
find merlin/ -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'
find *.py -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'
find tests/ -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'
find Makefile -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'
# Make a list of all dependencies/requirements
reqlist:
johnnydep merlin --output-format pinned
release:
$(PYTHON) -m build .
clean-release:
rm -rf dist
rm -rf build
# remove python bytecode files
clean-py:
-find $(MRLN) -name "*.py[cod]" -exec rm -f {} \;
-find $(MRLN) -name "__pycache__" -type d -exec rm -rf {} \;
# remove all studies/ directories
clean-output:
-find $(MRLN) -name "studies*" -type d -exec rm -rf {} \;
-find . -maxdepth 1 -name "studies*" -type d -exec rm -rf {} \;
-find . -maxdepth 1 -name "merlin.log" -type f -exec rm -rf {} \;
# remove doc build files
clean-docs:
rm -rf $(DOCS)/build
# remove unwanted files
clean: clean-py clean-docs clean-release