Merge pull request #118 from netboxlabs/unit-test-suite

Unit test suite (1st pass)

Author: bctiemann

.github/workflows/lint-tests.yaml

@@ -0,0 +1,90 @@
+name: Lint and tests
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: false
+
+permissions:
+  contents: write
+  checks: write
+  pull-requests: write
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install .[dev]
+          pip install .[test]
+      - name: Run ruff
+        run: ruff check
+  tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version: [ "3.10", "3.11", "3.12" ]
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: netbox
+          POSTGRES_PASSWORD: netbox
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - name: Checkout netbox-custom-objects
+        uses: actions/checkout@v4
+        with:
+          path: netbox-custom-objects
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Checkout netbox
+        uses: actions/checkout@v4
+        with:
+          repository: "netbox-community/netbox"
+          path: netbox
+      - name: Install netbox-custom-objects
+        working-directory: netbox-custom-objects
+        run: |
+          # Include tests directory for test
+          sed -i 's/exclude-package-data/#exclude-package-data/g' pyproject.toml
+          python -m pip install --upgrade pip
+          pip install .
+          pip install .[test]
+      - name: Install dependencies & configure plugin
+        working-directory: netbox
+        run: |
+          ln -s $(pwd)/../netbox-custom-objects/testing/configuration.py netbox/netbox/configuration.py
+          
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt -U
+      - name: Run tests
+        working-directory: netbox
+        run: |
+          python netbox/manage.py test netbox_custom_objects.tests --keepdb

netbox_custom_objects/models.py

