Add unit test and more coverage (#56)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Restructured member and video functionality into `MemberService` and
`VideoService` classes for improved modularity and separation of
concerns.
- **New Features**
- Introduced enhanced video URL validation to ensure a minimum length.
- **Tests**
- Added comprehensive tests for video and member services, validating
error handling, validation, and functionality.
- **Chores**
- Added pylint check using `poetry run pylint src` to the CircleCI
configuration for static code analysis.
- Updated imports and instantiation in the `main.py` file for improved
efficiency.
- Introduced a new test case `test_main_startup` in `test_main.py` for
testing startup behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: csikb

.circleci/config.yml

@@ -31,7 +31,8 @@ jobs:
           pkg-manager: poetry
       - run: poetry run isort . --check
       - run: poetry run black . --check
-      - run: poetry run mypy -p src.bss_web_file_server
+      - run: poetry run pylint src
+      - run: poetry run mypy -p src
   verify-requirements:
     executor: python
     steps:
@@ -50,11 +51,22 @@ jobs:
       - github-cli/setup:
           version: 2.43.1
       - run: gh release create << pipeline.git.tag >> -t << pipeline.git.tag >> --generate-notes
+  coverage:
+    executor: python
+    steps:
+      - checkout
+      - python/install-packages:
+          pkg-manager: poetry
+      - run: poetry run pytest --cov=src  --cov-report=html --cov-fail-under=100
+      - store_artifacts:
+          path: htmlcov
 workflows:
   Build:
     jobs:
       - lint:
           name: Lint
+      - coverage:
+          name: Coverage
       - verify-requirements:
           name: Verify requirements.txt
       - python/test:

poetry.lock

@@ -8,8 +8,8 @@ packages = [{include = "bss_web_file_server", from = "src"}]
 
 [tool.poetry.dependencies]
 python = "^3.12"
-fastapi = {extras=["all"], version="0.110.0"}
-uvicorn = {extras = ["standard"], version = "0.28.0"}
+fastapi = {version="0.110.0", extras=["all"]}
+uvicorn = {version = "0.28.0", extras = ["standard"]}
 pillow = "10.2.0"
 pillow-avif-plugin = "1.4.3"
 python-multipart = "0.0.9"
@@ -25,6 +25,7 @@ types-Pillow = "10.2.0.20240311"
 httpx = "^0.23.0"
 pytest = "^8.0.0"
 pytest-mock = "^3.10.0"
+pytest-cov = "^4.1.0"
 mypy = "1.9.0"
 
 [tool.isort]

pyproject.toml

@@ -1,20 +1,27 @@
 """Main module for the FastAPI application."""
 
+from contextlib import asynccontextmanager
+
 from fastapi import FastAPI
 
 from .routers import health, member, video
-from .services.member import create_member_base_path
-from .services.video import create_video_base_path
+from .services.member import MemberService
+from .services.video import VideoService
+
+member_service = MemberService()
+video_service = VideoService()
+
+
+@asynccontextmanager
+async def lifespan(api: FastAPI):  # pylint: disable=unused-argument
+    """Create the base paths for the video and member folders on startup."""
+    video_service.create_base_path()
+    member_service.create_base_path()
+    yield
 
-app = FastAPI()
+
+app = FastAPI(lifespan=lifespan)
 
 app.include_router(health.router)
 app.include_router(video.router)
 app.include_router(member.router)
-
-
-@app.on_event("startup")
-async def startup_event():
-    """Create the base paths for the video and member folders on startup."""
-    create_video_base_path()
-    create_member_base_path()

src/bss_web_file_server/main.py

@@ -1,12 +1,14 @@
 """ A module for storing the video model. """
 
+from typing import Annotated
 from uuid import UUID
 
+from annotated_types import Len
 from pydantic import BaseModel
 
 
 class Video(BaseModel):
     """A class for storing video data."""
 
     id: UUID
-    urls: list[str]
+    urls: Annotated[list[str], Len(min_length=1)]

src/bss_web_file_server/models/video.py

@@ -1,15 +1,18 @@
 """Health check endpoints."""
 
 from fastapi import APIRouter
+from fastapi.responses import PlainTextResponse
 
 router = APIRouter(tags=["Health"])
 
 
-@router.get("/health", response_model=str)
+@router.get("/health", response_class=PlainTextResponse)
 async def health():
+    """Health check endpoint."""
     return "UP"
 
 
-@router.get("/ping", response_model=str)
+@router.get("/ping", response_class=PlainTextResponse)
 async def ping():
+    """Ping check endpoint."""
     return "PONG"

src/bss_web_file_server/routers/health.py

@@ -6,14 +6,10 @@
 from fastapi import APIRouter, Response, UploadFile, status
 
 from ..models.member import Member
-from ..services.member import (
-    create_folder_structure,
-    create_profile_picture,
-    to_id_path,
-    update_symlink,
-)
+from ..services.member import MemberService
 
 router = APIRouter(tags=["Member"], prefix="/api/v1/member")
+service: MemberService = MemberService()
 
 
 @router.post("", response_model=Member)
@@ -23,7 +19,7 @@ def create_member_folder(member: Member):
     :param member: Member object
     :return: 200 and the original member object
     """
-    create_folder_structure(member)
+    service.create_folder_structure(member)
     return member
 
 
@@ -35,9 +31,9 @@ def update_member_folder(member: Member):
     :param member: Member object
     :return: 200 and the original member object
     """
-    if not to_id_path(member.id).exists():
+    if not service.to_id_path(member.id).exists():
         return Response(status_code=status.HTTP_404_NOT_FOUND)
-    update_symlink(member)
+    service.update_symlink(member)
     return member
 
 
@@ -52,15 +48,15 @@ async def upload_member_picture(member_id: UUID, file: UploadFile):
     :param file: the image file
     :return: 200 and the original member_id
     """
-    if not to_id_path(member_id).exists():
-        return Response(status_code=status.HTTP_404_NOT_FOUND)
     # pylint: disable=duplicate-code
+    if not service.to_id_path(member_id).exists():
+        return Response(status_code=status.HTTP_404_NOT_FOUND)
     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()
-    create_profile_picture(file_content, member_id)
+    # pylint: enable=duplicate-code
+    service.create_profile_picture(file_content, member_id)
     return member_id

src/bss_web_file_server/routers/member.py

@@ -5,15 +5,11 @@
 
 from fastapi import APIRouter, Response, UploadFile, status
 
-from ..services.video import (
-    Video,
-    create_folder_structure,
-    create_thumbnails,
-    to_id_path,
-    update_symlinks,
-)
+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)
@@ -23,7 +19,7 @@ def create_video_folder(video: Video):
     :param video: Video object
     :return: 200 and the original video object
     """
-    create_folder_structure(video)
+    service.create_folder_structure(video)
     return video
 
 
@@ -35,9 +31,9 @@ def update_video_folder(video: Video):
     :param video: Video object
     :return: 200 and the original video object
     """
-    if not to_id_path(video.id).exists():
+    if not service.to_id_path(video.id).exists():
         return Response(status_code=status.HTTP_404_NOT_FOUND)
-    update_symlinks(video)
+    service.update_symlinks(video)
     return video
 
 
@@ -52,15 +48,15 @@ async def upload_video_poster(video_id: UUID, file: UploadFile):
     :param file: the image file
     :return: 200 and the original video_id
     """
-    if not to_id_path(video_id).exists():
-        return Response(status_code=status.HTTP_404_NOT_FOUND)
     # pylint: disable=duplicate-code
+    if not service.to_id_path(video_id).exists():
+        return Response(status_code=status.HTTP_404_NOT_FOUND)
     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()
-    create_thumbnails(file_content, video_id)
+    # pylint: enable=duplicate-code
+    service.create_thumbnails(file_content, video_id)
     return video_id