add more tests

Author: csikb

.circleci/config.yml

@@ -31,6 +31,7 @@ jobs:
           pkg-manager: poetry
       - run: poetry run isort . --check
       - run: poetry run black . --check
+      - run: poetry run pylint src
       - run: poetry run mypy -p src.bss_web_file_server
   verify-requirements:
     executor: python

src/bss_web_file_server/main.py

@@ -1,7 +1,5 @@
 """Main module for the FastAPI application."""
 
-from typing import Annotated
-
 from fastapi import FastAPI
 
 from .routers import health, member, video
@@ -14,12 +12,12 @@
 app.include_router(video.router)
 app.include_router(member.router)
 
+member_service = MemberService()
+video_service = VideoService()
+
 
 @app.on_event("startup")
-async def startup_event(
-    member_service=MemberService(),
-    video_service=VideoService(),
-):
+async def startup_event():
     """Create the base paths for the video and member folders on startup."""
     video_service.create_base_path()
     member_service.create_base_path()

src/bss_web_file_server/routers/health.py

@@ -8,9 +8,11 @@
 
 @router.get("/health", response_class=PlainTextResponse)
 async def health():
+    """Health check endpoint."""
     return "UP"
 
 
 @router.get("/ping", response_class=PlainTextResponse)
 async def ping():
+    """Ping check endpoint."""
     return "PONG"

src/bss_web_file_server/routers/member.py

@@ -3,39 +3,32 @@
 import re
 from uuid import UUID
 
-from fastapi import APIRouter, Depends, Response, UploadFile, status
+from fastapi import APIRouter, Response, UploadFile, status
 
 from ..models.member import Member
 from ..services.member import MemberService
 
 router = APIRouter(tags=["Member"], prefix="/api/v1/member")
+service: MemberService = MemberService()
 
 
 @router.post("", response_model=Member)
-def create_member_folder(
-    member: Member,
-    service: MemberService = Depends(MemberService),
-):
+def create_member_folder(member: Member):
     """
     Create a folder structure for a member and return the member object.
     :param member: Member object
-    :param service: MemberService
     :return: 200 and the original member object
     """
     service.create_folder_structure(member)
     return member
 
 
 @router.put("", response_model=Member)
-def update_member_folder(
-    member: Member,
-    service: MemberService = Depends(MemberService),
-):
+def update_member_folder(member: Member):
     """
     Update the folder structure for a member and return the member object.
     If the member does not exist, return a 404.
     :param member: Member object
-    :param service: MemberService
     :return: 200 and the original member object
     """
     if not service.to_id_path(member.id).exists():
