Add granular DB error types with retry logic
New exceptions: DatabaseBusyError, DatabasePermissionDeniedError, DatabasePathInvalidError, DatabaseCorruptedError, DatabaseUnavailableError. open_db creates parent directory if missing. Catches all aiosqlite errors and maps to specific exception types. get_db retries up to 3x on locked database with backoff. Propagates specific exceptions instead of generic HTTPException. Tests for all new error types and retry behavior.
This commit is contained in:
@@ -3,6 +3,7 @@ from __future__ import annotations
|
||||
from unittest.mock import AsyncMock, MagicMock, patch
|
||||
|
||||
import aiohttp
|
||||
import aiosqlite
|
||||
import pytest
|
||||
from fastapi import FastAPI
|
||||
from starlette.requests import Request
|
||||
@@ -19,6 +20,13 @@ from app.dependencies import (
|
||||
get_settings,
|
||||
get_settings_repo,
|
||||
)
|
||||
from app.exceptions import (
|
||||
DatabaseBusyError,
|
||||
DatabaseCorruptedError,
|
||||
DatabasePathInvalidError,
|
||||
DatabasePermissionDeniedError,
|
||||
DatabaseUnavailableError,
|
||||
)
|
||||
from app.main import create_app
|
||||
from app.models.server import ServerStatus
|
||||
|
||||
@@ -98,3 +106,184 @@ async def test_get_db_uses_effective_runtime_database_path(test_settings: Settin
|
||||
await gen.aclose()
|
||||
|
||||
mock_open_db.assert_awaited_once_with("/tmp/runtime.db")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Database error handling tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_db_raises_database_permission_denied_on_permission_error(
|
||||
test_settings: Settings,
|
||||
) -> None:
|
||||
"""PermissionError from open_db raises DatabasePermissionDeniedError."""
|
||||
with patch(
|
||||
"app.db.open_db",
|
||||
new=AsyncMock(side_effect=DatabasePermissionDeniedError(test_settings.database_path)),
|
||||
):
|
||||
gen = get_db(settings=test_settings)
|
||||
with pytest.raises(DatabasePermissionDeniedError) as exc_info:
|
||||
await gen.__anext__()
|
||||
await gen.aclose()
|
||||
|
||||
assert exc_info.value.error_code == "database_permission_denied"
|
||||
assert exc_info.value.database_path == test_settings.database_path
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_db_raises_database_path_invalid_on_missing_directory(
|
||||
test_settings: Settings,
|
||||
) -> None:
|
||||
"""sqlite3.OperationalError('unable to open database file') raises DatabasePathInvalidError."""
|
||||
with patch(
|
||||
"app.db.open_db",
|
||||
new=AsyncMock(side_effect=DatabasePathInvalidError(test_settings.database_path)),
|
||||
):
|
||||
gen = get_db(settings=test_settings)
|
||||
with pytest.raises(DatabasePathInvalidError) as exc_info:
|
||||
await gen.__anext__()
|
||||
await gen.aclose()
|
||||
|
||||
assert exc_info.value.error_code == "database_path_invalid"
|
||||
assert exc_info.value.database_path == test_settings.database_path
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_db_retries_on_database_locked(test_settings: Settings) -> None:
|
||||
"""get_db retries up to 3 times when database is locked."""
|
||||
mock_connection = MagicMock()
|
||||
mock_connection.close = AsyncMock()
|
||||
|
||||
locked_err = DatabaseUnavailableError(
|
||||
test_settings.database_path, "database is locked"
|
||||
)
|
||||
|
||||
with patch(
|
||||
"app.db.open_db",
|
||||
new=AsyncMock(side_effect=[locked_err, locked_err, mock_connection]),
|
||||
) as mock_open:
|
||||
gen = get_db(settings=test_settings)
|
||||
with patch("asyncio.sleep", new=AsyncMock()) as mock_sleep:
|
||||
connection = await gen.__anext__()
|
||||
await gen.aclose()
|
||||
|
||||
assert mock_open.call_count == 3
|
||||
assert connection is mock_connection
|
||||
assert mock_sleep.call_count == 2
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_db_fails_after_max_retries_on_database_locked(
|
||||
test_settings: Settings,
|
||||
) -> None:
|
||||
"""After 3 retries on database locked, raises DatabaseBusyError."""
|
||||
locked_err = DatabaseUnavailableError(
|
||||
test_settings.database_path, "database is locked"
|
||||
)
|
||||
|
||||
with patch("app.db.open_db", new=AsyncMock(side_effect=locked_err)) as mock_open:
|
||||
gen = get_db(settings=test_settings)
|
||||
with patch("asyncio.sleep", new=AsyncMock()):
|
||||
with pytest.raises(DatabaseBusyError) as exc_info:
|
||||
await gen.__anext__()
|
||||
await gen.aclose()
|
||||
|
||||
assert mock_open.call_count == 3
|
||||
assert exc_info.value.error_code == "database_busy"
|
||||
assert exc_info.value.retries == 3
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_db_raises_database_corrupted_on_malformed_db(
|
||||
test_settings: Settings,
|
||||
) -> None:
|
||||
"""sqlite3.DatabaseError('database disk image is malformed') raises DatabaseCorruptedError."""
|
||||
with patch(
|
||||
"app.db.open_db",
|
||||
new=AsyncMock(side_effect=DatabaseCorruptedError(test_settings.database_path)),
|
||||
):
|
||||
gen = get_db(settings=test_settings)
|
||||
with pytest.raises(DatabaseCorruptedError) as exc_info:
|
||||
await gen.__anext__()
|
||||
await gen.aclose()
|
||||
|
||||
assert exc_info.value.error_code == "database_corrupted"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_open_db_creates_parent_directory_if_missing(tmp_path: pytest.Path) -> None:
|
||||
"""open_db creates the parent directory when it does not exist."""
|
||||
from pathlib import Path
|
||||
|
||||
from app.db import open_db
|
||||
|
||||
db_path = str(Path(str(tmp_path)) / "subdir" / "deeper" / "bangui.db")
|
||||
mock_conn = MagicMock()
|
||||
mock_conn.close = AsyncMock()
|
||||
mock_conn.execute = AsyncMock()
|
||||
mock_conn.commit = AsyncMock()
|
||||
|
||||
with patch("aiosqlite.connect", new=AsyncMock(return_value=mock_conn)), \
|
||||
patch("app.db._configure_connection", new=AsyncMock()):
|
||||
connection = await open_db(db_path)
|
||||
|
||||
assert connection is mock_conn
|
||||
assert Path(db_path).parent.exists()
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_open_db_logs_specific_sqlite_error_code() -> None:
|
||||
"""open_db logs the SQLite error code when available."""
|
||||
from app.db import open_db
|
||||
|
||||
exc = aiosqlite.OperationalError("database is locked")
|
||||
exc.sqlite_errorcode = 5 # SQLITE_BUSY
|
||||
|
||||
with patch("aiosqlite.connect", new=AsyncMock(side_effect=exc)), \
|
||||
pytest.raises(DatabaseUnavailableError):
|
||||
await open_db("/tmp/test.db")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Error metadata tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_database_busy_error_metadata() -> None:
|
||||
"""DatabaseBusyError returns correct metadata."""
|
||||
err = DatabaseBusyError("/data/bangui.db", retries=3)
|
||||
assert err.error_code == "database_busy"
|
||||
metadata = err.get_error_metadata()
|
||||
assert metadata["database_path"] == "/data/bangui.db"
|
||||
assert metadata["retries"] == 3
|
||||
|
||||
|
||||
def test_database_permission_denied_error_metadata() -> None:
|
||||
"""DatabasePermissionDeniedError returns correct metadata."""
|
||||
err = DatabasePermissionDeniedError("/data/bangui.db")
|
||||
assert err.error_code == "database_permission_denied"
|
||||
assert err.get_error_metadata()["database_path"] == "/data/bangui.db"
|
||||
|
||||
|
||||
def test_database_path_invalid_error_metadata() -> None:
|
||||
"""DatabasePathInvalidError returns correct metadata."""
|
||||
err = DatabasePathInvalidError("/data/bangui.db")
|
||||
assert err.error_code == "database_path_invalid"
|
||||
assert err.get_error_metadata()["database_path"] == "/data/bangui.db"
|
||||
|
||||
|
||||
def test_database_corrupted_error_metadata() -> None:
|
||||
"""DatabaseCorruptedError returns correct metadata."""
|
||||
err = DatabaseCorruptedError("/data/bangui.db")
|
||||
assert err.error_code == "database_corrupted"
|
||||
assert err.get_error_metadata()["database_path"] == "/data/bangui.db"
|
||||
|
||||
|
||||
def test_database_unavailable_error_metadata() -> None:
|
||||
"""DatabaseUnavailableError returns correct metadata."""
|
||||
err = DatabaseUnavailableError("/data/bangui.db", "some error")
|
||||
assert err.error_code == "database_unavailable"
|
||||
metadata = err.get_error_metadata()
|
||||
assert metadata["database_path"] == "/data/bangui.db"
|
||||
assert metadata["error"] == "some error"
|
||||
|
||||
Reference in New Issue
Block a user