test: 🚨 Ensure FastAPI setup works as expected

Author: ddanier

README.md

@@ -55,7 +55,7 @@ from yourapp.loader import loader
 
 @asynccontextmanager
 async def lifespan(app: FastAPI):
-    loader.setup()  # Setup everythign on FastAPI startup
+    loader.setup()  # Setup everything on FastAPI startup
     yield
 
 

pyproject.toml

@@ -24,6 +24,7 @@ flake8-print = "^5.0.0"
 flake8-debugger = "^4.1.2"
 pytest-cov = ">=3,<5"
 tox = ">=3.26,<5.0"
+httpx = ">=0.24.1,<1.0.0"
 
 [tool.isort]
 multi_line_output = 3

tests/test_fastapi_integration.py

@@ -0,0 +1,59 @@
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+from fastapi.testclient import TestClient
+
+from fastapi_module_loader import BaseModule, ModuleLoader
+
+
+class TrackingModule(BaseModule):
+    is_load: bool = False
+    is_pre_setup: bool = False
+    is_setup: bool = False
+    is_post_setup: bool = False
+
+    def load(self) -> None:
+        self.is_load = True
+
+    def pre_setup(self) -> None:
+        self.is_pre_setup = True
+
+    def setup(self) -> None:
+        self.is_setup = True
+
+    def post_setup(self) -> None:
+        self.is_post_setup = True
+
+
+loader = ModuleLoader(
+    [
+        "tests.test_fastapi_integration.TrackingModule",
+    ],
+)
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    loader.setup()  # Setup everything on FastAPI startup
+    yield
+
+
+loader.load()  # Ensure everything is loaded
+app = FastAPI(lifespan=lifespan)  # Pass the lifespan context manager to FastAPI
+
+
+@app.get("/")
+async def root():
+    assert loader.is_loaded is True
+    assert loader.loaded_modules[0].is_load is True
+    assert loader.is_setup is True
+    assert loader.loaded_modules[0].is_pre_setup is True
+    assert loader.loaded_modules[0].is_setup is True
+    assert loader.loaded_modules[0].is_post_setup is True
+    return {"message": "all ok"}
+
+
+def test_fastapi_integration() -> None:
+    with TestClient(app) as client:
+        response = client.get("/")
+        assert response.status_code == 200

tox.ini

@@ -9,6 +9,7 @@ envlist =
 [testenv]
 deps =
     pytest
+    httpx
 setenv =
     PYTHONPATH = .
 commands = pytest