Replace black, flake8, pydocstyle, bandit with ruff

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ env:
   PLUGIN_NAME: "nautobot-app-ssot"
 
 jobs:
-  black:
+  ruff:
     runs-on: "ubuntu-22.04"
     env:
       INVOKE_NAUTOBOT_SSOT_LOCAL: "True"
@@ -25,41 +25,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v4"
-      - name: "Linting: black"
-        run: "poetry run invoke black"
-  bandit:
-    runs-on: "ubuntu-22.04"
-    env:
-      INVOKE_NAUTOBOT_SSOT_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
-      - name: "Linting: bandit"
-        run: "poetry run invoke bandit"
-  pydocstyle:
-    runs-on: "ubuntu-22.04"
-    env:
-      INVOKE_NAUTOBOT_SSOT_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
-      - name: "Linting: pydocstyle"
-        run: "poetry run invoke pydocstyle"
-  flake8:
-    runs-on: "ubuntu-22.04"
-    env:
-      INVOKE_NAUTOBOT_SSOT_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
-      - name: "Linting: flake8"
-        run: "poetry run invoke flake8"
+      - name: "Linting: ruff"
+        run: "poetry run invoke ruff"
   poetry:
     runs-on: "ubuntu-22.04"
     env:
@@ -84,12 +51,9 @@ jobs:
         run: "poetry run invoke yamllint"
   pylint:
     needs:
-      - "bandit"
-      - "pydocstyle"
-      - "flake8"
       - "poetry"
       - "yamllint"
-      - "black"
+      - "ruff"
     runs-on: "ubuntu-22.04"
     strategy:
       fail-fast: true
@@ -127,12 +91,9 @@ jobs:
         run: "poetry run invoke pylint"
   check-migrations:
     needs:
-      - "bandit"
-      - "pydocstyle"
-      - "flake8"
       - "poetry"
       - "yamllint"
-      - "black"
+      - "ruff"
     runs-on: "ubuntu-22.04"
     strategy:
       fail-fast: true

.gitignore

@@ -1,6 +1,9 @@
 # Ansible Retry Files
 *.retry
 
+# Ruff Stuff
+.ruff_cache
+
 # Swap files
 *.swp
 

nautobot_ssot/__init__.py

@@ -1,10 +1,11 @@
 """App declaration for nautobot_ssot."""
-import os
 from importlib import metadata
+import os
 
 from django.conf import settings
-from nautobot.extras.plugins import NautobotAppConfig
+
 from nautobot.core.settings_funcs import is_truthy
+from nautobot.extras.plugins import NautobotAppConfig
 
 from nautobot_ssot.integrations.utils import each_enabled_integration_module
 from nautobot_ssot.utils import logger

nautobot_ssot/contrib.py

@@ -5,11 +5,11 @@
 from collections import defaultdict
 from dataclasses import dataclass
 
-import pydantic
-from diffsync import DiffSyncModel, DiffSync
+from diffsync import DiffSync, DiffSyncModel
 from django.contrib.contenttypes.models import ContentType
-from django.core.exceptions import ValidationError, MultipleObjectsReturned
+from django.core.exceptions import MultipleObjectsReturned, ValidationError
 from django.db.models import Model
+import pydantic
 from typing_extensions import get_type_hints
 
 

nautobot_ssot/filters.py

@@ -1,7 +1,7 @@
 """Filtering logic for Sync and SyncLogEntry records."""
 
-import django_filters
 from django.db.models import Q
+import django_filters
 
 from nautobot.apps.filters import BaseFilterSet
 

nautobot_ssot/forms.py

@@ -3,7 +3,7 @@
 from django import forms
 
 from nautobot.apps.forms import add_blank_choice
-from nautobot.core.forms import BootstrapMixin, BOOLEAN_WITH_BLANK_CHOICES
+from nautobot.core.forms import BOOLEAN_WITH_BLANK_CHOICES, BootstrapMixin
 
 from .choices import SyncLogEntryActionChoices, SyncLogEntryStatusChoices
 from .models import Sync, SyncLogEntry

nautobot_ssot/integrations/__init__.py

@@ -0,0 +1 @@
+"""Single Source of Truth integrations."""

nautobot_ssot/integrations/aci/diffsync/__init__.py

@@ -0,0 +1 @@
+"""ACI integration DiffSync adapters and models."""

nautobot_ssot/integrations/aci/diffsync/adapters/__init__.py

@@ -0,0 +1 @@
+"""ACI integration DiffSync adapters."""

nautobot_ssot/integrations/aci/diffsync/adapters/aci.py

@@ -2,27 +2,30 @@
 # pylint: disable=duplicate-code
 
 
+from ipaddress import ip_network
 import logging
 import os
 import re
 from typing import Optional
-from ipaddress import ip_network
+
 from diffsync import DiffSync
 from diffsync.exceptions import ObjectNotFound
