Refactor/import utils package

.devcontainer/README.md

@@ -98,6 +98,8 @@ Below are the dev container defaults. The field name to change these defaults is
 - Plugin loader: enabled; reads `.devcontainer/config/plugin-config.py` if present
 - If `plugin-config.py` is missing: plugin is enabled with empty config (features won’t work until configured)
 
+
+
 ## 🔧 Configuration
 
 ### NetBox Version and Environment (use .devcontainer/.env)

.devcontainer/scripts/diagnose.sh

@@ -1,8 +1,10 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 
 echo "🔍 DevContainer Startup Diagnostics"
 echo "=================================="
 
+PLUGIN_WS_DIR="${PLUGIN_DIR:-$(cd "$(dirname "$0")/../.." && pwd)}"
 echo "📍 Current working directory: $(pwd)"
 echo "👤 Current user: $(whoami)"
 echo "🆔 User ID: $(id)"
@@ -26,18 +28,20 @@ echo "  - Redis: $(timeout 3 bash -c 'cat < /dev/null > /dev/tcp/redis/6379' 2>/
 echo ""
 echo "🗂️ File System:"
 echo "  - NetBox venv: $(test -f /opt/netbox/venv/bin/activate && echo 'Exists' || echo 'Missing')"
-echo "  - Plugin directory: $(test -d /workspaces/netbox-librenms-plugin && echo 'Exists' || echo 'Missing')"
-echo "  - Setup script: $(test -f /workspaces/netbox-librenms-plugin/.devcontainer/scripts/setup.sh && echo 'Exists' || echo 'Missing')"
-echo "  - Start script: $(test -f /workspaces/netbox-librenms-plugin/.devcontainer/scripts/start-netbox.sh && echo 'Exists' || echo 'Missing')"
-echo "  - Start script executable: $(test -x /workspaces/netbox-librenms-plugin/.devcontainer/scripts/start-netbox.sh && echo 'Yes' || echo 'No')"
-echo "  - Plugin config: $(test -f /workspaces/netbox-librenms-plugin/.devcontainer/plugin-config.py && echo 'Found' || echo 'Missing (using defaults)')"
+echo "  - Plugin directory: $(test -d "$PLUGIN_WS_DIR" && echo 'Exists' || echo 'Missing')"
+echo "  - Setup script: $(test -f "$PLUGIN_WS_DIR/.devcontainer/scripts/setup.sh" && echo 'Exists' || echo 'Missing')"
+echo "  - Start script: $(test -f "$PLUGIN_WS_DIR/.devcontainer/scripts/start-netbox.sh" && echo 'Exists' || echo 'Missing')"
+echo "  - Start script executable: $(test -x "$PLUGIN_WS_DIR/.devcontainer/scripts/start-netbox.sh" && echo 'Yes' || echo 'No')"
+echo "  - Plugin config: $(test -f "$PLUGIN_WS_DIR/.devcontainer/config/plugin-config.py" && echo 'Found' || echo 'Missing (using defaults)')"
 echo "  - NetBox config path: /opt/netbox/netbox/netbox/configuration.py"
 
 echo ""
 echo "🚀 Process Status:"
 if [ -f /tmp/netbox.pid ]; then
   PID=$(cat /tmp/netbox.pid)
-  if kill -0 $PID 2>/dev/null; then
+  if [ -z "$PID" ]; then
+    echo "  - NetBox server: PID file exists but is empty"
+  elif kill -0 "$PID" 2>/dev/null; then
     echo "  - NetBox server: Running (PID: $PID)"
   else
     echo "  - NetBox server: PID file exists but process not running"

.devcontainer/scripts/load-aliases.sh

@@ -1,67 +1,225 @@
 #!/bin/bash
+# netbox-librenms-plugin devcontainer script
 # Quick alias loader for current session
 # Usage: source .devcontainer/scripts/load-aliases.sh
 
 export PATH="/opt/netbox/venv/bin:$PATH"
 export DEBUG="${DEBUG:-True}"
-PLUGIN_DIR="/workspaces/netbox-librenms-plugin"
+PLUGIN_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
 
-alias netbox-run-bg="$PLUGIN_DIR/.devcontainer/scripts/start-netbox.sh --background"
-alias netbox-run="$PLUGIN_DIR/.devcontainer/scripts/start-netbox.sh"
+# Clean up empty CA bundle vars (Compose/devcontainer inject "" when host var is
+# unset, which breaks requests/curl).  When setup.sh has installed custom CAs
+# into the system trust store, point to it instead.
+for _ca_var in REQUESTS_CA_BUNDLE SSL_CERT_FILE CURL_CA_BUNDLE; do
+  _val="${!_ca_var}"
+  if [ -z "$_val" ]; then
+    if [ -f /etc/ssl/certs/ca-certificates.crt ]; then
+      declare -x "$_ca_var=/etc/ssl/certs/ca-certificates.crt"
+    else
+      unset "$_ca_var"
+    fi
+  fi
+done
+unset _ca_var _val
+
+# Load shared process management helpers
+if ! source "$PLUGIN_DIR/.devcontainer/scripts/process-helpers.sh"; then
+  printf '%s\n' "Failed to load process-helpers.sh" >&2
+  return 1
+fi
+
+netbox-run-bg() { "$PLUGIN_DIR/.devcontainer/scripts/start-netbox.sh" --background; }
+netbox-run()    { "$PLUGIN_DIR/.devcontainer/scripts/start-netbox.sh"; }
 
 # Robust stop command that kills both tracked and orphaned processes
-alias netbox-stop='echo "🛑 Stopping NetBox and RQ workers..."; \
-  if [ -f /tmp/netbox.pid ]; then \
-    PID=$(cat /tmp/netbox.pid 2>/dev/null); \
-    if [ -n "$PID" ] && kill -0 "$PID" 2>/dev/null; then \
-      kill "$PID" 2>/dev/null || kill -9 "$PID" 2>/dev/null; \
-      echo "   Stopped NetBox (PID: $PID)"; \
-    fi; \
-    rm -f /tmp/netbox.pid; \
-  fi; \
-  if [ -f /tmp/rqworker.pid ]; then \
-    PID=$(cat /tmp/rqworker.pid 2>/dev/null); \
-    if [ -n "$PID" ] && kill -0 "$PID" 2>/dev/null; then \
-      kill "$PID" 2>/dev/null || kill -9 "$PID" 2>/dev/null; \
-      echo "   Stopped RQ worker (PID: $PID)"; \
-    fi; \
-    rm -f /tmp/rqworker.pid; \
-  fi; \
-  if pgrep -f "python.*rqworker" >/dev/null 2>&1; then \
-    ORPHAN_COUNT=$(pgrep -cf "python.*rqworker" 2>/dev/null || echo 0); \
-    pkill -9 -f "python.*rqworker" 2>/dev/null; \
-    echo "   Killed $ORPHAN_COUNT orphaned RQ worker(s)"; \
-  fi; \
-  if pgrep -f "python.*runserver.*8000" >/dev/null 2>&1; then \
-    pkill -9 -f "python.*runserver.*8000" 2>/dev/null; \
-    echo "   Killed orphaned NetBox server(s)"; \
-  fi; \
-  echo "✅ All processes stopped"'
-
-alias netbox-restart="netbox-stop && sleep 1 && netbox-run-bg"
-alias netbox-reload="cd $PLUGIN_DIR && (command -v uv >/dev/null 2>&1 && uv pip install -e . || pip install -e .) && netbox-restart"
+netbox-stop() {
+  echo "🛑 Stopping NetBox and RQ workers..."
+  if [ -f /tmp/netbox.pid ]; then
+    local PID
+    PID=$(cat /tmp/netbox.pid 2>/dev/null)
+    if [ -n "$PID" ] && kill -0 "$PID" 2>/dev/null; then
+      if is_expected_pid "$PID" "python.*runserver.*8000"; then
+        graceful_kill_pid "$PID"
+        echo "   Stopped NetBox (PID: $PID)"
+      else
+        echo "   Skipping stale /tmp/netbox.pid (PID $PID is not NetBox runserver)"
+      fi
+    fi
+    rm -f /tmp/netbox.pid
+  fi
+  if [ -f /tmp/rqworker.pid ]; then
+    local PID
+    PID=$(cat /tmp/rqworker.pid 2>/dev/null)
+    if [ -n "$PID" ] && kill -0 "$PID" 2>/dev/null; then
+      if is_expected_pid "$PID" "python.*rqworker"; then
+        graceful_kill_pid "$PID"
+        echo "   Stopped RQ worker (PID: $PID)"
+      else
+        echo "   Skipping stale /tmp/rqworker.pid (PID $PID is not rqworker)"
+      fi
+    fi
+    rm -f /tmp/rqworker.pid
+  fi
+  if pgrep -f "python.*rqworker" >/dev/null 2>&1; then
+    local ORPHAN_COUNT
+    ORPHAN_COUNT=$(pgrep -cf "python.*rqworker" 2>/dev/null || echo 0)
+    graceful_kill_pattern "python.*rqworker"
+    echo "   Killed $ORPHAN_COUNT orphaned RQ worker(s)"
+  fi
+  if pgrep -f "python.*runserver.*8000" >/dev/null 2>&1; then
+    graceful_kill_pattern "python.*runserver.*8000"
+    echo "   Killed orphaned NetBox server(s)"
+  fi
+  echo "✅ All processes stopped"
+}
+
+netbox-restart() {
+  netbox-stop && sleep 1 && netbox-run-bg
+}
+
+netbox-reload() {
+  cd "$PLUGIN_DIR" || return 1
+  if command -v uv >/dev/null 2>&1; then
+    uv pip install -e . || return 1
+  else
+    pip install -e . || return 1
+  fi
+  netbox-restart
+}
 
 alias netbox-logs="tail -f /tmp/netbox.log"
