netbox-docker-plugin 5.0.1__tar.gz → 5.1.1__tar.gz

{netbox_docker_plugin-5.0.1/netbox_docker_plugin.egg-info → netbox_docker_plugin-5.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 5.0.1
+Version: 5.1.1
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin
@@ -10,6 +10,10 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: requests-mock; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
 Dynamic: license-file
 
 # Netbox Docker Plugin

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/__init__.py

@@ -11,7 +11,7 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "5.0.1"
+    version = "5.1.1"
     base_url = "docker"
     min_version = "4.5.0"
     author = "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/api/serializers.py

@@ -175,7 +175,11 @@ class NestedContainerSerializer(WritableNestedSerializer):
             "operation",
             "hostname",
             "cap_add",
+            "cap_drop",
             "log_driver",
+            "secOpt",
+            "pid_mode",
+            "extra_hosts",
             "cmd",
         )
 
@@ -481,6 +485,10 @@ class ContainerSerializer(NetBoxModelSerializer):
             "hostname",
             "restart_policy",
             "cap_add",
+            "cap_drop",
+            "secOpt",
+            "pid_mode",
+            "extra_hosts",
             "cmd",
             "ports",
             "env",

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/forms/container.py

@@ -19,6 +19,7 @@ from ..models.container import (
     Container,
     ContainerRestartPolicyChoices,
     ContainerCapAddChoices,
+    ContainerCapDropChoices,
 )
 from ..models.image import Image
 
@@ -36,6 +37,9 @@ class ContainerForm(NetBoxModelForm):
         query_params={"host_id": "$host"},
     )
     cap_add = forms.MultipleChoiceField(choices=ContainerCapAddChoices, required=False)
+    cap_drop = forms.MultipleChoiceField(
+        choices=ContainerCapDropChoices, required=False
+    )
 
     class Meta:
         """Container form definition Meta class"""
@@ -48,6 +52,10 @@ class ContainerForm(NetBoxModelForm):
             "hostname",
             "restart_policy",
             "cap_add",
+            "cap_drop",
+            "secOpt",
+            "pid_mode",
+            "extra_hosts",
             "log_driver",
             "cmd",
             "tags",
@@ -59,6 +67,10 @@ class ContainerForm(NetBoxModelForm):
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
             "cap_add": "Add Host capabilities",
+            "cap_drop": "Drop Host capabilities",
+            "secOpt": "Security options (separate by comma)",
+            "pid_mode": "PID mode",
+            "extra_hosts": "Extra hosts (separate by comma). Specified in the form hostname:IP",
             "log_driver": "Logging driver",
             "cmd": "Command",
         }
@@ -73,6 +85,9 @@ class ContainerEditForm(NetBoxModelForm):
         required=True,
     )
     cap_add = forms.MultipleChoiceField(choices=ContainerCapAddChoices, required=False)
+    cap_drop = forms.MultipleChoiceField(
+        choices=ContainerCapDropChoices, required=False
+    )
 
     class Meta:
         """Container form definition Meta class"""
@@ -84,6 +99,10 @@ class ContainerEditForm(NetBoxModelForm):
             "hostname",
             "restart_policy",
             "cap_add",
+            "cap_drop",
+            "secOpt",
+            "pid_mode",
+            "extra_hosts",
             "log_driver",
             "cmd",
             "tags",
@@ -94,6 +113,10 @@ class ContainerEditForm(NetBoxModelForm):
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
             "cap_add": "Add Host capabilities",
+            "cap_drop": "Drop Host capabilities",
+            "secOpt": "Security options (separate by comma)",
+            "pid_mode": "PID mode",
+            "extra_hosts": "Extra hosts (separate by comma). Specified in the form hostname:IP",
             "log_driver": "Logging driver",
             "cmd": "Command",
         }

netbox_docker_plugin-5.1.1/netbox_docker_plugin/migrations/1043_container_cap_drop_container_extra_hosts_and_more.py

