netbox-docker-plugin 1.6.2__tar.gz → 1.8.0__tar.gz

{netbox_docker_plugin-1.6.2/netbox_docker_plugin.egg-info → netbox_docker_plugin-1.8.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.6.2
+Version: 1.8.0
 Summary: Manage Docker with Netbox & style.
-Author-email: Vincent Simonin <vincent@saashup.com>
+Author-email: Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin
 Project-URL: Bug Tracker, https://github.com/SaaShup/netbox-docker-plugin/issues
 Keywords: netbox,netbox-plugin,docker

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/__init__.py

@@ -10,12 +10,14 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "1.6.2"
+    version = "1.8.0"
     base_url = "docker"
-    author= "Vincent Simonin"
-    author_email= "vincent@saashup.com"
+    author= "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"
+    author_email= "vincent@saashup.com, david.jose.delassus@gmail.com"
 
     def ready(self):
+        from . import signals # pylint: disable=unused-import, import-outside-toplevel
+
         post_migrate.connect(create_webhook)
 
         super().ready()

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/api/serializers.py

@@ -159,6 +159,7 @@ class NestedMountSerializer(WritableNestedSerializer):
         fields = (
             "id",
             "source",
+            "read_only",
         )
 
 
@@ -340,6 +341,7 @@ class MountSerializer(serializers.ModelSerializer):
         fields = (
             "source",
             "volume",
+            "read_only",
         )
 
 
@@ -353,6 +355,7 @@ class BindSerializer(serializers.ModelSerializer):
         fields = (
             "host_path",
             "container_path",
+            "read_only",
         )
 
 

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/forms/bind.py

@@ -27,11 +27,13 @@ class BindForm(BootstrapMixin, forms.ModelForm):
             "container",
             "host_path",
             "container_path",
+            "read_only",
         )
         labels = {
             "container": "Container",
             "host_path": "Path to mount on host",
             "container_path": "Mountpoint in container",
+            "read_only": "Mount as read-only within the container",
         }
 
 

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/forms/container.py

@@ -14,11 +14,7 @@ from netbox.forms import (
 )
 from ..models.volume import Volume
 from ..models.host import Host
-from ..models.container import (
-    Container,
-    ContainerStateChoices,
-    ContainerRestartPolicyChoices,
-)
+from ..models.container import Container, ContainerRestartPolicyChoices
 from ..models.image import Image
 
 
@@ -44,7 +40,6 @@ class ContainerForm(NetBoxModelForm):
             "image",
             "name",
             "hostname",
-            "state",
             "restart_policy",
             "tags",
         )
@@ -53,7 +48,6 @@ class ContainerForm(NetBoxModelForm):
             "host": "Host",
             "image": "Image",
             "hostname": "Hostname",
-            "state": "State",
             "restart_policy": "Restart Policy",
         }
 
@@ -79,9 +73,6 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
         required=False,
         label="Image",
     )
-    state = forms.ChoiceField(
-        label="State", choices=ContainerStateChoices, required=False
-    )
     restart_policy = forms.ChoiceField(
         label="Restart Policy", choices=ContainerRestartPolicyChoices, required=False
     )
@@ -91,13 +82,6 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
 class ContainerImportForm(NetBoxModelImportForm):
     """Container importation form definition class"""
 
-    state = forms.ChoiceField(
-        label="State",
-        choices=ContainerStateChoices,
-        required=False,
-        help_text="Container State. Can be `created`, `restarting`, "
-        + "`running`, `paused`, `exited` or `dead`.",
-    )
     restart_policy = forms.ChoiceField(
         label="Restart Policy",
         choices=ContainerRestartPolicyChoices,
@@ -114,7 +98,6 @@ class ContainerImportForm(NetBoxModelImportForm):
             "name",
             "host",
             "image",
-            "state",
             "hostname",
         )
         labels = {
@@ -127,11 +110,6 @@ class ContainerImportForm(NetBoxModelImportForm):
 class ContainerBulkEditForm(NetBoxModelBulkEditForm):
     """Container bulk edit form definition class"""
 
-    state = forms.ChoiceField(
-        label="State",
-        choices=ContainerStateChoices,
-        required=True,
-    )
     restart_policy = forms.ChoiceField(
         label="Restart Policy",
         choices=ContainerRestartPolicyChoices,
@@ -142,7 +120,7 @@ class ContainerBulkEditForm(NetBoxModelBulkEditForm):
     )
 
     model = Container
-    fieldsets = (("General", ("state", "restart_policy", "hostname")),)
+    fieldsets = (("General", ("restart_policy", "hostname")),)
 
 
 class ContainerOperationForm(NetBoxModelForm):

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/forms/mount.py

@@ -31,11 +31,13 @@ class MountForm(BootstrapMixin, forms.ModelForm):
             "container",
             "source",
             "volume",
+            "read_only",
         )
         labels = {
             "container": "Container",
             "source": "Source directory",
             "volume": "Volume",
+            "read_only": "Mount as read-only within the container",
         }
 
 

