-
Notifications
You must be signed in to change notification settings - Fork 4
/
tasks.py
653 lines (552 loc) · 18.5 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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
# Copyright 2023 University of Stuttgart
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# flake8: noqa
from os import environ
from os import execvpe as replace_process
from pathlib import Path
from platform import system
from re import match
from typing import List, cast
from dotenv import load_dotenv, set_key, unset_key
from invoke import task
from invoke.context import Context
from invoke.runners import Result
from qunicorn_core.static.qunicorn_exception import QunicornError
if system() == "Windows":
from subprocess import list2cmdline as join
else:
from shlex import join
load_dotenv(".flaskenv")
load_dotenv(".env")
MODULE_NAME = "qunicorn_core"
CELERY_WORKER = f"{MODULE_NAME}.celery_worker:CELERY"
# a list of allowed licenses, dependencies with other licenses will trigger an error in the list-licenses command
ALLOWED_LICENSES = [
"3-Clause BSD License",
"Apache 2.0",
"Apache-2.0",
"Apache 2.0 License",
"Apache License 2.0",
"Apache License, Version 2.0",
"Apache Software License",
"BSD License",
"BSD",
"BSD 3-Clause",
"Eclipse Public License 2.0 (EPL-2.0)",
"GNU Lesser General Public License v2 or later (LGPLv2+)",
"GNU Library or Lesser General Public License (LGPL)",
"GNU Lesser General Public License v3 (LGPLv3)",
"GPLv3",
"Historical Permission Notice and Disclaimer (HPND)",
"ISC License (ISCL)",
"MIT License",
"MIT",
"Mozilla Public License 2.0 (MPL 2.0)",
"new BSD",
"Python Software Foundation License",
"Zope Public License",
]
@task
def stop_broker(c):
"""Stop the previously started redis broker container with docker or podman.
Discovers the container id from the environment variable REDIS_CONTAINER_ID.
If the variable is not set ``--latest`` is used (this assumes that the latest
created container is the broker!).
To use podman instead of docker set the DOCKER_CMD environment variable to "podman".
Args:
c (Context): task context
"""
c = cast(Context, c)
docker_cmd = environ.get("DOCKER_CMD", "docker")
container_id = environ.get("REDIS_CONTAINER_ID", "--latest")
c.run(join([docker_cmd, "stop", container_id]))
@task(stop_broker)
def reset_broker(c):
"""Remove the current redis container and unset the REDIS_CONTAINER_ID variable.
Discovers the container id from the environment variable REDIS_CONTAINER_ID.
If the variable is not set this task does nothing.
To use podman instead of docker set the DOCKER_CMD environment variable to "podman".
Args:
c (Context): task context
"""
c = cast(Context, c)
docker_cmd = environ.get("DOCKER_CMD", "docker")
container_id = environ.get("REDIS_CONTAINER_ID")
if not container_id:
return
c.run(join([docker_cmd, "rm", container_id]), echo=True)
dot_env_path = Path(".env")
unset_key(dot_env_path, "REDIS_CONTAINER_ID")
@task
def start_broker(c, port=None):
"""Start a redis broker container with docker or podman.
Resuses an existing container if the environment variable REDIS_CONTAINER_ID is set.
The reused container ignores the port option!
Sets the environemnt variable in the .env file if a new container is created.
Redis port is optionally read from REDIS_PORT environment variable. Use the
``reset-broker`` task to remove the old container to create a new container
with a different port.
To use podman instead of docker set the DOCKER_CMD environment variable to "podman".
Args:
c (Context): task context
port (str, optional): outside port for connections to redis. Defaults to "6379".
"""
c = cast(Context, c)
docker_cmd = environ.get("DOCKER_CMD", "docker")
container_id = environ.get("REDIS_CONTAINER_ID", None)
if container_id:
res: Result = c.run(join([docker_cmd, "restart", container_id]), echo=True)
if res.failed:
print(f"Failed to start container with id {container_id}.")
return
if not port:
port = environ.get("REDIS_PORT", "6379")
c.run(join([docker_cmd, "run", "-d", "-p", f"{port}:6379", "redis"]), echo=True)
result: Result = c.run(join([docker_cmd, "ps", "-q", "--latest"]), hide=True)
result_container_id = result.stdout.strip()
dot_env_path = Path(".env")
if not dot_env_path.exists():
dot_env_path.touch()
set_key(dot_env_path, "REDIS_CONTAINER_ID", result_container_id)
@task
def worker(c, pool="solo", concurrency=1, dev=False, log_level="INFO", periodic_scheduler=False):
"""Run the celery worker, optionally starting the redis broker.
Args:
c (Context): task context
pool (str, optional): the executor pool to use for celery workers (defaults to "solo" for development on
linux and windows)
concurrency (int, optional): the number of concurrent workers (defaults to 1 for development)
dev (bool, optional): If true the redis docker container will be started before the worker and stopped after
the workers
finished. Defaults to False. #noqa
log_level (str, optional): The log level of the celery logger in the worker (
DEBUG|INFO|WARNING|ERROR|CRITICAL|FATAL). Defaults
to "INFO". #noqa
periodic_scheduler (bool, optional): If true a celery beat scheduler will be started alongside the worker.
This is needed for
periodic tasks. Should only be set to True for one worker otherwise the periodic tasks get executed too often
(see readme file).
S #noqa
"""
if dev:
start_broker(c)
c = cast(Context, c)
cmd = [
"celery",
"--app",
CELERY_WORKER,
"worker",
f"--pool={pool}",
"--concurrency",
str(concurrency),
"--loglevel",
log_level.upper(),
"-E",
]
if periodic_scheduler:
cmd += ["-B"]
if dev:
c.run(join(cmd), echo=True)
stop_broker(c)
else:
# if not in dev mode completely replace the current process with the started process
print(join(cmd))
replace_process(cmd[0], cmd, environ)
@task
def check_linting(c):
"""Checks if there are some linting issues which would be detected by the python pipeline"""
print("First check if there are some flake8 warnings/errors:")
c.run(
join(["flake8", "."]),
echo=True,
warn=True,
)
print("\nNow check if there are some black warnings/errors:")
c.run(
join(["black", "--check", "."]),
echo=True,
warn=True,
)
@task
def celery_status(c):
"""Show the status of celery workers.
Args:
c (Context): task context
"""
c = cast(Context, c)
c.run(
join(["celery", "--app", CELERY_WORKER, "status"]),
echo=True,
hide="err",
warn=True,
)
@task
def celery_queues(c):
"""Show the queus of the celery instance.
Args:
c (Context): task context
"""
c = cast(Context, c)
c.run(
join(["celery", "--app", CELERY_WORKER, "list", "bindings"]),
echo=True,
hide="err",
warn=True,
)
@task(celery_queues)
def celery_inspect(c):
"""Show a detailed status report of the running workers and queues.
Args:
c (Context): task context
"""
c.run(
join(["celery", "--app", CELERY_WORKER, "inspect", "report"]),
echo=True,
hide="err",
warn=True,
)
c.run(
join(["celery", "--app", CELERY_WORKER, "inspect", "stats"]),
echo=True,
hide="err",
warn=True,
)
@task
def celery_enable_events(c):
"""Enable celery worker events events.
Args:
c (Context): task context
"""
c.run(
join(["celery", "--app", CELERY_WORKER, "control", "enable_events"]),
echo=True,
hide="err",
warn=True,
)
@task
def celery_disable_events(c):
"""Disable celery worker events events.
Args:
c (Context): task context
"""
c.run(
join(["celery", "--app", CELERY_WORKER, "control", "disable_events"]),
echo=True,
hide="err",
warn=True,
)
@task(pre=(celery_enable_events,), post=(celery_disable_events,))
def celery_monitor(c):
"""Show current events.
Args:
c (Context): task context
"""
c.run(
join(["celery", "--app", CELERY_WORKER, "events"]),
pty=True,
hide="err",
warn=True,
)
@task
def purge_task_queues(c):
"""Purge all task queues. Deletes tasks forever!
Args:
c (Context): task context
"""
answer = input("This action cannot be undone. Type in 'purge' to purge all task queues:")
if answer != "purge":
print("Not purging task queues.")
return
c.run(
join(["celery", "--app", CELERY_WORKER, "purge"]),
echo=True,
hide="err",
warn=True,
)
@task
def start_gunicorn(c, workers=1, log_level="info", docker=False):
"""Start the gunicorn server.
This task is intended to be run in docker.
The gunicorn server port defaults to 8080 but can be changed by setting
the SERVER_PORT environment variable.
Args:
c (Context): task context
workers (int, optional): The number of parallel workers (set this to around <nr_of_cores>*2 + 1). Defaults to 1.
log_level (str, optional): the log level to output in console. Defaults to "info".
docker (bool, optional): set this to True if running inside of docker. Defaults to false.
"""
server_port: str = environ.get("SERVER_PORT", "8080")
assert match(
r"[1-9][0-9]*", server_port
), f"The given server port '{server_port}' does not have the right format! (must be a valid port number)"
cmd = [
"python",
"-m",
"gunicorn",
"--pythonpath",
".",
"--worker-tmp-dir",
"/dev/shm" if docker else "/tmp", # use in memory file system for heartbeats
"-w",
environ.get("GUNICORN_WORKERS", str(workers)),
"-b",
f"0.0.0.0:{server_port}",
"--log-level",
log_level.lower(),
"--error-logfile=-",
f"{MODULE_NAME}:create_app()",
]
print(join(cmd))
# replaces the current process with the subprocess!
replace_process(cmd[0], cmd, environ)
@task
def await_db(c):
"""Docker specific task. Do not call."""
c.run("/wait", echo=True, warn=False)
@task
def upgrade_db(c):
"""Upgrade the database to the newest migration."""
c.run(join(["python", "-m", "flask", "db", "upgrade"]), echo=True, warn=True)
c.run(join(["python", "-m", "flask", "load-providers"]), echo=True, warn=True)
@task
def ensure_paths(c):
"""Docker specific task. Do not call."""
Path("/app/instance").mkdir(parents=True, exist_ok=True)
@task(ensure_paths)
def start_docker(c):
"""Docker entry point task. Do not call!"""
def execute_pre_tasks(do_upgrade_db=False):
task(await_db)
if do_upgrade_db:
upgrade_db(c)
log_level = environ.get("DEFAULT_LOG_LEVEL", "INFO")
concurrency_env = environ.get("CONCURRENCY", "1")
concurrency = int(concurrency_env) if concurrency_env.isdigit() else 1
if environ.get("CONTAINER_MODE", "").lower() == "server":
execute_pre_tasks(do_upgrade_db=True)
start_gunicorn(c, workers=concurrency, log_level=log_level, docker=True)
elif environ.get("CONTAINER_MODE", "").lower() == "worker":
execute_pre_tasks()
worker_pool = environ.get("CELERY_WORKER_POOL", "threads")
periodic_scheduler = bool(environ.get("PERIODIC_SCHEDULER", False))
worker(
c,
concurrency=concurrency,
pool=worker_pool,
log_level=log_level,
periodic_scheduler=periodic_scheduler,
)
else:
raise QunicornError("Environment variable 'CONTAINER_MODE' must be set to either 'server' or 'worker'!")
@task
def doc(c, format_="html", all_=False, color=True):
"""Build the documentation.
Args:
c (Context): task context
format_ (str, optional): the format to build. Defaults to "html".
all (bool, optional): build all files new. Defaults to False.
color (bool, optional): color output. Defaults to True.
"""
cmd = ["sphinx-build", "-b", format_]
if all_:
cmd.append("-a")
if color:
cmd.append("--color")
else:
cmd.append("--no-color")
cmd += [".", "_build"]
with c.cd(str(Path("./docs"))):
c.run(join(cmd), echo=True)
@task
def update_source_doc(c):
"""Update the autogenerated source documentation files.
Args:
c (Context): task context
"""
cmd = [
"sphinx-apidoc",
"--separate",
"--force",
"-o",
"docs/source",
".",
"./tasks.py",
"docs",
"tests",
"migrations",
]
c.run(join(cmd), echo=True)
# remove unwanted files
for p in (
Path("docs/source/modules.rst"),
Path("docs/source/qunicorn_core.celery_worker.rst"),
):
if p.exists():
p.unlink()
@task
def browse_doc(c):
"""Open the documentation in the browser.
Args:
c (Context): task context
"""
index_path = Path("./docs/_build/index.html")
if not index_path.exists():
doc(c)
print(f"Open: file://{index_path.resolve()}")
import webbrowser
webbrowser.open_new_tab(str(index_path.resolve()))
@task
def doc_index(c, filter_=""):
"""Search the index of referencable sphinx targets in the documentation.
Args:
c (Context): task context
filter_ (str, optional): an optional filter string. Defaults to "".
"""
inv_path = Path("./docs/_build/objects.inv")
if not inv_path.exists():
doc(c)
if filter_:
filter_ = filter_.lower()
with c.cd(str(Path("./docs"))):
output: Result = c.run(
join(["python", "-m", "sphinx.ext.intersphinx", "_build/objects.inv"]),
echo=True,
hide="stdout",
)
print(
"".join(
l
for l in output.stdout.splitlines(True)
if (l and not l[0].isspace()) or (not filter_) or (filter_ in l.lower())
),
)
@task
def list_licenses(c, format_="json", include_installed=False, summary=False, short=False, echo=False):
"""List licenses of dependencies.
By default only the direct (and transitive) dependencies of the plugin runner are included.
Args:
c (Context): task context
format_ (str, optional): The output format (json, html, markdown, plain, plain-vertical, rst, confluence,
json-license-finder,
csv). Defaults to "json". #noqa
include_installed (bool, optional): If true all currently installed packages are considered dependencies.
Defaults to False.
summary (bool, optional): If true output a summary of found licenses. Defaults to False.
short (bool, optional): If true only name, version, license and authors of a apackage are printed. Defaults
to False.
echo (bool, optional): If true the command used to generate the license output is printed to console.
Defaults to False.
"""
packages: List[str] = []
if not include_installed:
packages_output: Result = c.run(
join(["poetry", "export", "--dev", "--without-hashes"]),
echo=False,
hide="both",
)
packages = [p.split("=", 1)[0] for p in packages_output.stdout.splitlines() if p]
cmd: List[str] = [
"pip-licenses",
"--format",
format_,
"--with-authors",
"--allow-only",
";".join(ALLOWED_LICENSES),
]
if not short:
cmd += [
"--with-urls",
"--with-description",
"--with-license-file",
"--no-license-path",
"--with-notice-file",
]
if summary:
cmd.append("--summary")
if not include_installed:
cmd += [
"--packages",
*packages,
]
c.run(
join(cmd),
echo=echo,
warn=True,
)
@task
def update_licenses(c, include_installed=False):
"""Update the licenses template to include all licenses.
By default only the direct (and transitive) dependencies of the qunicorn are included.
Args:
c (Context): task context
include_installed (bool, optional): Include all currently installed libraries. Defaults to False.
"""
packages: List[str] = []
if not include_installed:
packages_output: Result = c.run(
join(["poetry", "export", "--dev", "--without-hashes"]),
echo=False,
hide="both",
)
packages = [p.split("=", 1)[0] for p in packages_output.stdout.splitlines() if p]
cmd: List[str] = [
"pip-licenses",
"--format",
"html",
"--output-file",
str((Path(".") / Path(MODULE_NAME) / Path("templates/licenses.html")).resolve()),
"--with-authors",
"--with-urls",
"--with-description",
"--with-license-file",
"--no-license-path",
"--with-notice-file",
"--allow-only",
";".join(ALLOWED_LICENSES),
]
if not include_installed:
cmd += [
"--packages",
*packages,
]
c.run(
join(cmd),
echo=True,
hide="err",
warn=True,
)
# Does not work correctly under windows
@task(update_licenses)
def update_dependencies(c):
"""Update dependencies that are derived from the pyproject.toml dependencies (e.g. doc dependencies and licenses).
Args:
c (Context): task context
"""
c.run(
join(
[
"poetry",
"export",
"--dev",
"--format",
"requirements.txt",
"--without-hashes", # with hashes fails because pip is to strict with transitive dependencies
"--output",
str(Path("./docs/requirements.txt")),
]
),
echo=True,
# hide="err",
warn=True,
)