Add example of testing lifespan to fastapi example

CHANGELOG.rst

@@ -9,6 +9,12 @@ Changelog
 0.21
 ====
 
+0.21.5 <../0.21.5>`_ - 2024-07-18
+------
+Added
+^^^^^
+- Propagate `_create_db` parameter to RegisterTortoise. (#1676)
+
 0.21.4 <../0.21.4>`_ - 2024-07-03
 ------
 Added

examples/fastapi/_tests.py

@@ -38,6 +38,7 @@ def anyio_backend() -> str:
 
 @asynccontextmanager
 async def client_manager(app, base_url="http://test", **kw) -> ClientManagerType:
+ app.state.testing = True
  async with LifespanManager(app):
  transport = ASGITransport(app=app)
  async with AsyncClient(transport=transport, base_url=base_url, **kw) as c:

examples/fastapi/main.py

@@ -1,20 +1,50 @@
 # pylint: disable=E0611,E0401
+import os
 from contextlib import asynccontextmanager
 from typing import AsyncGenerator
 
-from config import register_orm
 from fastapi import FastAPI
+
+from examples.fastapi.config import register_orm
 from routers import router as users_router
+from tortoise import Tortoise, generate_config
+from tortoise.contrib.fastapi import RegisterTortoise
 
 
 @asynccontextmanager
-async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
- # app startup
- async with register_orm(app):
+async def lifespan_test(app: FastAPI) -> AsyncGenerator[None, None]:
+ config = generate_config(
+ os.getenv("TORTOISE_TEST_DB", ""),
+ app_modules={"models": ["models"]},
+ testing=True,
+ connection_label="models",
+ )
+ async with RegisterTortoise(
+ app=app,
+ config=config,
+ generate_schemas=True,
+ add_exception_handlers=True,
+ _create_db=True,
+ ):
  # db connected
  yield
  # app teardown
  # db connections closed
+ await Tortoise._drop_databases()
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
+ if getattr(app.state, "testing", None):
+ async with lifespan_test(app) as _:
+ yield
+ else:
+ # app startup
+ async with register_orm(app):
+ # db connected
+ yield
+ # app teardown
+ # db connections closed
 
 
 app = FastAPI(title="Tortoise ORM FastAPI example", lifespan=lifespan)

tortoise/contrib/fastapi/__init__.py

@@ -108,6 +108,7 @@ def __init__(
  add_exception_handlers: bool = False,
  use_tz: bool = False,
  timezone: str = "UTC",
+ _create_db: bool = False,
  ) -> None:
  self.app = app
  self.config = config
@@ -117,6 +118,7 @@ def __init__(
  self.generate_schemas = generate_schemas
  self.use_tz = use_tz
  self.timezone = timezone
+ self._create_db = _create_db
 
  if add_exception_handlers:
 
@@ -139,6 +141,7 @@ async def init_orm(self) -> None: # pylint: disable=W0612
  modules=self.modules,
  use_tz=self.use_tz,
  timezone=self.timezone,
+ _create_db=self._create_db,
  )
  logger.info("Tortoise-ORM started, %s, %s", connections._get_storage(), Tortoise.apps)
  if self.generate_schemas: