-
Notifications
You must be signed in to change notification settings - Fork 5
/
tasks.py
913 lines (746 loc) · 30.2 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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
"""Tasks for use with Invoke.
Copyright (c) 2023, Network to Code, LLC
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.
"""
import os
import re
import sys
from pathlib import Path
from time import sleep
from invoke.collection import Collection
from invoke.exceptions import Exit, UnexpectedExit
from invoke.tasks import task as invoke_task
def is_truthy(arg):
"""Convert "truthy" strings into Booleans.
Examples:
>>> is_truthy('yes')
True
Args:
arg (str): Truthy string (True values are y, yes, t, true, on and 1; false values are n, no,
f, false, off and 0. Raises ValueError if val is anything else.
"""
if isinstance(arg, bool):
return arg
val = str(arg).lower()
if val in ("y", "yes", "t", "true", "on", "1"):
return True
elif val in ("n", "no", "f", "false", "off", "0"):
return False
else:
raise ValueError(f"Invalid truthy value: `{arg}`")
# Use pyinvoke configuration for default values, see http://docs.pyinvoke.org/en/stable/concepts/configuration.html
# Variables may be overwritten in invoke.yml or by the environment variables INVOKE_NAUTOBOT_FLOOR_PLAN_xxx
namespace = Collection("nautobot_floor_plan")
namespace.configure(
{
"nautobot_floor_plan": {
"nautobot_ver": "2.3.1",
"project_name": "nautobot-floor-plan",
"python_ver": "3.11",
"local": False,
"compose_dir": os.path.join(os.path.dirname(__file__), "development"),
"compose_files": [
"docker-compose.base.yml",
"docker-compose.redis.yml",
"docker-compose.postgres.yml",
"docker-compose.dev.yml",
],
"compose_http_timeout": "86400",
}
}
)
def _is_compose_included(context, name):
return f"docker-compose.{name}.yml" in context.nautobot_floor_plan.compose_files
def _await_healthy_service(context, service):
container_id = docker_compose(context, f"ps -q -- {service}", pty=False, echo=False, hide=True).stdout.strip()
_await_healthy_container(context, container_id)
def _await_healthy_container(context, container_id):
while True:
result = context.run(
"docker inspect --format='{{.State.Health.Status}}' " + container_id,
pty=False,
echo=False,
hide=True,
)
if result.stdout.strip() == "healthy":
break
print(f"Waiting for `{container_id}` container to become healthy ...")
sleep(1)
def task(function=None, *args, **kwargs):
"""Task decorator to override the default Invoke task decorator and add each task to the invoke namespace."""
def task_wrapper(function=None):
"""Wrapper around invoke.task to add the task to the namespace as well."""
if args or kwargs:
task_func = invoke_task(*args, **kwargs)(function)
else:
task_func = invoke_task(function)
namespace.add_task(task_func)
return task_func
if function:
# The decorator was called with no arguments
return task_wrapper(function)
# The decorator was called with arguments
return task_wrapper
def docker_compose(context, command, **kwargs):
"""Helper function for running a specific docker compose command with all appropriate parameters and environment.
Args:
context (obj): Used to run specific commands
command (str): Command string to append to the "docker compose ..." command, such as "build", "up", etc.
**kwargs: Passed through to the context.run() call.
"""
build_env = {
# Note: 'docker compose logs' will stop following after 60 seconds by default,
# so we are overriding that by setting this environment variable.
"COMPOSE_HTTP_TIMEOUT": context.nautobot_floor_plan.compose_http_timeout,
"NAUTOBOT_VER": context.nautobot_floor_plan.nautobot_ver,
"PYTHON_VER": context.nautobot_floor_plan.python_ver,
**kwargs.pop("env", {}),
}
compose_command_tokens = [
"docker compose",
f"--project-name {context.nautobot_floor_plan.project_name}",
f'--project-directory "{context.nautobot_floor_plan.compose_dir}"',
]
for compose_file in context.nautobot_floor_plan.compose_files:
compose_file_path = os.path.join(context.nautobot_floor_plan.compose_dir, compose_file)
compose_command_tokens.append(f' -f "{compose_file_path}"')
compose_command_tokens.append(command)
# If `service` was passed as a kwarg, add it to the end.
service = kwargs.pop("service", None)
if service is not None:
compose_command_tokens.append(service)
print(f'Running docker compose command "{command}"')
compose_command = " ".join(compose_command_tokens)
return context.run(compose_command, env=build_env, **kwargs)
def run_command(context, command, **kwargs):
"""Wrapper to run a command locally or inside the nautobot container."""
if is_truthy(context.nautobot_floor_plan.local):
if "command_env" in kwargs:
kwargs["env"] = {
**kwargs.get("env", {}),
**kwargs.pop("command_env"),
}
return context.run(command, **kwargs)
else:
# Check if nautobot is running, no need to start another nautobot container to run a command
docker_compose_status = "ps --services --filter status=running"
results = docker_compose(context, docker_compose_status, hide="out")
command_env_args = ""
if "command_env" in kwargs:
command_env = kwargs.pop("command_env")
for key, value in command_env.items():
command_env_args += f' --env="{key}={value}"'
if "nautobot" in results.stdout:
compose_command = f"exec{command_env_args} nautobot {command}"
else:
compose_command = f"run{command_env_args} --rm --entrypoint='{command}' nautobot"
pty = kwargs.pop("pty", True)
return docker_compose(context, compose_command, pty=pty, **kwargs)
# ------------------------------------------------------------------------------
# BUILD
# ------------------------------------------------------------------------------
@task(
help={
"force_rm": "Always remove intermediate containers",
"cache": "Whether to use Docker's cache when building the image (defaults to enabled)",
}
)
def build(context, force_rm=False, cache=True):
"""Build Nautobot docker image."""
command = "build"
if not cache:
command += " --no-cache"
if force_rm:
command += " --force-rm"
print(f"Building Nautobot with Python {context.nautobot_floor_plan.python_ver}...")
docker_compose(context, command)
@task
def generate_packages(context):
"""Generate all Python packages inside docker and copy the file locally under dist/."""
command = "poetry build"
run_command(context, command)
def _get_docker_nautobot_version(context, nautobot_ver=None, python_ver=None):
"""Extract Nautobot version from base docker image."""
if nautobot_ver is None:
nautobot_ver = context.nautobot_floor_plan.nautobot_ver
if python_ver is None:
python_ver = context.nautobot_floor_plan.python_ver
dockerfile_path = os.path.join(context.nautobot_floor_plan.compose_dir, "Dockerfile")
base_image = context.run(f"grep --max-count=1 '^FROM ' {dockerfile_path}", hide=True).stdout.strip().split(" ")[1]
base_image = base_image.replace(r"${NAUTOBOT_VER}", nautobot_ver).replace(r"${PYTHON_VER}", python_ver)
pip_nautobot_ver = context.run(f"docker run --rm --entrypoint '' {base_image} pip show nautobot", hide=True)
match_version = re.search(r"^Version: (.+)$", pip_nautobot_ver.stdout.strip(), flags=re.MULTILINE)
if match_version:
return match_version.group(1)
else:
raise Exit(f"Nautobot version not found in Docker base image {base_image}.")
@task(
help={
"check": (
"If enabled, check for outdated dependencies in the poetry.lock file, "
"instead of generating a new one. (default: disabled)"
),
"constrain_nautobot_ver": (
"Run 'poetry add nautobot@[version] --lock' to generate the lockfile, "
"where [version] is the version installed in the Dockerfile's base image. "
"Generally intended to be used in CI and not for local development. (default: disabled)"
),
"constrain_python_ver": (
"When using `constrain_nautobot_ver`, further constrain the nautobot version "
"to python_ver so that poetry doesn't complain about python version incompatibilities. "
"Generally intended to be used in CI and not for local development. (default: disabled)"
),
}
)
def lock(context, check=False, constrain_nautobot_ver=False, constrain_python_ver=False):
"""Generate poetry.lock file."""
if constrain_nautobot_ver:
docker_nautobot_version = _get_docker_nautobot_version(context)
command = f"poetry add --lock nautobot@{docker_nautobot_version}"
if constrain_python_ver:
command += f" --python {context.nautobot_floor_plan.python_ver}"
try:
output = run_command(context, command, hide=True)
print(output.stdout, end="")
print(output.stderr, file=sys.stderr, end="")
except UnexpectedExit:
print("Unable to add Nautobot dependency with version constraint, falling back to git branch.")
command = f"poetry add --lock git+https://github.com/nautobot/nautobot.git#{context.nautobot_floor_plan.nautobot_ver}"
if constrain_python_ver:
command += f" --python {context.nautobot_floor_plan.python_ver}"
run_command(context, command)
else:
command = f"poetry {'check' if check else 'lock --no-update'}"
run_command(context, command)
# ------------------------------------------------------------------------------
# START / STOP / DEBUG
# ------------------------------------------------------------------------------
@task(help={"service": "If specified, only affect this service."})
def debug(context, service=""):
"""Start specified or all services and its dependencies in debug mode."""
print(f"Starting {service} in debug mode...")
docker_compose(context, "up", service=service)
@task(help={"service": "If specified, only affect this service."})
def start(context, service=""):
"""Start specified or all services and its dependencies in detached mode."""
print("Starting Nautobot in detached mode...")
docker_compose(context, "up --detach", service=service)
@task(help={"service": "If specified, only affect this service."})
def restart(context, service=""):
"""Gracefully restart specified or all services."""
print("Restarting Nautobot...")
docker_compose(context, "restart", service=service)
@task(help={"service": "If specified, only affect this service."})
def stop(context, service=""):
"""Stop specified or all services, if service is not specified, remove all containers."""
print("Stopping Nautobot...")
docker_compose(context, "stop" if service else "down --remove-orphans", service=service)
@task(
aliases=("down",),
help={
"volumes": "Remove Docker compose volumes (default: True)",
"import-db-file": "Import database from `import-db-file` file into the fresh environment (default: empty)",
},
)
def destroy(context, volumes=True, import_db_file=""):
"""Destroy all containers and volumes."""
print("Destroying Nautobot...")
docker_compose(context, f"down --remove-orphans {'--volumes' if volumes else ''}")
if not import_db_file:
return
if not volumes:
raise ValueError("Cannot specify `--no-volumes` and `--import-db-file` arguments at the same time.")
print(f"Importing database file: {import_db_file}...")
input_path = Path(import_db_file).absolute()
if not input_path.is_file():
raise ValueError(f"File not found: {input_path}")
command = [
"run",
"--rm",
"--detach",
f"--volume='{input_path}:/docker-entrypoint-initdb.d/dump.sql'",
"--",
"db",
]
container_id = docker_compose(context, " ".join(command), pty=False, echo=False, hide=True).stdout.strip()
_await_healthy_container(context, container_id)
print("Stopping database container...")
context.run(f"docker stop {container_id}", pty=False, echo=False, hide=True)
print("Database import complete, you can start Nautobot with the following command:")
print("invoke start")
@task
def export(context):
"""Export docker compose configuration to `compose.yaml` file.
Useful to:
- Debug docker compose configuration.
- Allow using `docker compose` command directly without invoke.
"""
docker_compose(context, "convert > compose.yaml")
@task(name="ps", help={"all": "Show all, including stopped containers"})
def ps_task(context, all=False):
"""List containers."""
docker_compose(context, f"ps {'--all' if all else ''}")
@task
def vscode(context):
"""Launch Visual Studio Code with the appropriate Environment variables to run in a container."""
command = "code nautobot.code-workspace"
context.run(command)
@task(
help={
"service": "If specified, only display logs for this service (default: all)",
"follow": "Flag to follow logs (default: False)",
"tail": "Tail N number of lines (default: all)",
}
)
def logs(context, service="", follow=False, tail=0):
"""View the logs of a docker compose service."""
command = "logs "
if follow:
command += "--follow "
if tail:
command += f"--tail={tail} "
docker_compose(context, command, service=service)
# ------------------------------------------------------------------------------
# ACTIONS
# ------------------------------------------------------------------------------
@task(
help={
"file": "Python file to execute",
"env": "Environment variables to pass to the command",
"plain": "Flag to run nbshell in plain mode (default: False)",
},
)
def nbshell(context, file="", env={}, plain=False):
"""Launch an interactive nbshell session."""
command = [
"nautobot-server",
"nbshell",
"--plain" if plain else "",
f"< '{file}'" if file else "",
]
run_command(context, " ".join(command), pty=not bool(file), command_env=env)
@task
def shell_plus(context):
"""Launch an interactive shell_plus session."""
command = "nautobot-server shell_plus"
run_command(context, command)
@task
def cli(context):
"""Launch a bash shell inside the Nautobot container."""
run_command(context, "bash")
@task(
help={
"user": "name of the superuser to create (default: admin)",
}
)
def createsuperuser(context, user="admin"):
"""Create a new Nautobot superuser account (default: "admin"), will prompt for password."""
command = f"nautobot-server createsuperuser --username {user}"
run_command(context, command)
@task(
help={
"name": "name of the migration to be created; if unspecified, will autogenerate a name",
}
)
def makemigrations(context, name=""):
"""Perform makemigrations operation in Django."""
command = "nautobot-server makemigrations nautobot_floor_plan"
if name:
command += f" --name {name}"
run_command(context, command)
@task
def migrate(context):
"""Perform migrate operation in Django."""
command = "nautobot-server migrate"
run_command(context, command)
@task(help={})
def post_upgrade(context):
"""
Performs Nautobot common post-upgrade operations using a single entrypoint.
This will run the following management commands with default settings, in order:
- migrate
- trace_paths
- collectstatic
- remove_stale_contenttypes
- clearsessions
- invalidate all
"""
command = "nautobot-server post_upgrade"
run_command(context, command)
@task(
help={
"service": "Docker compose service name to run command in (default: nautobot).",
"command": "Command to run (default: bash).",
"file": "File to run command with (default: empty)",
},
)
def exec(context, service="nautobot", command="bash", file=""):
"""Launch a command inside the running container (defaults to bash shell inside nautobot container)."""
command = [
"exec",
"--",
service,
command,
f"< '{file}'" if file else "",
]
docker_compose(context, " ".join(command), pty=not bool(file))
@task(
help={
"db-name": "Database name (default: Nautobot database)",
"input-file": "SQL file to execute and quit (default: empty, start interactive CLI)",
"output-file": "Ouput file, overwrite if exists (default: empty, output to stdout)",
"query": "SQL command to execute and quit (default: empty)",
}
)
def dbshell(context, db_name="", input_file="", output_file="", query=""):
"""Start database CLI inside the running `db` container.
Doesn't use `nautobot-server dbshell`, using started `db` service container only.
"""
if input_file and query:
raise ValueError("Cannot specify both, `input_file` and `query` arguments")
if output_file and not (input_file or query):
raise ValueError("`output_file` argument requires `input_file` or `query` argument")
env = {}
if query:
env["_SQL_QUERY"] = query
command = [
"exec",
"--env=_SQL_QUERY" if query else "",
"-- db sh -c '",
]
if _is_compose_included(context, "mysql"):
command += [
"mysql",
"--user=$MYSQL_USER",
"--password=$MYSQL_PASSWORD",
f"--database={db_name or '$MYSQL_DATABASE'}",
]
elif _is_compose_included(context, "postgres"):
command += [
"psql",
"--username=$POSTGRES_USER",
f"--dbname={db_name or '$POSTGRES_DB'}",
]
else:
raise ValueError("Unsupported database backend.")
command += [
"'",
'<<<"$_SQL_QUERY"' if query else "",
f"< '{input_file}'" if input_file else "",
f"> '{output_file}'" if output_file else "",
]
docker_compose(
context,
" ".join(command),
env=env,
pty=not (input_file or output_file or query),
)
@task(
help={
"db-name": "Database name to create (default: Nautobot database)",
"input-file": "SQL dump file to replace the existing database with. This can be generated using `invoke backup-db` (default: `dump.sql`).",
}
)
def import_db(context, db_name="", input_file="dump.sql"):
"""Stop Nautobot containers and replace the current database with the dump into `db` container."""
docker_compose(context, "stop -- nautobot worker beat")
start(context, "db")
_await_healthy_service(context, "db")
command = ["exec -- db sh -c '"]
if _is_compose_included(context, "mysql"):
if not db_name:
db_name = "$MYSQL_DATABASE"
command += [
"mysql --user root --password=$MYSQL_ROOT_PASSWORD",
'--execute="',
f"DROP DATABASE IF EXISTS {db_name};",
f"CREATE DATABASE {db_name};",
(
""
if db_name == "$MYSQL_DATABASE"
else f"GRANT ALL PRIVILEGES ON {db_name}.* TO $MYSQL_USER; FLUSH PRIVILEGES;"
),
'"',
"&&",
"mysql",
f"--database={db_name}",
"--user=$MYSQL_USER",
"--password=$MYSQL_PASSWORD",
]
elif _is_compose_included(context, "postgres"):
if not db_name:
db_name = "$POSTGRES_DB"
command += [
f"dropdb --if-exists --user=$POSTGRES_USER {db_name} &&",
f"createdb --user=$POSTGRES_USER {db_name} &&",
f"psql --user=$POSTGRES_USER --dbname={db_name}",
]
else:
raise ValueError("Unsupported database backend.")
command += [
"'",
f"< '{input_file}'",
]
docker_compose(context, " ".join(command), pty=False)
print("Database import complete, you can start Nautobot now: `invoke start`")
@task(
help={
"db-name": "Database name to backup (default: Nautobot database)",
"output-file": "Ouput file, overwrite if exists (default: `dump.sql`)",
"readable": "Flag to dump database data in more readable format (default: `True`)",
}
)
def backup_db(context, db_name="", output_file="dump.sql", readable=True):
"""Dump database into `output_file` file from `db` container."""
start(context, "db")
_await_healthy_service(context, "db")
command = ["exec -- db sh -c '"]
if _is_compose_included(context, "mysql"):
command += [
"mysqldump",
"--user=root",
"--password=$MYSQL_ROOT_PASSWORD",
"--skip-extended-insert" if readable else "",
db_name if db_name else "$MYSQL_DATABASE",
]
elif _is_compose_included(context, "postgres"):
command += [
"pg_dump",
"--username=$POSTGRES_USER",
f"--dbname={db_name or '$POSTGRES_DB'}",
"--inserts" if readable else "",
]
else:
raise ValueError("Unsupported database backend.")
command += [
"'",
f"> '{output_file}'",
]
docker_compose(context, " ".join(command), pty=False)
print(50 * "=")
print("The database backup has been successfully completed and saved to the following file:")
print(output_file)
print("You can import this database backup with the following command:")
print(f"invoke import-db --input-file '{output_file}'")
print(50 * "=")
# ------------------------------------------------------------------------------
# DOCS
# ------------------------------------------------------------------------------
@task
def docs(context):
"""Build and serve docs locally for development."""
command = "mkdocs serve -v"
if is_truthy(context.nautobot_floor_plan.local):
print(">>> Serving Documentation at http://localhost:8001")
run_command(context, command)
else:
start(context, service="docs")
@task
def build_and_check_docs(context):
"""Build documentation to be available within Nautobot."""
command = "mkdocs build --no-directory-urls --strict"
run_command(context, command)
@task(name="help")
def help_task(context):
"""Print the help of available tasks."""
import tasks # pylint: disable=all
root = Collection.from_module(tasks)
for task_name in sorted(root.task_names):
print(50 * "-")
print(f"invoke {task_name} --help")
context.run(f"invoke {task_name} --help")
@task(
help={
"version": "Version of Nautobot Floor Plan to generate the release notes for.",
}
)
def generate_release_notes(context, version=""):
"""Generate Release Notes using Towncrier."""
command = "poetry run towncrier build"
if version:
command += f" --version {version}"
else:
command += " --version `poetry version -s`"
# Due to issues with git repo ownership in the containers, this must always run locally.
context.run(command)
# ------------------------------------------------------------------------------
# TESTS
# ------------------------------------------------------------------------------
@task
def hadolint(context):
"""Check Dockerfile for hadolint compliance and other style issues."""
command = "hadolint development/Dockerfile"
run_command(context, command)
@task
def pylint(context):
"""Run pylint code analysis."""
exit_code = 0
base_pylint_command = 'pylint --verbose --init-hook "import nautobot; nautobot.setup()" --rcfile pyproject.toml'
command = f"{base_pylint_command} nautobot_floor_plan"
if not run_command(context, command, warn=True):
exit_code = 1
# run the pylint_django migrations checkers on the migrations directory, if one exists
migrations_dir = Path(__file__).absolute().parent / Path("nautobot_floor_plan") / Path("migrations")
if migrations_dir.is_dir():
migrations_pylint_command = (
f"{base_pylint_command} --load-plugins=pylint_django.checkers.migrations"
" --disable=all --enable=fatal,missing-backwards-migration-callable"
" nautobot_floor_plan.migrations"
)
if not run_command(context, migrations_pylint_command, warn=True):
exit_code = 1
else:
print("No migrations directory found, skipping migrations checks.")
raise Exit(code=exit_code)
@task(aliases=("a",))
def autoformat(context):
"""Run code autoformatting."""
ruff(context, action=["format"], fix=True)
@task(
help={
"action": "Available values are `['lint', 'format']`. Can be used multiple times. (default: `['lint', 'format']`)",
"target": "File or directory to inspect, repeatable (default: all files in the project will be inspected)",
"fix": "Automatically fix selected actions. May not be able to fix all issues found. (default: False)",
"output_format": "See https://docs.astral.sh/ruff/settings/#output-format for details. (default: `concise`)",
},
iterable=["action", "target"],
)
def ruff(context, action=None, target=None, fix=False, output_format="concise"):
"""Run ruff to perform code formatting and/or linting."""
if not action:
action = ["lint", "format"]
if not target:
target = ["."]
exit_code = 0
if "format" in action:
command = "ruff format "
if not fix:
command += "--check "
command += " ".join(target)
if not run_command(context, command, warn=True):
exit_code = 1
if "lint" in action:
command = "ruff check "
if fix:
command += "--fix "
command += f"--output-format {output_format} "
command += " ".join(target)
if not run_command(context, command, warn=True):
exit_code = 1
raise Exit(code=exit_code)
@task
def yamllint(context):
"""Run yamllint to validate formatting adheres to NTC defined YAML standards.
Args:
context (obj): Used to run specific commands
"""
command = "yamllint . --format standard"
run_command(context, command)
@task
def check_migrations(context):
"""Check for missing migrations."""
command = "nautobot-server makemigrations --dry-run --check"
run_command(context, command)
@task(
help={
"keepdb": "save and re-use test database between test runs for faster re-testing.",
"label": "specify a directory or module to test instead of running all Nautobot tests",
"failfast": "fail as soon as a single test fails don't run the entire test suite",
"buffer": "Discard output from passing tests",
"pattern": "Run specific test methods, classes, or modules instead of all tests",
"verbose": "Enable verbose test output.",
}
)
def unittest( # noqa: PLR0913
context,
keepdb=False,
label="nautobot_floor_plan",
failfast=False,
buffer=True,
pattern="",
verbose=False,
):
"""Run Nautobot unit tests."""
command = f"coverage run --module nautobot.core.cli test {label}"
if keepdb:
command += " --keepdb"
if failfast:
command += " --failfast"
if buffer:
command += " --buffer"
if pattern:
command += f" -k='{pattern}'"
if verbose:
command += " --verbosity 2"
run_command(context, command)
@task
def unittest_coverage(context):
"""Report on code test coverage as measured by 'invoke unittest'."""
command = "coverage report --skip-covered --include 'nautobot_floor_plan/*' --omit *migrations*"
run_command(context, command)
@task(
help={
"failfast": "fail as soon as a single test fails don't run the entire test suite. (default: False)",
"keepdb": "Save and re-use test database between test runs for faster re-testing. (default: False)",
"lint-only": "Only run linters; unit tests will be excluded. (default: False)",
}
)
def tests(context, failfast=False, keepdb=False, lint_only=False):
"""Run all tests for this app."""
# If we are not running locally, start the docker containers so we don't have to for each test
if not is_truthy(context.nautobot_floor_plan.local):
print("Starting Docker Containers...")
start(context)
# Sorted loosely from fastest to slowest
print("Running ruff...")
ruff(context)
print("Running yamllint...")
yamllint(context)
print("Running poetry check...")
lock(context, check=True)
print("Running migrations check...")
check_migrations(context)
print("Running pylint...")
pylint(context)
print("Running mkdocs...")
build_and_check_docs(context)
print("Checking app config schema...")
validate_app_config(context)
if not lint_only:
print("Running unit tests...")
unittest(context, failfast=failfast, keepdb=keepdb)
unittest_coverage(context)
print("All tests have passed!")
@task
def generate_app_config_schema(context):
"""Generate the app config schema from the current app config.
WARNING: Review and edit the generated file before committing.
Its content is inferred from:
- The current configuration in `PLUGINS_CONFIG`
- `NautobotAppConfig.default_settings`
- `NautobotAppConfig.required_settings`
"""
start(context, service="nautobot")
nbshell(
context,
file="development/app_config_schema.py",
env={"APP_CONFIG_SCHEMA_COMMAND": "generate"},
)
@task
def validate_app_config(context):
"""Validate the app config based on the app config schema."""
start(context, service="nautobot")
nbshell(
context,
plain=True,
file="development/app_config_schema.py",
env={"APP_CONFIG_SCHEMA_COMMAND": "validate"},
)