♻️ Removed unused endpoint from dynamic-sidecar (#7255)

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

services/dynamic-sidecar/openapi.json

@@ -229,95 +229,6 @@
         }
       }
     },
-    "/v1/containers/{id}/logs": {
-      "get": {
-        "tags": [
-          "containers"
-        ],
-        "summary": "Get Container Logs",
-        "description": "Returns the logs of a given container if found",
-        "operationId": "get_container_logs_v1_containers__id__logs_get",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "string",
-              "title": "Id"
-            }
-          },
-          {
-            "name": "since",
-            "in": "query",
-            "required": false,
-            "schema": {
-              "type": "integer",
-              "title": "Timestamp",
-              "description": "Only return logs since this time, as a UNIX timestamp",
-              "default": 0
-            },
-            "description": "Only return logs since this time, as a UNIX timestamp"
-          },
-          {
-            "name": "until",
-            "in": "query",
-            "required": false,
-            "schema": {
-              "type": "integer",
-              "title": "Timestamp",
-              "description": "Only return logs before this time, as a UNIX timestamp",
-              "default": 0
-            },
-            "description": "Only return logs before this time, as a UNIX timestamp"
-          },
-          {
-            "name": "timestamps",
-            "in": "query",
-            "required": false,
-            "schema": {
-              "type": "boolean",
-              "title": "Display timestamps",
-              "description": "Enabling this parameter will include timestamps in logs",
-              "default": false
-            },
-            "description": "Enabling this parameter will include timestamps in logs"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Successful Response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  },
-                  "title": "Response Get Container Logs V1 Containers  Id  Logs Get"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Container does not exists"
-          },
-          "500": {
-            "description": "Errors in container"
-          },
-          "422": {
-            "description": "Validation Error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/HTTPValidationError"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
     "/v1/containers/name": {
       "get": {
         "tags": [

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/rest/containers.py

@@ -199,54 +199,6 @@ async def get_containers_activity(
 #
 
 
-@router.get(
-    "/containers/{id}/logs",
-    responses={
-        status.HTTP_404_NOT_FOUND: {
-            "description": "Container does not exists",
-        },
-        status.HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Errors in container"},
-    },
-)
-@cancel_on_disconnect
-async def get_container_logs(
-    request: Request,
-    shared_store: Annotated[SharedStore, Depends(get_shared_store)],
-    container_id: str = PathParam(..., alias="id"),
-    since: int = Query(
-        default=0,
-        title="Timestamp",
-        description="Only return logs since this time, as a UNIX timestamp",
-    ),
-    until: int = Query(
-        default=0,
-        title="Timestamp",
-        description="Only return logs before this time, as a UNIX timestamp",
-    ),
-    timestamps: bool = Query(  # noqa: FBT001
-        default=False,
-        title="Display timestamps",
-        description="Enabling this parameter will include timestamps in logs",
-    ),
-) -> list[str]:
-    """Returns the logs of a given container if found"""
-    _ = request
-
-    _raise_if_container_is_missing(container_id, shared_store.container_names)
-
-    async with docker_client() as docker:
-        container_instance = await docker.containers.get(container_id)
-
-        args = {"stdout": True, "stderr": True, "since": since, "until": until}
-        if timestamps:
-            args["timestamps"] = True
-
-        container_logs: list[str] = await container_instance.log(
-            **args
-        )  # type:ignore[call-overload]
-        return container_logs
-
-
 @router.get(
     "/containers/name",
     responses={

services/dynamic-sidecar/tests/unit/test_api_rest_containers.py

@@ -423,35 +423,6 @@ async def test_containers_docker_status_docker_error(
     assert response.status_code == mock_aiodocker_containers_get, response.text
 
 
-async def test_container_inspect_logs_remove(
-    test_client: TestClient, started_containers: list[str]
-):
-    for container in started_containers:
-        # get container logs
-        # FIXME: slow call?
-        response = await test_client.get(f"/{API_VTAG}/containers/{container}/logs")
-        assert response.status_code == status.HTTP_200_OK, response.text
-
-        # inspect container
-        response = await test_client.get(f"/{API_VTAG}/containers/{container}")
-        assert response.status_code == status.HTTP_200_OK, response.text
-        parsed_response = response.json()
-        assert parsed_response["Name"] == f"/{container}"
-
-
-async def test_container_logs_with_timestamps(
-    test_client: TestClient, started_containers: list[str]
-):
-    for container in started_containers:
-        print("getting logs of container", container, "...")
-        response = await test_client.get(
-            f"/{API_VTAG}/containers/{container}/logs",
-            query_string={"timestamps": True},
-        )
-        assert response.status_code == status.HTTP_200_OK, response.text
-        assert response.json() == []
-
-
 async def test_container_missing_container(
     test_client: TestClient, not_started_containers: list[str]
 ):
@@ -461,11 +432,6 @@ def _expected_error_string(container: str) -> dict[str, str]:
         }
 
     for container in not_started_containers:
-        # get container logs
-        response = await test_client.get(f"/{API_VTAG}/containers/{container}/logs")
-        assert response.status_code == status.HTTP_404_NOT_FOUND, response.text
-        assert response.json() == _expected_error_string(container)
-
         # inspect container
         response = await test_client.get(f"/{API_VTAG}/containers/{container}")
         assert response.status_code == status.HTTP_404_NOT_FOUND, response.text
@@ -485,10 +451,6 @@ def _expected_error_string(status_code: int) -> dict[str, Any]:
         }
 
     for container in started_containers:
-        # get container logs
-        response = await test_client.get(f"/{API_VTAG}/containers/{container}/logs")
-        assert response.status_code == mock_aiodocker_containers_get, response.text
-        assert response.json() == _expected_error_string(mock_aiodocker_containers_get)
 
         # inspect container
         response = await test_client.get(f"/{API_VTAG}/containers/{container}")