netbox-docker-plugin 1.5.2__tar.gz → 1.6.1__tar.gz

{netbox_docker_plugin-1.5.2/netbox_docker_plugin.egg-info → netbox_docker_plugin-1.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.5.2
+Version: 1.6.1
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/__init__.py

@@ -10,7 +10,7 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "1.5.2"
+    version = "1.6.1"
     base_url = "docker"
     author= "Vincent Simonin"
     author_email= "vincent@saashup.com"

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/api/serializers.py

@@ -3,6 +3,7 @@
 # pylint: disable=E1101
 
 from rest_framework import serializers
+from utilities.utils import dict_to_filter_params
 from users.api.nested_serializers import NestedTokenSerializer
 from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
 from ..models.host import Host
@@ -63,6 +64,7 @@ class NestedImageSerializer(WritableNestedSerializer):
             "version",
             "size",
             "ImageID",
+            "Digest",
         )
 
 
@@ -85,6 +87,20 @@ class NestedVolumeSerializer(WritableNestedSerializer):
             "driver",
         )
 
+    def to_internal_value(self, data):
+        if data is None:
+            return None
+
+        if isinstance(data, dict):
+            params = dict_to_filter_params(data)
+            if Volume.objects.filter(**params).count() == 0:
+                host = Host.objects.get(pk=params["host"])
+                volume = Volume(host= host, name= params["name"])
+                volume.save()
+                return volume
+
+        return super().to_internal_value(data)
+
 
 class NestedNetworkSerializer(WritableNestedSerializer):
     """Nested Network Serializer class"""
@@ -126,6 +142,7 @@ class NestedContainerSerializer(WritableNestedSerializer):
             "ContainerID",
             "state",
             "status",
+            "restart_policy",
             "operation",
             "hostname",
         )
@@ -203,6 +220,7 @@ class ImageSerializer(NetBoxModelSerializer):
             "registry",
             "size",
             "ImageID",
+            "Digest",
             "custom_fields",
             "created",
             "last_updated",
@@ -379,6 +397,7 @@ class ContainerSerializer(NetBoxModelSerializer):
             "status",
             "ContainerID",
             "hostname",
+            "restart_policy",
             "ports",
             "env",
             "labels",

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/filtersets.py

@@ -165,7 +165,7 @@ class ContainerFilterSet(NetBoxModelFilterSet):
         """Container filterset definition meta class"""
 
         model = Container
-        fields = ("id", "name", "state", "hostname")
+        fields = ("id", "name", "state", "hostname", "restart_policy")
 
     # pylint: disable=W0613
     def search(self, queryset, name, value):

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/forms/container.py

@@ -14,7 +14,11 @@ from netbox.forms import (
 )
 from ..models.volume import Volume
 from ..models.host import Host
-from ..models.container import Container, ContainerStateChoices
+from ..models.container import (
+    Container,
+    ContainerStateChoices,
+    ContainerRestartPolicyChoices,
+)
 from ..models.image import Image
 
 
@@ -41,6 +45,7 @@ class ContainerForm(NetBoxModelForm):
             "name",
             "hostname",
             "state",
+            "restart_policy",
             "tags",
         )
         labels = {
@@ -49,6 +54,7 @@ class ContainerForm(NetBoxModelForm):
             "image": "Image",
             "hostname": "Hostname",
             "state": "State",
+            "restart_policy": "Restart Policy",
         }
 
 
@@ -76,6 +82,9 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
     state = forms.ChoiceField(
         label="State", choices=ContainerStateChoices, required=False
     )
+    restart_policy = forms.ChoiceField(
+        label="Restart Policy", choices=ContainerRestartPolicyChoices, required=False
+    )
     tag = TagFilterField(model)
 
 
@@ -87,7 +96,14 @@ class ContainerImportForm(NetBoxModelImportForm):
         choices=ContainerStateChoices,
         required=False,
         help_text="Container State. Can be `created`, `restarting`, "
-        + "`running`, `paused`, `exited`or `dead`.",
+        + "`running`, `paused`, `exited` or `dead`.",
+    )
+    restart_policy = forms.ChoiceField(
+        label="Restart Policy",
+        choices=ContainerRestartPolicyChoices,
+        required=False,
+        help_text="Container restart policy. Can be `no`, `on-failure`, "
+        + "`always`, `unless-stopped`.",
     )
 
     class Meta:
@@ -105,9 +121,6 @@ class ContainerImportForm(NetBoxModelImportForm):
             "name": "Unique container name",
             "host": "Host identifier",
             "image": "Image identifier",