-alias netbox-status="[ -f /tmp/netbox.pid ] && kill -0 \$(cat /tmp/netbox.pid) 2>/dev/null && echo 'NetBox is running (PID: '\$(cat /tmp/netbox.pid)')' || echo 'NetBox is not running'; [ -f /tmp/rqworker.pid ] && kill -0 \$(cat /tmp/rqworker.pid) 2>/dev/null && echo 'RQ worker is running (PID: '\$(cat /tmp/rqworker.pid)')' || echo 'RQ worker is not running'"
 alias rq-logs="tail -f /tmp/rqworker.log"
-alias rq-status="[ -f /tmp/rqworker.pid ] && kill -0 \$(cat /tmp/rqworker.pid) 2>/dev/null && echo 'RQ worker is running (PID: '\$(cat /tmp/rqworker.pid)')' || echo 'RQ worker is not running'"
-alias netbox-shell="cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell"
-alias netbox-test="cd $PLUGIN_DIR && source /opt/netbox/venv/bin/activate && python -m pytest"
-alias netbox-manage="cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py"
-alias plugin-install="cd $PLUGIN_DIR && (command -v uv >/dev/null 2>&1 && uv pip install -e . || pip install -e .)"
-alias ruff-check="cd $PLUGIN_DIR && ruff check ."
-alias ruff-format="cd $PLUGIN_DIR && ruff format ."
-alias ruff-fix="cd $PLUGIN_DIR && ruff check --fix ."
-alias diagnose="$PLUGIN_DIR/.devcontainer/scripts/diagnose.sh"
-alias plugins-install='if [ -f "$PLUGIN_DIR/.devcontainer/extra-requirements.txt" ]; then source /opt/netbox/venv/bin/activate && pip install -r "$PLUGIN_DIR/.devcontainer/extra-requirements.txt"; else echo "No .devcontainer/extra-requirements.txt found"; fi'
+
+netbox-status() {
+  local PID
+  if [ -f /tmp/netbox.pid ]; then
+    PID=$(cat /tmp/netbox.pid 2>/dev/null)
+    if [ -n "$PID" ] && is_expected_pid "$PID" "python.*runserver.*8000"; then
+      echo "NetBox is running (PID: $PID)"
+    else
+      echo "NetBox is not running"
+    fi
+  else
+    echo "NetBox is not running"
+  fi
+  if [ -f /tmp/rqworker.pid ]; then
+    PID=$(cat /tmp/rqworker.pid 2>/dev/null)
+    if [ -n "$PID" ] && is_expected_pid "$PID" "python.*rqworker"; then
+      echo "RQ worker is running (PID: $PID)"
+    else
+      echo "RQ worker is not running"
+    fi
+  else
+    echo "RQ worker is not running"
+  fi
+}
+
+rq-status() {
+  local PID
+  if [ -f /tmp/rqworker.pid ]; then
+    PID=$(cat /tmp/rqworker.pid 2>/dev/null)
+    if [ -n "$PID" ] && is_expected_pid "$PID" "python.*rqworker"; then
+      echo "RQ worker is running (PID: $PID)"
+    else
+      echo "RQ worker is not running"
+    fi
+  else
+    echo "RQ worker is not running"
+  fi
+}
+
+netbox-shell() {
+  cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell
+}
+
+netbox-test() {
+  cd "$PLUGIN_DIR" && source /opt/netbox/venv/bin/activate && python -m pytest "$@"
+}
+
+netbox-manage() {
+  cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py "$@"
+}
+
+plugin-install() {
+  cd "$PLUGIN_DIR" || return 1
+  if command -v uv >/dev/null 2>&1; then
+    uv pip install -e .
+  else
+    pip install -e .
+  fi
+}
+
+plugins-install() {
+  if [ -f "$PLUGIN_DIR/.devcontainer/extra-requirements.txt" ]; then
+    source /opt/netbox/venv/bin/activate && pip install -r "$PLUGIN_DIR/.devcontainer/extra-requirements.txt"
+  else
+    echo "No .devcontainer/extra-requirements.txt found"
+  fi
+}
+
+ruff-check() { cd "$PLUGIN_DIR" && command ruff check .; }
+ruff-format() { cd "$PLUGIN_DIR" && command ruff format .; }
+ruff-fix()    { cd "$PLUGIN_DIR" && command ruff check --fix .; }
+
+diagnose() { "$PLUGIN_DIR/.devcontainer/scripts/diagnose.sh"; }
 
 # RQ job inspection commands
