Merge pull request #130 from SaaShup/container_exec

fanshan · web-flow · commit ea13d79810e0 · 2024-05-21T10:13:41.000+02:00
✨ Container exec
diff --git a/netbox_docker_plugin/__init__.py b/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.10.0"
+    version = "1.11.0"
     base_url = "docker"
     author= "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"
     author_email= "vincent@saashup.com, david.jose.delassus@gmail.com"
diff --git a/netbox_docker_plugin/api/serializers.py b/netbox_docker_plugin/api/serializers.py
@@ -584,3 +584,14 @@ class Meta:
             "containers",
             "registries",
         )
+
+class ContainerCommandSerializer(serializers.Serializer):
+    """Container command Serializer class"""
+
+    cmd=serializers.ListField(child=serializers.CharField())
+
+    def create(self, validated_data):
+        pass
+
+    def update(self, instance, validated_data):
+        pass
diff --git a/netbox_docker_plugin/api/views.py b/netbox_docker_plugin/api/views.py
@@ -1,15 +1,19 @@
 """API views definitions"""
 
 from collections.abc import Sequence
-from drf_spectacular.utils import extend_schema, OpenApiResponse, OpenApiExample
+import json
+import requests
 from rest_framework import status
+from rest_framework.renderers import JSONRenderer
 from rest_framework.decorators import action
 from rest_framework.response import Response
-import requests
-
+from drf_spectacular.utils import (
+    extend_schema,
+    OpenApiResponse,
+    OpenApiExample,
+)
 from users.models import Token
 from netbox.api.viewsets import NetBoxModelViewSet
-
 from .. import filtersets
 from .renderers import PlainTextRenderer
 from .serializers import (
@@ -19,6 +23,7 @@
     NetworkSerializer,
     ContainerSerializer,
     RegistrySerializer,
+    ContainerCommandSerializer,
 )
 from ..models.host import Host
 from ..models.image import Image
@@ -103,7 +108,6 @@ class ContainerViewSet(NetBoxModelViewSet):
     serializer_class = ContainerSerializer
     http_method_names = ["get", "post", "patch", "delete", "options"]
 
-
     @extend_schema(
         operation_id="plugins_docker_container_logs",
         responses={
@@ -135,7 +139,7 @@ class ContainerViewSet(NetBoxModelViewSet):
         renderer_classes=[PlainTextRenderer],
     )
     def logs(self, _request, **_kwargs):
-        """ Fetch container's logs """
+        """Fetch container's logs"""
 
         container: Container = self.get_object()
         agent_url = container.host.endpoint
@@ -160,6 +164,64 @@ def logs(self, _request, **_kwargs):
             content_type="text/plain",
         )
 
+    @extend_schema(
+        operation_id="plugins_docker_container_exec",
+        request=ContainerCommandSerializer,
+        responses={
+            (200, "text/plain"): OpenApiResponse(
+                response=str,
+                examples=[
+                    OpenApiExample(
+                        "Command output",
+                        value={"stdout": "..."},
+                        media_type="application/json",
+                    ),
+                ],
+            ),
+            (502, "text/plain"): OpenApiResponse(
+                response=str,
+                examples=[
+                    OpenApiExample(
+                        "Engine error",
+                        value="Error as returned by Agent",
+                        media_type="text/plain",
+                    ),
+                ],
+            ),
+        },
+    )
+    @action(detail=True, methods=["post"], renderer_classes=[JSONRenderer])
+    def exec(self, _request, **_kwargs):
+        """Exec a command on a Container"""
+
+        serializer = ContainerCommandSerializer(data=_request.data)
+        if not serializer.is_valid():
+            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+        container: Container = self.get_object()
+        agent_url = container.host.endpoint
+        container_id = container.ContainerID
+
+        url = f"{agent_url}/api/engine/containers/{container_id}/exec"
+
+        try:
+            resp = requests.put(
+                url,
+                data=json.dumps(serializer.validated_data),
+                timeout=30,
+                headers={"Content-Type": "application/json"},
+            )
+            resp.raise_for_status()
+
+        except requests.HTTPError:
+            return Response(
+                resp.text,
+                status=status.HTTP_502_BAD_GATEWAY,
+                content_type="text/plain",
+            )
+
+        return Response(data=json.loads(resp.text))
+
 
 class RegistryViewSet(NetBoxModelViewSet):
     """Registry view set class"""
