netbox-docker-plugin 4.12.0__tar.gz → 5.0.0__tar.gz

{netbox_docker_plugin-4.12.0/netbox_docker_plugin.egg-info → netbox_docker_plugin-5.0.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 4.12.0
+Version: 5.0.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
 Project-URL: Bug Tracker, https://github.com/SaaShup/netbox-docker-plugin/issues
 Keywords: netbox,netbox-plugin,docker
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -44,7 +44,7 @@ Once the plugin and webhooks are installed, you can:
 4. Manage the container status, start, stop, restart.
 
 
-> [!NOTE]  
+> [!NOTE]
 > Adding a host with curl needs a specific `Origin` HTTP header to make it working. Example :
 >
 > ```bash
@@ -67,7 +67,8 @@ Below the compatibility list of the Netbox Docker PLugin and Netbox. Please chos
 | 4.1.\*         | 3.\*                         |
 | 4.2.\*         | 4.\*                         |
 | 4.3.\*         | 4.\*                         |
-| >=4.3.7        | >=4.5.1                      |
+| >=4.3.7 <4.5.0 | >=4.5.1 <5.\*                |
+| >=4.5.0        | >=5.\*                       |
 
 You can follow [the official plugins installation
 instructions](https://docs.netbox.dev/en/stable/plugins/#installing-plugins).

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/README.md

@@ -30,7 +30,7 @@ Once the plugin and webhooks are installed, you can:
 4. Manage the container status, start, stop, restart.
 
 
-> [!NOTE]  
+> [!NOTE]
 > Adding a host with curl needs a specific `Origin` HTTP header to make it working. Example :
 >
 > ```bash
@@ -53,7 +53,8 @@ Below the compatibility list of the Netbox Docker PLugin and Netbox. Please chos
 | 4.1.\*         | 3.\*                         |
 | 4.2.\*         | 4.\*                         |
 | 4.3.\*         | 4.\*                         |
-| >=4.3.7        | >=4.5.1                      |
+| >=4.3.7 <4.5.0 | >=4.5.1 <5.\*                |
+| >=4.5.0        | >=5.\*                       |
 
 You can follow [the official plugins installation
 instructions](https://docs.netbox.dev/en/stable/plugins/#installing-plugins).

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/netbox_docker_plugin/__init__.py

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

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/netbox_docker_plugin/api/serializers.py

@@ -32,7 +32,16 @@ class NestedTokenSerializer(WritableNestedSerializer):
         """Nested Token Serializer Meta class"""
 
         model = Token
-        fields = ["id", "url", "display_url", "display", "key", "write_enabled"]
+        fields = [
+            "id",
+            "url",
+            "display_url",
+            "display",
+            "key",
+            "token",
+            "version",
+            "write_enabled",
+        ]
 
 
 class NestedHostSerializer(WritableNestedSerializer):

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/netbox_docker_plugin/api/views.py

@@ -4,6 +4,7 @@ from collections.abc import Sequence
 import json
 import requests
 from django.utils.html import escape
+from django.core.serializers.json import DjangoJSONEncoder
 from rest_framework import status
 from rest_framework.renderers import JSONRenderer
 from rest_framework.decorators import action
@@ -103,7 +104,12 @@ class ImageViewSet(NetBoxModelViewSet):
             data = serializer.data
             data["force"] = True
 
-            resp = requests.post(url, timeout=10, json={"data": data})
+            resp = requests.post(
+                url,
+                timeout=10,
+                data=json.dumps({"data": data}, cls=DjangoJSONEncoder),
+                headers={"Content-Type": "application/json"}
+            )
             resp.raise_for_status()
 
         except requests.HTTPError:

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/netbox_docker_plugin/models/host.py

@@ -102,9 +102,7 @@ class Host(NetBoxModel):
 
         return super().delete(using, keep_parents)
 
-    def save(
-        self, *args, **kwargs
-    ):
+    def save(self, *args, **kwargs):
         if self.operation == HostOperationChoices.OPERATION_REFRESH:
             self.state = HostStateChoices.STATE_REFRESHING
 

netbox_docker_plugin-5.0.0/netbox_docker_plugin/tests/image/test_force_pull_image_with_special_cf.py

@@ -0,0 +1,103 @@
+"""Test force pull image with special custom fields."""
+
+import datetime
+import requests_mock
+from django.urls import reverse
+from core.models import ObjectType
+from rest_framework import status
+from users.models import ObjectPermission
+from extras.models import CustomField
+from netbox_docker_plugin.models.host import Host
+from netbox_docker_plugin.models.image import Image
+from netbox_docker_plugin.models.registry import Registry
+from netbox_docker_plugin.tests.base import BaseAPITestCase
+
+class ForcePullImageWithSpecialCFTestCase(BaseAPITestCase):
+    """Force Pull Image With Special Custom Fields Test Case Class """
+
+    model = Image
+
+    """Set up test data method."""
+    @classmethod
+    def setUpTestData(cls):
+        # --- Create a host ---
+        cls.host = Host.objects.create(endpoint="http://localhost:8080", name="host1")
+
+        # --- Create a registry ---
+        cls.registry = Registry.objects.filter(name="dockerhub")[0]
+
+        # --- Create custom fields for Image ---
+        ot = ObjectType.objects.get_for_model(Image)
+
+        cls.cf_date = CustomField.objects.create(
+            name="cf_date",
+            type="date",
+        )
+        cls.cf_date.object_types.set([ot])
+        cls.cf_date.save()
+
+        cls.cf_datetime = CustomField.objects.create(
+            name="cf_datetime",
+            type="datetime",
+        )
+        cls.cf_datetime.object_types.set([ot])
+        cls.cf_datetime.save()
+
+        # --- Create images ---
+        Image.objects.create(
+            host=cls.host,
+            name="image_date",
+            registry=cls.registry,
+            custom_field_data={"cf_date": datetime.date.today()}
+        )
+
+        Image.objects.create(
+            host=cls.host,
+            name="image_datetime",
+            registry=cls.registry,
+            custom_field_data={"cf_datetime": datetime.datetime.now()}
+        )
+
+    def _add_object_permission(self, image):
+        # --- Add object-level permission ---
+        obj_perm = ObjectPermission(
+            name="Test permission",
+            constraints={"pk": image.pk},
+            actions=["add"],
+        )
+        obj_perm.save()
+        # pylint: disable=E1101
+        obj_perm.users.add(self.user)
+        # pylint: disable=E1101
+        obj_perm.object_types.add(ObjectType.objects.get_for_model(self.model))
+
+    def _force_pull_image(self, image):
+        # --- Call add object-level permission ---
+        self._add_object_permission(image)
+        # --- Build image force pull API url ---
+        endpoint = reverse(
+            viewname=f"plugins-api:{self._get_view_namespace()}:image-force-pull",
+            kwargs={"pk": image.pk},
+        )
+        with requests_mock.Mocker() as m:
+            # --- Call API endpoint ---
+            m.post(
+                "http://localhost:8080/api/engine/images",
+                text="{}",
+            )
+            response = self.client.post(endpoint, **self.header)
+            return response
+
+    def test_force_pull_with_date_custom_field(self):
+        """Test force pull image with custom field of type Date."""
+        image_date = Image.objects.get(name="image_date")
+        response = self._force_pull_image(image_date)
+        self.assertHttpStatus(response, status.HTTP_200_OK)
+        self.assertEqual(response.data, {"success": True, "payload": {}})
+
+    def test_force_pull_with_datetime_custom_field(self):
+        """Test force pull image with custom field of type DateTime."""
+        image_datetime = Image.objects.get(name="image_datetime")
+        response = self._force_pull_image(image_datetime)
+        self.assertHttpStatus(response, status.HTTP_200_OK)
+        self.assertEqual(response.data, {"success": True, "payload": {}})

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/netbox_docker_plugin/utilities/__init__.py

@@ -25,7 +25,7 @@ webhooks = [
         "type_job_start": False,
         "type_job_end": False,
         "http_method": "GET",
-        "payload_url": "{{ data.endpoint }}/api/engine/endpoint?id={{ data.id }}&token={{ data.token.key }}&endpoint={{ data.endpoint }}&url={{ data.netbox_base_url }}",
+        "payload_url": "{{ data.endpoint }}/api/engine/endpoint?id={{ data.id }}&token=nbt_{{ data.token.key }}.{{ data.token.token }}&endpoint={{ data.endpoint }}&url={{ data.netbox_base_url }}",
         "ssl_verification": False,
     },
     {
@@ -235,6 +235,14 @@ def create_webhook(app_config, **kwargs):
                     # pylint: disable=E1101
                     eventrule.object_types.set([obj_content_type.pk])
                     eventrule.save()
+                else:
+                    if (
+                        results[0].http_method != webhook["http_method"]
+                        or results[0].payload_url != webhook["payload_url"]
+                    ):
+                        results[0].http_method = webhook["http_method"]
+                        results[0].payload_url = webhook["payload_url"]
+                        results[0].save()
 
             return
 

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0/netbox_docker_plugin.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 4.12.0
+Version: 5.0.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
 Project-URL: Bug Tracker, https://github.com/SaaShup/netbox-docker-plugin/issues
 Keywords: netbox,netbox-plugin,docker
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -44,7 +44,7 @@ Once the plugin and webhooks are installed, you can:
 4. Manage the container status, start, stop, restart.
 
 
-> [!NOTE]  
+> [!NOTE]
 > Adding a host with curl needs a specific `Origin` HTTP header to make it working. Example :
 >
 > ```bash
@@ -67,7 +67,8 @@ Below the compatibility list of the Netbox Docker PLugin and Netbox. Please chos
 | 4.1.\*         | 3.\*                         |
 | 4.2.\*         | 4.\*                         |
 | 4.3.\*         | 4.\*                         |
-| >=4.3.7        | >=4.5.1                      |
+| >=4.3.7 <4.5.0 | >=4.5.1 <5.\*                |
+| >=4.5.0        | >=5.\*                       |
 
 You can follow [the official plugins installation
 instructions](https://docs.netbox.dev/en/stable/plugins/#installing-plugins).

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/netbox_docker_plugin.egg-info/SOURCES.txt

@@ -110,6 +110,7 @@ netbox_docker_plugin/tests/host/test_host_api.py
 netbox_docker_plugin/tests/host/test_host_views.py
 netbox_docker_plugin/tests/host/test_replace_password.py
 netbox_docker_plugin/tests/image/__init__.py
+netbox_docker_plugin/tests/image/test_force_pull_image_with_special_cf.py
 netbox_docker_plugin/tests/image/test_image_api.py
 netbox_docker_plugin/tests/image/test_image_views.py
 netbox_docker_plugin/tests/network/__init__.py

{netbox_docker_plugin-4.12.0 → netbox_docker_plugin-5.0.0}/pyproject.toml

@@ -4,14 +4,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-docker-plugin"
-version = "4.12.0"
+version = "5.0.0"
 authors = [
   { name="Vincent Simonin", email="vincent@saashup.com" },
   { name="David Delassus", email="david.jose.delassus@gmail.com" }
 ]
 description = "Manage Docker with Netbox & style."
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.12"
 classifiers = [
     "Programming Language :: Python :: 3",
 ]