+
 from nautobot_ssot.integrations.aci.constant import PLUGIN_CFG
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotTenant
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotVrf
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotDeviceType
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotDeviceRole
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotDevice
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotInterfaceTemplate
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotInterface
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotIPAddress
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotPrefix
 from nautobot_ssot.integrations.aci.diffsync.client import AciApi
+from nautobot_ssot.integrations.aci.diffsync.models import (
+    NautobotDevice,
+    NautobotDeviceRole,
+    NautobotDeviceType,
+    NautobotInterface,
+    NautobotInterfaceTemplate,
+    NautobotIPAddress,
+    NautobotPrefix,
+    NautobotTenant,
+    NautobotVrf,
+)
 from nautobot_ssot.integrations.aci.diffsync.utils import load_yamlfile
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -58,6 +61,8 @@ def __init__(self, *args, job=None, sync=None, client, **kwargs):
             job (object, optional): Aci job. Defaults to None.
             sync (object, optional): Aci DiffSync. Defaults to None.
             client (object): Aci credentials.
+            *args: Variable length argument list.
+            **kwargs: Arbitrary keyword arguments.
         """
         super().__init__(*args, **kwargs)
         self.job = job
@@ -80,7 +85,7 @@ def load_tenants(self):
         """Load tenants from ACI."""
         tenant_list = self.conn.get_tenants()
         for _tenant in tenant_list:
-            if not _tenant["name"] in PLUGIN_CFG.get("ignore_tenants"):
+            if _tenant["name"] not in PLUGIN_CFG.get("ignore_tenants"):
                 tenant_name = f"{self.tenant_prefix}:{_tenant['name']}"
                 new_tenant = self.tenant(
                     name=tenant_name,

nautobot_ssot/integrations/aci/diffsync/adapters/nautobot.py

@@ -1,27 +1,31 @@
 """DiffSync Adapter for Nautobot."""
 # pylint: disable=duplicate-code
 
-import logging
 from collections import defaultdict
+import logging
+
 from diffsync import DiffSync
 from diffsync.enum import DiffSyncModelFlags
 from django.contrib.contenttypes.models import ContentType
 from django.db.models import ProtectedError
-from nautobot.tenancy.models import Tenant
-from nautobot.dcim.models import DeviceType, Device, InterfaceTemplate, Interface
-from nautobot.extras.models import Role
+
+from nautobot.dcim.models import Device, DeviceType, Interface, InterfaceTemplate
+from nautobot.extras.models import Role, Tag
 from nautobot.ipam.models import IPAddress, Prefix, VRF
-from nautobot.extras.models import Tag
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotTenant
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotVrf
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotDeviceType
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotDeviceRole
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotDevice
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotInterfaceTemplate
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotInterface
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotIPAddress
-from nautobot_ssot.integrations.aci.diffsync.models import NautobotPrefix
+from nautobot.tenancy.models import Tenant
+
 from nautobot_ssot.integrations.aci.constant import PLUGIN_CFG
+from nautobot_ssot.integrations.aci.diffsync.models import (
+    NautobotDevice,
+    NautobotDeviceRole,
+    NautobotDeviceType,
+    NautobotInterface,
+    NautobotInterfaceTemplate,
+    NautobotIPAddress,
+    NautobotPrefix,
+    NautobotTenant,
+    NautobotVrf,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -60,6 +64,8 @@ def __init__(self, *args, job=None, sync=None, client, **kwargs):
             job (object, optional): Nautobot job. Defaults to None.
             sync (object, optional): Nautobot DiffSync. Defaults to None.
             client (object): ACI credentials.
+            *args: Variable length argument list.
+            **kwargs: Arbitrary keyword arguments.
         """
         super().__init__(*args, **kwargs)
         self.job = job
@@ -76,6 +82,8 @@ def sync_complete(self, source: DiffSync, *args, **kwargs):
 
         Args:
             source (DiffSync): DiffSync