netbox_docker_plugin-1.8.0/netbox_docker_plugin/migrations/0028_mount_and_bind_read_only.py

@@ -0,0 +1,25 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "0027_container_restart_policy"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="mount",
+            name="read_only",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="bind",
+            name="read_only",
+            field=models.BooleanField(default=False),
+        ),
+    ]

netbox_docker_plugin-1.8.0/netbox_docker_plugin/migrations/0029_alter_container_state.py

@@ -0,0 +1,20 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "0028_mount_and_bind_read_only"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="container",
+            name="state",
+            field=models.CharField(default="none", max_length=32),
+        ),
+    ]

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/models/container.py

@@ -16,7 +16,7 @@ from utilities.choices import ChoiceSet
 from utilities.querysets import RestrictedQuerySet
 from netbox.models import NetBoxModel
 from .image import Image
-from .host import Host
+from .host import Host, HostStateChoices
 from .network import Network
 from .volume import Volume
 
@@ -26,7 +26,7 @@ class ContainerStateChoices(ChoiceSet):
 
     key = "Container.state"
 
-    DEFAULT_VALUE = "created"
+    DEFAULT_VALUE = "none"
 
     CHOICES = [
         ("created", "Created", "dark"),
@@ -133,6 +133,39 @@ class Container(NetBoxModel):
         default=ContainerRestartPolicyChoices.DEFAULT_VALUE,
     )
 
+    @property
+    def can_create(self) -> bool:
+        """ Check if the container can be created """
+        return self.state == "none"
+
+    @property
+    def can_start(self) -> bool:
+        """ Check if the container can be started """
+        return self.state in ["created", "exited", "dead"]
+
+    @property
+    def can_stop(self) -> bool:
+        """ Check if the container can be stopped """
+        return self.state in ["running"]
+
+    @property
+    def can_restart(self) -> bool:
+        """ Check if the container can be restarted """
+        return self.state in ["running"]
+
+    @property
+    def can_recreate(self) -> bool:
+        """ Check if the container can be recreated """
+        return self.state in ["created", "running", "exited", "dead"]
+
+    @property
+    def can_delete(self) -> bool:
+        """ Check if the container can be deleted """
+        return (
+            self.host.state == HostStateChoices.STATE_DELETED
+            or self.state in ["created", "paused", "exited", "dead"]
+        )
+
     class Meta:
         """Image Model Meta Class"""
 
@@ -301,6 +334,9 @@ class Mount(models.Model):
             MaxLengthValidator(limit_value=1024),
         ],
     )
+    read_only = models.BooleanField(
+        default=False,
+    )
 
     class Meta:
         """Mount Model Meta Class"""
@@ -349,6 +385,9 @@ class Bind(models.Model):
             MaxLengthValidator(limit_value=1024),
         ],
     )
+    read_only = models.BooleanField(
+        default=False,
+    )
 
     class Meta:
         """Mount Model Meta Class"""

netbox_docker_plugin-1.8.0/netbox_docker_plugin/signals.py

@@ -0,0 +1,33 @@
+""" Hooks on Django model signals. """
+
+from django.db.models.signals import pre_delete, pre_save
+from django.dispatch import receiver
+from utilities.exceptions import AbortRequest
+
+from .models import Container
+
+
+@receiver(pre_delete, sender=Container)
+def prevent_deleting_running_containers(instance, **_kwargs):
+    """ Abort deletion if container is running. """
+
+    if not instance.can_delete:
+        raise AbortRequest(
+            f"The container {instance.name} is running, please stop it before deletion"
+        )
+
+
+@receiver(pre_save, sender=Container)
+def restrict_container_actions(instance, **_kwargs):
+    """ Check if the container's state is correct for the given action """
+
+    if any([
+        instance.operation == "create" and not instance.can_create,
+        instance.operation == "start" and not instance.can_start,
+        instance.operation == "restart" and not instance.can_restart,
+        instance.operation == "stop" and not instance.can_stop,
+        instance.operation == "recreate" and not instance.can_recreate,
+    ]):
+        raise AbortRequest(
+            f"Cannot {instance.operation} container {instance.name} in state {instance.state}"
+        )

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/tables.py

@@ -335,8 +335,18 @@ class MountTable(NetBoxTable):
         """Mount Table definition Meta class"""
 
         model = Mount
-        fields = ("container", "source", "volume", "container")
-        default_columns = ("container", "source", "volume")
+        fields = (
+            "container",
+            "source",
+            "volume",
+            "read_only",
+        )
+        default_columns = (
+            "container",
+            "source",
+            "volume",
+            "read_only",
+        )
 
 
 class BindTable(NetBoxTable):