@@ -98,12 +98,12 @@ def clone_fields(self):
         """
         if not hasattr(self, 'custom_object_type_id'):
             return ()
-        
+
         # Get all field names where is_cloneable=True for this custom object type
         cloneable_fields = self.custom_object_type.fields.filter(
             is_cloneable=True
         ).values_list('name', flat=True)
-        
+
         return tuple(cloneable_fields)
 
     def get_absolute_url(self):
@@ -126,7 +126,6 @@ class CustomObjectType(NetBoxModel):
     # Class-level cache for generated models
     _model_cache = {}
     _through_model_cache = {}  # Now stores {custom_object_type_id: {through_model_name: through_model}}
-
     name = models.CharField(max_length=100, unique=True)
     description = models.TextField(blank=True)
     schema = models.JSONField(blank=True, default=dict)
@@ -441,7 +440,6 @@ def get_model(
         if self.id not in self._through_model_cache:
             self._through_model_cache[self.id] = {}
         self._through_model_cache[self.id][through_model_name] = through_model
-
         return model
 
     def create_model(self):
@@ -1138,19 +1136,19 @@ def save(self, *args, **kwargs):
             else:
                 old_field = field_type.get_model_field(self.original)
                 old_field.contribute_to_class(model, self._original_name)
-                
+
                 # Special handling for MultiObject fields when the name changes
-                if (self.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT and 
+                if (self.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT and
                     self.name != self._original_name):
                     # For renamed MultiObject fields, we just need to rename the through table
                     old_through_table_name = self.original.through_table_name
                     new_through_table_name = self.through_table_name
-                    
+
                     # Check if old through table exists
                     with connection.cursor() as cursor:
                         tables = connection.introspection.table_names(cursor)
                         old_table_exists = old_through_table_name in tables
-                    
+
                     if old_table_exists:
                         # Create temporary models to represent the old and new through table states
                         old_through_meta = type(
@@ -1170,16 +1168,16 @@ def save(self, *args, **kwargs):
                                 "Meta": old_through_meta,
                                 "id": models.AutoField(primary_key=True),
                                 "source": models.ForeignKey(
-                                    model, on_delete=models.CASCADE, 
+                                    model, on_delete=models.CASCADE,
                                     db_column="source_id", related_name="+"
                                 ),
                                 "target": models.ForeignKey(
-                                    model, on_delete=models.CASCADE, 
+                                    model, on_delete=models.CASCADE,
                                     db_column="target_id", related_name="+"
                                 ),
                             },
                         )
-                        
+
                         new_through_meta = type(
                             "Meta",
                             (),
@@ -1197,22 +1195,23 @@ def save(self, *args, **kwargs):
                                 "Meta": new_through_meta,
                                 "id": models.AutoField(primary_key=True),
                                 "source": models.ForeignKey(
-                                    model, on_delete=models.CASCADE, 
+                                    model, on_delete=models.CASCADE,
                                     db_column="source_id", related_name="+"
                                 ),
                                 "target": models.ForeignKey(
-                                    model, on_delete=models.CASCADE, 
+                                    model, on_delete=models.CASCADE,
                                     db_column="target_id", related_name="+"
                                 ),
                             },
                         )
-                        
+                        new_through_model  # To silence ruff error
+
                         # Rename the table using Django's schema editor
                         schema_editor.alter_db_table(old_through_model, old_through_table_name, new_through_table_name)
                     else:
                         # No old table exists, create the new through table
                         field_type.create_m2m_table(self, model, self.name)
-                    
+
                     # Alter the field normally (this updates the field definition)
                     schema_editor.alter_field(model, old_field, model_field)
                 else:

netbox_custom_objects/tests/__init__.py

@@ -0,0 +1 @@
+# Tests package for netbox_custom_objects plugin

netbox_custom_objects/tests/base.py

@@ -0,0 +1,203 @@
+# Test utilities for netbox_custom_objects plugin
+from django.contrib.contenttypes.models import ContentType
+from django.test import Client
+from extras.models import CustomFieldChoiceSet
+from utilities.testing import create_test_user
+
+from netbox_custom_objects.models import CustomObjectType, CustomObjectTypeField
+
+
+class CustomObjectsTestCase:
+    """
+    Base test case for custom objects tests.
+    """
+
+    @classmethod
+    def setUpTestData(cls):
+        """Set up test data that should be created once for the entire test class."""
+        pass
+
+    def setUp(self):
+        """Set up test data."""
+        self.user = create_test_user('testuser')
+        self.client = Client()
+        self.client.force_login(self.user)
+
+    @classmethod
+    def create_custom_object_type(cls, **kwargs):
+        """Helper method to create a custom object type."""
+        defaults = {
+            'name': 'TestObject',
+            'description': 'A test custom object type',
+            'verbose_name_plural': 'Test Objects'
+        }
+        defaults.update(kwargs)
+        return CustomObjectType.objects.create(**defaults)
+
+    @classmethod
+    def create_custom_object_type_field(cls, custom_object_type, **kwargs):
+        """Helper method to create a custom object type field."""
+        defaults = {
+            'custom_object_type': custom_object_type,
+            'name': 'test_field',
+            'label': 'Test Field',
+            'type': 'text'
+        }
+        defaults.update(kwargs)
+        return CustomObjectTypeField.objects.create(**defaults)
+
+    @classmethod
+    def create_choice_set(cls, **kwargs):
+        """Helper method to create a choice set."""
+        defaults = {
+            'name': 'Test Choice Set',
+            'extra_choices': [
+                ['choice1', 'Choice 1'],
+                ['choice2', 'Choice 2'],
+                ['choice3', 'Choice 3'],
+            ]
+        }
+        defaults.update(kwargs)
+        return CustomFieldChoiceSet.objects.create(**defaults)
+
+    @classmethod
+    def get_device_content_type(cls):
+        """Get the device content type for object field testing."""
+        return ContentType.objects.get(app_label='dcim', model='device')
+
+    @classmethod
+    def get_site_content_type(cls):
+        """Get the site content type for object field testing."""
+        return ContentType.objects.get(app_label='dcim', model='site')
+
+    def create_simple_custom_object_type(self, **kwargs):
+        """Create a simple custom object type with basic fields."""
+        custom_object_type = CustomObjectsTestCase.create_custom_object_type(**kwargs)
+
+        # Add a text field as primary
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="name",
+            label="Name",
+            type="text",
+            primary=True,
+            required=True
+        )
+
+        # Add a description field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="description",
+            label="Description",
+            type="text",
+            required=False
+        )
+
+        return custom_object_type
+
+    def create_complex_custom_object_type(self, **kwargs):
+        """Create a complex custom object type with various field types."""
+        custom_object_type = CustomObjectsTestCase.create_custom_object_type(**kwargs)
+        choice_set = CustomObjectsTestCase.create_choice_set()
+        device_content_type = CustomObjectsTestCase.get_device_content_type()
+
+        # Primary text field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="name",
+            label="Name",
+            type="text",
+            primary=True,
+            required=True
+        )
+
+        # Integer field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="count",
+            label="Count",
+            type="integer",
+            validation_minimum=0,
+            validation_maximum=100
+        )
+
+        # Boolean field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="active",
+            label="Active",
+            type="boolean",
+            default=True
+        )
+
+        # Select field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="status",
+            label="Status",
+            type="select",
+            choice_set=choice_set
+        )
+
+        # Object field (device)
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="device",
+            label="Device",
+            type="object",
+            related_object_type=device_content_type
+        )
+
+        return custom_object_type
+
+    def create_self_referential_custom_object_type(self, **kwargs):
+        """Create a custom object type that can reference itself."""
+        custom_object_type = CustomObjectsTestCase.create_custom_object_type(**kwargs)
+
+        # Primary text field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="name",
+            label="Name",
+            type="text",
+            primary=True,
+            required=True
+        )
+
+        return custom_object_type
+
+    def create_multi_object_custom_object_type(self, **kwargs):
+        """Create a custom object type with multi-object fields."""
+        custom_object_type = CustomObjectsTestCase.create_custom_object_type(**kwargs)
+        device_content_type = CustomObjectsTestCase.get_device_content_type()
+        site_content_type = CustomObjectsTestCase.get_site_content_type()
+
+        # Primary text field
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="name",
+            label="Name",
+            type="text",
+            primary=True,
+            required=True
+        )
+
+        # Multi-object field (devices)
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="devices",
+            label="Devices",
+            type="multiobject",
+            related_object_type=device_content_type
+        )
+
+        # Multi-object field (sites)
+        CustomObjectsTestCase.create_custom_object_type_field(
+            custom_object_type,
+            name="sites",
+            label="Sites",
+            type="multiobject",
+            related_object_type=site_content_type
+        )
+
+        return custom_object_type