-
Notifications
You must be signed in to change notification settings - Fork 4
/
tasks.py
493 lines (371 loc) · 11.8 KB
/
tasks.py
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
from invoke import Collection, task
PACKAGE_DIR = "pyadr"
#################################################################
# setting up dev env
#################################################################
@task
def setup_dev_host(context):
"""
Setup host dev requirements
"""
context.run("./scripts/install_pyenv.sh")
context.run("./scripts/install_poetry.sh")
print(
"Host setup correctly. "
"Restart your shell or source your shell config file to be up and running :)"
)
@task
def setup_pre_commit_hooks(context):
"""
Setup pre-commit hooks
"""
context.run("pre-commit install --hook-type pre-commit")
@task
def setup_release_tools(context):
"""
Setup release tools (semantic-release)
"""
context.run('npm install -g semantic-release@"^17.0.4"')
context.run('npm install -g @semantic-release/changelog@"^5.0.1"')
context.run('npm install -g @semantic-release/exec@"^5.0.0"')
context.run('npm install -g @semantic-release/git@"^9.0.0"')
context.run('npm install -g @semantic-release/github@"^7.0.5"')
#################################################################
# setting up ci-cd env
#################################################################
@task
def setup_cicd_common(context):
context.run("pip install --upgrade pip")
@task(setup_cicd_common)
def setup_cicd_test_stage(context):
context.run("git config --global user.name 'Foo Bar'")
context.run("git config --global user.email '[email protected]'")
@task(setup_cicd_common)
def setup_cicd_release_stage(context):
pass
@task(setup_cicd_common)
def setup_cicd_publish_stage(context):
pass
#################################################################
# cleaning
#################################################################
@task
def clean_build(context):
"""
Remove build artifacts
"""
context.run("rm -fr build/")
context.run("rm -fr dist/")
context.run("rm -fr .eggs/")
context.run("find . -name '*.egg-info' -exec rm -fr {} +")
context.run("find . -name '*.egg' -exec rm -f {} +")
@task
def clean_pyc(context):
"""
Remove Python artifacts
"""
context.run("find . -name '*.pyc' -exec rm -f {} +")
context.run("find . -name '*.pyo' -exec rm -f {} +")
context.run("find . -name '*~' -exec rm -f {} +")
context.run("find . -name '__pycache__' -exec rm -fr {} +")
context.run("find . -name '.pytest_cache' -exec rm -fr {} +")
@task
def clean_test(context):
"""
Remove test and coverage artifacts
"""
context.run("rm -fr .tox/")
context.run("rm -f .coverage")
context.run("rm -fr htmlcov/")
@task(clean_build, clean_pyc, clean_test)
def clean(context):
"""
Remove all build, test, coverage and Python artifacts
"""
pass
@task
def clean_venv(context):
"""
Remove virtual environment
"""
# poetry env remove might not to work if `virtualenvs.in-project = true`
# (see https://github.com/python-poetry/poetry/issues/2124)
# so if not, remove whole `.venv` directory using https://unix.stackexchange.com/questions/153763 # noqa
context.run(
"poetry env remove $$(poetry env info -p)/bin/python && ([ $$? -eq 0 ]) "
"|| rm -rf $$(poetry env info -p)"
)
#################################################################
# all tests and checks
#################################################################
@task
def tox(context):
"""
Run tox default targets, usually all tests and BDD tests (see tox.ini)
"""
context.run("poetry run tox")
@task()
def tox_p(context):
"""
Same as 'tox', but with parallel runs
"""
context.run("poetry run tox -p auto")
#################################################################
# repl
#################################################################
@task
def repl(context):
"""
Run the repl tool (bpython in our case)
"""
context.run("poetry run bpython")
#################################################################
# linting
#################################################################
@task
def lint(context):
"""
Check style with flake8
"""
context.run(f"poetry run flake8 {PACKAGE_DIR} tests features")
#################################################################
# formatting
#################################################################
@task
def isort(context):
context.run(f"poetry run isort --profile black {PACKAGE_DIR} tests features")
@task
def black(context):
context.run(f"poetry run black {PACKAGE_DIR} tests features")
@task(isort, black)
def format(context):
"""
Enforce correct format with isort and black
"""
pass
@task
def format_check(context):
"""
Check format for compliance with black and isort
"""
context.run(f"poetry run isort -c --profile black {PACKAGE_DIR} tests features")
context.run(f"poetry run black --check {PACKAGE_DIR} tests features")
#################################################################
# typing
#################################################################
@task
def type(context):
context.run(f"poetry run mypy -p {PACKAGE_DIR} -p tests")
#################################################################
# unit testing
#################################################################
@task
def test(context):
"""
Run unit tests
"""
context.run(
"poetry run pytest "
f"--cov={PACKAGE_DIR} "
"--cov-report=html "
"--cov-report=term tests"
)
@task(aliases=["tox-test-default-version", "tox-py"])
def tox_test(context):
"""
Run unit tests with the default Python
"""
context.run("poetry run tox -e py")
@task(aliases=["tox-py311"])
def tox_test_py311(context):
"""
Run unit tests with Python 3.11
"""
context.run("poetry run tox -e py311")
@task(aliases=["tox-py310"])
def tox_test_py310(context):
"""
Run unit tests with Python 3.10
"""
context.run("poetry run tox -e py310")
@task(aliases=["tox-py39"])
def tox_test_py39(context):
"""
Run unit tests with Python 3.9
"""
context.run("poetry run tox -e py39")
@task(aliases=["tox-py38"])
def tox_test_py38(context):
"""
Run unit tests with Python 3.8
"""
context.run("poetry run tox -e py38")
@task(aliases=["tox-test-all-versions"])
def tox_test_all(context):
"""
Run unit tests on each Python version declared
"""
context.run("poetry run tox -e py311,py310,py39,py38,py37")
#################################################################
# acceptance testing / bdd
#################################################################
@task
def bdd(context):
"""
Run bdd tests
"""
context.run("poetry run behave features --format=pretty --tags=~wip --tags=~skip")
@task(aliases=["tox_bdd_default-version"])
def tox_bdd(context):
"""
Run bdd tests with the default Python
"""
context.run("poetry run tox -e bdd")
@task
def tox_bdd_py311(context):
"""
Run bdd tests with Python 3.11
"""
context.run("poetry run tox -e bdd-py311")
@task
def tox_bdd_py310(context):
"""
Run bdd tests with Python 3.10
"""
context.run("poetry run tox -e bdd-py310")
@task
def tox_bdd_py39(context):
"""
Run bdd tests with Python 3.9
"""
context.run("poetry run tox -e bdd-py39")
@task
def tox_bdd_py38(context):
"""
Run bdd tests with Python 3.8
"""
context.run("poetry run tox -e bdd-py38")
@task(aliases=["tox-bdd-all-versions"])
def tox_bdd_all(context):
"""
Run bdd tests on every Python version declared
"""
context.run("poetry run tox -e bdd-py311,bdd-py310,bdd-py39,bdd-py38")
#################################################################
# releasing (full cycle)
#################################################################
@task
def cicd_release(context):
"""
Launch the release process and release a new version if required
"""
context.run("npx semantic-release")
@task(clean)
def publish(context):
context.run("poetry run python scripts/verify_pypi_env_variables.py")
context.run(
'[ -z $$PYPI_REPOSITORY_NAME ] || repo_arg="-r $$PYPI_REPOSITORY_NAME" '
"&& poetry publish --build $$repo_arg"
)
#################################################################
# git targets
#################################################################
@task
def prune_branches(context):
"""
Prune obsolete local tracking branches and local branches
"""
context.run("git remote prune origin")
context.run(
"git branch -vv | "
"grep ': gone]'| "
"grep -v '\\*' | "
"awk '{ print $1; }' | "
"xargs git branch -d"
)
@task(aliases=["pbf"])
def prune_branches_force(context):
"""
Same as prune-branches but force delete local branches
"""
context.run("git remote prune origin")
context.run(
"git branch -vv | "
"grep ': gone]'| "
"grep -v '\\*' | "
"awk '{ print $1; }' | "
"xargs git branch -D"
)
@task(post=[prune_branches_force], aliases=["pms"])
def post_pr_merge_sync(context):
"""
Switch to main, pull and run prune-branches-force task
"""
context.run("git switch main")
context.run("git pull")
#################################################################
# Run all local tests and checks
#################################################################
@task(format, lint)
def all_checks(context):
"""
Run all checks
"""
pass
@task(test, bdd, all_checks)
def all_locals(context):
"""
Run all local tests and checks
"""
pass
#################################################################
# Tasks organization in namespaces
#################################################################
namespace = Collection()
namespace_dev_env_setup = Collection("dev_env_setup")
namespace_dev_env_setup.add_task(setup_dev_host)
namespace_dev_env_setup.add_task(setup_pre_commit_hooks)
namespace_dev_env_setup.add_task(setup_release_tools)
namespace_cicd_setup = Collection("cicd_setup")
namespace_cicd_setup.add_task(setup_cicd_test_stage, "setup_test_stage")
namespace_cicd_setup.add_task(setup_cicd_release_stage, "setup_release_stage")
namespace_cicd_setup.add_task(setup_cicd_publish_stage, "setup_publish_stage")
namespace_tox = Collection("tox_")
namespace_tox.add_task(tox_test, name="test")
namespace_tox.add_task(tox_test_all, name="test_all")
namespace_tox.add_task(tox_test_py311, name="test_py311")
namespace_tox.add_task(tox_test_py310, name="test_py310")
namespace_tox.add_task(tox_test_py39, name="test_py39")
namespace_tox.add_task(tox_test_py38, name="test_py38")
namespace_tox.add_task(tox_bdd, name="bdd")
namespace_tox.add_task(tox_bdd_all, name="bdd_all")
namespace_tox.add_task(tox_bdd_py311, name="bdd_py311")
namespace_tox.add_task(tox_bdd_py310, name="bdd_py310")
namespace_tox.add_task(tox_bdd_py39, name="bdd_py39")
namespace_tox.add_task(tox_bdd_py38, name="bdd_py38")
namespace_cicd = Collection("cicd")
namespace_cicd.add_task(cicd_release, name="release")
namespace_git = Collection("git")
namespace_git.add_task(prune_branches)
namespace_git.add_task(prune_branches_force)
namespace_git.add_task(post_pr_merge_sync)
namespace.add_collection(namespace_dev_env_setup)
namespace.add_collection(namespace_cicd_setup)
namespace.add_collection(namespace_cicd)
namespace.add_collection(namespace_tox)
namespace.add_collection(namespace_git)
namespace.add_task(clean)
namespace.add_task(clean_venv)
namespace.add_task(all_checks)
namespace.add_task(all_locals)
namespace.add_task(test)
namespace.add_task(bdd)
namespace.add_task(isort)
namespace.add_task(black)
namespace.add_task(format)
namespace.add_task(format_check)
namespace.add_task(lint)
namespace.add_task(type)
namespace.add_task(repl)
namespace.add_task(tox)
namespace.add_task(tox_p)