84 lines
2.7 KiB
Python
84 lines
2.7 KiB
Python
"""Shared pytest fixtures for the BanGUI backend test suite.
|
|
|
|
All fixtures are async-compatible via pytest-asyncio. External dependencies
|
|
(fail2ban socket, HTTP APIs) are always mocked so tests never touch real
|
|
infrastructure.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
# Ensure the bundled fail2ban package is importable.
|
|
_FAIL2BAN_MASTER: Path = Path(__file__).resolve().parents[2] / "fail2ban-master"
|
|
if str(_FAIL2BAN_MASTER) not in sys.path:
|
|
sys.path.insert(0, str(_FAIL2BAN_MASTER))
|
|
|
|
import aiosqlite
|
|
import pytest
|
|
from httpx import ASGITransport, AsyncClient
|
|
|
|
from app.config import Settings
|
|
from app.db import init_db
|
|
from app.main import create_app
|
|
|
|
|
|
@pytest.fixture
|
|
def test_settings(tmp_path: Path) -> Settings:
|
|
"""Return a ``Settings`` instance configured for testing.
|
|
|
|
Uses a temporary directory for the database so tests are isolated from
|
|
each other and from the development database.
|
|
|
|
Args:
|
|
tmp_path: Pytest-provided temporary directory (unique per test).
|
|
|
|
Returns:
|
|
A :class:`~app.config.Settings` instance with overridden paths.
|
|
"""
|
|
config_dir = tmp_path / "fail2ban"
|
|
(config_dir / "jail.d").mkdir(parents=True)
|
|
(config_dir / "filter.d").mkdir(parents=True)
|
|
(config_dir / "action.d").mkdir(parents=True)
|
|
|
|
return Settings(
|
|
database_path=str(tmp_path / "test_bangui.db"),
|
|
fail2ban_socket="/tmp/fake_fail2ban.sock",
|
|
fail2ban_config_dir=str(config_dir),
|
|
session_secret="test-secret-key-do-not-use-in-production",
|
|
session_duration_minutes=60,
|
|
timezone="UTC",
|
|
log_level="debug",
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
async def client(test_settings: Settings) -> AsyncClient: # type: ignore[misc]
|
|
"""Provide an ``AsyncClient`` wired to a test instance of the BanGUI app.
|
|
|
|
The client sends requests directly to the ASGI application (no network).
|
|
``app.state.db`` is initialised manually so router tests can use the
|
|
database without triggering the full ASGI lifespan.
|
|
|
|
Args:
|
|
test_settings: Injected test settings fixture.
|
|
|
|
Yields:
|
|
An :class:`httpx.AsyncClient` with ``base_url="http://test"``.
|
|
"""
|
|
app = create_app(settings=test_settings)
|
|
|
|
# Bootstrap the database on app.state so Depends(get_db) works in tests.
|
|
# The ASGI lifespan is not triggered by ASGITransport, so we do this here.
|
|
db: aiosqlite.Connection = await aiosqlite.connect(test_settings.database_path)
|
|
db.row_factory = aiosqlite.Row
|
|
await init_db(db)
|
|
app.state.db = db
|
|
|
|
transport: ASGITransport = ASGITransport(app=app)
|
|
async with AsyncClient(transport=transport, base_url="http://test") as ac:
|
|
yield ac
|
|
|
|
await db.close()
|