-            "state": "Container State. Can be `created`, `restarting`, "
-            + "`running`, `paused`, `exited`or `dead`.",
-            "hostname": "Container hostname"
         }
 
 
@@ -119,12 +132,17 @@ class ContainerBulkEditForm(NetBoxModelBulkEditForm):
         choices=ContainerStateChoices,
         required=True,
     )
+    restart_policy = forms.ChoiceField(
+        label="Restart Policy",
+        choices=ContainerRestartPolicyChoices,
+        required=True,
+    )
     hostname = forms.CharField(
         label="Hostname", max_length=256, min_length=1, required=False
     )
 
     model = Container
-    fieldsets = (("General", ("state", "hostname")),)
+    fieldsets = (("General", ("state", "restart_policy", "hostname")),)
 
 
 class ContainerOperationForm(NetBoxModelForm):

netbox_docker_plugin-1.6.1/netbox_docker_plugin/migrations/0026_image_digest.py

@@ -0,0 +1,29 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "0025_alter_image_version"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="image",
+            name="Digest",
+            field=models.CharField(
+                blank=True,
+                max_length=512,
+                null=True,
+                validators=[
+                    django.core.validators.MinLengthValidator(limit_value=1),
+                    django.core.validators.MaxLengthValidator(limit_value=512),
+                ],
+            ),
+        ),
+    ]

netbox_docker_plugin-1.6.1/netbox_docker_plugin/migrations/0027_container_restart_policy.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", "0026_image_digest"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="container",
+            name="restart_policy",
+            field=models.CharField(default="no", max_length=32),
+        ),
+    ]

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/models/container.py

@@ -56,6 +56,21 @@ class ContainerOperationChoices(ChoiceSet):
     ]
 
 
+class ContainerRestartPolicyChoices(ChoiceSet):
+    """Container restart policy choices definition class"""
+
+    key = "Container.restart_policy"
+
+    DEFAULT_VALUE = "no"
+
+    CHOICES = [
+        ("no", "no", "dark"),
+        ("on-failure", "on-failure", "blue"),
+        ("always", "always", "blue"),
+        ("unless-stopped", "unless-stopped", "blue"),
+    ]
+
+
 class PortTypeChoices(ChoiceSet):
     """Port type choices definition class"""
 
@@ -112,6 +127,11 @@ class Container(NetBoxModel):
         blank=True,
         null=True,
     )
+    restart_policy = models.CharField(
+        max_length=32,
+        choices=ContainerRestartPolicyChoices,
+        default=ContainerRestartPolicyChoices.DEFAULT_VALUE,
+    )
 
     class Meta:
         """Image Model Meta Class"""

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/models/image.py

@@ -53,6 +53,15 @@ class Image(NetBoxModel):
         blank=True,
         null=True,
     )
+    Digest = models.CharField(
+        max_length=512,
+        validators=[
+            MinLengthValidator(limit_value=1),
+            MaxLengthValidator(limit_value=512),
+        ],
+        blank=True,
+        null=True,
+    )
 
     class Meta:
         """Image Model Meta Class"""

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/tables.py

@@ -255,6 +255,7 @@ class ContainerTable(NetBoxTable):
             "status",
             "ContainerID",
             "hostname",
+            "restart_policy",
             "port_count",
             "mount_count",
             "bind_count",

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -67,6 +67,10 @@
             <th scope="row">State</th>
             <td>{{ object.get_state_display }}</td>
           </tr>
+          <tr>
+            <th scope="row">Restart Policy</th>
+            <td>{{ object.get_restart_policy_display }}</td>
+          </tr>
           <tr>
             <th scope="row">Status</th>
             <td>{{ object.status|placeholder }}</td>

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/templates/netbox_docker_plugin/image.html

@@ -29,6 +29,16 @@
             <th scope="row">ImageID</th>
             <td>{{ object.ImageID|placeholder }}</td>
           </tr>
