Version 2.6.0

Author: miaow2

.github/workflows/commit.yaml

@@ -24,14 +24,14 @@ jobs:
       - name: Run ruff format
         run: ruff format .
       - name: Run ruff
-        run: ruff .
+        run: ruff check .
 
   test:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 10
       matrix:
-        netbox_version: ["v3.5.9", "v3.6.9", "v3.7.8"]
+        netbox_version: ["v3.6.9", "v3.7.8", "v4.0.7"]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

README.md

@@ -1,4 +1,4 @@
-[![NetBox version](https://img.shields.io/badge/NetBox-3.5|3.6-blue.svg)](https://github.com/netbox-community/netbox)
+[![NetBox version](https://img.shields.io/badge/NetBox-3.6|3.7|4.0-blue.svg)](https://github.com/netbox-community/netbox)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/netbox-config-diff.svg)](https://pypi.org/project/netbox-config-diff/)
 [![PyPI version](https://badge.fury.io/py/netbox-config-diff.svg)](https://badge.fury.io/py/netbox-config-diff)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -42,9 +42,10 @@ This is possible thanks to the scrapli_cfg. Read [Scrapli](https://github.com/sc
 
 ## Compatibility
 
-| NetBox Version | Plugin Version |
-|----------------|----------------|
-|  3.5, 3.6, 3.7 |    =>0.1.0     |
+| NetBox Version | Plugin Version   |
+|----------------|------------------|
+|  3.5           | =>0.1.0, <=2.5.0 |
+|  3.6, 3.7, 4.0 |      =>0.1.0     |
 
 <!--install-start-->
 ## Installing
@@ -107,7 +108,7 @@ Read this [doc](https://miaow2.github.io/netbox-config-diff/colliecting-diffs/)
 
 ## Video
 
-My presention about plugin at October NetBox community call (19.10.2023).
+My presention about plugin at October NetBox community call (19.10.2023, plugin version 2.0.0).
 
 [![October NetBox community call](https://img.youtube.com/vi/B4uhtYh278o/0.jpg)](https://youtu.be/B4uhtYh278o?t=425)
 <!--usage-end-->

development/Dockerfile

@@ -6,7 +6,7 @@ ENV PYTHONDONTWRITEBYTECODE 1
 ARG NETBOX_VERSION
 
 RUN apt-get update \
-    && apt-get install -y --no-install-recommends git \
+    && apt-get install -y --no-install-recommends git postgresql-client libpq-dev gcc build-essential \
     && pip install --upgrade pip
 
 # Install NetBox

docs/changelog.md

@@ -1,6 +1,12 @@
 # Changelog
 
 
+## 2.6.0 (2024-07-14)
+
+* [#62](https://github.com/miaow2/netbox-config-diff/issues/62) Add support for NetBox 4.0
+
+This release drops support for NetBox 3.5.
+
 ## 2.5.0 (2024-06-30)
 
 * [#67](https://github.com/miaow2/netbox-config-diff/issues/67) Add option `default_desired_privilege_level` to plugins variables (thanks to [@cknost](https://github.com/cknost))

netbox_config_diff/__init__.py

@@ -1,8 +1,14 @@
-from extras.plugins import PluginConfig
+from netbox.settings import VERSION
+
+if VERSION.startswith("3."):
+    from extras.plugins import PluginConfig
+else:
+    from netbox.plugins import PluginConfig
+
 
 __author__ = "Artem Kotik"
 __email__ = "[email protected]"
-__version__ = "2.5.0"
+__version__ = "2.6.0"
 
 
 class ConfigDiffConfig(PluginConfig):
@@ -14,7 +20,7 @@ class ConfigDiffConfig(PluginConfig):
     version = __version__
     base_url = "config-diff"
     required_settings = ["USERNAME", "PASSWORD"]
-    min_version = "3.5.0"
+    min_version = "3.6.0"
     default_settings = {
         "USER_SECRET_ROLE": "Username",
         "PASSWORD_SECRET_ROLE": "Password",

netbox_config_diff/api/serializers.py

@@ -2,16 +2,22 @@
 from dcim.models import Device
 from netbox.api.fields import ChoiceField, SerializedPKRelatedField
 from netbox.api.serializers import NetBoxModelSerializer
+from netbox.settings import VERSION
 from rest_framework import serializers
 from rest_framework.serializers import ValidationError
 from users.api.nested_serializers import NestedUserSerializer
-from utilities.utils import local_now
 
 from netbox_config_diff.choices import ConfigComplianceStatusChoices, ConfigurationRequestStatusChoices
 from netbox_config_diff.constants import ACCEPTABLE_DRIVERS
 from netbox_config_diff.models import ConfigCompliance, ConfigurationRequest, PlatformSetting, Substitute
 
+if VERSION.startswith("3."):
+    from utilities.utils import local_now
+else:
+    from utilities.datetime import local_now
 
+
+# TODO: after droping support for NetBox 3.x, delete nested serializers and add brief_fields
 class ConfigComplianceSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(view_name="plugins-api:netbox_config_diff-api:configcompliance-detail")
     device = NestedDeviceSerializer()

netbox_config_diff/compliance/base.py

@@ -11,15 +11,20 @@
 from django.db.models import Q
 from extras.scripts import MultiObjectVar, ObjectVar, TextVar
 from jinja2.exceptions import TemplateError
+from netbox.settings import VERSION
 from netutils.config.compliance import diff_network_config
 from utilities.exceptions import AbortScript
-from utilities.utils import render_jinja2
 
 from netbox_config_diff.models import ConplianceDeviceDataClass
 
 from .secrets import SecretsMixin
 from .utils import PLATFORM_MAPPING, CustomChoiceVar, exclude_lines, get_remediation_commands, get_unified_diff
 
+if VERSION.startswith("3."):
+    from utilities.utils import render_jinja2
+else:
+    from utilities.jinja2 import render_jinja2
+
 
 class ConfigDiffBase(SecretsMixin):
     site = ObjectVar(

netbox_config_diff/compliance/secrets.py

@@ -2,11 +2,16 @@
 from typing import TYPE_CHECKING
 
 from dcim.models import Device
-from extras.plugins import get_installed_plugins, get_plugin_config
+from netbox.settings import VERSION
 
 if TYPE_CHECKING:
     from netbox_secrets.models import Secret
 
+if VERSION.startswith("3."):
+    from extras.plugins import get_installed_plugins, get_plugin_config
+else:
+    from netbox.plugins import get_installed_plugins, get_plugin_config
+
 
 class SecretsMixin:
     username: str

netbox_config_diff/configurator/base.py

@@ -7,11 +7,11 @@
 from asgiref.sync import sync_to_async
 from dcim.models import Device
 from jinja2.exceptions import TemplateError
+from netbox.settings import VERSION
 from netutils.config.compliance import diff_network_config
 from scrapli import AsyncScrapli
 from scrapli_cfg.platform.base.async_platform import AsyncScrapliCfgPlatform
 from scrapli_cfg.response import ScrapliCfgResponse
-from utilities.utils import NetBoxFakeRequest
 
 from netbox_config_diff.compliance.secrets import SecretsMixin
 from netbox_config_diff.compliance.utils import PLATFORM_MAPPING, get_remediation_commands, get_unified_diff
@@ -22,6 +22,11 @@
 
 from .factory import AsyncScrapliCfg
 
+if VERSION.startswith("3."):
+    from utilities.utils import NetBoxFakeRequest
+else:
+    from utilities.request import NetBoxFakeRequest
+
 
 class Configurator(SecretsMixin):
     def __init__(self, devices: Iterable[Device], request: NetBoxFakeRequest) -> None:

netbox_config_diff/forms/__init__.py

@@ -0,0 +1,23 @@
+from .general import (
+    ConfigComplianceFilterForm,
+    ConfigurationRequestFilterForm,
+    ConfigurationRequestForm,
+    ConfigurationRequestScheduleForm,
+    PlatformSettingBulkEditForm,
+    PlatformSettingFilterForm,
+    PlatformSettingForm,
+    SubstituteFilterForm,
+    SubstituteForm,
+)
+
+__all__ = [
+    "ConfigComplianceFilterForm",
+    "ConfigurationRequestFilterForm",
+    "ConfigurationRequestForm",
+    "ConfigurationRequestScheduleForm",
+    "PlatformSettingBulkEditForm",
+    "PlatformSettingFilterForm",
+    "PlatformSettingForm",
+    "SubstituteFilterForm",
+    "SubstituteForm",
+]