@@ -350,8 +360,18 @@ class BindTable(NetBoxTable):
         """Bind Table definition Meta class"""
 
         model = Bind
-        fields = ("container", "host_path", "container_path")
-        default_columns = ("container", "host_path", "container_path")
+        fields = (
+            "container",
+            "host_path",
+            "container_path",
+            "read_only",
+        )
+        default_columns = (
+            "container",
+            "host_path",
+            "container_path",
+            "read_only",
+        )
 
 
 class NetworkSettingTable(NetBoxTable):

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -6,7 +6,13 @@
 <form action="{% url 'plugins:netbox_docker_plugin:container_operation' pk=object.id operation='start' %}" method="post">
   {% csrf_token %}
   <input type="hidden" name="operation" value="start">
-  <button type="submit" class="btn btn-sm btn-success">
+  <button
+    type="submit"
+    class="btn btn-sm btn-success"
+    {% if not object.can_start %}
+    disabled
+    {% endif %}
+  >
     <i class="mdi mdi-play"></i> Start
   </button>
 </form>
@@ -14,7 +20,13 @@
 <form action="{% url 'plugins:netbox_docker_plugin:container_operation' pk=object.id operation='stop' %}" method="post">
   {% csrf_token %}
   <input type="hidden" name="operation" value="stop">
-  <button type="submit" class="btn btn-sm btn-danger">
+  <button
+    type="submit"
+    class="btn btn-sm btn-danger"
+    {% if not object.can_stop %}
+    disabled
+    {% endif %}
+  >
     <i class="mdi mdi-stop"></i> Stop
   </button>
 </form>
@@ -22,7 +34,13 @@
 <form action="{% url 'plugins:netbox_docker_plugin:container_operation' pk=object.id operation='restart' %}" method="post">
   {% csrf_token %}
   <input type="hidden" name="operation" value="restart">
-  <button type="submit" class="btn btn-sm btn-light">
+  <button
+    type="submit"
+    class="btn btn-sm btn-light"
+    {% if not object.can_restart %}
+    disabled
+    {% endif %}
+  >
     <i class="mdi mdi-restart"></i> Restart
   </button>
 </form>
@@ -30,7 +48,13 @@
 <form action="{% url 'plugins:netbox_docker_plugin:container_operation' pk=object.id operation='recreate' %}" method="post">
   {% csrf_token %}
   <input type="hidden" name="operation" value="recreate">
-  <button type="submit" class="btn btn-sm btn-dark">
+  <button
+    type="submit"
+    class="btn btn-sm btn-dark"
+    {% if not object.can_recreate %}
+    disabled
+    {% endif %}
+  >
     <i class="mdi mdi-autorenew"></i> Recreate
   </button>
 </form>

netbox_docker_plugin-1.8.0/netbox_docker_plugin/tests/container/test_container_actions.py

