netbox-docker-plugin 5.1.0__tar.gz → 5.2.0__tar.gz

{netbox_docker_plugin-5.1.0/netbox_docker_plugin.egg-info → netbox_docker_plugin-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 5.1.0
+Version: 5.2.0
 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.1.0 → netbox_docker_plugin-5.2.0}/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.1.0"
+    version = "5.2.0"
     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.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/api/serializers.py

@@ -5,6 +5,7 @@
 from rest_framework import serializers
 from utilities.query import dict_to_filter_params
 from users.models import Token
+from virtualization.api.serializers import VirtualMachineSerializer
 from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
 from ..models.host import Host
 from ..models.image import Image
@@ -693,6 +694,7 @@ class HostSerializer(NetBoxModelSerializer):
     containers = NestedContainerSerializer(many=True, read_only=True)
     registries = NestedRegistrySerializer(many=True, read_only=True)
     token = NestedTokenSerializer(read_only=True)
+    virtual_machine = VirtualMachineSerializer(required=False)
 
     class Meta:
         """Host Serializer Meta class"""
@@ -706,6 +708,7 @@ class HostSerializer(NetBoxModelSerializer):
             "name",
             "state",
             "token",
+            "virtual_machine",
             "netbox_base_url",
             "agent_version",
             "docker_api_version",

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/api/views.py

@@ -39,7 +39,13 @@ class HostViewSet(NetBoxModelViewSet):
     """Host view set class"""
 
     queryset = Host.objects.prefetch_related(
-        "images", "volumes", "networks", "containers", "registries", "tags"
+        "images",
+        "volumes",
+        "networks",
+        "containers",
+        "registries",
+        "virtual_machine",
+        "tags",
     )
     filterset_class = filtersets.HostFilterSet
     serializer_class = HostSerializer
@@ -108,7 +114,7 @@ class ImageViewSet(NetBoxModelViewSet):
                 url,
                 timeout=10,
                 data=json.dumps({"data": data}, cls=DjangoJSONEncoder),
-                headers={"Content-Type": "application/json"}
+                headers={"Content-Type": "application/json"},
             )
             resp.raise_for_status()
 

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/filtersets.py

@@ -38,6 +38,7 @@ class HostFilterSet(NetBoxModelFilterSet):
             "state",
             "agent_version",
             "docker_api_version",
+            "virtual_machine",
         )
 
     # pylint: disable=W0613

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/forms/host.py

@@ -2,7 +2,8 @@
 
 from django import forms
 from utilities.forms.rendering import FieldSet
-from utilities.forms.fields import TagFilterField
+from utilities.forms.fields import TagFilterField, DynamicModelChoiceField
+from virtualization.models import VirtualMachine
 from netbox.forms import (
     NetBoxModelForm,
     NetBoxModelImportForm,
@@ -12,9 +13,43 @@ from netbox.forms import (
 from ..models.host import Host, HostStateChoices
 
 
+class HostAddForm(NetBoxModelForm):
+    """Host form definition class"""
+
+    virtual_machine = DynamicModelChoiceField(
+        queryset=VirtualMachine.objects.all(),
+        selector=True,
+        required=False,
+        label="Virtual Machine",
+    )
+
+    class Meta:
+        """Host form definition Meta class"""
+
+        model = Host
+        fields = (
+            "name",
+            "endpoint",
+            "virtual_machine",
+        )
+        help_texts = {"name": "Unique Name", "endpoint": "Docker instance endpoint"}
+        labels = {"name": "Name", "endpoint": "Endpoint"}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields.pop("tags", None)
+
+
 class HostForm(NetBoxModelForm):
     """Host form definition class"""
 
+    virtual_machine = DynamicModelChoiceField(
+        queryset=VirtualMachine.objects.all(),
+        selector=True,
+        required=False,
+        label="Virtual Machine",
+    )
+
     class Meta:
         """Host form definition Meta class"""
 
@@ -22,6 +57,7 @@ class HostForm(NetBoxModelForm):
         fields = (
             "name",
             "endpoint",
+            "virtual_machine",
             "tags",
         )
         help_texts = {"name": "Unique Name", "endpoint": "Docker instance endpoint"}

netbox_docker_plugin-5.2.0/netbox_docker_plugin/migrations/1044_host_virtual_machine.py

@@ -0,0 +1,29 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        (
+            "netbox_docker_plugin",
+            "1043_container_cap_drop_container_extra_hosts_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="host",
+            name="virtual_machine",
+            field=models.OneToOneField(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="virtualization.virtualmachine",
+            ),
+        ),
+    ]

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/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
@@ -306,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}"
 
@@ -314,6 +328,7 @@ class Container(NetBoxModel):
         return reverse("plugins:netbox_docker_plugin:container", args=[self.pk])
 
     def clean(self):