@@ -0,0 +1,60 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.contrib.postgres.fields
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "1042_registry_username_max_length"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="container",
+            name="cap_drop",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.CharField(blank=True, max_length=32, null=True),
+                blank=True,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="container",
+            name="extra_hosts",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.CharField(blank=True, max_length=512, null=True),
+                blank=True,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="container",
+            name="pid_mode",
+            field=models.CharField(blank=True, max_length=512, null=True),
+        ),
+        migrations.AddField(
+            model_name="container",
+            name="secOpt",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.CharField(blank=True, max_length=512, null=True),
+                blank=True,
+                null=True,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="image",
+            name="size",
+            field=models.IntegerField(
+                default=0,
+                validators=[
+                    django.core.validators.MinValueValidator(limit_value=0),
+                    django.core.validators.MaxValueValidator(limit_value=8192),
+                ],
+            ),
+        ),
+    ]

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/models/container.py

@@ -2,17 +2,19 @@
 
 # pylint: disable=E1101
 
+from django.contrib.contenttypes.models import ContentType
 from django.contrib.postgres.fields import ArrayField
 from django.core.exceptions import ValidationError
-from django.db import models
-from django.db.models.functions import Lower
-from django.urls import reverse
 from django.core.validators import (
     MinLengthValidator,
     MaxLengthValidator,
     MinValueValidator,
     MaxValueValidator,
 )
+from django.db import models
+from django.db.models.functions import Lower
+from django.urls import reverse
+from extras.models import JournalEntry
 from utilities.choices import ChoiceSet
 from utilities.querysets import RestrictedQuerySet
 from netbox.models import NetBoxModel
@@ -110,6 +112,41 @@ class ContainerCapAddChoices(ChoiceSet):
         ("SYS_PTRACE", "SYS_PTRACE"),
         ("SYS_RESOURCE", "SYS_RESOURCE"),
         ("SYS_NICE", "SYS_NICE"),
+        ("ALL", "ALL"),
+    ]
+
+
+class ContainerCapDropChoices(ChoiceSet):
+    """cap-drop choices definition class"""
+
+    key = "Container.cap_drop"
+
+    CHOICES = [
+        ("AUDIT_WRITE", "AUDIT_WRITE"),
+        ("CHOWN", "CHOWN"),
+        ("DAC_OVERRIDE", "DAC_OVERRIDE"),
+        ("FOWNER", "FOWNER"),
+        ("FSETID", "FSETID"),
+        ("KILL", "KILL"),
+        ("MKNOD", "MKNOD"),
+        ("NET_BIND_SERVICE", "NET_BIND_SERVICE"),
+        ("NET_RAW", "NET_RAW"),
+        ("SETFCAP", "SETFCAP"),
+        ("SETGID", "SETGID"),
+        ("SETPCAP", "SETPCAP"),
+        ("SETUID", "SETUID"),
+        ("SYS_CHROOT", "SYS_CHROOT"),
+        ("ALL", "ALL"),
+    ]
+
+
+class PidModeChoices(ChoiceSet):
+    """Pid mode choices definition class"""
+
+    key = "Container.pid_mode"
+
+    CHOICES = [
+        ("host", "host"),
     ]
 
 
@@ -170,11 +207,34 @@ class Container(NetBoxModel):
         null=True,
         blank=True,
     )
+    cap_drop = ArrayField(
+        models.CharField(
+            max_length=32, blank=True, null=True, choices=ContainerCapDropChoices
+        ),
+        null=True,
+        blank=True,
+    )
     log_driver = models.CharField(
         max_length=32,
         null=True,
         blank=True,
     )
+    secOpt = ArrayField(
+        models.CharField(max_length=512, blank=True, null=True),
+        null=True,
+        blank=True,
+    )
+    pid_mode = models.CharField(
+        max_length=512,
+        choices=PidModeChoices,
+        null=True,
+        blank=True,
+    )
+    extra_hosts = ArrayField(
+        models.CharField(max_length=512, blank=True, null=True),
+        null=True,
+        blank=True,
+    )
     cmd = ArrayField(
         models.CharField(max_length=1024, blank=True, null=True),
         null=True,
@@ -248,6 +308,18 @@ class Container(NetBoxModel):
             ),
         )
 
+    def delete(self, using=None, keep_parents=False):
+        ct = ContentType.objects.get_for_model(self)
+        qs = JournalEntry.objects.filter(
+            assigned_object_type=ct,
+            assigned_object_id=self.pk,
+        )
+        # _raw_delete issues a single SQL DELETE bypassing Django's Collector,
+        # avoiding per-row post_delete signals (ObjectChange writes) that make
+        # bulk journal cleanup O(n) slow.
+        qs._raw_delete(qs.db)  # pylint: disable=protected-access
+        return super().delete(using, keep_parents)
+
     def __str__(self):
         return f"{self.name}"
 

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/models/image.py

