feat: refactored tests to make them easier to maintain (#215)

TeKrop · Nov 10, 2024 · 20341ed · 20341ed
1 parent 46ed1f0
commit 20341ed
Show file tree

Hide file tree

Showing 127 changed files with 1,375 additions and 208,517 deletions.
diff --git a/Makefile b/Makefile
@@ -83,4 +83,7 @@ clean: down ## Clean up Docker environment
 lock: ## Update lock file
 	uv lock
 
-.PHONY: help build start lint format shell exec test up down clean lock
+update_test_fixtures: ## Update test fixtures (heroes, players, etc.)
+	$(DOCKER RUN) uv run python -m tests.update_test_fixtures $(PARAMS)
+
+.PHONY: help build start lint format shell exec test up down clean lock update_test_fixtures
diff --git a/app/config.py b/app/config.py
@@ -147,6 +147,14 @@ class Settings(BaseSettings):
     # Discord Webhook URL
     discord_webhook_url: str = ""
 
+    # Error message to be displayed to API users
+    internal_server_error_message: str = (
+        "An internal server error occurred during the process. The developer "
+        "received a notification, but don't hesitate to create a GitHub "
+        "issue if you want any news concerning the bug resolution : "
+        "https://github.com/TeKrop/overfast-api/issues"
+    )
+
     ############
     # LOCAL
     ############

diff --git a/app/helpers.py b/app/helpers.py
@@ -57,7 +57,7 @@ def overfast_internal_error(url: str, error: Exception) -> HTTPException:
     # If we're using a profiler, it means we're debugging, raise the error
     # directly in order to have proper backtrace in logs
     if settings.profiler:
-        raise error
+        raise error  # pragma: no cover
 
     # Else, send a message to the given channel using Discord Webhook URL
     send_discord_webhook_message(
@@ -68,12 +68,7 @@ def overfast_internal_error(url: str, error: Exception) -> HTTPException:
 
     return HTTPException(
         status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
-        detail=(
-            "An internal server error occurred during the process. The developer "
-            "received a notification, but don't hesitate to create a GitHub "
-            "issue if you want any news concerning the bug resolution : "
-            "https://github.com/TeKrop/overfast-api/issues"
-        ),
+        detail=settings.internal_server_error_message,
     )
 
 
@@ -85,7 +80,7 @@ def send_discord_webhook_message(message: str) -> httpx.Response | None:
         logger.error(message)
         return None
 
-    return httpx.post(
+    return httpx.post(  # pragma: no cover
         settings.discord_webhook_url, data={"content": message}, timeout=10
     )
 

diff --git a/app/main.py b/app/main.py
@@ -7,7 +7,6 @@
 from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
 from fastapi.openapi.utils import get_openapi
 from fastapi.responses import JSONResponse
-from fastapi.staticfiles import StaticFiles
 from starlette.exceptions import HTTPException as StarletteHTTPException
 
 from .config import settings
@@ -45,7 +44,6 @@ async def lifespan(_: FastAPI):  # pragma: no cover
     await overfast_client.aclose()
 
 
-app = FastAPI(title="OverFast API", docs_url=None, redoc_url=None, lifespan=lifespan)
 description = f"""OverFast API provides comprehensive data on Overwatch 2 heroes,
 game modes, maps, and player statistics by scraping Blizzard pages. Developed with
 the efficiency of **FastAPI** and **Selectolax**, it leverages **nginx** as a
@@ -74,72 +72,85 @@ async def lifespan(_: FastAPI):  # pragma: no cover
 - Integer and float string representations are converted to their respective types
 """
 
+app = FastAPI(
+    title="OverFast API",
+    description=description,
+    version=settings.app_version,
+    openapi_tags=[
+        {
+            "name": RouteTag.HEROES,
+            "description": "Overwatch heroes details : lore, abilities, etc.",
+            "externalDocs": {
+                "description": "Blizzard heroes page, source of the information",
+                "url": "https://overwatch.blizzard.com/en-us/heroes/",
+            },
+        },
+        {
+            "name": RouteTag.GAMEMODES,
+            "description": "Overwatch gamemodes details",
+            "externalDocs": {
+                "description": "Overwatch home page, source of the information",
+                "url": "https://overwatch.blizzard.com/en-us/",
+            },
+        },
+        {
+            "name": RouteTag.MAPS,
+            "description": "Overwatch maps details",
+        },
+        {
+            "name": RouteTag.PLAYERS,
+            "description": players_section_description,
+            "externalDocs": {
+                "description": "Blizzard profile pages, source of the information",
+                "url": "https://overwatch.blizzard.com/en-us/search/",
+            },
+        },
+    ],
+    servers=[{"url": settings.app_base_url, "description": "Production server"}],
+    docs_url=None,
+    redoc_url=None,
+    lifespan=lifespan,
+    contact={
+        "name": 'Valentin "TeKrop" PORCHET',
+        "url": "https://github.com/TeKrop/overfast-api",
+        "email": "[email protected]",
+    },
+    license_info={
+        "name": "MIT",
+        "url": "https://github.com/TeKrop/overfast-api/blob/main/LICENSE",
+    },
+)
+
+# Add customized OpenAPI specs with app logo
+
 
 def custom_openapi():  # pragma: no cover
     if app.openapi_schema:
         return app.openapi_schema
 
     openapi_schema = get_openapi(
-        title="OverFast API",
-        description=description,
-        version=settings.app_version,
-        contact={
-            "name": 'Valentin "TeKrop" PORCHET',
-            "url": "https://github.com/TeKrop/overfast-api",
-            "email": "[email protected]",
-        },
-        license_info={
-            "name": "MIT",
-            "url": "https://github.com/TeKrop/overfast-api/blob/main/LICENSE",
-        },
+        title=app.title,
+        description=app.description,
+        version=app.version,
+        contact=app.contact,
+        license_info=app.license_info,
         routes=app.routes,
-        tags=[
-            {
-                "name": RouteTag.HEROES,
-                "description": "Overwatch heroes details : lore, abilities, etc.",
-                "externalDocs": {
-                    "description": "Blizzard heroes page, source of the information",
-                    "url": "https://overwatch.blizzard.com/en-us/heroes/",
-                },
-            },
-            {
-                "name": RouteTag.GAMEMODES,
-                "description": "Overwatch gamemodes details",
-                "externalDocs": {
-                    "description": "Overwatch home page, source of the information",
-                    "url": "https://overwatch.blizzard.com/en-us/",
-                },
-            },
-            {
-                "name": RouteTag.MAPS,
-                "description": "Overwatch maps details",
-            },
-            {
-                "name": RouteTag.PLAYERS,
-                "description": players_section_description,
-                "externalDocs": {
-                    "description": "Blizzard profile pages, source of the information",
-                    "url": "https://overwatch.blizzard.com/en-us/search/",
-                },
-            },
-        ],
-        servers=[{"url": settings.app_base_url, "description": "Production server"}],
+        tags=app.openapi_tags,
+        servers=app.servers,
     )
     openapi_schema["info"]["x-logo"] = {
         "url": "https://files.tekrop.fr/overfast_api_logo_full_1000.png",
         "altText": "OverFast API Logo",
     }
+
     app.openapi_schema = openapi_schema
     return app.openapi_schema
 
 
 app.openapi = custom_openapi
 
-app.mount("/static", StaticFiles(directory="static"), name="static")
-
-app.logger = logger
-logger.info("OverFast API... Online !")
-logger.info("Version : {}", settings.app_version)
+# Add custom exception handlers for Starlet HTTP exceptions, but also
+# for Pydantic Validation Errors
 
 
 @app.exception_handler(StarletteHTTPException)
@@ -182,7 +193,7 @@ async def overridden_swagger():
 
 
 # Add supported profiler as middleware
-if settings.profiler:
+if settings.profiler:  # pragma: no cover
     supported_profilers = {
         Profiler.MEMRAY: MemrayInMemoryMiddleware,
         Profiler.PYINSTRUMENT: PyInstrumentMiddleware,
@@ -205,3 +216,6 @@ async def overridden_swagger():
 app.include_router(gamemodes.router, prefix="/gamemodes")
 app.include_router(maps.router, prefix="/maps")
 app.include_router(players.router, prefix="/players")
+
+logger.info("OverFast API... Online !")
+logger.info("Version : {}", settings.app_version)
diff --git a/app/middlewares.py b/app/middlewares.py
@@ -16,7 +16,7 @@
     import pyinstrument
 
 
-class OverFastMiddleware(BaseHTTPMiddleware):
+class OverFastMiddleware(BaseHTTPMiddleware):  # pragma: no cover
     async def dispatch(
         self, request: Request, call_next: Callable
     ) -> HTMLResponse | JSONResponse:
@@ -28,7 +28,7 @@ async def dispatch(
         return await self._dispatch(request, call_next)
 
 
-class MemrayInMemoryMiddleware(OverFastMiddleware):
+class MemrayInMemoryMiddleware(OverFastMiddleware):  # pragma: no cover
     async def _dispatch(self, request: Request, call_next: Callable) -> HTMLResponse:
         # Create an temporary file
         with tempfile.NamedTemporaryFile(suffix=".bin", delete=False) as tmp_bin_file:
@@ -77,15 +77,15 @@ def generate_html_report(self, tmp_bin_path: Path) -> str:
         return html_content
 
 
-class PyInstrumentMiddleware(OverFastMiddleware):
+class PyInstrumentMiddleware(OverFastMiddleware):  # pragma: no cover
     async def _dispatch(self, request: Request, call_next: Callable) -> HTMLResponse:
         with pyinstrument.Profiler(interval=0.001, async_mode="enabled") as profiler:
             await call_next(request)
 
         return HTMLResponse(profiler.output_html())
 
 
-class TraceMallocMiddleware(OverFastMiddleware):
+class TraceMallocMiddleware(OverFastMiddleware):  # pragma: no cover
     def __init__(self, app: FastAPI):
         super().__init__(app)
         tracemalloc.start()
@@ -118,7 +118,7 @@ async def _dispatch(self, request: Request, call_next: Callable) -> JSONResponse
         return JSONResponse(content=memory_report)
 
 
-class ObjGraphMiddleware(OverFastMiddleware):
+class ObjGraphMiddleware(OverFastMiddleware):  # pragma: no cover
     async def _dispatch(self, request: Request, call_next: Callable) -> JSONResponse:
         # Capture common object types before processing
         objects_before = objgraph.most_common_types(limit=10)

diff --git a/app/models.py b/app/models.py
@@ -2,6 +2,8 @@
 
 from pydantic import BaseModel, Field
 
+from app.config import settings
+
 
 class BlizzardErrorMessage(BaseModel):
     error: str = Field(
@@ -15,14 +17,7 @@ class InternalServerErrorMessage(BaseModel):
     error: str = Field(
         ...,
         description="Message describing the internal server error",
-        examples=[
-            (
-                "An internal server error occurred during the process. The developer "
-                "received a notification, but don't hesitate to create a GitHub "
-                "issue if you want any news concerning the bug resolution : "
-                "https://github.com/TeKrop/overfast-api/issues"
-            ),
-        ],
+        examples=[settings.internal_server_error_message],
     )
 
 

diff --git a/app/players/helpers.py b/app/players/helpers.py
@@ -13,19 +13,6 @@
 FLOAT_PATTERN = re.compile(r"^-?\d+(,\d+)*\.\d+$")
 
 
-# List of players used for testing
-players_ids = [
-    "copypasting-1216",  # Player with an empty hero career stats (lucio)
-    "Dekk-2677",  # Classic profile without rank
-    "KIRIKO-21253",  # Profile with rank on only two roles
-    "Player-1112937",  # Console player
-    "quibble-11594",  # Profile without endorsement
-    "TeKrop-2217",  # Classic profile
-    "Unknown-1234",  # No player
-    "JohnV1-1190",  # Player without any title ingame
-]
-
-
 @cache
 def get_hero_name(hero_key: HeroKey) -> str:
     """Get a hero name based on the CSV file"""

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "overfast-api"
-version = "3.4.0"
+version = "3.5.0"
 description = "Overwatch API giving data about heroes, maps, and players statistics."
 license = {file = "LICENSE"}
 authors = [
@@ -12,7 +12,6 @@ dependencies = [
     "fastapi[standard]==0.115.*",
     "httpx[http2]==0.27.*",
     "loguru==0.7.*",
-    "lxml==5.3.*",
     "redis==5.2.*",
     "pydantic==2.9.*",
     "pydantic-settings==2.6.*",

diff --git a/tests/fixtures/html/heroes.html b/tests/fixtures/html/heroes.html
diff --git a/tests/fixtures/html/heroes/ana.html b/tests/fixtures/html/heroes/ana.html
diff --git a/tests/fixtures/html/heroes/ashe.html b/tests/fixtures/html/heroes/ashe.html
diff --git a/tests/fixtures/html/heroes/baptiste.html b/tests/fixtures/html/heroes/baptiste.html
diff --git a/tests/fixtures/html/heroes/bastion.html b/tests/fixtures/html/heroes/bastion.html