feat: NetBox compatibility checker script

Author: snaselj

netbox-checker/netbox_checker/__init__.py

@@ -0,0 +1,5 @@
+from .checker import check_netbox
+
+__all__ = [
+    "check_netbox",
+]

netbox-checker/netbox_checker/checker.py

@@ -0,0 +1,52 @@
+"""NetBox check script to validate data before importing to Nautobot."""
+
+import sys
+from os import getenv
+
+from django.apps import apps
+from django.urls import reverse
+
+_SETTINGS = {
+    "max_outputs": 0,
+    "base_url": "",
+}
+
+
+def _print_issues(message: str, queryset):
+    """Print issues to the console."""
+    for obj in queryset:
+        _SETTINGS["max_outputs"] -= 1
+        if _SETTINGS["max_outputs"] < 0:
+            sys.exit(0)
+
+        print(f"{message} {obj.id} {obj}")
+
+        app_label = obj._meta.app_label
+        model_name = obj._meta.model_name
+        url = reverse(f"{app_label}:{model_name}", kwargs={"pk": obj.id})
+        print(f"{_SETTINGS['base_url']}{url}")
+
+        print(100 * "-")
+
+
+def _find_missing_cables(side: str):
+    """Check for cables missing termination side `A` or `B`."""
+    Cable = apps.get_model("dcim", "Cable")
+    CableTermination = apps.get_model("dcim", "CableTermination")
+
+    cables_missing = Cable.objects.exclude(id__in=CableTermination.objects.filter(cable_end="A").values("cable_id"))
+
+    if cables_missing.count():
+        _print_issues(f"Missing cable termination on side {side}:", cables_missing)
+
+
+def check_netbox(
+    max_outputs=int(getenv("NETBOX_CHECKER_MAX_OUTPUTS") or 10),
+    base_url=getenv("NETBOX_CHECKER_BASE_URL", "http://localhost:8000"),
+):
+    """Main function."""
+    _SETTINGS["max_outputs"] = max_outputs
+    _SETTINGS["base_url"] = base_url
+
+    _find_missing_cables("A")
+    _find_missing_cables("B")

netbox-checker/pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "netbox-checker"
+version = "0.1.0"
+description = "Simple tool to check the status of a NetBox instance"
+requires-python = ">=3.8"
+dependencies = [
+    "requests",
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

netbox-checker/run.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+#
+# Usage with `netbox-community/netbox-docker`
+#
+# ./run.sh <netbox-docker-path>
+
+set -e
+
+if [[ $1 == "inside-docker" ]]; then
+  echo "Running inside container"
+
+  pip install -e /netbox-checker
+
+  /opt/netbox/netbox/manage.py nbshell \
+      --command='from netbox_checker import check_netbox; check_netbox()'
+else
+  echo "Running docker compose"
+
+  export NETBOX_CHECKER_PATH="$PWD"
+  export NETBOX_DOCKER_PATH=${1:-$NETBOX_CHECKER_PATH/../netbox-docker}
+
+  cd "$NETBOX_DOCKER_PATH"
+
+  docker compose run \
+    --user=root \
+    --env NETBOX_CHECKER_MAX_OUTPUTS \
+    --env NETBOX_CHECKER_BASE_URL \
+    --volume "$NETBOX_CHECKER_PATH:/netbox-checker" \
+    netbox /netbox-checker/run.sh inside-docker
+fi