@@ -0,0 +1,171 @@
+""" Container action restrictions test suite """
+
+from django.db import transaction
+from django.test import TestCase
+from utilities.exceptions import AbortRequest
+from netbox_docker_plugin.models.container import Container
+from netbox_docker_plugin.models.host import Host, HostStateChoices
+from netbox_docker_plugin.models.image import Image
+from netbox_docker_plugin.models.registry import Registry
+
+
+class ContainerActionTestCase(TestCase):
+    """ Test the various scenarii of container actions """
+
+    objects = {}
+
+    def test_allowed_operations(self):
+        """ Test that only specific operations are allowed according to a state """
+
+        cases = [
+            ("create", ["none"]),
+            ("start", ["created", "exited", "dead"]),
+            ("stop", ["running"]),
+            ("restart", ["running"]),
+            ("recreate", ["created", "exited", "dead", "running"]),
+            ("noop", ["created", "restarting", "running", "paused", "exited", "dead", "none"]),
+        ]
+
+        for operation, states in cases:
+            for state in states:
+                with self.subTest(operation=operation, state=state):
+                    with transaction.atomic():
+                        name = f"container-{operation}-{state}"
+                        obj = Container.objects.create(
+                            host=self.objects["host1"],
+                            image=self.objects["image2"],
+                            name=name,
+                            operation="none",
+                            state=state,
+                        )
+
+                        obj.operation = operation
+                        obj.save()
+
+                    self.assertEqual(
+                        Container.objects.get(name=name).operation,
+                        operation,
+                    )
+
+    def test_forbidden_operations(self):
+        """ Test that forbidden operations raise an AbortRequest """
+
+        cases = [
+            ("create", ["created", "restarting", "running", "paused", "exited", "dead"]),
+            ("start", ["running", "restarting", "paused", "none"]),
+            ("stop", ["created", "restarting", "paused", "exited", "dead", "none"]),
+            ("restart", ["created", "restarting", "paused", "exited", "dead", "none"]),
+            ("recreate", ["restarting", "paused", "none"]),
+        ]
+
+        for operation, states in cases:
+            for state in states:
+                with self.subTest(operation=operation, state=state):
+                    with transaction.atomic():
+                        with self.assertRaises(
+                            AbortRequest,
+                            msg=f"AbortRequest not raised for {state}",
+                        ):
+                            name = f"container-{operation}-{state}"
+                            obj = Container.objects.create(
+                                host=self.objects["host1"],
+                                image=self.objects["image2"],
+                                name=name,
+                                operation="none",
+                                state=state,
+                            )
+
+                            obj.operation = operation
+                            obj.save()
+
+    def test_delete_non_running_container(self):
+        """ Test that a non running container can be deleted """
+
+        for state in ["created", "paused", "exited", "dead"]:
+            with self.subTest(operation="delete", state=state):
+                with transaction.atomic():
+                    name = f"container-delete-{state}"
+                    obj = Container.objects.create(
+                        host=self.objects["host1"],
+                        image=self.objects["image2"],
+                        name=name,
+                        operation="none",
+                        state=state,
+                    )
+
+                    obj.delete()
+
+                self.assertFalse(Container.objects.filter(name=name).exists())
+
+    def test_delete_running_container(self):
+        """ Test that a running container cannot be deleted """
+
+        for state in ["running", "restarting", "none"]:
+            with self.subTest(operation="delete", state=state):
+                with transaction.atomic():
+                    with self.assertRaises(
+                        AbortRequest,
+                        msg=f"AbortRequest not raised for {state}",
+                    ):
+                        name = f"container-delete-{state}"
+                        obj = Container.objects.create(
+                            host=self.objects["host1"],
+                            image=self.objects["image2"],
+                            name=name,
+                            operation="none",
+                            state=state,
+                        )
+
+                        obj.delete()
+
+    def test_delete_container_on_deleted_host(self):
+        """ Test that a container on a deleted host can be deleted """
+
+        for state in ["created", "running", "restarted", "paused", "exited", "dead", "none"]:
+            with self.subTest(operation="delete", state=state):
+                with transaction.atomic():
+                    name = f"container-delete-{state}"
+                    obj = Container.objects.create(
+                        host=self.objects["host2"],
+                        image=self.objects["image2"],
+                        name=name,
+                        operation="none",
+                        state=state,
+                    )
+
+                    obj.delete()
+
+                self.assertFalse(Container.objects.filter(name=name).exists())
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.objects["host1"] = Host.objects.create(
+            endpoint="http://localhost:8080",
+            name="host1",
+        )
+        cls.objects["registry1"] = Registry.objects.create(
+            host=cls.objects["host1"],
+            name="registry1",
+            serveraddress="http://localhost:8080",
+        )
+        cls.objects["image2"] = Image.objects.create(
+            host=cls.objects["host1"],
+            registry=cls.objects["registry1"],
+            name="image2",
+        )
+
+        cls.objects["host2"] = Host.objects.create(
+            endpoint="http://localhost:8080",
+            name="host2",
+            state=HostStateChoices.STATE_DELETED,
+        )
+        cls.objects["registry2"] = Registry.objects.create(
+            host=cls.objects["host2"],
+            name="registry2",
+            serveraddress="http://localhost:8080",
+        )
+        cls.objects["image2"] = Image.objects.create(
+            host=cls.objects["host2"],
+            registry=cls.objects["registry2"],
+            name="image2",
+        )

{netbox_docker_plugin-1.6.2 → netbox_docker_plugin-1.8.0}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -1,3 +1,4 @@
+# pylint: disable=R0801
 """Container Test Case"""
 
 from utilities.testing import APIViewTestCases
@@ -64,9 +65,27 @@ class ContainerApiTestCase(
         volume2 = Volume.objects.create(host=host1, name="volume2")
         volume3 = Volume.objects.create(host=host2, name="volume3")
 
-        Container.objects.create(host=host1, image=image1, name="container1")
-        Container.objects.create(host=host1, image=image1, name="container2")
-        Container.objects.create(host=host2, image=image2, name="container3")
+        Container.objects.create(
+            host=host1,
+            image=image1,
+            name="container1",
+            operation="none",
+            state="created",
+        )
+        Container.objects.create(
+            host=host1,
+            image=image1,
+            name="container2",
+            operation="none",
+            state="created",
+        )
+        Container.objects.create(
+            host=host2,
+            image=image2,
+            name="container3",
+            operation="none",
+            state="created",
+        )
 
         cls.create_data = [
             {