nautobot 2.3.8__py3-none-any.whl → 2.3.9__py3-none-any.whl

nautobot/extras/tests/test_plugins.py

@@ -6,12 +6,15 @@ from django.core.exceptions import ValidationError
 from django.template import engines
 from django.test import override_settings
 from django.urls import NoReverseMatch, reverse
+import django_tables2 as tables
 import netaddr
 
 from nautobot.circuits.models import Circuit, CircuitType, Provider
 from nautobot.core.testing import APIViewTestCases, disable_warnings, extract_page_body, TestCase, ViewTestCases
+from nautobot.core.utils.lookup import get_table_for_model
 from nautobot.dcim.models import Device, DeviceType, Location, LocationType, Manufacturer
 from nautobot.dcim.tests.test_views import create_test_device
+from nautobot.extras import plugins
 from nautobot.extras.choices import CustomFieldTypeChoices, RelationshipTypeChoices
 from nautobot.extras.jobs import get_job
 from nautobot.extras.models import CustomField, Relationship, RelationshipAssociation, Role, Secret, Status
@@ -647,6 +650,97 @@ class FilterExtensionTest(TestCase):
         self.assertIn("example_app_description", form.fields.keys())
 
 
+class TableExtensionTest(TestCase):
+    """Tests for adding table extensions."""
+
+    def test_alter_queryset(self):
+        """Test the 'alter_queryset' method of the TableExtension class."""
+        extension = plugins.TableExtension()
+        queryset = object()
+        result = extension.alter_queryset(queryset)
+        self.assertEqual(result, queryset)
+
+    def test__add_columns_into_model_table(self):
+        """Test the '_add_columns_into_model_table' function."""
+        extension = plugins.TableExtension()
+        extension.model = "tenancy.tenant"
+        extension.table_columns = {
+            "tenant_group": tables.Column(verbose_name="Name conflicts with existing column"),
+            "tenant_success": tables.Column(verbose_name="This name should be registered"),
+        }
+        extension.add_to_default_columns = ["tenant_group", "tenant_success"]
+
+        with self.assertLogs("nautobot.extras.plugins", level="WARNING") as logger:
+            plugins._add_columns_into_model_table(extension, "tenant")
+            table = get_table_for_model(extension.model)
+            expected = [
+                "ERROR:nautobot.extras.plugins:tenant: There was a name conflict with existing "
+                "table column `tenant_group`, the custom column was ignored."
+            ]
+            with self.subTest("error is logged"):
+                self.assertEqual(logger.output, expected)
+
+        with self.subTest("column is added to default_columns"):
+            self.assertIn("tenant_success", table.base_columns)
+
+    def test__add_column_to_table_base_columns(self):
+        """Test the '_add_column_to_table_base_columns' function."""
+        table = get_table_for_model("tenancy.tenant")
+
+        with self.subTest("raises TypeError"):
+            column = object()
+            with self.assertRaises(TypeError) as context:
+                plugins._add_column_to_table_base_columns(table, "test_column", column, "my_app")
+                self.assertEqual(
+                    context.exception, "Custom column `test_column` is not an instance of django_tables2.Column."
+                )
+
+        with self.subTest("raises AttributeError"):
+            column = tables.Column()
+            with self.assertRaises(AttributeError) as context:
+                plugins._add_column_to_table_base_columns(table, "pk", column, "my_app")
+                self.assertEqual(
+                    context.exception, "There was a conflict with table column `pk`, the custom column was ignored."
+                )
+
+        with self.subTest("Adds column to base_columns"):
+            column = tables.Column()
+            plugins._add_column_to_table_base_columns(table, "unique_name", column, "my_app")
+            self.assertIn("unique_name", table.base_columns)
+
+    def test__modify_default_table_columns(self):
+        """Test the '_modify_default_table_columns' function."""
+        extension = plugins.TableExtension()
+        extension.model = "tenancy.tenant"
+        extension.add_to_default_columns = ["new_column"]
+        extension.remove_from_default_columns = ["description"]
+
+        table = get_table_for_model(extension.model)
+        table.base_columns["new_column"] = tables.Column()
+
+        plugins._modify_default_table_columns(extension, "my_app")
+
+        with self.subTest("column is added to default_columns"):
+            self.assertIn("new_column", table.Meta.default_columns)
+
+        with self.subTest("column is removed from default_columns"):
+            self.assertNotIn("description", table.Meta.default_columns)
+
+    def test__validate_is_subclass_of_table_extension(self):
+        """Test the '_validate_is_subclass_of_table_extension' function."""
+        with self.assertRaises(TypeError):
+            plugins._validate_is_subclass_of_table_extension(object)
+
+    def test__validate_table_column_name_is_prefixed_with_app_name(self):
+        """Test the '_validate_table_column_name_is_prefixed_with_app_name' function."""
+        with self.assertRaises(ValueError) as context:
+            plugins._validate_table_column_name_is_prefixed_with_app_name("not_prefixed", "prefix")
+            self.assertEqual(
+                context.exception,
+                "Attempted to create a custom table column `not_prefixed` that did not start with `prefix`",
+            )
+
+
 class LoadPluginTest(TestCase):
     """
     Validate that plugin helpers work as intended.

nautobot/extras/views.py

@@ -737,7 +737,9 @@ class DynamicGroupView(generic.ObjectView):
 
         if table_class is not None:
             # Members table (for display on Members nav tab)
-            members_table = table_class(members.restrict(request.user, "view"), orderable=False)
+            members_table = table_class(
+                members.restrict(request.user, "view"), orderable=False, exclude=["dynamic_group_count"]
+            )
             paginate = {
                 "paginator_class": EnhancedPaginator,
                 "per_page": get_paginate_count(request),

nautobot/project-static/docs/404.html

@@ -12,7 +12,7 @@
       
       
       <link rel="icon" href="/projects/core/en/stable/assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
     
     
       
@@ -20,7 +20,7 @@
       
     
     
-      <link rel="stylesheet" href="/projects/core/en/stable/assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="/projects/core/en/stable/assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="/projects/core/en/stable/assets/stylesheets/palette.06af60db.min.css">
@@ -6364,6 +6364,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="/projects/core/en/stable/development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="/projects/core/en/stable/development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -8629,7 +8650,7 @@
     <script id="__config" type="application/json">{"base": "/projects/core/en/stable/", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "/projects/core/en/stable/assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="/projects/core/en/stable/assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="/projects/core/en/stable/assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/apps/index.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -6386,6 +6386,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -8796,7 +8817,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/apps/nautobot-apps.html

@@ -16,7 +16,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
     
     
       
@@ -24,7 +24,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -6384,6 +6384,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -8730,7 +8751,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>