+          <tr>
+            <th scope="row">Digest</th>
+            <td>
+              {% if object.Digest is None %}
+                {{ object.Digest|placeholder }}
+              {% else %}
+                {{ object.Digest|truncatechars:32 }}
+              {% endif %}
+            </td>
+          </tr>
         </table>
       </div>
     </div>

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -27,6 +27,7 @@ class ContainerApiTestCase(
         "id",
         "name",
         "operation",
+        "restart_policy",
         "state",
         "status",
         "url",

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/tests/container/test_container_views.py

@@ -31,7 +31,7 @@ class ContainerViewsTestCase(
         image2 = Image.objects.create(host=host2, name="image2", registry=registry2)
 
         container1 = Container.objects.create(
-            host=host1, image=image1, name="container1"
+            host=host1, image=image1, name="container1", restart_policy="always"
         )
         container2 = Container.objects.create(
             host=host1, image=image1, name="container2"
@@ -44,6 +44,7 @@ class ContainerViewsTestCase(
             "host": host1.pk,
             "image": image1.pk,
             "state": "created",
+            "restart_policy": "unless-stopped",
         }
 
         cls.csv_data = (
@@ -52,10 +53,13 @@ class ContainerViewsTestCase(
             f"container7,{host2.pk},{image2.pk},container7",
         )
 
-        cls.bulk_edit_data = {"state": "running"}
+        cls.bulk_edit_data = {
+            "state": "running",
+            "restart_policy": "always",
+        }
 
         cls.csv_update_data = (
-            "id,name,host,image,state,hostname",
-            f"{container1.pk},container1,{host1.pk},{image1.pk},paused,",
-            f"{container2.pk},container2,{host1.pk},{image1.pk},running,container2",
+            "id,name,host,image,state,hostname,restart_policy",
+            f"{container1.pk},container1,{host1.pk},{image1.pk},paused,,on-failure",
+            f"{container2.pk},container2,{host1.pk},{image1.pk},running,container2,unless-stopped",
         )

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin/tests/image/test_image_api.py

@@ -19,6 +19,7 @@ class ImageApiTestCase(
 
     model = Image
     brief_fields = [
+        "Digest",
         "ImageID",
         "display",
         "id",

netbox_docker_plugin-1.6.1/netbox_docker_plugin/tests/volume/test_volume_api.py

@@ -0,0 +1,122 @@
+"""Volume Test Case"""
+
+from django.urls import reverse
+from django.contrib.contenttypes.models import ContentType
+from rest_framework import status
+from users.models import ObjectPermission
+from utilities.testing import APIViewTestCases
+from netbox_docker_plugin.models.host import Host
+from netbox_docker_plugin.models.volume import Volume
+from netbox_docker_plugin.models.image import Image
+from netbox_docker_plugin.models.registry import Registry
+from netbox_docker_plugin.models.container import Container, Mount
+from netbox_docker_plugin.tests.base import BaseAPITestCase
+
+
+class VolumeApiTestCase(
+    BaseAPITestCase,
+    APIViewTestCases.GetObjectViewTestCase,
+    APIViewTestCases.ListObjectsViewTestCase,
+    APIViewTestCases.CreateObjectViewTestCase,
+    APIViewTestCases.UpdateObjectViewTestCase,
+    APIViewTestCases.DeleteObjectViewTestCase,
+):
+    """Volume Test Case Class"""
+
+    model = Volume
+    brief_fields = ["display", "driver", "id", "name", "url"]
+
+    @classmethod
+    def setUpTestData(cls) -> None:
+        host1 = Host.objects.create(endpoint="http://localhost:8080", name="host1")
+        host2 = Host.objects.create(endpoint="http://localhost:8080", name="host2")
+
+        Volume.objects.create(host=host1, name="volume1")
+        Volume.objects.create(host=host1, name="volume2")
+        Volume.objects.create(host=host2, name="volume3")
+
+        cls.create_data = [
+            {
+                "host": host1.pk,
+                "name": "volume4",
+            },
+            {
+                "host": host1.pk,
+                "name": "volume5",
+            },
+            {
+                "host": host2.pk,
+                "name": "volume6",
+            },
+        ]
+
+    def test_that_embedded_anonymous_volume_is_created(self):
+        """Test that embedded anonymous Volume is created on Container update"""
+
+        # Assign model-level permission
+        obj_perm = ObjectPermission(
+            name="Test permission", actions=["add", "change", "view"]
+        )
+        obj_perm.save()
+        # pylint: disable=E1101
+        obj_perm.users.add(self.user)
+        # pylint: disable=E1101
+        obj_perm.object_types.add(ContentType.objects.get_for_model(self.model))
+        obj_perm.object_types.add(ContentType.objects.get_for_model(Container))
+        obj_perm.object_types.add(ContentType.objects.get_for_model(Mount))
+        obj_perm.object_types.add(ContentType.objects.get_for_model(Image))
+
+        host = Host.objects.create(endpoint="http://localhost:8088", name="host8")
+
+        registry = Registry.objects.create(
+            host=host, name="registry8", serveraddress="http://localhost:8089"
+        )
+
+        image = Image.objects.create(host=host, name="image8", registry=registry)
+
+        container = Container.objects.create(host=host, image=image, name="container8")
+
+        response = self.client.patch(
+            reverse(f"plugins-api:{self._get_view_namespace()}:container-list"),
+            # pylint: disable=C0301
+            [
+                {
+                    "id": container.pk,
+                    "host": host.pk,
+                    "mounts": [
+                        {
+                            "source": "/var/lib/docker/volumes/2419be4bd98f41a8e625c9e4479c1c5b0f8da4b5807f08a0340aa7a2e1574fdd/_data",
+                            "volume": {
+                                "name": "2419be4bd98f41a8e625c9e4479c1c5b0f8da4b5807f08a0340aa7a2e1574fdd",
+                                "host": host.pk,
+                            },
+                        },
+                        {
+                            "source": "/var/lib/docker/volumes/844654ee4ac9d716679ed38b83c4ab6830a9db60ebf3fb2c000c7454bc41e9e2/_data",
+                            "volume": {
+                                "name": "844654ee4ac9d716679ed38b83c4ab6830a9db60ebf3fb2c000c7454bc41e9e2",
+                                "host": host.pk,
+                            },
+                        },
+                    ],
+                }
+            ],
+            format="json",
+            **self.header,
+        )
+
+        self.assertHttpStatus(response, status.HTTP_200_OK)
+
+        self.assertTrue(
+            Volume.objects.filter(
+                name="2419be4bd98f41a8e625c9e4479c1c5b0f8da4b5807f08a0340aa7a2e1574fdd",
+                host=host.pk,
+            ).exists()
+        )
+
+        self.assertTrue(
+            Volume.objects.filter(
+                name="844654ee4ac9d716679ed38b83c4ab6830a9db60ebf3fb2c000c7454bc41e9e2",
+                host=host.pk,
+            ).exists()
+        )

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1/netbox_docker_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.5.2
+Version: 1.6.1
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/netbox_docker_plugin.egg-info/SOURCES.txt

@@ -53,6 +53,8 @@ netbox_docker_plugin/migrations/0022_bind_bind_netbox_docker_plugin_bind_unique_
 netbox_docker_plugin/migrations/0023_delete_hosts.py
 netbox_docker_plugin/migrations/0024_registry_host_alter_registry_name_and_more.py
 netbox_docker_plugin/migrations/0025_alter_image_version.py
+netbox_docker_plugin/migrations/0026_image_digest.py
+netbox_docker_plugin/migrations/0027_container_restart_policy.py
 netbox_docker_plugin/migrations/__init__.py
 netbox_docker_plugin/models/__init__.py
 netbox_docker_plugin/models/container.py

{netbox_docker_plugin-1.5.2 → netbox_docker_plugin-1.6.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-docker-plugin"
-version = "1.5.2"
+version = "1.6.1"
 authors = [
   { name="Vincent Simonin", email="vincent@saashup.com" },
 ]

netbox_docker_plugin-1.5.2/netbox_docker_plugin/tests/volume/test_volume_api.py

@@ -1,44 +0,0 @@
-"""Volume Test Case"""
-
-from utilities.testing import APIViewTestCases
-from netbox_docker_plugin.models.host import Host
-from netbox_docker_plugin.models.volume import Volume
-from netbox_docker_plugin.tests.base import BaseAPITestCase
-
-
-class VolumeApiTestCase(
-    BaseAPITestCase,
-    APIViewTestCases.GetObjectViewTestCase,
-    APIViewTestCases.ListObjectsViewTestCase,
-    APIViewTestCases.CreateObjectViewTestCase,
-    APIViewTestCases.UpdateObjectViewTestCase,
-    APIViewTestCases.DeleteObjectViewTestCase,
-):
-    """Volume Test Case Class"""
-
-    model = Volume
-    brief_fields = ["display", "driver", "id", "name", "url"]
-
-    @classmethod
-    def setUpTestData(cls) -> None:
-        host1 = Host.objects.create(endpoint="http://localhost:8080", name="host1")
-        host2 = Host.objects.create(endpoint="http://localhost:8080", name="host2")
-
-        Volume.objects.create(host=host1, name="volume1")
-        Volume.objects.create(host=host1, name="volume2")
-        Volume.objects.create(host=host2, name="volume3")
-
-        cls.create_data = [
-            {
-                "host": host1.pk,
-                "name": "volume4",
-            },
-            {
-                "host": host1.pk,
-                "name": "volume5",
-            },
-            {
-                "host": host2.pk,
-                "name": "volume6",
-            },
-        ]