diff --git a/netbox_docker_plugin/templates/netbox_docker_plugin/container-exec.html b/netbox_docker_plugin/templates/netbox_docker_plugin/container-exec.html
@@ -0,0 +1,76 @@
+{% extends "netbox_docker_plugin/container-layout.html" %}
+
+{% load plugins %}
+
+{% block content %}
+<div class="row mb-3">
+  <div class="col col-md-12">
+    <div class="card">
+      <h5 class="card-header">EXEC</h5>
+      <div class="card-body">
+        <p class="input-group">
+          <label class="input-group-text" for="container-exec-command">Command</label>
+          <input type="text" class="form-control" id="container-exec-command" data-id="{{ object.pk }}">
+          <button class="btn btn-primary" id="container-exec-button"><i class="mdi mdi-play"></i> Exec</button>
+        </p>
+        <pre id="container-exec-output" data-follow="true" class="p-2 text-white border-dark"
+          style="height: 300px; overflow-y: auto; background-color: black; resize: vertical;">
+        </pre>
+      </div>
+    </div>
+  </div>
+</div>
+{% endblock %}
+
+{% block head %}
+<script type="application/javascript">
+  document.addEventListener("DOMContentLoaded", () => {
+    const input = document.getElementById("container-exec-command");
+    const button = document.getElementById("container-exec-button");
+    const pre = document.getElementById("container-exec-output");
+
+    input.addEventListener("keypress", (event) => {
+      if (event.key == "Enter") {
+        exec(input.dataset.id, input.value.split(" "), pre);
+      }
+    });
+
+    button.addEventListener("click", () => {
+      exec(input.dataset.id, input.value.split(" "), pre);
+    });
+
+    const exec = async (id, cmd, elemOutput) => {
+      document.querySelectorAll(".alert").forEach(e => e.remove());
+
+      while (elemOutput.firstChild) {
+        elemOutput.removeChild(elemOutput.lastChild);
+      }
+
+      if (cmd.length > 0 && cmd[0].length > 0) {
+        const response = await fetch(`/api/plugins/docker/containers/${id}/exec/`, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            "X-CSRFToken": "{{ csrf_token }}"
+          },
+          body: JSON.stringify({
+            cmd: cmd
+          })
+        });
+
+        if (response.ok) {
+          elemOutput.appendChild(document.createTextNode((await response.json()).stdout))
+
+          return;
+        }
+
+        const alert = document.createElement("div");
+        alert.classList.add("alert", "alert-danger");
+        alert.appendChild(document.createTextNode("Command exec failed!"));
+
+        elemOutput.before(alert);
+      }
+    }
+  });
+</script>
+{% endblock %}
diff --git a/netbox_docker_plugin/templates/netbox_docker_plugin/container-logs.html b/netbox_docker_plugin/templates/netbox_docker_plugin/container-logs.html
@@ -6,26 +6,18 @@
 <div class="row mb-3">
   <div class="col col-md-12">
     <div class="card">
-      <div class="card-header">
-        <div class="d-sm-flex p-2 flex-row align-items-center">
-          <h5 class="flex-grow-1">LOGS</h5>
-          <button
-            id="container-logs-button"
-            type="button"
-            class="btn btn-primary"
-          >
+      <div class="card-header d-flex">
+        <h5 class="flex-grow-1">LOGS</h5>
+        <div>
+          <button id="container-logs-button" type="button" class="btn btn-primary btn-sm">
             <i id="container-logs-cb" class="mdi mdi-checkbox-marked"></i> Follow logs
           </button>
         </div>
+      </div>
       <div class="card-body">
-        <pre
-          id="container-logs-panel"
-          data-follow="true"
-          class="p-2 text-white border-dark"
-          style="height: 300px; overflow-y: auto; background-color: black;"
-          hx-get="/api/plugins/docker/containers/{{ object.pk }}/logs/"
-          hx-trigger="load, every 30s"
-        >
+        <pre id="container-logs-panel" data-follow="true" class="p-2 text-white border-dark"
+          style="height: 300px; overflow-y: auto; background-color: black; resize: vertical;"
+          hx-get="/api/plugins/docker/containers/{{ object.pk }}/logs/" hx-trigger="load, every 30s">
         </pre>
       </div>
     </div>
@@ -35,29 +27,29 @@ <h5 class="flex-grow-1">LOGS</h5>
 
 {% block head %}
 <script type="application/javascript">