-alias rq-stats="cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py rqstats"
-alias rq-jobs="cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell -c \"from django_rq import get_queue; q = get_queue('default'); print(f'Jobs in queue: {len(q)}'); [print(f'  {job.id[:8]}: {job.func_name} - {job.get_status()}') for job in q.jobs[:10]]\""
-alias rq-failed="cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell -c \"from django_rq import get_failed_queue; q = get_failed_queue(); print(f'Failed jobs: {len(q)}'); [print(f'  {job.id[:8]}: {job.func_name}') for job in q.jobs[:10]]\""
-alias rq-recent="cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell -c \"from core.models import Job; jobs = Job.objects.all().order_by('-created')[:10]; [print(f'{j.id}: {j.name[:50]} - {getattr(j.status, \\\"value\\\", j.status)} ({j.user})') for j in jobs]\""
+rq-stats() {
+  cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py rqstats
+}
+
+rq-jobs() {
+  cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell -c \
+    "from django_rq import get_queue; q = get_queue('default'); print(f'Jobs in queue: {len(q)}'); [print(f'  {job.id[:8]}: {job.func_name} - {job.get_status()}') for job in q.jobs[:10]]"
+}
+
+rq-failed() {
+  cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell -c \
+    "from django_rq import get_failed_queue; q = get_failed_queue(); print(f'Failed jobs: {len(q)}'); [print(f'  {job.id[:8]}: {job.func_name}') for job in q.jobs[:10]]"
+}
+
+rq-recent() {
+  cd /opt/netbox/netbox && source /opt/netbox/venv/bin/activate && python manage.py shell -c \
+    "from core.models import Job; jobs = Job.objects.all().order_by('-created')[:10]; [print(f'{j.id}: {j.name[:50]} - {getattr(j.status, \"value\", j.status)} ({j.user})') for j in jobs]"
+}
 
 # Help
