Unify api serializers (#16)

netbox_slm/__init__.py

@@ -4,14 +4,15 @@ from extras.plugins import PluginConfig
 class SLMConfig(PluginConfig):
     name = 'netbox_slm'
     verbose_name = 'Software Lifecycle Management'
-    description = 'Software Lifecycle Management'
-    version = '1.2'
-    author = 'Hedde van der Heide'
-    author_email = 'hedde.vanderheide@ictu.nl'
+    description = 'Software Lifecycle Management Netbox Plugin.'
+    version = '1.3'
+    author = 'ICTU'
+    author_email = 'open-source-projects@ictu.nl'
     base_url = 'slm'
     required_settings = []
     default_settings = {
         'version_info': False
     }
 
+
 config = SLMConfig

netbox_slm/api/serializers.py

@@ -1,9 +1,7 @@
 from rest_framework import serializers
 
 from netbox.api.serializers import NetBoxModelSerializer
-from netbox_slm.models import (
-    SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation,
-)
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
 
 
 class SoftwareProductSerializer(NetBoxModelSerializer):
@@ -19,7 +17,7 @@ class SoftwareProductSerializer(NetBoxModelSerializer):
         ]
 
     def get_display(self, obj):
-        return f"{obj.manufacturer.name} - {obj.name}"
+        return f"{obj.manufacturer} - {obj}"
 
 
 class SoftwareProductVersionSerializer(NetBoxModelSerializer):
@@ -35,7 +33,7 @@ class SoftwareProductVersionSerializer(NetBoxModelSerializer):
         ]
 
     def get_display(self, obj):
-        return obj.name
+        return f"{obj}"
 
 
 class SoftwareProductInstallationSerializer(NetBoxModelSerializer):
@@ -52,4 +50,4 @@ class SoftwareProductInstallationSerializer(NetBoxModelSerializer):
         ]
 
     def get_display(self, obj):
-        return obj
+        return f"{obj}"

netbox_slm/api/urls.py

@@ -12,4 +12,4 @@ router.APIRootView = NetboxSLMRootView
 router.register("softwareproducts", SoftwareProductViewSet)
 router.register("softwareproductversions", SoftwareProductVersionViewSet)
 router.register("softwareproductinstallations", SoftwareProductInstallationViewSet)
-urlpatterns = router.urls
+urlpatterns = router.urls

netbox_slm/api/views.py

@@ -1,15 +1,13 @@
-from netbox.api.viewsets import NetBoxModelViewSet
 from rest_framework.routers import APIRootView
 
+from netbox.api.viewsets import NetBoxModelViewSet
 from netbox_slm.api.serializers import (
     SoftwareProductSerializer, SoftwareProductVersionSerializer, SoftwareProductInstallationSerializer,
 )
 from netbox_slm.filtersets import (
     SoftwareProductFilterSet, SoftwareProductVersionFilterSet, SoftwareProductInstallationFilterSet,
 )
-from netbox_slm.models import (
-    SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation,
-)
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
 
 
 class NetboxSLMRootView(APIRootView):

netbox_slm/filtersets.py

@@ -1,11 +1,12 @@
 from django.db.models import Q
 
 from netbox.filtersets import NetBoxModelFilterSet
-from netbox_slm.models import *
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
 
 
 class SoftwareProductFilterSet(NetBoxModelFilterSet):
     """Filter capabilities for SoftwareProduct instances."""
+
     class Meta:
         model = SoftwareProduct
         fields = tuple()
@@ -14,13 +15,13 @@ class SoftwareProductFilterSet(NetBoxModelFilterSet):
         """Perform the filtered search."""
         if not value.strip():
             return queryset
-        qs_filter = Q(name__icontains=value) | \
-                    Q(manufacturer__name__icontains=value)
+        qs_filter = Q(name__icontains=value) | Q(manufacturer__name__icontains=value)
         return queryset.filter(qs_filter)
 
 
 class SoftwareProductVersionFilterSet(NetBoxModelFilterSet):
     """Filter capabilities for SoftwareProductVersion instances."""
