Add unit tests for station service and enhance documentation
Some checks failed
Backend CI / lint-and-test (push) Failing after 37s

- Introduced unit tests for the station service, covering creation, updating, and archiving of stations.
- Added detailed building block view documentation outlining the architecture of the Rail Game system.
- Created runtime view documentation illustrating key user interactions and system behavior.
- Developed concepts documentation detailing domain models, architectural patterns, and security considerations.
- Updated architecture documentation to reference new detailed sections for building block and runtime views.
This commit is contained in:
2025-10-11 18:52:25 +02:00
parent 2b9877a9d3
commit 615b63ba76
18 changed files with 1662 additions and 443 deletions

View File

@@ -3,8 +3,10 @@ from fastapi import APIRouter
from backend.app.api.auth import router as auth_router
from backend.app.api.health import router as health_router
from backend.app.api.network import router as network_router
from backend.app.api.stations import router as stations_router
router = APIRouter()
router.include_router(health_router, tags=["health"])
router.include_router(auth_router)
router.include_router(network_router)
router.include_router(stations_router)

View File

@@ -0,0 +1,94 @@
from __future__ import annotations
from fastapi import APIRouter, Depends, HTTPException, status
from sqlalchemy.orm import Session
from backend.app.api.deps import get_current_user, get_db
from backend.app.models import StationCreate, StationModel, StationUpdate, UserPublic
from backend.app.services.stations import (
archive_station,
create_station,
get_station,
list_stations,
update_station,
)
router = APIRouter(prefix="/stations", tags=["stations"])
@router.get("", response_model=list[StationModel])
def read_stations(
include_inactive: bool = False,
_: UserPublic = Depends(get_current_user),
db: Session = Depends(get_db),
) -> list[StationModel]:
return list_stations(db, include_inactive=include_inactive)
@router.get("/{station_id}", response_model=StationModel)
def read_station(
station_id: str,
_: UserPublic = Depends(get_current_user),
db: Session = Depends(get_db),
) -> StationModel:
try:
return get_station(db, station_id)
except LookupError as exc:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND, detail=str(exc)
) from exc
except ValueError as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST, detail=str(exc)
) from exc
@router.post("", response_model=StationModel, status_code=status.HTTP_201_CREATED)
def create_station_endpoint(
payload: StationCreate,
_: UserPublic = Depends(get_current_user),
db: Session = Depends(get_db),
) -> StationModel:
try:
return create_station(db, payload)
except ValueError as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST, detail=str(exc)
) from exc
@router.put("/{station_id}", response_model=StationModel)
def update_station_endpoint(
station_id: str,
payload: StationUpdate,
_: UserPublic = Depends(get_current_user),
db: Session = Depends(get_db),
) -> StationModel:
try:
return update_station(db, station_id, payload)
except LookupError as exc:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND, detail=str(exc)
) from exc
except ValueError as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST, detail=str(exc)
) from exc
@router.post("/{station_id}/archive", response_model=StationModel)
def archive_station_endpoint(
station_id: str,
_: UserPublic = Depends(get_current_user),
db: Session = Depends(get_db),
) -> StationModel:
try:
return archive_station(db, station_id)
except LookupError as exc:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND, detail=str(exc)
) from exc
except ValueError as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST, detail=str(exc)
) from exc

View File