+        """Validate that the image belongs to the same host and has been pulled."""
         super().clean()
 
         if self.host != self.image.host:
@@ -321,6 +336,11 @@ class Container(NetBoxModel):
                 {"image": f"Image {self.image} does not belong to host {self.host}."}
             )
 
+        if not self.image.ImageID:
+            raise ValidationError(
+                {"image": f"Image {self.image} has no ID yet. Pull or refresh it first."}
+            )
+
 
 class Port(models.Model):
     """Container definition class"""

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/models/host.py

@@ -9,6 +9,7 @@ from django.core.validators import (
 )
 from utilities.choices import ChoiceSet
 from users.models import Token
+from virtualization.models import VirtualMachine
 from netbox.models import NetBoxModel
 
 
@@ -64,6 +65,12 @@ class Host(NetBoxModel):
         default=HostStateChoices.STATE_CREATED,
     )
     token = models.ForeignKey(Token, on_delete=models.SET_NULL, null=True, blank=True)
+    virtual_machine = models.OneToOneField(
+        VirtualMachine,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
     netbox_base_url = models.CharField(
         max_length=1024,
         validators=[URLValidator()],

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tables.py

@@ -26,6 +26,7 @@ class HostTable(NetBoxTable):
     """Host Table definition class"""
 
     name = tables.Column(linkify=True)
+    virtual_machine = tables.Column(linkify=True, verbose_name="Virtual Machine")
     image_count = columns.LinkedCountColumn(
         viewname="plugins:netbox_docker_plugin:image_list",
         url_params={"host_id": "pk"},
@@ -62,6 +63,7 @@ class HostTable(NetBoxTable):
             "name",
             "endpoint",
             "state",
+            "virtual_machine",
             "agent_version",
             "docker_api_version",
             "image_count",

netbox_docker_plugin-5.2.0/netbox_docker_plugin/template_content.py

@@ -0,0 +1,23 @@
+"""Template modifications definitions"""
+
+# pylint: disable=W0223
+
+from netbox.plugins import PluginTemplateExtension
+from .models import Host
+
+
+class VirtualMachineHostTable(PluginTemplateExtension):
+    """Virtual machine object template"""
+
+    models = ["virtualization.virtualmachine"]
+
+    def right_page(self):
+        return self.render(
+            "netbox_docker_plugin/virtual_machine_host_table.html",
+            extra_context={
+                "Host": Host.objects.filter(virtual_machine=self.context["object"])
+            },
+        )
+
+
+template_extensions = [VirtualMachineHostTable]

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/templates/netbox_docker_plugin/host.html

@@ -27,6 +27,17 @@
           <th scope="row">Endpoint</th>
           <td>{{ object.endpoint|remove_password }}</td>
         </tr>
+        <tr>
+          <th scope="row">Virtual Machine</th>
+          <td>
+            {% if object.virtual_machine %}
+            <a href="{% url 'virtualization:virtualmachine' pk=object.virtual_machine.pk %}">
+              {{ object.virtual_machine|placeholder }}</a>
+            {% else %}
+            {{ object.virtual_machine|placeholder }}</a>
+            {% endif %}
+          </td>
+        </tr>
         <tr>
           <th scope="row">State</th>
           <td>{{ object.get_state_display }}</td>

netbox_docker_plugin-5.2.0/netbox_docker_plugin/templates/netbox_docker_plugin/virtual_machine_host_table.html

@@ -0,0 +1,4 @@
+<div class="card">
+    <h2 class="card-header">Docker Host</h2>
+    {% htmx_table 'plugins:netbox_docker_plugin:host_list' virtual_machine=object.pk %}
+</div>

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -70,8 +70,18 @@ class ContainerApiTestCase(
             host=host2, name="registry2", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image2", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1,
+            name="image1",
+            registry=registry1,
+            ImageID="sha256:abc123",
+        )
+        image2 = Image.objects.create(
+            host=host2,
+            name="image2",
+            registry=registry2,
+            ImageID="sha256:abc456",
+        )
 
         network1 = Network.objects.create(host=host1, name="network1")
         network2 = Network.objects.create(host=host2, name="network2")
@@ -244,6 +254,7 @@ class ContainerApiTestCase(
             host=host3,
             name="image3",
             registry=registry3,
+            ImageID="sha256:abc789",
         )
         container11 = Container.objects.create(
             host=host3,
@@ -330,8 +341,18 @@ class ContainerApiTestCase(
             host=host2, name="registry5", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1,
+            name="image",
+            registry=registry1,
+            ImageID="sha256:abc101112",
+        )
+        image2 = Image.objects.create(
+            host=host2,
+            name="image",
+            registry=registry2,
+            ImageID="sha256:abc131415",
+        )
 
         container = Container.objects.create(host=host1, image=image1, name="container")
 

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tests/container/test_container_api_exec.py

@@ -28,7 +28,12 @@ class ContainerApiExecTestCase(BaseAPITestCase):
             host=host1, name="registry1", serveraddress="http://localhost:8080"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
+        image1 = Image.objects.create(
+            host=host1,
+            name="image1",
+            registry=registry1,
+            ImageID="sha256:abc123",
+        )
 
         container = Container.objects.create(
             host=host1,
@@ -86,11 +91,11 @@ class ContainerApiExecTestCase(BaseAPITestCase):
             m.put(
                 "http://localhost:8080/api/engine/containers/1234/exec",
                 text="Error",
-                status_code= 500
+                status_code=500,
             )
 
             response = self.client.post(
                 self.endpoint, **self.header, data={"cmd": ["ls"]}, format="json"
             )
             self.assertHttpStatus(response, status.HTTP_502_BAD_GATEWAY)
-            self.assertEqual(response.data, 'Error')
+            self.assertEqual(response.data, "Error")

netbox_docker_plugin-5.2.0/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.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tests/container/test_container_operation_view.py

@@ -257,8 +257,12 @@ class ContainerViewsTestCase(BaseModelViewTestCase, ModelViewTestCase):
             host=host2, name="registry2", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image2", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1, name="image1", registry=registry1, ImageID="sha256:abc123"
+        )
+        image2 = Image.objects.create(
+            host=host2, name="image2", registry=registry2, ImageID="sha256:abc456"
+        )
 
         Container.objects.create(
             host=host1,

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tests/container/test_container_validation.py

@@ -39,6 +39,36 @@ class ContainerValidationTestCase(TestCase):
 
         self.assertTrue(isinstance(container.id, int))
 
+    def test_that_container_image_must_have_an_id(self):
+        """Test that the image must have been pulled (non-empty ImageID)"""
+
+        with self.assertRaises(ValidationError) as cm:
+            container = Container(
+                host=self.objects["host1"],
+                image=self.objects["image1"],
+                name="container_no_image_id",
+                operation="none",
+                state="created",
+            )
+            container.clean()
+
+        self.assertEqual(
+            cm.exception.message_dict["image"],
+            ["Image image1:latest has no ID yet. Pull or refresh it first."],
+        )
+
+    def test_that_container_image_with_id_passes_validation(self):
+        """Test that an image with a non-empty ImageID passes validation"""
+
+        container = Container(
+            host=self.objects["host1"],
+            image=self.objects["image1_pulled"],
+            name="container_with_image_id",
+            operation="none",
+            state="created",
+        )
+        container.clean()  # must not raise
+
     def test_that_container_image_must_be_on_the_same_host(self):
         """Test that Container image must be on the same host"""
 
@@ -138,6 +168,12 @@ class ContainerValidationTestCase(TestCase):
         cls.objects["image1"] = Image.objects.create(
             host=cls.objects["host1"], name="image1", registry=cls.objects["registry1"]
         )
+        cls.objects["image1_pulled"] = Image.objects.create(
+            host=cls.objects["host1"],
+            name="image1_pulled",
+            registry=cls.objects["registry1"],
+            ImageID="sha256:abc123",
+        )
         cls.objects["image2"] = Image.objects.create(
             host=cls.objects["host2"], name="image2", registry=cls.objects["registry2"]
         )

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tests/container/test_container_views.py

@@ -28,8 +28,12 @@ class ContainerViewsTestCase(
             host=host2, name="registry2", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image2", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1, name="image1", registry=registry1, ImageID="sha256:abc123"
+        )
+        image2 = Image.objects.create(
+            host=host2, name="image2", registry=registry2, ImageID="sha256:abc456"
+        )
 
         container1 = Container.objects.create(
             host=host1,

{netbox_docker_plugin-5.1.0 → netbox_docker_plugin-5.2.0}/netbox_docker_plugin/tests/host/test_host_views.py

@@ -26,6 +26,7 @@ class HostViewsTestCase(BaseModelViewTestCase, ViewTestCases.PrimaryObjectViewTe
         "host7,http://localhost:8084",
     )
     bulk_edit_data = {"endpoint": "http://localhost:8083"}
+    validation_excluded_fields = ["tags"]
 
     def setUp(self):
         super().setUp()
@@ -91,8 +92,7 @@ class HostViewsTestCase(BaseModelViewTestCase, ViewTestCases.PrimaryObjectViewTe
         """Test the host error state"""
 
         self.assertEqual(
-           self.objects["host_error_state"].state,
-            HostStateChoices.STATE_ERROR
+            self.objects["host_error_state"].state, HostStateChoices.STATE_ERROR
         )
 
     @classmethod