-alias dev-help='echo "🎯 NetBox LibreNMS Plugin Development Commands:"; echo ""; echo "📊 NetBox Server Management:"; echo "  netbox-run-bg       : Start NetBox in background"; echo "  netbox-run          : Start NetBox in foreground (for debugging)"; echo "  netbox-stop         : Stop NetBox and RQ worker"; echo "  netbox-restart      : Restart NetBox and RQ worker"; echo "  netbox-reload       : Reinstall plugin and restart NetBox"; echo "  netbox-status       : Check if NetBox and RQ worker are running"; echo "  netbox-logs         : View NetBox server logs"; echo ""; echo "⚙️  Background Jobs (RQ Worker):"; echo "  rq-status           : Check if RQ worker is running"; echo "  rq-logs             : View RQ worker logs"; echo "  rq-stats            : Show RQ queue statistics"; echo "  rq-jobs             : List jobs in default queue"; echo "  rq-failed           : List failed jobs"; echo "  rq-recent           : Show recent NetBox jobs"; echo ""; echo "🛠️  Development Tools:"; echo "  netbox-shell        : Open NetBox Django shell"; echo "  netbox-test         : Run plugin tests"; echo "  netbox-manage       : Run Django management commands"; echo "  plugin-install      : Reinstall plugin in development mode"; echo ""; echo "🧹 Code Quality:"; echo "  ruff-check          : Check code with Ruff"; echo "  ruff-format         : Format code with Ruff"; echo "  ruff-fix            : Auto-fix code issues with Ruff"; echo ""; echo "🔎 Diagnostics:"; echo "  diagnose            : Run startup diagnostics"; echo "  dev-help            : Show this help message"; echo ""; echo "📖 NetBox available at: http://localhost:8000 (admin/admin)"; echo ""'
+dev-help() {
+  echo "🎯 NetBox LibreNMS Plugin Development Commands:"
+  echo ""
+  echo "📊 NetBox Server Management:"
+  echo "  netbox-run-bg       : Start NetBox in background"
+  echo "  netbox-run          : Start NetBox in foreground (for debugging)"
+  echo "  netbox-stop         : Stop NetBox and RQ worker"
+  echo "  netbox-restart      : Restart NetBox and RQ worker"
+  echo "  netbox-reload       : Reinstall plugin and restart NetBox"
+  echo "  netbox-status       : Check if NetBox and RQ worker are running"
+  echo "  netbox-logs         : View NetBox server logs"
+  echo ""
+  echo "⚙️  Background Jobs (RQ Worker):"
+  echo "  rq-status           : Check if RQ worker is running"
+  echo "  rq-logs             : View RQ worker logs"
+  echo "  rq-stats            : Show RQ queue statistics"
+  echo "  rq-jobs             : List jobs in default queue"
+  echo "  rq-failed           : List failed jobs"
+  echo "  rq-recent           : Show recent NetBox jobs"
+  echo ""
+  echo "🛠️  Development Tools:"
+  echo "  netbox-shell        : Open NetBox Django shell"
+  echo "  netbox-test         : Run plugin tests"
+  echo "  netbox-manage       : Run Django management commands"
+  echo "  plugin-install      : Reinstall plugin in development mode"
+  echo ""
+  echo "🧹 Code Quality:"
+  echo "  ruff-check          : Check code with Ruff"
+  echo "  ruff-format         : Format code with Ruff"
+  echo "  ruff-fix            : Auto-fix code issues with Ruff"
+  echo ""
+  echo "🔎 Diagnostics:"
+  echo "  diagnose            : Run startup diagnostics"
+  echo "  dev-help            : Show this help message"
+  echo ""
+  echo "📖 NetBox available at: http://localhost:8000 (admin/admin)"
+}
 
 echo "✅ Aliases loaded! Try: rq-status, rq-stats, rq-recent, dev-help"

.devcontainer/scripts/process-helpers.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+# Shared process management helpers.
+# Sourced by load-aliases.sh and start-netbox.sh.
+
+# Graceful termination: SIGTERM, wait, then SIGKILL if still alive.
+graceful_kill_pid() {
+  local pid="$1"
+  kill -15 "$pid" 2>/dev/null
+  sleep 2
+  kill -0 "$pid" 2>/dev/null && kill -9 "$pid" 2>/dev/null
+}
+
+graceful_kill_pattern() {
+  local pattern="$1"
+  pkill -15 -f "$pattern" 2>/dev/null
+  sleep 2
+  pgrep -f "$pattern" >/dev/null 2>&1 && pkill -9 -f "$pattern" 2>/dev/null
+}
+
+# Verify a PID matches the expected process before killing it
+is_expected_pid() {
+  local pid="$1" pattern="$2"
+  ps -p "$pid" -o args= 2>/dev/null | grep -Eq "$pattern"
+}