@@ -0,0 +1,93 @@
from __future__ import annotations
"""Geographic presets and tagging rules for OpenStreetMap imports."""
from dataclasses import dataclass
from typing import Iterable, Mapping, Tuple
@dataclass(frozen=True)
class BoundingBox:
"""Geographic bounding box expressed as WGS84 coordinates."""
name: str
north: float
south: float
east: float
west: float
description: str | None = None
def __post_init__(self) -> None:
if self.north <= self.south:
msg = f"north ({self.north}) must be greater than south ({self.south})"
raise ValueError(msg)
if self.east <= self.west:
msg = f"east ({self.east}) must be greater than west ({self.west})"
raise ValueError(msg)
def contains(self, latitude: float, longitude: float) -> bool:
"""Return True when the given coordinate lies inside the bounding box."""
return (
self.south <= latitude <= self.north and self.west <= longitude <= self.east
)
def to_overpass_arg(self) -> str:
"""Return the bbox string used for Overpass API queries."""
return f"{self.south},{self.west},{self.north},{self.east}"
# Primary metropolitan areas we plan to support.
DEFAULT_REGIONS: Tuple[BoundingBox, ...] = (
BoundingBox(
name="berlin_metropolitan",
north=52.6755,
south=52.3381,
east=13.7611,
west=13.0884,
description="Berlin and surrounding rapid transit network",
),
BoundingBox(
name="hamburg_metropolitan",
north=53.7447,
south=53.3950,
east=10.3253,
west=9.7270,
description="Hamburg S-Bahn and harbor region",
),
BoundingBox(
name="munich_metropolitan",
north=48.2485,
south=47.9960,
east=11.7229,
west=11.3600,
description="Munich S-Bahn core and airport corridor",
),
)
# Tags that identify passenger stations and stops.
STATION_TAG_FILTERS: Mapping[str, Tuple[str, ...]] = {
"railway": ("station", "halt", "stop"),
"public_transport": ("station", "stop_position", "platform"),
"train": ("yes", "regional", "suburban"),
}
def compile_overpass_filters(filters: Mapping[str, Iterable[str]]) -> str:
"""Build an Overpass boolean expression that matches the provided filters."""
parts: list[str] = []
for key, values in filters.items():
options = "|".join(sorted(set(values)))
parts.append(f' ["{key}"~"^({options})$"]')
return "\n".join(parts)
__all__ = [
"BoundingBox",
"DEFAULT_REGIONS",
"STATION_TAG_FILTERS",
"compile_overpass_filters",
]

View File

