Prepare for upgrade to NetBox v4.0.6 (#40)

wkoot · web-flow · commit 86215f43a626 · 2024-07-09T22:15:58.000+02:00
Closes #38
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -16,13 +16,13 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: "3.9"
+        python-version: "3.11"
 
     - name: Install tools
       run: pip install .[tools]
 
-    - name: Run ruff
-      run: ruff netbox_slm
+    - name: Run ruff lint
+      run: ruff check netbox_slm
 
-    - name: Run black
-      run: black netbox_slm
+    - name: Run ruff format
+      run: ruff format netbox_slm
diff --git a/ci/Dockerfile b/ci/Dockerfile
@@ -1,4 +1,4 @@
-ARG PYTHON_VERSION=3.10
+ARG PYTHON_VERSION=3.11
 FROM python:${PYTHON_VERSION}-alpine AS compile-image
 
 WORKDIR /build
@@ -11,7 +11,7 @@ RUN pip install -U .[build]
 RUN python -m build
 RUN pip install --no-index /build
 
-FROM netboxcommunity/netbox:v3.7.2
+FROM netboxcommunity/netbox:v4.0.6
 
-ARG PYTHON_VERSION=3.10
+ARG PYTHON_VERSION=3.11
 COPY --from=compile-image /opt/netbox/venv/lib/python${PYTHON_VERSION}/site-packages/netbox_slm /opt/netbox/venv/lib/python${PYTHON_VERSION}/site-packages/netbox_slm
diff --git a/ci/Dockerfile-CI b/ci/Dockerfile-CI
@@ -1,4 +1,4 @@
-FROM netboxcommunity/netbox:v3.7.2
+FROM netboxcommunity/netbox:v4.0.6
 
 RUN mkdir /ci && chmod go+w /ci
 COPY ../ci/requirements_ci.txt /ci/
diff --git a/ci/docker-compose.ci.yml b/ci/docker-compose.ci.yml
@@ -1,4 +1,4 @@
-version: '3.7'
+---
 services:
   netbox:
     ports:
diff --git a/ci/docker-compose.yml b/ci/docker-compose.yml
@@ -1,7 +1,7 @@
-version: '3.7'
+---
 services:
   netbox: &netbox
-    image: netboxcommunity/netbox:${VERSION-v3.7.2}
+    image: netboxcommunity/netbox:${VERSION-v4.0.6}
     depends_on:
     - postgres
     - redis
diff --git a/ci/requirements_ci.txt b/ci/requirements_ci.txt
@@ -1,2 +1,2 @@
-coverage==7.2.2
+coverage==7.5.4
 unittest-xml-reporting==3.2.0
diff --git a/netbox_slm/__init__.py b/netbox_slm/__init__.py
@@ -1,4 +1,4 @@
-from extras.plugins import PluginConfig
+from netbox.plugins import PluginConfig
 
 __version__ = "1.6.0"
 
diff --git a/netbox_slm/api/serializers.py b/netbox_slm/api/serializers.py
@@ -10,7 +10,7 @@ class SoftwareLicenseSerializer(NetBoxModelSerializer):
 
     class Meta:
         model = SoftwareLicense
-        fields = [
+        fields = (
             "id",
             "display",
             "url",
@@ -31,7 +31,8 @@ class Meta:
             "custom_field_data",
             "created",
             "last_updated",
-        ]
+        )
+        brief_fields = ("id", "display", "url", "name", "description")
 
     def get_display(self, obj):
         return f"{obj}"
@@ -43,7 +44,7 @@ class SoftwareProductSerializer(NetBoxModelSerializer):
 
     class Meta:
         model = SoftwareProduct
-        fields = [
+        fields = (
             "id",
             "display",
             "url",
@@ -55,7 +56,8 @@ class Meta:
             "custom_field_data",
             "created",
             "last_updated",
-        ]
+        )
+        brief_fields = ("id", "display", "url", "name", "description")
 
     def get_display(self, obj):
         return f"{obj.manufacturer} - {obj}"
@@ -69,7 +71,7 @@ class SoftwareProductInstallationSerializer(NetBoxModelSerializer):
 
     class Meta:
         model = SoftwareProductInstallation
-        fields = [
+        fields = (
             "id",
             "display",
             "url",
@@ -83,7 +85,8 @@ class Meta:
             "custom_field_data",
             "created",
             "last_updated",
-        ]
+        )
+        brief_fields = ("id", "display", "url", "name")
 
     def get_display(self, obj):
         return f"{obj}"
@@ -95,7 +98,7 @@ class SoftwareProductVersionSerializer(NetBoxModelSerializer):
 
     class Meta:
         model = SoftwareProductVersion
-        fields = [
+        fields = (
             "id",
             "display",
             "url",
@@ -113,7 +116,8 @@ class Meta:
             "custom_field_data",
             "created",
             "last_updated",
-        ]
+        )
+        brief_fields = ("id", "display", "url", "name")
 
     def get_display(self, obj):
         return f"{obj}"
diff --git a/netbox_slm/forms/software_license.py b/netbox_slm/forms/software_license.py
@@ -4,6 +4,7 @@
 from netbox.forms import NetBoxModelForm, NetBoxModelImportForm, NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation, SoftwareLicense
 from utilities.forms.fields import CommentField, DynamicModelChoiceField, TagFilterField, LaxURLField
+from utilities.forms.rendering import FieldSet
 from utilities.forms.widgets import APISelect, DatePicker
 
 
@@ -62,7 +63,7 @@ class Meta:
 
 class SoftwareLicenseFilterForm(NetBoxModelFilterSetForm):
     model = SoftwareLicense
-    fieldsets = ((None, ("q", "tag")),)
+    fieldsets = (FieldSet(None, ("q", "tag")),)
     tag = TagFilterField(model)
 
 
@@ -85,13 +86,4 @@ class SoftwareLicenseBulkEditForm(NetBoxModelBulkEditForm):
     version = DynamicModelChoiceField(queryset=SoftwareProductVersion.objects.all(), required=False)
     installation = DynamicModelChoiceField(queryset=SoftwareProductInstallation.objects.all(), required=False)
     model = SoftwareLicense
-    fieldsets = (
-        (
-            None,
-            (
-                "software_product",
-                "version",
-                "installation",
-            ),
-        ),
-    )
+    fieldsets = (FieldSet(None, ("software_product", "version", "installation")),)
diff --git a/netbox_slm/forms/software_product.py b/netbox_slm/forms/software_product.py
@@ -4,6 +4,7 @@
 from netbox.forms import NetBoxModelForm, NetBoxModelImportForm, NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
 from netbox_slm.models import SoftwareProduct
 from utilities.forms.fields import CommentField, DynamicModelChoiceField, TagFilterField
+from utilities.forms.rendering import FieldSet
 
 
 class SoftwareProductForm(NetBoxModelForm):
@@ -29,7 +30,7 @@ class Meta:
 
 class SoftwareProductFilterForm(NetBoxModelFilterSetForm):
     model = SoftwareProduct
-    fieldsets = ((None, ("q", "tag")),)
+    fieldsets = (FieldSet(None, ("q", "tag")),)
     tag = TagFilterField(model)
 
 
diff --git a/netbox_slm/forms/software_product_installation.py b/netbox_slm/forms/software_product_installation.py
@@ -5,6 +5,7 @@
 from netbox.forms import NetBoxModelForm, NetBoxModelImportForm, NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
 from netbox_slm.models import SoftwareProductInstallation, SoftwareProduct, SoftwareProductVersion
 from utilities.forms.fields import CommentField, DynamicModelChoiceField, TagFilterField
+from utilities.forms.rendering import FieldSet
 from utilities.forms.widgets import APISelect
 from virtualization.models import VirtualMachine, Cluster
 
@@ -56,7 +57,7 @@ def clean_version(self):
 
 class SoftwareProductInstallationFilterForm(NetBoxModelFilterSetForm):
     model = SoftwareProductInstallation
-    fieldsets = ((None, ("q", "tag")),)
+    fieldsets = (FieldSet(None, ("q", "tag")),)
     tag = TagFilterField(model)
 
 
@@ -70,12 +71,4 @@ class SoftwareProductInstallationBulkEditForm(NetBoxModelBulkEditForm):
     software_product = DynamicModelChoiceField(queryset=SoftwareProduct.objects.all(), required=False)
     version = DynamicModelChoiceField(queryset=SoftwareProductVersion.objects.all(), required=False)
     model = SoftwareProductInstallation
-    fieldsets = (
-        (
-            None,
-            (
-                "software_product",
-                "version",
-            ),
-        ),
-    )
+    fieldsets = (FieldSet(None, ("software_product", "version")),)
diff --git a/netbox_slm/forms/software_product_version.py b/netbox_slm/forms/software_product_version.py
@@ -4,6 +4,7 @@
 from netbox.forms import NetBoxModelForm, NetBoxModelImportForm, NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion
 from utilities.forms.fields import CommentField, DynamicModelChoiceField, TagFilterField
+from utilities.forms.rendering import FieldSet
 from utilities.forms.widgets import APISelect, DatePicker
 
 
@@ -39,7 +40,7 @@ class Meta:
 
 class SoftwareProductVersionFilterForm(NetBoxModelFilterSetForm):
     model = SoftwareProductVersion
-    fieldsets = ((None, ("q", "tag")),)
+    fieldsets = (FieldSet(None, ("q", "tag")),)
     tag = TagFilterField(model)
 
 
diff --git a/netbox_slm/navigation.py b/netbox_slm/navigation.py
@@ -1,5 +1,4 @@
-from extras.plugins import PluginMenuButton, PluginMenuItem
-from utilities.choices import ButtonColorChoices
+from netbox.plugins import PluginMenuButton, PluginMenuItem
 
 menu_items = (
     PluginMenuItem(
@@ -10,14 +9,12 @@
                 "plugins:netbox_slm:softwareproduct_add",
                 "Add",
                 "mdi mdi-plus-thick",
-                ButtonColorChoices.GREEN,
                 permissions=["netbox_slm.add_softwareproduct"],
             ),
             PluginMenuButton(
                 "plugins:netbox_slm:softwareproduct_import",
                 "Import",
                 "mdi mdi-upload",
-                ButtonColorChoices.CYAN,
                 permissions=["netbox_slm.add_softwareproduct"],
             ),
         ),
@@ -30,14 +27,12 @@
                 "plugins:netbox_slm:softwareproductversion_add",
                 "Add",
                 "mdi mdi-plus-thick",
-                ButtonColorChoices.GREEN,
                 permissions=["netbox_slm.add_softwareproductversion"],
             ),
             PluginMenuButton(
                 "plugins:netbox_slm:softwareproductversion_import",
                 "Import",
                 "mdi mdi-upload",
-                ButtonColorChoices.CYAN,
                 permissions=["netbox_slm.add_softwareproductversion"],
             ),
         ),