-htmx.onLoad(function(elt) {
-  const logPanel = document.getElementById("container-logs-panel")
-  const followButton = document.getElementById("container-logs-button")
-  const checkbox = document.getElementById("container-logs-cb")
-
-  const isFollowEnabled = () => JSON.parse(logPanel.dataset.follow) === true
-  const toggleFollow = () => {
-    logPanel.dataset.follow = !isFollowEnabled()
-    followButton.classList.toggle("btn-primary")
-    followButton.classList.toggle("btn-outline-primary")
-    checkbox.classList.toggle("mdi-checkbox-marked")
-    checkbox.classList.toggle("mdi-checkbox-blank-outline")
-  }
+  htmx.onLoad(function (elt) {
+    const logPanel = document.getElementById("container-logs-panel")
+    const followButton = document.getElementById("container-logs-button")
+    const checkbox = document.getElementById("container-logs-cb")
 
-  logPanel.addEventListener("htmx:afterSwap", function() {
-    if (isFollowEnabled()) {
-      this.scrollTop = this.scrollHeight
+    const isFollowEnabled = () => JSON.parse(logPanel.dataset.follow) === true
+    const toggleFollow = () => {
+      logPanel.dataset.follow = !isFollowEnabled()
+      followButton.classList.toggle("btn-primary")
+      followButton.classList.toggle("btn-outline-primary")
+      checkbox.classList.toggle("mdi-checkbox-marked")
+      checkbox.classList.toggle("mdi-checkbox-blank-outline")
     }
-  })
 
-  followButton.addEventListener("click", function() {
-    toggleFollow()
+    logPanel.addEventListener("htmx:afterSwap", function () {
+      if (isFollowEnabled()) {
+        this.scrollTop = this.scrollHeight
+      }
+    })
+
+    followButton.addEventListener("click", function () {
+      toggleFollow()
+    })
   })
-})
 </script>
 {% endblock %}
diff --git a/netbox_docker_plugin/tests/container/test_container_api_exec.py b/netbox_docker_plugin/tests/container/test_container_api_exec.py
@@ -0,0 +1,96 @@
+# pylint: disable=R0801
+"""Container Test Case"""
+
+import requests_mock
+from django.urls import reverse
+from django.contrib.contenttypes.models import ContentType
+from django.core.serializers.json import DjangoJSONEncoder
+from rest_framework import status
+from users.models import ObjectPermission
+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
+from netbox_docker_plugin.tests.base import BaseAPITestCase
+
+
+class ContainerApiExecTestCase(BaseAPITestCase):
+    """Container Exec Test Case Class"""
+
+    model = Container
+
+    def setUp(self):
+        super().setUp()
+
+        host1 = Host.objects.create(endpoint="http://localhost:8080", name="host1")
+
+        registry1 = Registry.objects.create(
+            host=host1, name="registry1", serveraddress="http://localhost:8080"
+        )
+
+        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
+
+        container = Container.objects.create(
+            host=host1,
+            image=image1,
+            name="container1",
+            operation="none",
+            state="created",
+            ContainerID="1234",
+        )
+
+        # Add object-level permission
+        obj_perm = ObjectPermission(
+            name="Test permission",
+            constraints={"pk": container.pk},
+            actions=["add"],
+        )
+        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))
+
+        self.endpoint = reverse(
+            viewname=f"plugins-api:{self._get_view_namespace()}:container-exec",
+            kwargs={"pk": container.pk},
+        )
+
+    def test_that_exec_endpoint_works(self):
+        """Test Exec endpoint"""
+
+        with requests_mock.Mocker(json_encoder=DjangoJSONEncoder) as m:
+            m.put(
+                "http://localhost:8080/api/engine/containers/1234/exec",
+                json={"stdout": "..."},
+            )
+
+            response = self.client.post(
+                self.endpoint, **self.header, data={"cmd": ["ls"]}, format="json"
+            )
+            self.assertHttpStatus(response, status.HTTP_200_OK)
+            self.assertEqual(response.data, {"stdout": "..."})
+
+    def test_that_exec_endpoint_with_invalid_command_fail(self):
+        """Test exec endpoinr with invalid command"""
+
+        response = self.client.post(
+            self.endpoint, **self.header, data={"command": ["ls"]}, format="json"
+        )
+        self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
+
+    def test_that_exec_endpoint_fail_with_backend_error(self):
+        """Test Exec endpoint"""
+
+        with requests_mock.Mocker(json_encoder=DjangoJSONEncoder) as m:
+            m.put(
+                "http://localhost:8080/api/engine/containers/1234/exec",
+                text="Error",
+                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')
diff --git a/netbox_docker_plugin/urls.py b/netbox_docker_plugin/urls.py
diff --git a/netbox_docker_plugin/views/container.py b/netbox_docker_plugin/views/container.py
diff --git a/pyproject.toml b/pyproject.toml
