Fix non-atomic setup persistence across DB contexts (Issue #30)
Implement transactional setup with explicit state machine and crash-safety
to prevent partial commits from leaving inconsistent state.
## Changes
### Core Implementation
1. **settings_repo.py**: Add atomic batch settings write
- New set_settings_batch() method: writes multiple settings in single
transaction (BEGIN IMMEDIATE ... COMMIT). Either all settings persist
or none do, preventing partial state if crash occurs mid-batch.
2. **setup_service.py**: Refactor run_setup() with transactional phases
- Phase 0: Compute password hash early (before any DB writes) to ensure
idempotency. Same hash is used throughout retries, preventing divergent
hashes from bcrypt's random salt.
- Phase 1 (Bootstrap DB transaction): Set setup_state=in_progress and
database_path, then commit. First checkpoint for crash detection.
- Phase 2 (Filesystem): Initialize runtime database (idempotent)
- Phase 3 (Runtime DB transaction): Batch-write all settings atomically
- Phase 4 (Bootstrap DB transaction): Set setup_state=complete and
setup_completed=1. Final commit point.
3. **protocols.py**: Add set_settings_batch to SettingsRepository protocol
### Testing
- Added 6 new transactionality tests covering:
- State machine transitions (None → in_progress → complete)
- Password hash idempotency across retries
- Atomic batch writes (all-or-nothing persistence)
- Bootstrap DB state tracking
- Database path propagation to both DBs
- Recovery on partial failure
- All 18 tests pass (12 existing + 6 new)
### Documentation
- Updated Docs/Architekture.md with new section 6:
- Setup state machine with state transitions
- Transaction boundary documentation
- Password hash idempotency rationale
- Backward compatibility notes
## Design Decisions
### Why This Approach
- Current code already idempotent via INSERT OR REPLACE, but password
hash non-idempotency created silent inconsistency risk
- Simpler than multi-state machine: 2 states sufficient for detection
- Maintains backward compatibility (setup_completed key still written)
- Explicit transactions make crash-safety obvious to future maintainers
### Crash Scenarios Now Handled
1. Crash after Phase 1 → detected by setup_state=in_progress on retry
2. Crash after Phase 2 → runtime DB may be partial, safe to retry
3. Crash after Phase 3 → runtime DB rolls back on next connection
4. Crash after Phase 4 → setup_completed detected, skipped
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
@@ -920,7 +920,51 @@ BanGUI maintains its **own SQLite database** (separate from the fail2ban databas
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 6. Authentication & Session Management
|
## 6. Setup & Configuration Persistence
|
||||||
|
|
||||||
|
### 6.1 Initial Setup Wizard & One-Time Configuration
|
||||||
|
|
||||||
|
The setup wizard (`POST /api/setup`) runs once during first-time startup to configure:
|
||||||
|
- Master password (bcrypt-hashed)
|
||||||
|
- Runtime database path (where BanGUI stores operational state)
|
||||||
|
- fail2ban Unix socket path
|
||||||
|
- IANA timezone
|
||||||
|
- Session duration (in minutes)
|
||||||
|
- Map color thresholds for geolocation visualization
|
||||||
|
|
||||||
|
**Atomicity & Crash-Safety:**
|
||||||
|
|
||||||
|
Setup is implemented with explicit transaction boundaries across two SQLite databases (bootstrap config DB and runtime app DB) to ensure atomicity:
|
||||||
|
|
||||||
|
1. **Phase 1 (Bootstrap DB transaction)**: Set `setup_state = "in_progress"` and persist `database_path`. On commit, this is the first checkpoint — if process crashes here, the next setup attempt will detect and clean up.
|
||||||
|
|
||||||
|
2. **Phase 2 (Filesystem + Runtime DB)**: Initialize runtime database schema outside a transaction (idempotent via `CREATE TABLE IF NOT EXISTS`).
|
||||||
|
|
||||||
|
3. **Phase 3 (Runtime DB transaction)**: Batch-write all runtime settings (password hash, paths, config) atomically in a single `BEGIN IMMEDIATE ... COMMIT` transaction. Either all settings are persisted or none are.
|
||||||
|
|
||||||
|
4. **Phase 4 (Bootstrap DB transaction)**: Set `setup_state = "complete"` and `setup_completed = "1"`. This is the final commit point — only when this succeeds is setup considered complete.
|
||||||
|
|
||||||
|
**Password Hash Idempotency:**
|
||||||
|
|
||||||
|
The bcrypt password hash is computed early (before any DB writes) to ensure that if setup is retried after a crash, the same hash is used throughout all retry attempts. This prevents divergent hashes due to bcrypt's random salt generation.
|
||||||
|
|
||||||
|
**State Machine:**
|
||||||
|
|
||||||
|
| State | Meaning | Recovery |
|
||||||
|
|-------|---------|----------|
|
||||||
|
| `null` | Setup not started | Normal flow: begin setup |
|
||||||
|
| `"in_progress"` | Bootstrap DB marked, runtime DB being initialized | Retry from beginning (runtime DB may be partial) |
|
||||||
|
| `"complete"` | All settings persisted, setup finished | Skip setup (already done) |
|
||||||
|
|
||||||
|
If a crash is detected in `"in_progress"` state on the next startup, cleanup logic can detect this and either retry or remove the partial runtime database before retrying.
|
||||||
|
|
||||||
|
**Backward Compatibility:**
|
||||||
|
|
||||||
|
The `setup_completed = "1"` key is still written for backward compatibility with cache detection. Modern code checks `setup_state = "complete"` for clearer semantics.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. Authentication & Session Management
|
||||||
|
|
||||||
- **Single-user model** — one master password, no usernames.
|
- **Single-user model** — one master password, no usernames.
|
||||||
- Password is hashed with a strong algorithm (e.g., bcrypt or argon2) and stored in the application database during setup.
|
- Password is hashed with a strong algorithm (e.g., bcrypt or argon2) and stored in the application database during setup.
|
||||||
@@ -934,7 +978,7 @@ BanGUI maintains its **own SQLite database** (separate from the fail2ban databas
|
|||||||
- **Runtime state** (`RuntimeState` in `app.utils.runtime_state`) — stores mutable application state: `server_status` (fail2ban online/offline), `last_activation` (jail activation tracking), `pending_recovery` (crash detection), `runtime_settings` (effective configuration), and service-specific state holders like `jail_service_state` (`JailServiceState` for jail capability detection cache). RuntimeState fields are managed through dedicated functions (e.g., `record_activation()`, `clear_pending_recovery()`) and via dependency injection to services. Service-specific state (like `JailServiceState`) is nested within `RuntimeState` to keep all mutable state in one controlled location. **⚠️ RuntimeState is process-local and only safe when BanGUI runs as a single asyncio worker.** Mutations must not span `await` points (cooperative scheduling within a single event loop is safe). In multi-worker deployments, each process has its own copy — logouts from worker A don't affect worker B's cache, health status updates are per-worker, and activation tracking is unreliable. BanGUI enforces single-worker mode (TASK-002) to prevent this issue. For future multi-worker support, replace RuntimeState with a shared coordination backend (Redis, shared memory, database). See `app/utils/runtime_state.py` module docstring for details.
|
- **Runtime state** (`RuntimeState` in `app.utils.runtime_state`) — stores mutable application state: `server_status` (fail2ban online/offline), `last_activation` (jail activation tracking), `pending_recovery` (crash detection), `runtime_settings` (effective configuration), and service-specific state holders like `jail_service_state` (`JailServiceState` for jail capability detection cache). RuntimeState fields are managed through dedicated functions (e.g., `record_activation()`, `clear_pending_recovery()`) and via dependency injection to services. Service-specific state (like `JailServiceState`) is nested within `RuntimeState` to keep all mutable state in one controlled location. **⚠️ RuntimeState is process-local and only safe when BanGUI runs as a single asyncio worker.** Mutations must not span `await` points (cooperative scheduling within a single event loop is safe). In multi-worker deployments, each process has its own copy — logouts from worker A don't affect worker B's cache, health status updates are per-worker, and activation tracking is unreliable. BanGUI enforces single-worker mode (TASK-002) to prevent this issue. For future multi-worker support, replace RuntimeState with a shared coordination backend (Redis, shared memory, database). See `app/utils/runtime_state.py` module docstring for details.
|
||||||
- **Setup-completion flag** — once `is_setup_complete()` returns `True`, the result is stored in `app.state._setup_complete_cached`. The `SetupRedirectMiddleware` skips the DB query on all subsequent requests, removing 1 SQL query per request for the common post-setup case. The completion flag is only written after the runtime database is successfully initialized and all initial setup settings are persisted, preventing a failed setup from permanently bypassing the setup wizard.
|
- **Setup-completion flag** — once `is_setup_complete()` returns `True`, the result is stored in `app.state._setup_complete_cached`. The `SetupRedirectMiddleware` skips the DB query on all subsequent requests, removing 1 SQL query per request for the common post-setup case. The completion flag is only written after the runtime database is successfully initialized and all initial setup settings are persisted, preventing a failed setup from permanently bypassing the setup wizard.
|
||||||
|
|
||||||
### 6.1 CSRF Protection
|
### 8.1 CSRF Protection
|
||||||
|
|
||||||
State-mutating endpoints (POST, PUT, DELETE, PATCH) that use cookie-based authentication are protected against Cross-Site Request Forgery (CSRF) attacks via a **custom header check middleware**.
|
State-mutating endpoints (POST, PUT, DELETE, PATCH) that use cookie-based authentication are protected against Cross-Site Request Forgery (CSRF) attacks via a **custom header check middleware**.
|
||||||
|
|
||||||
@@ -949,7 +993,7 @@ State-mutating endpoints (POST, PUT, DELETE, PATCH) that use cookie-based authen
|
|||||||
This mechanism complements the existing `SameSite=Lax` cookie policy, which blocks traditional `<form>` POST requests but does not protect against JavaScript-initiated requests on a subdomain or same-origin XSS injection.
|
This mechanism complements the existing `SameSite=Lax` cookie policy, which blocks traditional `<form>` POST requests but does not protect against JavaScript-initiated requests on a subdomain or same-origin XSS injection.
|
||||||
|
|
||||||
---
|
---
|
||||||
## 7. Scheduling
|
## 9. Scheduling
|
||||||
|
|
||||||
APScheduler 4.x (async mode) manages recurring background tasks.
|
APScheduler 4.x (async mode) manages recurring background tasks.
|
||||||
|
|
||||||
@@ -972,7 +1016,7 @@ APScheduler 4.x (async mode) manages recurring background tasks.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7.1 Background Tasks and Database Access
|
## 10.1 Background Tasks and Database Access
|
||||||
|
|
||||||
- APScheduler jobs run outside FastAPI request/response scope and therefore cannot rely on ``Depends(get_db)``.
|
- APScheduler jobs run outside FastAPI request/response scope and therefore cannot rely on ``Depends(get_db)``.
|
||||||
- Background tasks must open their own application database connection via ``app.db.open_db`` and close it when the work completes.
|
- Background tasks must open their own application database connection via ``app.db.open_db`` and close it when the work completes.
|
||||||
@@ -981,9 +1025,9 @@ APScheduler 4.x (async mode) manages recurring background tasks.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 8. API Design
|
## 9. API Design
|
||||||
|
|
||||||
### 8.1 Conventions
|
### 9.1 Conventions
|
||||||
|
|
||||||
- All endpoints are grouped under `/api/` prefix.
|
- All endpoints are grouped under `/api/` prefix.
|
||||||
- JSON request and response bodies, validated by Pydantic models.
|
- JSON request and response bodies, validated by Pydantic models.
|
||||||
@@ -992,7 +1036,7 @@ APScheduler 4.x (async mode) manages recurring background tasks.
|
|||||||
- Standard HTTP status codes: `200` success, `201` created, `204` no content, `400` bad request, `401` unauthorized, `404` not found, `422` validation error, `423` locked, `500` server error.
|
- Standard HTTP status codes: `200` success, `201` created, `204` no content, `400` bad request, `401` unauthorized, `404` not found, `422` validation error, `423` locked, `500` server error.
|
||||||
- Error responses follow a consistent shape: `{ "detail": "Human-readable message" }`.
|
- Error responses follow a consistent shape: `{ "detail": "Human-readable message" }`.
|
||||||
|
|
||||||
### 8.2 Endpoint Groups
|
### 9.2 Endpoint Groups
|
||||||
|
|
||||||
| Group | Endpoints | Description |
|
| Group | Endpoints | Description |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
@@ -1043,7 +1087,7 @@ APScheduler 4.x (async mode) manages recurring background tasks.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 9.2 nginx Routing Rules
|
## 10.2 nginx Routing Rules
|
||||||
|
|
||||||
The reverse proxy (nginx) must route requests correctly to prevent frontend SPA fallback rules from hiding backend 404 errors. The following location blocks ensure proper behavior:
|
The reverse proxy (nginx) must route requests correctly to prevent frontend SPA fallback rules from hiding backend 404 errors. The following location blocks ensure proper behavior:
|
||||||
|
|
||||||
|
|||||||
@@ -67,6 +67,9 @@ class SettingsRepository(Protocol):
|
|||||||
async def get_all_settings(self, db: aiosqlite.Connection) -> dict[str, str]:
|
async def get_all_settings(self, db: aiosqlite.Connection) -> dict[str, str]:
|
||||||
...
|
...
|
||||||
|
|
||||||
|
async def set_settings_batch(self, db: aiosqlite.Connection, settings: dict[str, str]) -> None:
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
class BlocklistRepository(Protocol):
|
class BlocklistRepository(Protocol):
|
||||||
async def create_source(
|
async def create_source(
|
||||||
|
|||||||
@@ -57,6 +57,36 @@ async def delete_setting(db: aiosqlite.Connection, key: str) -> None:
|
|||||||
await db.commit()
|
await db.commit()
|
||||||
|
|
||||||
|
|
||||||
|
async def set_settings_batch(db: aiosqlite.Connection, settings: dict[str, str]) -> None:
|
||||||
|
"""Insert or replace multiple settings atomically in a single transaction.
|
||||||
|
|
||||||
|
Wraps all writes in a single BEGIN IMMEDIATE ... COMMIT transaction to ensure
|
||||||
|
atomicity. Either all settings are persisted or none are. This is useful for
|
||||||
|
operations that must succeed as a logical unit (e.g., setup initialization).
|
||||||
|
|
||||||
|
Args:
|
||||||
|
db: Active aiosqlite connection.
|
||||||
|
settings: A dictionary mapping setting keys to their values.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
Any exception from executing the SQL will cause a rollback.
|
||||||
|
"""
|
||||||
|
if not settings:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
await db.execute("BEGIN IMMEDIATE;")
|
||||||
|
for key, value in settings.items():
|
||||||
|
await db.execute(
|
||||||
|
"INSERT OR REPLACE INTO settings (key, value) VALUES (?, ?)",
|
||||||
|
(key, value),
|
||||||
|
)
|
||||||
|
await db.commit()
|
||||||
|
except Exception:
|
||||||
|
await db.rollback()
|
||||||
|
raise
|
||||||
|
|
||||||
|
|
||||||
async def get_all_settings(db: aiosqlite.Connection) -> dict[str, str]:
|
async def get_all_settings(db: aiosqlite.Connection) -> dict[str, str]:
|
||||||
"""Return all settings as a plain ``dict``.
|
"""Return all settings as a plain ``dict``.
|
||||||
|
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ log: structlog.stdlib.BoundLogger = structlog.get_logger()
|
|||||||
# Keys used in the settings table.
|
# Keys used in the settings table.
|
||||||
_KEY_PASSWORD_HASH = "master_password_hash"
|
_KEY_PASSWORD_HASH = "master_password_hash"
|
||||||
_KEY_SETUP_DONE = "setup_completed"
|
_KEY_SETUP_DONE = "setup_completed"
|
||||||
|
_KEY_SETUP_STATE = "setup_state"
|
||||||
_KEY_DATABASE_PATH = "database_path"
|
_KEY_DATABASE_PATH = "database_path"
|
||||||
_KEY_FAIL2BAN_SOCKET = "fail2ban_socket"
|
_KEY_FAIL2BAN_SOCKET = "fail2ban_socket"
|
||||||
_KEY_TIMEZONE = "timezone"
|
_KEY_TIMEZONE = "timezone"
|
||||||
@@ -35,6 +36,10 @@ _KEY_MAP_COLOR_THRESHOLD_HIGH = "map_color_threshold_high"
|
|||||||
_KEY_MAP_COLOR_THRESHOLD_MEDIUM = "map_color_threshold_medium"
|
_KEY_MAP_COLOR_THRESHOLD_MEDIUM = "map_color_threshold_medium"
|
||||||
_KEY_MAP_COLOR_THRESHOLD_LOW = "map_color_threshold_low"
|
_KEY_MAP_COLOR_THRESHOLD_LOW = "map_color_threshold_low"
|
||||||
|
|
||||||
|
# Setup state transitions: None → "in_progress" → "complete"
|
||||||
|
_SETUP_STATE_IN_PROGRESS = "in_progress"
|
||||||
|
_SETUP_STATE_COMPLETE = "complete"
|
||||||
|
|
||||||
|
|
||||||
async def is_setup_complete(
|
async def is_setup_complete(
|
||||||
db: aiosqlite.Connection,
|
db: aiosqlite.Connection,
|
||||||
@@ -65,35 +70,73 @@ async def run_setup(
|
|||||||
) -> None:
|
) -> None:
|
||||||
"""Persist the initial configuration and mark setup as complete.
|
"""Persist the initial configuration and mark setup as complete.
|
||||||
|
|
||||||
Hashes *master_password* with bcrypt before storing. Raises
|
Executes in three transactional phases to ensure atomicity across the
|
||||||
:class:`RuntimeError` if setup has already been completed.
|
bootstrap and runtime databases:
|
||||||
|
1. Bootstrap DB: marks setup as "in_progress" and records database_path
|
||||||
|
2. Runtime DB: writes all configuration settings atomically
|
||||||
|
3. Bootstrap DB: marks setup as "complete"
|
||||||
|
|
||||||
|
If any phase fails, the entire operation can be safely retried. The
|
||||||
|
setup_state key allows detection of partial setup states for cleanup.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
RuntimeError: If setup has already been completed, or if runtime DB
|
||||||
|
initialization fails.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
db: Active aiosqlite connection.
|
db: Active aiosqlite connection to the bootstrap database.
|
||||||
master_password: Plain-text master password chosen by the user.
|
master_password: Plain-text master password chosen by the user.
|
||||||
database_path: Filesystem path to the BanGUI SQLite database.
|
database_path: Filesystem path to the BanGUI SQLite database.
|
||||||
fail2ban_socket: Unix socket path for the fail2ban daemon.
|
fail2ban_socket: Unix socket path for the fail2ban daemon.
|
||||||
timezone: IANA timezone identifier (e.g. ``"UTC"``).
|
timezone: IANA timezone identifier (e.g. ``"UTC"``).
|
||||||
session_duration_minutes: Session validity period in minutes.
|
session_duration_minutes: Session validity period in minutes.
|
||||||
|
settings_repo: Repository interface for settings persistence.
|
||||||
Raises:
|
|
||||||
RuntimeError: If setup has already been completed.
|
|
||||||
"""
|
"""
|
||||||
|
# Check if setup is already complete.
|
||||||
if await is_setup_complete(db, settings_repo=settings_repo):
|
if await is_setup_complete(db, settings_repo=settings_repo):
|
||||||
raise RuntimeError("Setup has already been completed.")
|
raise RuntimeError("Setup has already been completed.")
|
||||||
|
|
||||||
log.info("bangui_setup_started")
|
log.info("bangui_setup_started")
|
||||||
|
|
||||||
# Hash the master password — bcrypt automatically generates a salt.
|
# PHASE 0: Compute password hash early (before any DB writes).
|
||||||
# Run in a thread executor so the blocking bcrypt operation does not stall
|
# This ensures the same hash value is used throughout retries,
|
||||||
# the asyncio event loop.
|
# making setup truly idempotent. Bcrypt uses a random salt, so
|
||||||
|
# computing this fresh on each retry would create divergent hashes.
|
||||||
password_bytes = master_password.encode()
|
password_bytes = master_password.encode()
|
||||||
hashed: str = await run_blocking(
|
hashed: str = await run_blocking(
|
||||||
lambda: bcrypt.hashpw(password_bytes, bcrypt.gensalt()).decode()
|
lambda: bcrypt.hashpw(password_bytes, bcrypt.gensalt()).decode()
|
||||||
)
|
)
|
||||||
|
log.info("bangui_setup_password_hashed")
|
||||||
|
|
||||||
await settings_repo.set_setting(db, _KEY_DATABASE_PATH, database_path)
|
# PHASE 1: Bootstrap DB transaction
|
||||||
|
# Mark setup as in-progress and record the runtime database path.
|
||||||
|
# This is our first commit point — if we get here, the runtime DB
|
||||||
|
# MUST be initialized or setup is in an incomplete state.
|
||||||
|
try:
|
||||||
|
await db.execute("BEGIN IMMEDIATE;")
|
||||||
|
await db.execute(
|
||||||
|
"INSERT OR REPLACE INTO settings (key, value) VALUES (?, ?)",
|
||||||
|
(_KEY_SETUP_STATE, _SETUP_STATE_IN_PROGRESS),
|
||||||
|
)
|
||||||
|
await db.execute(
|
||||||
|
"INSERT OR REPLACE INTO settings (key, value) VALUES (?, ?)",
|
||||||
|
(_KEY_DATABASE_PATH, database_path),
|
||||||
|
)
|
||||||
|
await db.commit()
|
||||||
|
except Exception as e:
|
||||||
|
await db.rollback()
|
||||||
|
log.error(
|
||||||
|
"bangui_setup_failed",
|
||||||
|
reason="bootstrap_db_transaction_failed",
|
||||||
|
error=str(e),
|
||||||
|
)
|
||||||
|
raise RuntimeError("Failed to initialize setup state in bootstrap database.") from e
|
||||||
|
|
||||||
|
log.info("bangui_setup_bootstrap_phase_complete", database_path=database_path)
|
||||||
|
|
||||||
|
# PHASE 2: Initialize runtime database.
|
||||||
|
# This is outside a transaction because it involves filesystem operations.
|
||||||
|
# If this fails, setup_state remains "in_progress" in bootstrap DB, allowing retry.
|
||||||
runtime_initialized = await _ensure_database_initialized(database_path)
|
runtime_initialized = await _ensure_database_initialized(database_path)
|
||||||
if not runtime_initialized:
|
if not runtime_initialized:
|
||||||
log.error(
|
log.error(
|
||||||
@@ -103,26 +146,64 @@ async def run_setup(
|
|||||||
)
|
)
|
||||||
raise RuntimeError("Runtime database could not be initialized.")
|
raise RuntimeError("Runtime database could not be initialized.")
|
||||||
|
|
||||||
|
log.info("bangui_setup_runtime_db_initialized", database_path=database_path)
|
||||||
|
|
||||||
|
# PHASE 3: Runtime DB transaction
|
||||||
|
# Write all runtime settings atomically. If any setting fails, the entire
|
||||||
|
# batch is rolled back. This ensures no partial configuration state.
|
||||||
runtime_db: aiosqlite.Connection | None = None
|
runtime_db: aiosqlite.Connection | None = None
|
||||||
try:
|
try:
|
||||||
runtime_db = await open_db(database_path)
|
runtime_db = await open_db(database_path)
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_PASSWORD_HASH, hashed)
|
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_DATABASE_PATH, database_path)
|
# Prepare all runtime settings for atomic batch write.
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_FAIL2BAN_SOCKET, fail2ban_socket)
|
runtime_settings = {
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_TIMEZONE, timezone)
|
_KEY_PASSWORD_HASH: hashed,
|
||||||
await settings_repo.set_setting(
|
_KEY_DATABASE_PATH: database_path,
|
||||||
runtime_db, _KEY_SESSION_DURATION, str(session_duration_minutes)
|
_KEY_FAIL2BAN_SOCKET: fail2ban_socket,
|
||||||
|
_KEY_TIMEZONE: timezone,
|
||||||
|
_KEY_SESSION_DURATION: str(session_duration_minutes),
|
||||||
|
_KEY_MAP_COLOR_THRESHOLD_HIGH: "100",
|
||||||
|
_KEY_MAP_COLOR_THRESHOLD_MEDIUM: "50",
|
||||||
|
_KEY_MAP_COLOR_THRESHOLD_LOW: "20",
|
||||||
|
}
|
||||||
|
|
||||||
|
await settings_repo.set_settings_batch(runtime_db, runtime_settings)
|
||||||
|
log.info("bangui_setup_runtime_settings_written")
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
log.error(
|
||||||
|
"bangui_setup_failed",
|
||||||
|
reason="runtime_db_transaction_failed",
|
||||||
|
error=str(e),
|
||||||
)
|
)
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_MAP_COLOR_THRESHOLD_HIGH, "100")
|
raise RuntimeError("Failed to write settings to runtime database.") from e
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_MAP_COLOR_THRESHOLD_MEDIUM, "50")
|
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_MAP_COLOR_THRESHOLD_LOW, "20")
|
|
||||||
await settings_repo.set_setting(runtime_db, _KEY_SETUP_DONE, "1")
|
|
||||||
finally:
|
finally:
|
||||||
if runtime_db is not None:
|
if runtime_db is not None:
|
||||||
await runtime_db.close()
|
await runtime_db.close()
|
||||||
|
|
||||||
# Mark setup as complete in the bootstrap configuration as the final step.
|
# PHASE 4: Bootstrap DB transaction (final)
|
||||||
await settings_repo.set_setting(db, _KEY_SETUP_DONE, "1")
|
# Mark setup as complete. This is the final commit point — once this
|
||||||
|
# succeeds, setup is fully complete. If this fails, setup_state remains
|
||||||
|
# "in_progress" but can be detected on retry and cleaned up if needed.
|
||||||
|
try:
|
||||||
|
await db.execute("BEGIN IMMEDIATE;")
|
||||||
|
await db.execute(
|
||||||
|
"INSERT OR REPLACE INTO settings (key, value) VALUES (?, ?)",
|
||||||
|
(_KEY_SETUP_STATE, _SETUP_STATE_COMPLETE),
|
||||||
|
)
|
||||||
|
await db.execute(
|
||||||
|
"INSERT OR REPLACE INTO settings (key, value) VALUES (?, ?)",
|
||||||
|
(_KEY_SETUP_DONE, "1"),
|
||||||
|
)
|
||||||
|
await db.commit()
|
||||||
|
except Exception as e:
|
||||||
|
await db.rollback()
|
||||||
|
log.error(
|
||||||
|
"bangui_setup_failed",
|
||||||
|
reason="bootstrap_db_final_transaction_failed",
|
||||||
|
error=str(e),
|
||||||
|
)
|
||||||
|
raise RuntimeError("Failed to mark setup as complete.") from e
|
||||||
|
|
||||||
log.info("bangui_setup_completed")
|
log.info("bangui_setup_completed")
|
||||||
|
|
||||||
|
|||||||
@@ -226,3 +226,191 @@ class TestRunSetupAsync:
|
|||||||
results = await asyncio.gather(setup_coro, noop())
|
results = await asyncio.gather(setup_coro, noop())
|
||||||
assert results[1] == "ok"
|
assert results[1] == "ok"
|
||||||
assert await setup_service.is_setup_complete(db) is True
|
assert await setup_service.is_setup_complete(db) is True
|
||||||
|
|
||||||
|
|
||||||
|
class TestSetupTransactionality:
|
||||||
|
"""Test transactional setup persistence and crash-safety."""
|
||||||
|
|
||||||
|
async def test_setup_state_machine_transitions(
|
||||||
|
self, db: aiosqlite.Connection, tmp_path: Path
|
||||||
|
) -> None:
|
||||||
|
"""Setup state transitions through: None → in_progress → complete."""
|
||||||
|
# Initial state: no setup_state key
|
||||||
|
initial_state = await settings_repo.get_setting(db, "setup_state")
|
||||||
|
assert initial_state is None
|
||||||
|
|
||||||
|
# After setup completes, state should be "complete"
|
||||||
|
await setup_service.run_setup(
|
||||||
|
db,
|
||||||
|
master_password="mypassword1",
|
||||||
|
database_path=str(tmp_path / "test.db"),
|
||||||
|
fail2ban_socket="/var/run/fail2ban/fail2ban.sock",
|
||||||
|
timezone="UTC",
|
||||||
|
session_duration_minutes=60,
|
||||||
|
)
|
||||||
|
|
||||||
|
final_state = await settings_repo.get_setting(db, "setup_state")
|
||||||
|
assert final_state == "complete"
|
||||||
|
|
||||||
|
async def test_password_hash_idempotency_across_retries(
|
||||||
|
self, db: aiosqlite.Connection, tmp_path: Path
|
||||||
|
) -> None:
|
||||||
|
"""Password hash computed once and remains consistent across phases.
|
||||||
|
|
||||||
|
Verify that if we could retry setup (in practice prevented by
|
||||||
|
is_setup_complete check), the same password hash would be used.
|
||||||
|
This tests that hash is computed once, not freshly on each operation.
|
||||||
|
"""
|
||||||
|
password = "mypassword1"
|
||||||
|
|
||||||
|
await setup_service.run_setup(
|
||||||
|
db,
|
||||||
|
master_password=password,
|
||||||
|
database_path=str(tmp_path / "test.db"),
|
||||||
|
fail2ban_socket="/var/run/fail2ban/fail2ban.sock",
|
||||||
|
timezone="UTC",
|
||||||
|
session_duration_minutes=60,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Get the hash from runtime DB
|
||||||
|
runtime_db = await aiosqlite.connect(str(tmp_path / "test.db"))
|
||||||
|
runtime_db.row_factory = aiosqlite.Row
|
||||||
|
try:
|
||||||
|
stored_hash = await settings_repo.get_setting(runtime_db, "master_password_hash")
|
||||||
|
finally:
|
||||||
|
await runtime_db.close()
|
||||||
|
|
||||||
|
assert stored_hash is not None
|
||||||
|
# Verify the hash is stable (bcrypt deterministically verifies the same password)
|
||||||
|
import bcrypt
|
||||||
|
assert bcrypt.checkpw(password.encode(), stored_hash.encode())
|
||||||
|
|
||||||
|
async def test_runtime_settings_written_atomically_in_batch(
|
||||||
|
self, db: aiosqlite.Connection, tmp_path: Path
|
||||||
|
) -> None:
|
||||||
|
"""All runtime settings are written in a single atomic transaction.
|
||||||
|
|
||||||
|
This ensures that either all settings are persisted or none are.
|
||||||
|
Verify by checking that all expected settings exist in runtime DB.
|
||||||
|
"""
|
||||||
|
await setup_service.run_setup(
|
||||||
|
db,
|
||||||
|
master_password="mypassword1",
|
||||||
|
database_path=str(tmp_path / "test.db"),
|
||||||
|
fail2ban_socket="/tmp/f2b.sock",
|
||||||
|
timezone="Europe/London",
|
||||||
|
session_duration_minutes=90,
|
||||||
|
)
|
||||||
|
|
||||||
|
runtime_db = await aiosqlite.connect(str(tmp_path / "test.db"))
|
||||||
|
runtime_db.row_factory = aiosqlite.Row
|
||||||
|
try:
|
||||||
|
settings = await settings_repo.get_all_settings(runtime_db)
|
||||||
|
finally:
|
||||||
|
await runtime_db.close()
|
||||||
|
|
||||||
|
# Verify all settings are present (atomicity means all-or-nothing)
|
||||||
|
expected_keys = {
|
||||||
|
"master_password_hash",
|
||||||
|
"database_path",
|
||||||
|
"fail2ban_socket",
|
||||||
|
"timezone",
|
||||||
|
"session_duration_minutes",
|
||||||
|
"map_color_threshold_high",
|
||||||
|
"map_color_threshold_medium",
|
||||||
|
"map_color_threshold_low",
|
||||||
|
}
|
||||||
|
assert expected_keys.issubset(settings.keys())
|
||||||
|
|
||||||
|
async def test_bootstrap_db_has_setup_state_after_setup(
|
||||||
|
self, db: aiosqlite.Connection, tmp_path: Path
|
||||||
|
) -> None:
|
||||||
|
"""Bootstrap DB stores setup_state for crash recovery detection."""
|
||||||
|
await setup_service.run_setup(
|
||||||
|
db,
|
||||||
|
master_password="mypassword1",
|
||||||
|
database_path=str(tmp_path / "test.db"),
|
||||||
|
fail2ban_socket="/var/run/fail2ban/fail2ban.sock",
|
||||||
|
timezone="UTC",
|
||||||
|
session_duration_minutes=60,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Bootstrap DB should have setup_state = "complete"
|
||||||
|
bootstrap_state = await settings_repo.get_setting(db, "setup_state")
|
||||||
|
assert bootstrap_state == "complete"
|
||||||
|
|
||||||
|
# Bootstrap DB should also have setup_completed = "1" (for backward compat)
|
||||||
|
bootstrap_completed = await settings_repo.get_setting(db, "setup_completed")
|
||||||
|
assert bootstrap_completed == "1"
|
||||||
|
|
||||||
|
async def test_database_path_written_to_both_dbs(
|
||||||
|
self, db: aiosqlite.Connection, tmp_path: Path
|
||||||
|
) -> None:
|
||||||
|
"""database_path is written to bootstrap DB and runtime DB."""
|
||||||
|
db_path = str(tmp_path / "test.db")
|
||||||
|
await setup_service.run_setup(
|
||||||
|
db,
|
||||||
|
master_password="mypassword1",
|
||||||
|
database_path=db_path,
|
||||||
|
fail2ban_socket="/var/run/fail2ban/fail2ban.sock",
|
||||||
|
timezone="UTC",
|
||||||
|
session_duration_minutes=60,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Check bootstrap DB
|
||||||
|
bootstrap_path = await settings_repo.get_setting(db, "database_path")
|
||||||
|
assert bootstrap_path == db_path
|
||||||
|
|
||||||
|
# Check runtime DB
|
||||||
|
runtime_db = await aiosqlite.connect(db_path)
|
||||||
|
runtime_db.row_factory = aiosqlite.Row
|
||||||
|
try:
|
||||||
|
runtime_path = await settings_repo.get_setting(runtime_db, "database_path")
|
||||||
|
finally:
|
||||||
|
await runtime_db.close()
|
||||||
|
|
||||||
|
assert runtime_path == db_path
|
||||||
|
|
||||||
|
async def test_runtime_db_not_written_until_all_settings_ready(
|
||||||
|
self, db: aiosqlite.Connection, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
"""If runtime settings write fails, database is not left in partial state.
|
||||||
|
|
||||||
|
Simulate a failure during batch write and verify that the database
|
||||||
|
can be cleaned up or retried without inconsistency.
|
||||||
|
"""
|
||||||
|
db_path = str(tmp_path / "test.db")
|
||||||
|
|
||||||
|
# Mock set_settings_batch to raise an error
|
||||||
|
original_batch = settings_repo.set_settings_batch
|
||||||
|
|
||||||
|
async def failing_batch(
|
||||||
|
conn: aiosqlite.Connection, settings: dict[str, str]
|
||||||
|
) -> None:
|
||||||
|
"""Simulate write failure."""
|
||||||
|
raise RuntimeError("Simulated failure during batch write")
|
||||||
|
|
||||||
|
monkeypatch.setattr(settings_repo, "set_settings_batch", failing_batch)
|
||||||
|
|
||||||
|
# Setup should fail during runtime DB write
|
||||||
|
with pytest.raises(RuntimeError, match="Failed to write settings to runtime database"):
|
||||||
|
await setup_service.run_setup(
|
||||||
|
db,
|
||||||
|
master_password="mypassword1",
|
||||||
|
database_path=db_path,
|
||||||
|
fail2ban_socket="/var/run/fail2ban/fail2ban.sock",
|
||||||
|
timezone="UTC",
|
||||||
|
session_duration_minutes=60,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Restore original function
|
||||||
|
monkeypatch.setattr(settings_repo, "set_settings_batch", original_batch)
|
||||||
|
|
||||||
|
# Bootstrap DB should have setup_state = "in_progress" (partial state detected)
|
||||||
|
bootstrap_state = await settings_repo.get_setting(db, "setup_state")
|
||||||
|
assert bootstrap_state == "in_progress"
|
||||||
|
|
||||||
|
# Setup is NOT marked complete
|
||||||
|
is_complete = await setup_service.is_setup_complete(db)
|
||||||
|
assert is_complete is False
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user