test: add unit tests for branch_id field and related properties in Setting model

Signed-off-by: Michal Fiedorowicz <mfiedorowicz@netboxlabs.com>

Author: mfiedorowicz

netbox_diode_plugin/tests/test_models.py

@@ -1,6 +1,9 @@
 #!/usr/bin/env python
 # Copyright 2025 NetBox Labs, Inc.
 """Diode NetBox Plugin - Tests."""
+from unittest import mock
+
+from django.apps import apps
 from django.core.exceptions import ValidationError
 from django.test import TestCase
 
@@ -17,19 +20,98 @@ def test_validators(self):
         with self.assertRaises(ValidationError):
             setting.clean_fields()
 
-
     def test_str(self):
         """Check Setting model string representation."""
         setting = Setting(diode_target="http://localhost:8080")
         self.assertEqual(str(setting), "")
 
-
     def test_absolute_url(self):
         """Check Setting model absolute URL."""
         setting = Setting()
         self.assertEqual(setting.get_absolute_url(), "/netbox/plugins/diode/settings/")
 
-    def test_tags_disabled(self):
-        """Check Setting model has tags disabled."""
-        setting = Setting(diode_target="http://localhost:8080")
-        self.assertIsNone(setting.tags)
+    def test_branch_id_field_exists(self):
+        """Check Setting model has branch_id field."""
+        setting = Setting(diode_target="grpc://localhost:8080/diode")
+        self.assertIsNone(setting.branch_id)
+
+        # Set branch_id
+        setting.branch_id = 123
+        self.assertEqual(setting.branch_id, 123)
+
+    def test_branch_property_returns_none_when_no_branch_id(self):
+        """Check branch property returns None when branch_id is not set."""
+        setting = Setting(diode_target="grpc://localhost:8080/diode")
+        self.assertIsNone(setting.branch)
+
+    def test_branch_property_returns_none_when_plugin_not_installed(self):
+        """Check branch property returns None when branching plugin is not installed."""
+        setting = Setting(diode_target="grpc://localhost:8080/diode", branch_id=123)
+
+        # Mock the import to simulate plugin not being available
+        with mock.patch.dict('sys.modules', {'netbox_branching.models': None}):
+            self.assertIsNone(setting.branch)
+
+    def test_branch_property_returns_branch_when_available(self):
+        """Check branch property returns Branch object when available."""
+        if not apps.is_installed("netbox_branching"):
+            self.skipTest("netbox_branching plugin not installed")
+
+        from netbox_branching.models import Branch
+
+        # Create a test branch
+        branch = Branch.objects.create(name="test-branch")
+
+        setting = Setting(diode_target="grpc://localhost:8080/diode", branch_id=branch.id)
+
+        # Check branch property returns the correct branch
+        self.assertEqual(setting.branch.id, branch.id)
+        self.assertEqual(setting.branch.name, "test-branch")
+
+        # Clean up
+        branch.delete()
+
+    def test_branch_setter(self):
+        """Check branch setter updates branch_id."""
+        if not apps.is_installed("netbox_branching"):
+            self.skipTest("netbox_branching plugin not installed")
+
+        from netbox_branching.models import Branch
+
+        # Create a test branch
+        branch = Branch.objects.create(name="test-branch-setter")
+
+        setting = Setting(diode_target="grpc://localhost:8080/diode")
+
+        # Use setter to assign branch
+        setting.branch = branch
+        self.assertEqual(setting.branch_id, branch.id)
+
+        # Set to None
+        setting.branch = None
+        self.assertIsNone(setting.branch_id)
+
+        # Clean up
+        branch.delete()
+
+    def test_branch_schema_id_property(self):
+        """Check branch_schema_id property returns schema_id when branch is set."""
+        if not apps.is_installed("netbox_branching"):
+            self.skipTest("netbox_branching plugin not installed")
+
+        from netbox_branching.models import Branch
+
+        # Create a test branch
+        branch = Branch.objects.create(name="test-branch-schema")
+
+        setting = Setting(diode_target="grpc://localhost:8080/diode", branch_id=branch.id)
+
+        # Check branch_schema_id returns the schema_id
+        self.assertEqual(setting.branch_schema_id, branch.schema_id)
+
+        # Check it returns None when no branch
+        setting.branch_id = None
+        self.assertIsNone(setting.branch_schema_id)
+
+        # Clean up
+        branch.delete()

netbox_diode_plugin/tests/test_views.py

@@ -3,6 +3,7 @@
 """Diode NetBox Plugin - Tests."""
 from unittest import mock
 
+from django.contrib import messages
 from django.contrib.auth import get_user_model
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.messages.middleware import MessageMiddleware
@@ -158,8 +159,8 @@ def test_settings_update_post_redirects_to_login_page_for_unauthenticated_user(
         self.assertEqual(response.status_code, status.HTTP_302_FOUND)
         self.assertEqual(response.url, f"/netbox/login/?next={self.path}")
 
-    def test_settings_update_disallowed_on_get_method(self):
-        """Test that the accessing settings edit is not allowed with diode target override."""
+    def test_settings_update_allowed_on_get_method_with_override(self):
+        """Test that accessing settings edit shows info message when diode target is overridden."""
         with mock.patch(
             "netbox_diode_plugin.views.get_plugin_config"
         ) as mock_get_plugin_config:
@@ -173,7 +174,7 @@ def test_settings_update_disallowed_on_get_method(self):
                 "netbox_diode_plugin.change_setting",
             )
 
-            request = self.request_factory.post(self.path)
+            request = self.request_factory.get(self.path)
             request.user = user
             request.htmx = None
 
@@ -185,25 +186,22 @@ def test_settings_update_disallowed_on_get_method(self):
             middleware.process_request(request)
             request.session.save()
 
-            setattr(request, "session", "session")
-            messages = FallbackStorage(request)
-            request._messages = messages
-
             self.view.setup(request)
             response = self.view.get(request)
 
-            self.assertEqual(response.status_code, status.HTTP_302_FOUND)
-            self.assertEqual(
-                response.url, reverse("plugins:netbox_diode_plugin:settings")
-            )
-            self.assertEqual(len(request._messages._queued_messages), 1)
+            self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+            # Check that the message was added
+            storage = messages.get_messages(request)
+            message_list = list(storage)
+            self.assertEqual(len(message_list), 1)
             self.assertEqual(
-                str(request._messages._queued_messages[0]),
-                "The Diode target is not allowed to be modified.",
+                str(message_list[0]),
+                "The Diode target field is disabled because it is overridden in the plugin configuration.",
             )
 
-    def test_settings_update_disallowed_on_post_method(self):
-        """Test that the updating settings is not allowed with diode target override."""
+    def test_settings_update_allowed_on_post_method_with_override(self):
+        """Test that updating settings succeeds when diode target is overridden (field is disabled in form)."""
         with mock.patch(
             "netbox_diode_plugin.views.get_plugin_config"
         ) as mock_get_plugin_config:
@@ -237,12 +235,8 @@ def test_settings_update_disallowed_on_post_method(self):
             self.view.setup(request)
             response = self.view.post(request)
 
+            # Should succeed and redirect to settings view
             self.assertEqual(response.status_code, status.HTTP_302_FOUND)
             self.assertEqual(
                 response.url, reverse("plugins:netbox_diode_plugin:settings")
             )
-            self.assertEqual(len(request._messages._queued_messages), 1)
-            self.assertEqual(
-                str(request._messages._queued_messages[0]),
-                "The Diode target is not allowed to be modified.",
-            )