@@ -50,14 +45,12 @@
                 "plugins:netbox_slm:softwareproductinstallation_add",
                 "Add",
                 "mdi mdi-plus-thick",
-                ButtonColorChoices.GREEN,
                 permissions=["netbox_slm.add_softwareproductinstallation"],
             ),
             PluginMenuButton(
                 "plugins:netbox_slm:softwareproductinstallation_import",
                 "Import",
                 "mdi mdi-upload",
-                ButtonColorChoices.CYAN,
                 permissions=["netbox_slm.add_softwareproductinstallation"],
             ),
         ),
@@ -70,14 +63,12 @@
                 "plugins:netbox_slm:softwarelicense_add",
                 "Add",
                 "mdi mdi-plus-thick",
-                ButtonColorChoices.GREEN,
                 permissions=["netbox_slm.add_softwarelicense"],
             ),
             PluginMenuButton(
                 "plugins:netbox_slm:softwarelicense_import",
                 "Import",
                 "mdi mdi-upload",
-                ButtonColorChoices.CYAN,
                 permissions=["netbox_slm.add_softwarelicense"],
             ),
         ),
diff --git a/netbox_slm/templates/netbox_slm/softwarelicense.html b/netbox_slm/templates/netbox_slm/softwarelicense.html
diff --git a/netbox_slm/templates/netbox_slm/softwareproduct.html b/netbox_slm/templates/netbox_slm/softwareproduct.html
diff --git a/netbox_slm/templates/netbox_slm/softwareproductinstallation.html b/netbox_slm/templates/netbox_slm/softwareproductinstallation.html
diff --git a/netbox_slm/templates/netbox_slm/softwareproductversion.html b/netbox_slm/templates/netbox_slm/softwareproductversion.html
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM netboxcommunity/netbox:v3.7.2`
	`1`	`+FROM netboxcommunity/netbox:v4.0.6`
`2`	`2`
`3`	`3`	`RUN mkdir /ci && chmod go+w /ci`
`4`	`4`	`COPY ../ci/requirements_ci.txt /ci/`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: '3.7'`
	`1`	`+---`
`2`	`2`	`services:`
`3`	`3`	`netbox:`
`4`	`4`	`ports:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-coverage==7.2.2`
	`1`	`+coverage==7.5.4`
`2`	`2`	`unittest-xml-reporting==3.2.0`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from extras.plugins import PluginConfig`
	`1`	`+from netbox.plugins import PluginConfig`
`2`	`2`
`3`	`3`	`__version__ = "1.6.0"`
`4`	`4`