@@ -10,6 +10,7 @@ from .auth import (
from .base import (
StationCreate,
StationModel,
StationUpdate,
TrackCreate,
TrackModel,
TrainCreate,
@@ -29,6 +30,7 @@ __all__ = [
"UserPublic",
"StationCreate",
"StationModel",
"StationUpdate",
"TrackCreate",
"TrackModel",
"TrainScheduleCreate",

View File

@@ -42,6 +42,10 @@ class StationModel(IdentifiedModel[str]):
name: str
latitude: float
longitude: float
code: str | None = None
osm_id: str | None = None
elevation_m: float | None = None
is_active: bool = True
class TrackModel(IdentifiedModel[str]):
@@ -68,6 +72,16 @@ class StationCreate(CamelModel):
is_active: bool = True
class StationUpdate(CamelModel):
name: str | None = None
latitude: float | None = None
longitude: float | None = None
osm_id: str | None = None
code: str | None = None
elevation_m: float | None = None
is_active: bool | None = None
class TrackCreate(CamelModel):
start_station_id: str
end_station_id: str

View File

@@ -0,0 +1,195 @@
from __future__ import annotations
"""Application services for station CRUD operations."""
from datetime import datetime, timezone
from typing import cast
from uuid import UUID
from geoalchemy2.elements import WKBElement, WKTElement
from geoalchemy2.shape import to_shape
from sqlalchemy.orm import Session
from backend.app.db.models import Station
from backend.app.models import StationCreate, StationModel, StationUpdate
from backend.app.repositories import StationRepository
try: # pragma: no cover - optional dependency guard
from shapely.geometry import Point # type: ignore
except ImportError: # pragma: no cover - allow running without shapely at import time
Point = None # type: ignore[assignment]
def list_stations(
session: Session, include_inactive: bool = False
) -> list[StationModel]:
repo = StationRepository(session)
if include_inactive:
stations = repo.list()
else:
stations = repo.list_active()
return [_to_station_model(station) for station in stations]
def get_station(session: Session, station_id: str) -> StationModel:
repo = StationRepository(session)
station = _resolve_station(repo, station_id)
return _to_station_model(station)
def create_station(session: Session, payload: StationCreate) -> StationModel:
name = payload.name.strip()
if not name:
raise ValueError("Station name must not be empty")
_validate_coordinates(payload.latitude, payload.longitude)
repo = StationRepository(session)
station = repo.create(
StationCreate(
name=name,
latitude=payload.latitude,
longitude=payload.longitude,
osm_id=_normalize_optional(payload.osm_id),
code=_normalize_optional(payload.code),
elevation_m=payload.elevation_m,
is_active=payload.is_active,
)
)
session.flush()
session.refresh(station)
session.commit()
return _to_station_model(station)
def update_station(
session: Session, station_id: str, payload: StationUpdate
) -> StationModel:
repo = StationRepository(session)
station = _resolve_station(repo, station_id)
if payload.name is not None:
name = payload.name.strip()
if not name:
raise ValueError("Station name must not be empty")
station.name = name
if payload.latitude is not None or payload.longitude is not None:
if payload.latitude is None or payload.longitude is None:
raise ValueError("Both latitude and longitude must be provided together")
_validate_coordinates(payload.latitude, payload.longitude)
station.location = repo._point(
payload.latitude, payload.longitude
) # type: ignore[assignment]
if payload.osm_id is not None:
station.osm_id = _normalize_optional(payload.osm_id)
if payload.code is not None:
station.code = _normalize_optional(payload.code)
if payload.elevation_m is not None:
station.elevation_m = payload.elevation_m
if payload.is_active is not None:
station.is_active = payload.is_active
session.flush()
session.refresh(station)
session.commit()
return _to_station_model(station)
def archive_station(session: Session, station_id: str) -> StationModel:
repo = StationRepository(session)
station = _resolve_station(repo, station_id)
if station.is_active:
station.is_active = False
session.flush()
session.refresh(station)
session.commit()
return _to_station_model(station)
def _resolve_station(repo: StationRepository, station_id: str) -> Station:
identifier = _parse_station_id(station_id)
station = repo.get(identifier)
if station is None:
raise LookupError("Station not found")
return station
def _parse_station_id(station_id: str) -> UUID:
try:
return UUID(station_id)
except (ValueError, TypeError) as exc: # pragma: no cover - simple validation
raise ValueError("Invalid station identifier") from exc
def _validate_coordinates(latitude: float, longitude: float) -> None:
if not (-90.0 <= latitude <= 90.0):
raise ValueError("Latitude must be between -90 and 90 degrees")
if not (-180.0 <= longitude <= 180.0):
raise ValueError("Longitude must be between -180 and 180 degrees")
def _normalize_optional(value: str | None) -> str | None:
if value is None:
return None
normalized = value.strip()
return normalized or None
def _to_station_model(station: Station) -> StationModel:
latitude, longitude = _extract_coordinates(station.location)
created_at = station.created_at or datetime.now(timezone.utc)
updated_at = station.updated_at or created_at
return StationModel(
id=str(station.id),
name=station.name,
latitude=latitude,
longitude=longitude,
code=station.code,
osm_id=station.osm_id,
elevation_m=station.elevation_m,
is_active=station.is_active,
created_at=cast(datetime, created_at),
updated_at=cast(datetime, updated_at),
)
def _extract_coordinates(location: object) -> tuple[float, float]:
if location is None:
raise ValueError("Station location is unavailable")
# Attempt to leverage GeoAlchemy's shapely integration first.
try:
geometry = to_shape(cast(WKBElement | WKTElement, location))
if Point is not None and isinstance(geometry, Point):
return float(geometry.y), float(geometry.x)
except Exception: # pragma: no cover - fallback handles parsing
pass
if isinstance(location, WKTElement):
return _parse_wkt_point(location.data)
text = getattr(location, "desc", None)
if isinstance(text, str):
return _parse_wkt_point(text)
raise ValueError("Unable to read station geometry")
def _parse_wkt_point(wkt: str) -> tuple[float, float]:
marker = "POINT"
if not wkt.upper().startswith(marker):
raise ValueError("Unsupported geometry format")
start = wkt.find("(")
end = wkt.find(")", start)
if start == -1 or end == -1:
raise ValueError("Malformed POINT geometry")
coordinates = wkt[start + 1 : end].strip().split()
if len(coordinates) != 2:
raise ValueError("POINT geometry must contain two coordinates")
longitude, latitude = map(float, coordinates)
_validate_coordinates(latitude, longitude)
return latitude, longitude