@@ -45,30 +38,25 @@ def update_member_folder(
 
 
 @router.post("/{member_id}/profilePicture", response_model=UUID)
-async def upload_member_picture(
-    member_id: UUID,
-    file: UploadFile,
-    service: MemberService = Depends(MemberService),
-):
+async def upload_member_picture(member_id: UUID, file: UploadFile):
     """
     Upload a picture for a member to convert
     and store the profile picture in different formats
     If the member does not exist, return a 404.
     If the file is not an image, return a 500.
     :param member_id: the id of the member
     :param file: the image file
-    :param service: MemberService
     :return: 200 and the original member_id
     """
+    # pylint: disable=duplicate-code
     if not service.to_id_path(member_id).exists():
         return Response(status_code=status.HTTP_404_NOT_FOUND)
-    # pylint: disable=duplicate-code
     if file.content_type is not None and not re.match("image/.+", file.content_type):
         return Response(
             content="Mime is not an image format",
             status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
         )
-    # pylint: enable=duplicate-code
     file_content = await file.read()
+    # pylint: enable=duplicate-code
     service.create_profile_picture(file_content, member_id)
     return member_id

src/bss_web_file_server/routers/video.py

@@ -3,39 +3,32 @@
 import re
 from uuid import UUID
 
-from fastapi import APIRouter, Depends, Response, UploadFile, status
+from fastapi import APIRouter, Response, UploadFile, status
 
 from ..models.video import Video
 from ..services.video import VideoService
 
 router = APIRouter(tags=["Video"], prefix="/api/v1/video")
+service: VideoService = VideoService()
 
 
 @router.post("", response_model=Video)
-def create_video_folder(
-    video: Video,
-    service: VideoService = Depends(VideoService),
-):
+def create_video_folder(video: Video):
     """
     Create a folder structure for a video and return the video object.
     :param video: Video object
-    :param service: VideoService
     :return: 200 and the original video object
     """
     service.create_folder_structure(video)
     return video
 
 
 @router.put("", response_model=Video)
-def update_video_folder(
-    video: Video,
-    service: VideoService = Depends(VideoService),
-):
+def update_video_folder(video: Video):
     """
     Update the folder structure for a video and return the video object.
     If the video does not exist, return a 404.
     :param video: Video object
-    :param service: VideoService
     :return: 200 and the original video object
     """
     if not service.to_id_path(video.id).exists():
@@ -45,30 +38,25 @@ def update_video_folder(
 
 
 @router.post("/{video_id}/thumbnail", response_model=UUID)
-async def upload_video_poster(
-    video_id: UUID,
-    file: UploadFile,
-    service: VideoService = Depends(VideoService),
-):
+async def upload_video_poster(video_id: UUID, file: UploadFile):
     """
     Upload a picture for a video thumbnail to convert
     and store the thumbnail in different formats
     If the video does not exist, return a 404.
     If the file is not an image, return a 500.
     :param video_id: the id of the video
     :param file: the image file
-    :param service: VideoService
     :return: 200 and the original video_id
     """
+    # pylint: disable=duplicate-code
     if not service.to_id_path(video_id).exists():
         return Response(status_code=status.HTTP_404_NOT_FOUND)
-    # pylint: disable=duplicate-code
     if file.content_type is not None and not re.match("image/.+", file.content_type):
         return Response(
             content="Mime is not an image format",
             status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
         )
-    # pylint: enable=duplicate-code
     file_content = await file.read()
+    # pylint: enable=duplicate-code
     service.create_thumbnails(file_content, video_id)
     return video_id

src/bss_web_file_server/services/member.py

@@ -9,6 +9,7 @@
 
 
 class MemberService:
+    """Member service class."""
 
     def __init__(self, base_path: str = settings.server_base_path):
         self.id_paths_base = Path(base_path, "m")

src/bss_web_file_server/services/video.py

@@ -1,7 +1,6 @@
 """This module contains all video related service logic."""
 
 from pathlib import Path
-from typing import Annotated
 from uuid import UUID
 
 from ..models.video import Video
@@ -10,6 +9,7 @@
 
 
 class VideoService:
+    """Video service class."""
 
     def __init__(self, base_path: str = settings.server_base_path):
         self.id_paths_base = Path(base_path, "v")

tests/bss_web_file_server/routers/test_health.py

@@ -4,9 +4,7 @@
 from bss_web_file_server.routers import health
 
 app = FastAPI()
-
 app.include_router(health.router)
-
 client = TestClient(app)
 
 

tests/bss_web_file_server/routers/test_member.py

@@ -0,0 +1,101 @@
+import pytest
+from fastapi import FastAPI
+from fastapi.testclient import TestClient
+
+from bss_web_file_server.models.member import Member
+from bss_web_file_server.routers import member
+
+
+@pytest.fixture
+def client():
+    app = FastAPI()
+    app.include_router(member.router)
+    return TestClient(app)
+
+
+member_object = Member(id="00000000-0000-0000-0000-000000000000", url="bcsik")
+
+
+def test_create_member_folder(client, mocker):
+    service_mock = mocker.patch("bss_web_file_server.routers.member.service")
+    service_mock.create_folder_structure.return_value = None
+
+    member_data = {"id": str(member_object.id), "url": member_object.url}
+
+    response = client.post("/api/v1/member", json=member_data)
+
+    assert service_mock.create_folder_structure.call_count == 1
+    assert service_mock.create_folder_structure.call_args[0][0] == member_object
+    assert response.status_code == 200
+    assert response.json() == member_data
+
+
+def test_update_member_folder_no_id(client, mocker):
+    service_mock = mocker.patch("bss_web_file_server.routers.member.service")
+    service_mock.to_id_path.return_value.exists.return_value = False
+
+    member_data = {"id": str(member_object.id), "url": member_object.url}
+
+    response = client.put("/api/v1/member", json=member_data)
+
+    assert service_mock.update_symlink.call_count == 0
+    assert response.status_code == 404
+
+
+def test_update_member_folder(client, mocker):
+    service_mock = mocker.patch("bss_web_file_server.routers.member.service")
+    service_mock.to_id_path.return_value.exists.return_value = True
+    service_mock.update_symlink.return_value = None
+
+    member_data = {"id": str(member_object.id), "url": member_object.url}
+
+    response = client.put("/api/v1/member", json=member_data)
+
+    assert service_mock.update_symlink.call_count == 1
+    assert service_mock.update_symlink.call_args[0][0] == member_object
+    assert response.status_code == 200
+    assert response.json() == member_data
+
+
+def test_upload_member_picture_no_id(client, mocker):
+    service_mock = mocker.patch("bss_web_file_server.routers.member.service")
+    service_mock.to_id_path.return_value.exists.return_value = False
+
+    response = client.post(
+        f"/api/v1/member/{member_object.id}/profilePicture",
+        files={"file": ("file.jpg", "file_content", "image/jpeg")},
+    )
+
+    assert service_mock.create_profile_picture.call_count == 0
+    assert response.status_code == 404
+
+
+def test_upload_member_picture_not_image(client, mocker):
+    service_mock = mocker.patch("bss_web_file_server.routers.member.service")
+    service_mock.to_id_path.return_value.exists.return_value = True
+
+    response = client.post(
+        f"/api/v1/member/{member_object.id}/profilePicture",
+        files={"file": ("file.jpg", "file_content", "text/plain")},
+    )
+
+    assert service_mock.create_profile_picture.call_count == 0
+    assert response.status_code == 500
+    assert response.text == "Mime is not an image format"
+
+
+def test_upload_member_picture(client, mocker):
+    service_mock = mocker.patch("bss_web_file_server.routers.member.service")
+    service_mock.to_id_path.return_value.exists.return_value = True
+    service_mock.create_profile_picture.return_value = None
+
+    response = client.post(
+        f"/api/v1/member/{member_object.id}/profilePicture",
+        files={"file": ("file.jpg", "file_content", "image/jpeg")},
+    )
+
+    assert service_mock.create_profile_picture.call_count == 1
+    assert service_mock.create_profile_picture.call_args[0][0] == b"file_content"
+    assert service_mock.create_profile_picture.call_args[0][1] == member_object.id
+    assert response.status_code == 200
+    assert response.json() == str(member_object.id)