+
     class Meta:
         model = SoftwareProductVersion
         fields = (
@@ -39,6 +40,7 @@ class SoftwareProductVersionFilterSet(NetBoxModelFilterSet):
 
 class SoftwareProductInstallationFilterSet(NetBoxModelFilterSet):
     """Filter capabilities for SoftwareProductInstallation instances."""
+
     class Meta:
         model = SoftwareProductInstallation
         fields = tuple()

netbox_slm/forms.py

@@ -3,16 +3,9 @@ from django.urls import reverse_lazy
 from django.utils.translation import gettext as _
 
 from dcim.models import Manufacturer, Device
-from netbox.forms import (
-    NetBoxModelForm,
-    NetBoxModelCSVForm,
-    NetBoxModelBulkEditForm,
-    NetBoxModelFilterSetForm,
-)
+from netbox.forms import NetBoxModelForm, NetBoxModelCSVForm, NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-from utilities.forms import (
-    DynamicModelChoiceField, APISelect, TagFilterField, ChoiceField
-)
+from utilities.forms import DynamicModelChoiceField, APISelect, TagFilterField
 from virtualization.models import VirtualMachine
 
 

netbox_slm/models.py

@@ -9,7 +9,7 @@ from utilities.querysets import RestrictedQuerySet
 class SoftwareProduct(NetBoxModel):
     name = models.CharField(max_length=128)
     description = models.CharField(max_length=255, null=True, blank=True)
-    
+
     manufacturer = models.ForeignKey(
         to='dcim.Manufacturer',
         on_delete=models.PROTECT,
@@ -89,4 +89,4 @@ class SoftwareProductInstallation(NetBoxModel):
         return self.device or self.virtualmachine
 
     def render_type(self):
-        return f"{'device' if self.device else 'virtualmachine'}"
+        return 'device' if self.device else 'virtualmachine'

netbox_slm/navigation.py

@@ -1,7 +1,6 @@
 from extras.plugins import PluginMenuButton, PluginMenuItem
 from utilities.choices import ButtonColorChoices
 
-
 menu_items = (
     PluginMenuItem(
         link='plugins:netbox_slm:softwareproduct_list',

netbox_slm/tables.py

@@ -1,9 +1,9 @@
 import django_tables2 as tables
-
 from django.db.models import Count
 from django_tables2.utils import Accessor
+
+from netbox.tables import NetBoxTable, ToggleColumn, columns
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-from netbox.tables import NetBoxTable, ChoiceFieldColumn, ToggleColumn, columns
 
 
 class SoftwareProductTable(NetBoxTable):

netbox_slm/tests/test_models.py

@@ -0,0 +1,36 @@
+from django.test import TestCase
+
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
+
+
+class ModelTestCase(TestCase):
+    def setUp(self):
+        self.p_name = "test product"
+        self.v_name = "test version"
+
+        self.software_product = SoftwareProduct.objects.create(name=self.p_name)
+        self.software_product_version = SoftwareProductVersion.objects.create(
+            name=self.v_name, software_product=self.software_product
+        )
+        self.software_product_installation = SoftwareProductInstallation.objects.create(
+            software_product=self.software_product, version=self.software_product_version
+        )
+
+    def test_model_name(self):
+        self.assertEqual(self.p_name, str(self.software_product))
+        self.assertEqual(self.v_name, str(self.software_product_version))
+        self.assertTrue(str(self.software_product_installation).isnumeric())  # should be PK
+
+    def test_absolute_url(self):
+        self.assertEqual("/plugins/slm/software-products/1/", self.software_product.get_absolute_url())
+        self.assertEqual("/plugins/slm/versions/1/", self.software_product_version.get_absolute_url())
+        self.assertEqual("/plugins/slm/installations/1/", self.software_product_installation.get_absolute_url())
+
+    def test_get_installation_count(self):
+        installation_ss = '<a href="/plugins/slm/installations/?q={}">1</a>'
+        self.assertEqual(installation_ss.format(self.p_name), self.software_product.get_installation_count())
+        self.assertEqual(installation_ss.format(self.v_name), self.software_product_version.get_installation_count())
+
+    def test_product_installation_methods(self):
+        self.assertEqual("virtualmachine", self.software_product_installation.render_type())
+        self.assertIsNone(self.software_product_installation.get_platform())

netbox_slm/tests/test_smoke.py

@@ -1,16 +0,0 @@
-from django.test import TestCase
-
-from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-
-
-class ModelTestCase(TestCase):
-    def test_smoke(self):
-        software_product = SoftwareProduct.objects.create(name="test product")
-        software_product_version = SoftwareProductVersion.objects.create(
-            name="test version", software_product=software_product
-        )
-        software_product_installation = SoftwareProductInstallation.objects.create(
-            software_product=software_product, version=software_product_version
-        )
-
-        self.assertEqual('virtualmachine', software_product_installation.render_type())

netbox_slm/urls.py

@@ -1,6 +1,6 @@
 from django.urls import path
-from netbox.views.generic import ObjectChangeLogView
 
+from netbox.views.generic import ObjectChangeLogView
 from netbox_slm import views
 from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
 

netbox_slm/views.py

@@ -1,10 +1,6 @@
 from netbox.views import generic
-from netbox_slm import filtersets
-from netbox_slm import forms
-from netbox_slm import tables
-from netbox_slm.models import (
-    SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
-)
+from netbox_slm import filtersets, forms, tables
+from netbox_slm.models import SoftwareProduct, SoftwareProductVersion, SoftwareProductInstallation
 
 
 class SoftwareProductListView(generic.ObjectListView):