@@ -41,7 +41,7 @@ class Image(NetBoxModel):
         default=0,
         validators=[
             MinValueValidator(limit_value=0),
-            MaxValueValidator(limit_value=4096),
+            MaxValueValidator(limit_value=8192),
         ],
     )
     ImageID = models.CharField(

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/tables.py

@@ -385,6 +385,10 @@ class ContainerTable(NetBoxTable):
             "hostname",
             "restart_policy",
             "cap_add",
+            "cap_drop",
+            "secOpt",
+            "pid_mode",
+            "extra_hosts",
             "cmd",
             "port_count",
             "mount_count",

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -40,6 +40,22 @@
           <th scope="row">Host Capacities added</th>
           <td>{{ object.cap_add }}</td>
         </tr>
+        <tr>
+          <th scope="row">Host Capacities dropped</th>
+          <td>{{ object.cap_drop }}</td>
+        </tr>
+        <tr>
+          <th scope="row">Security options</th>
+          <td>{{ object.secOpt }}</td>
+        </tr>
+        <tr>
+          <th scope="row">PID mode</th>
+          <td>{{ object.pid_mode|placeholder }}</td>
+        </tr>
+        <tr>
+          <th scope="row">Extra hosts added</th>
+          <td>{{ object.extra_hosts }}</td>
+        </tr>
         <tr>
           <th scope="row">Status</th>
           <td>{{ object.status|placeholder }}</td>

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -30,14 +30,18 @@ class ContainerApiTestCase(
     brief_fields = [
         "ContainerID",
         "cap_add",
+        "cap_drop",
         "cmd",
         "display",
+        "extra_hosts",
         "hostname",
         "id",
         "log_driver",
         "name",
         "operation",
+        "pid_mode",
         "restart_policy",
+        "secOpt",
         "state",
         "status",
         "url",
@@ -195,6 +199,20 @@ class ContainerApiTestCase(
                 "cap_add": ["NET_ADMIN"],
                 "cmd": ["cat", "/etc/hosts"],
             },
+            {
+                "host": host2.pk,
+                "image": image2.pk,
+                "name": "container11",
+                "ports": [],
+                "env": [],
+                "labels": [],
+                "sysctls": [],
+                "cap_add": [],
+                "cap_drop": ["FSETID", "MKNOD"],
+                "pid_mode": "host",
+                "extra_hosts": ["test1:192.168.1.2", "test2:192.168.1.3"],
+                "secOpt": ["apparmor:unconfined"],
+            },
         ]
 
     def test_that_patch_overwrites_data_only_when_explicitly_set(self):

netbox_docker_plugin-5.1.1/netbox_docker_plugin/tests/container/test_container_delete.py

@@ -0,0 +1,137 @@
+"""Container deletion tests — journal entry cleanup"""
+
+import time
+
+from django.contrib.contenttypes.models import ContentType
+from django.test import TestCase
+
+from extras.models import JournalEntry
+from netbox_docker_plugin.models.container import Container
+from netbox_docker_plugin.models.host import Host
+from netbox_docker_plugin.models.image import Image
+from netbox_docker_plugin.models.registry import Registry
+
+
+def _make_journal_entries(container, count):
+    ct = ContentType.objects.get_for_model(Container)
+    batch_size = 10000
+    for start in range(0, count, batch_size):
+        JournalEntry.objects.bulk_create(
+            [
+                JournalEntry(
+                    assigned_object_type=ct,
+                    assigned_object_id=container.pk,
+                    created_by=None,
+                    kind="info",
+                    comments=f"entry {start + i}",
+                )
+                for i in range(min(batch_size, count - start))
+            ]
+        )
+
+
+class ContainerDeleteJournalTestCase(TestCase):
+    """Verify that container deletion cleans up journal entries in batches."""
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.host = Host.objects.create(endpoint="http://localhost:8080", name="host1")
+        cls.registry = Registry.objects.create(
+            host=cls.host,
+            name="registry1",
+            serveraddress="http://localhost:8080",
+        )
+        cls.image = Image.objects.create(
+            host=cls.host, name="image1", registry=cls.registry
+        )
+
+    def _make_container(self, name="container1", state="exited"):
+        """Create and return a Container in the given state."""
+        return Container.objects.create(
+            host=self.host,
+            image=self.image,
+            name=name,
+            operation="none",
+            state=state,
+        )
+
+    def test_delete_container_with_no_journal_entries(self):
+        """Container with no journal entries can be deleted without errors."""
+        container = self._make_container()
+        pk = container.pk
+        t0 = time.monotonic()
+        container.delete()
+        print(
+            f"Deleted container (0 journal entries) in {(time.monotonic() - t0) * 1000:.1f}ms"
+        )
+
+        self.assertFalse(Container.objects.filter(pk=pk).exists())
+
+    def test_delete_container_removes_journal_entries(self):
+        """Journal entries linked to the deleted container are removed."""
+        container = self._make_container(name="container2")
+        _make_journal_entries(container, 5)
+        ct = ContentType.objects.get_for_model(Container)
+
+        self.assertEqual(
+            JournalEntry.objects.filter(
+                assigned_object_type=ct, assigned_object_id=container.pk
+            ).count(),
+            5,
+        )
+
+        pk = container.pk
+        t0 = time.monotonic()
+        container.delete()
+        print(
+            f"Deleted container (5 journal entries) in {(time.monotonic() - t0) * 1000:.1f}ms"
+        )
+
+        self.assertFalse(Container.objects.filter(pk=pk).exists())
+        self.assertEqual(
+            JournalEntry.objects.filter(
+                assigned_object_type=ct, assigned_object_id=pk
+            ).count(),
+            0,
+        )
+
+    def test_delete_container_removes_many_journal_entries(self):
+        """Deletion removes all journal entries regardless of count."""
+        container = self._make_container(name="container3")
+        _make_journal_entries(container, 500000)
+        ct = ContentType.objects.get_for_model(Container)
+
+        pk = container.pk
+        t0 = time.monotonic()
+        container.delete()
+        elapsed = (time.monotonic() - t0) * 1000
+        print(f"Deleted container (500000 journal entries) in {elapsed:.1f}ms")
+
+        self.assertFalse(Container.objects.filter(pk=pk).exists())
+        self.assertEqual(
+            JournalEntry.objects.filter(
+                assigned_object_type=ct, assigned_object_id=pk
+            ).count(),
+            0,
+        )
+
+    def test_delete_does_not_remove_journal_entries_of_other_containers(self):
+        """Deleting one container must not remove journal entries of another."""
+        container_a = self._make_container(name="container4a")
+        container_b = self._make_container(name="container4b")
+        _make_journal_entries(container_a, 3)
+        _make_journal_entries(container_b, 3)
+        ct = ContentType.objects.get_for_model(Container)
+
+        t0 = time.monotonic()
+        container_a.delete()
+        print(
+            f"Deleted container (3 journal entries) in {(time.monotonic() - t0) * 1000:.1f}ms"
+        )
+
+        self.assertEqual(
+            JournalEntry.objects.filter(
+                assigned_object_type=ct, assigned_object_id=container_b.pk
+            ).count(),
+            3,
+        )

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/tests/container/test_container_views.py

@@ -67,8 +67,12 @@ class ContainerViewsTestCase(
             "image": image1.pk,
             "restart_policy": "unless-stopped",
             "cap_add": ["NET_ADMIN"],
+            "cap_drop": ["FSETID", "MKNOD"],
+            "pid_mode": "host",
+            "extra_hosts": "test1:192.168.1.2,test2:192.168.1.3",
+            "secOpt": "apparmor:unconfined",
             "log_driver": "syslog",
-            "cmd": "ls,-al"
+            "cmd": "ls,-al",
         }
 
         cls.csv_data = (

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin/views/container.py

@@ -1,5 +1,9 @@
 """Container views definitions"""
 
+from collections import defaultdict
+from django.db import router
+from django.db.models.deletion import Collector
+from extras.models import JournalEntry
 from utilities.query import count_related
 from utilities.views import ViewTab, register_model_view
 from netbox.views import generic
@@ -125,11 +129,66 @@ class ContainerBulkDeleteView(generic.BulkDeleteView):
     table = tables.ContainerTable
 
 
+class _JournalEntryCount:
+    """Proxy passed to the deletion template in place of a full JournalEntry list.
+
+    The template calls len() for the accordion header count, then iterates to
+    render individual rows. This object answers len() with a single COUNT query
+    and yields nothing on iteration, avoiding fetching hundreds of thousands of
+    rows just to display a number."""
+
+    def __init__(self, queryset):
+        self._queryset = queryset
+        self._count = None
+
+    def __len__(self):
+        if self._count is None:
+            self._count = self._queryset.count()
+        return self._count
+
+    def __iter__(self):
+        return iter([])
+
+    def __bool__(self):
+        return len(self) > 0
+
+
 class ContainerDeleteView(generic.ObjectDeleteView):
     """Container delete view definition"""
 
     default_return_url = "plugins:netbox_docker_plugin:container_list"
-    queryset = Container.objects.all()
+    queryset = Container.objects.select_related("host", "image")
+
+    def _get_dependent_objects(self, obj):
+        class SkipJournalCollector(Collector):
+            """Collector that skips JournalEntry to avoid a slow full scan."""
+
+            def collect(self, objs, **kwargs):  # pylint: disable=arguments-differ
+                if getattr(objs, "model", None) is JournalEntry:
+                    return
+                super().collect(objs, **kwargs)
+
+        using = router.db_for_write(obj._meta.model)
+        collector = SkipJournalCollector(using=using)
+        collector.collect([obj])
+
+        dependent_objects = defaultdict(list)
+        for model, instances in collector.instances_with_model():
+            if model._meta.auto_created:
+                continue
+            if instances == obj:
+                continue
+            dependent_objects[model].append(instances)
+
+        journal_qs = JournalEntry.objects.filter(
+            assigned_object_type__app_label="netbox_docker_plugin",
+            assigned_object_type__model="container",
+            assigned_object_id=obj.pk,
+        )
+        if journal_qs.exists():
+            dependent_objects[JournalEntry] = _JournalEntryCount(journal_qs)
+
+        return dict(dependent_objects)
 
 
 class ContainerOperationView(generic.ObjectEditView):

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1/netbox_docker_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 5.0.1
+Version: 5.1.1
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin
@@ -10,6 +10,10 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: requests-mock; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
 Dynamic: license-file
 
 # Netbox Docker Plugin

{netbox_docker_plugin-5.0.1 → netbox_docker_plugin-5.1.1}/netbox_docker_plugin.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ netbox_docker_plugin/urls.py
 netbox_docker_plugin.egg-info/PKG-INFO
 netbox_docker_plugin.egg-info/SOURCES.txt
 netbox_docker_plugin.egg-info/dependency_links.txt
+netbox_docker_plugin.egg-info/requires.txt
 netbox_docker_plugin.egg-info/top_level.txt
 netbox_docker_plugin/api/__init__.py
 netbox_docker_plugin/api/renderers.py
@@ -75,6 +76,7 @@ netbox_docker_plugin/migrations/1039_alter_port_public_port.py
 netbox_docker_plugin/migrations/1040_alter_container_log_driver.py
 netbox_docker_plugin/migrations/1041_sysctl.py
 netbox_docker_plugin/migrations/1042_registry_username_max_length.py
+netbox_docker_plugin/migrations/1043_container_cap_drop_container_extra_hosts_and_more.py
 netbox_docker_plugin/migrations/__init__.py
 netbox_docker_plugin/models/__init__.py
 netbox_docker_plugin/models/container.py
@@ -102,6 +104,7 @@ netbox_docker_plugin/tests/container/__init__.py
 netbox_docker_plugin/tests/container/test_container_actions.py
 netbox_docker_plugin/tests/container/test_container_api.py
 netbox_docker_plugin/tests/container/test_container_api_exec.py
+netbox_docker_plugin/tests/container/test_container_delete.py
 netbox_docker_plugin/tests/container/test_container_operation_view.py
 netbox_docker_plugin/tests/container/test_container_validation.py
 netbox_docker_plugin/tests/container/test_container_views.py

netbox_docker_plugin-5.1.1/netbox_docker_plugin.egg-info/requires.txt

@@ -0,0 +1,5 @@
+
+[dev]
+requests-mock
+coverage
+pylint