+            *args: Variable length argument list.
+            **kwargs: Arbitrary keyword arguments.
         """
         for grouping in (
             "ipaddress",

nautobot_ssot/integrations/aci/diffsync/client.py

@@ -1,17 +1,17 @@
 """All interactions with ACI."""  # pylint: disable=too-many-lines, too-many-instance-attributes, too-many-arguments
 # pylint: disable=invalid-name
 
-import sys
+from datetime import datetime, timedelta
+from ipaddress import ip_network
 import logging
-from datetime import datetime
-from datetime import timedelta
 import re
-from ipaddress import ip_network
+import sys
+from typing import Optional
+
 import requests
 import urllib3
 
-from .utils import tenant_from_dn, ap_from_dn, node_from_dn, pod_from_dn, fex_id_from_dn, interface_from_dn
-
+from .utils import ap_from_dn, fex_id_from_dn, interface_from_dn, node_from_dn, pod_from_dn, tenant_from_dn
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
@@ -59,7 +59,9 @@ def _login(self):
             self.refresh_timeout = int(resp.json()["imdata"][0]["aaaLogin"]["attributes"]["refreshTimeoutSeconds"])
         return resp
 
-    def _handle_request(self, url: str, params: dict = None, request_type: str = "get", data: dict = None) -> object:
+    def _handle_request(
+        self, url: str, params: Optional[dict] = None, request_type: str = "get", data: Optional[dict] = None
+    ) -> object:
         """Send a REST API call to the APIC."""
         try:
             resp = requests.request(
@@ -92,7 +94,7 @@ def _handle_error(self, response: object):
             f"Error: {response.status_code}, Reason: {response.reason}"
         )
 
-    def _get(self, uri: str, params: dict = None) -> object:
+    def _get(self, uri: str, params: Optional[dict] = None) -> object:
         """Method to retrieve data from the ACI fabric."""
         url = self.base_uri + uri
         if self._refresh_token():
@@ -108,7 +110,7 @@ def _get(self, uri: str, params: dict = None) -> object:
             return resp
         return self._handle_error(resp)
 
-    def _post(self, uri: str, params: dict = None, data=None) -> object:
+    def _post(self, uri: str, params: Optional[dict] = None, data=None) -> object:
         """Method to post data to the ACI fabric."""
         url = self.base_uri + uri
         if self._refresh_token():
@@ -384,16 +386,16 @@ def get_nodes(self) -> dict:
         resp = self._get('/api/class/topSystem.json?query-target-filter=ne(topSystem.role,"controller")')
 
         for node in resp.json()["imdata"]:
-            if node["topSystem"]["attributes"]["oobMgmtAddr"] != "0.0.0.0":  # nosec: B104
+            if node["topSystem"]["attributes"]["oobMgmtAddr"] != "0.0.0.0":  # noqa: S104
                 mgmt_addr = f"{node['topSystem']['attributes']['oobMgmtAddr']}/{node['topSystem']['attributes']['oobMgmtAddrMask']}"
             elif (
-                node["topSystem"]["attributes"]["address"] != "0.0.0.0"  # nosec: B104
+                node["topSystem"]["attributes"]["address"] != "0.0.0.0"  # noqa: S104
                 and node["topSystem"]["attributes"]["tepPool"]
             ):
                 mgmt_addr = f"{node['topSystem']['attributes']['address']}/{ip_network(node['topSystem']['attributes']['tepPool'], strict=False).prefixlen}"
             else:
                 mgmt_addr = ""
-            if node["topSystem"]["attributes"]["tepPool"] != "0.0.0.0":  # nosec: B104
+            if node["topSystem"]["attributes"]["tepPool"] != "0.0.0.0":  # noqa: S104
                 subnet = node["topSystem"]["attributes"]["tepPool"]
             elif mgmt_addr:
                 subnet = ip_network(mgmt_addr, strict=False).with_prefixlen
@@ -437,16 +439,16 @@ def get_controllers(self) -> dict:
             node_dict[node_id]["site"] = self.site
         resp = self._get('/api/class/topSystem.json?query-target-filter=eq(topSystem.role,"controller")')
         for node in resp.json()["imdata"]:
-            if node["topSystem"]["attributes"]["oobMgmtAddr"] != "0.0.0.0":  # nosec: B104
+            if node["topSystem"]["attributes"]["oobMgmtAddr"] != "0.0.0.0":  # noqa: S104
                 mgmt_addr = f"{node['topSystem']['attributes']['oobMgmtAddr']}/{node['topSystem']['attributes']['oobMgmtAddrMask']}"
             elif (
-                node["topSystem"]["attributes"]["address"] != "0.0.0.0"  # nosec: B104
+                node["topSystem"]["attributes"]["address"] != "0.0.0.0"  # noqa: S104
                 and node["topSystem"]["attributes"]["tepPool"]
             ):
                 mgmt_addr = f"{node['topSystem']['attributes']['address']}/{ip_network(node['topSystem']['attributes']['tepPool'], strict=False).prefixlen}"
             else:
                 mgmt_addr = ""
-            if node["topSystem"]["attributes"]["tepPool"] != "0.0.0.0":  # nosec: B104
+            if node["topSystem"]["attributes"]["tepPool"] != "0.0.0.0":  # noqa: S104
                 subnet = node["topSystem"]["attributes"]["tepPool"]
             elif mgmt_addr:
                 subnet = ip_network(mgmt_addr, strict=False).with_prefixlen

nautobot_ssot/integrations/aci/diffsync/models/__init__.py

@@ -1,14 +1,14 @@
 """Initialize models for Nautobot and ACI."""
 from .nautobot import (
-    NautobotTenant,
-    NautobotVrf,
     NautobotDevice,
     NautobotDeviceRole,
     NautobotDeviceType,
-    NautobotInterfaceTemplate,
     NautobotInterface,
-    NautobotPrefix,
+    NautobotInterfaceTemplate,
     NautobotIPAddress,
+    NautobotPrefix,
+    NautobotTenant,
+    NautobotVrf,
 )
 
 __all__ = [