Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
692ec436a5 | ||
|
|
a3d32a6fb1 |
@@ -32,7 +32,6 @@ from app.repositories.user import UserRepository
|
|||||||
from app.services.alert import AlertService
|
from app.services.alert import AlertService
|
||||||
from app.services.auth import AuthService, LoginPolicy
|
from app.services.auth import AuthService, LoginPolicy
|
||||||
from app.services.recommendation import RecommendationService
|
from app.services.recommendation import RecommendationService
|
||||||
from app.services.sensor import SensorService
|
|
||||||
from app.services.site import SiteService
|
from app.services.site import SiteService
|
||||||
from app.services.stats import StatsService
|
from app.services.stats import StatsService
|
||||||
from app.services.user import UserService
|
from app.services.user import UserService
|
||||||
@@ -168,13 +167,6 @@ def get_stats_service(session: SessionDep) -> StatsService:
|
|||||||
StatsServiceDep = Annotated[StatsService, Depends(get_stats_service)]
|
StatsServiceDep = Annotated[StatsService, Depends(get_stats_service)]
|
||||||
|
|
||||||
|
|
||||||
def get_sensor_service(session: SessionDep) -> SensorService:
|
|
||||||
return SensorService(sites=SiteRepository(session), readings=ReadingRepository(session))
|
|
||||||
|
|
||||||
|
|
||||||
SensorServiceDep = Annotated[SensorService, Depends(get_sensor_service)]
|
|
||||||
|
|
||||||
|
|
||||||
async def get_current_principal(
|
async def get_current_principal(
|
||||||
credentials: CredentialsDep,
|
credentials: CredentialsDep,
|
||||||
session: SessionDep,
|
session: SessionDep,
|
||||||
|
|||||||
@@ -71,10 +71,6 @@ TAGS: Final[list[dict[str, Any]]] = [
|
|||||||
"description": "Statistiques agrégées de consommation. Accessible à partir du rôle "
|
"description": "Statistiques agrégées de consommation. Accessible à partir du rôle "
|
||||||
"`lecteur`.",
|
"`lecteur`.",
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"name": "sensors",
|
|
||||||
"description": "État de santé des capteurs par site. Réservé au rôle `admin`.",
|
|
||||||
},
|
|
||||||
]
|
]
|
||||||
|
|
||||||
cookie_de_rafraichissement = APIKeyCookie(
|
cookie_de_rafraichissement = APIKeyCookie(
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
from fastapi import APIRouter
|
|
||||||
|
|
||||||
from app.api.deps import AdminDep, SensorServiceDep
|
|
||||||
from app.schemas.sensor import SensorStatusResponse
|
|
||||||
|
|
||||||
router = APIRouter()
|
|
||||||
|
|
||||||
|
|
||||||
@router.get(
|
|
||||||
"/status",
|
|
||||||
response_model=SensorStatusResponse,
|
|
||||||
summary="État de santé des capteurs par site",
|
|
||||||
)
|
|
||||||
async def get_status(_: AdminDep, service: SensorServiceDep) -> SensorStatusResponse:
|
|
||||||
etat = await service.status()
|
|
||||||
return SensorStatusResponse.model_validate(etat)
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
from fastapi import APIRouter
|
from fastapi import APIRouter
|
||||||
|
|
||||||
from app.api.openapi import REPONSE_SERVEUR, REPONSES_ADMIN, REPONSES_LECTEUR
|
from app.api.openapi import REPONSE_SERVEUR, REPONSES_ADMIN, REPONSES_LECTEUR
|
||||||
from app.api.v1.endpoints import alerts, auth, health, recommendations, sensors, sites, stats, users
|
from app.api.v1.endpoints import alerts, auth, health, recommendations, sites, stats, users
|
||||||
|
|
||||||
api_router = APIRouter(responses=REPONSE_SERVEUR)
|
api_router = APIRouter(responses=REPONSE_SERVEUR)
|
||||||
api_router.include_router(health.router, prefix="/health", tags=["health"])
|
api_router.include_router(health.router, prefix="/health", tags=["health"])
|
||||||
@@ -18,6 +18,3 @@ api_router.include_router(
|
|||||||
responses=REPONSES_LECTEUR,
|
responses=REPONSES_LECTEUR,
|
||||||
)
|
)
|
||||||
api_router.include_router(stats.router, prefix="/stats", tags=["stats"], responses=REPONSES_LECTEUR)
|
api_router.include_router(stats.router, prefix="/stats", tags=["stats"], responses=REPONSES_LECTEUR)
|
||||||
api_router.include_router(
|
|
||||||
sensors.router, prefix="/sensors", tags=["sensors"], responses=REPONSES_ADMIN
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -1,42 +0,0 @@
|
|||||||
from datetime import datetime
|
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
from pydantic import BaseModel, ConfigDict, Field
|
|
||||||
|
|
||||||
|
|
||||||
class SensorDiagnosticResponse(BaseModel):
|
|
||||||
model_config = ConfigDict(from_attributes=True)
|
|
||||||
|
|
||||||
status: Literal["ok", "failing"]
|
|
||||||
since: datetime | None = Field(
|
|
||||||
description=(
|
|
||||||
"Horodatage de la dernière lecture reçue pour ce site. Ce n'est pas le début de la "
|
|
||||||
"panne : l'historique ne permet pas de le dater sans requête supplémentaire."
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class SiteSensorsResponse(BaseModel):
|
|
||||||
model_config = ConfigDict(from_attributes=True)
|
|
||||||
|
|
||||||
consumption: SensorDiagnosticResponse
|
|
||||||
electrical: SensorDiagnosticResponse
|
|
||||||
temperature: SensorDiagnosticResponse
|
|
||||||
humidity: SensorDiagnosticResponse
|
|
||||||
network: SensorDiagnosticResponse
|
|
||||||
|
|
||||||
|
|
||||||
class SiteSensorStatusResponse(BaseModel):
|
|
||||||
model_config = ConfigDict(from_attributes=True)
|
|
||||||
|
|
||||||
site_id: str
|
|
||||||
site_name: str
|
|
||||||
sensors: SiteSensorsResponse
|
|
||||||
overall: Literal["ok", "degraded", "critical"]
|
|
||||||
|
|
||||||
|
|
||||||
class SensorStatusResponse(BaseModel):
|
|
||||||
model_config = ConfigDict(from_attributes=True)
|
|
||||||
|
|
||||||
timestamp: datetime
|
|
||||||
sites: list[SiteSensorStatusResponse]
|
|
||||||
@@ -1,137 +0,0 @@
|
|||||||
from dataclasses import dataclass
|
|
||||||
from datetime import UTC, datetime
|
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
from app.models.energy import Reading, Site
|
|
||||||
from app.repositories.reading import ReadingRepository
|
|
||||||
from app.repositories.site import SiteRepository
|
|
||||||
|
|
||||||
CapteurStatus = Literal["ok", "failing"]
|
|
||||||
OverallStatus = Literal["ok", "degraded", "critical"]
|
|
||||||
|
|
||||||
QUALITES_CONNUES: frozenset[str] = frozenset({"good", "partial", "degraded", "critical"})
|
|
||||||
|
|
||||||
RAISON_VERS_CAPTEUR: dict[str, str] = {
|
|
||||||
"consumption_sensor_failure": "consumption",
|
|
||||||
"electrical_sensor_failure": "electrical",
|
|
||||||
"temperature_sensor_failure": "temperature",
|
|
||||||
"humidity_sensor_failure": "humidity",
|
|
||||||
"network_loss": "network",
|
|
||||||
}
|
|
||||||
|
|
||||||
CHAMPS_PAR_CAPTEUR: dict[str, tuple[str, ...]] = {
|
|
||||||
"consumption": ("consumption_kw",),
|
|
||||||
"electrical": ("voltage_v", "current_a", "power_factor"),
|
|
||||||
"temperature": ("temperature_celsius",),
|
|
||||||
"humidity": ("humidity_percent",),
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True, slots=True)
|
|
||||||
class DiagnosticCapteur:
|
|
||||||
status: CapteurStatus
|
|
||||||
since: datetime | None
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True, slots=True)
|
|
||||||
class SanteCapteurs:
|
|
||||||
consumption: DiagnosticCapteur
|
|
||||||
electrical: DiagnosticCapteur
|
|
||||||
temperature: DiagnosticCapteur
|
|
||||||
humidity: DiagnosticCapteur
|
|
||||||
network: DiagnosticCapteur
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True, slots=True)
|
|
||||||
class SanteSite:
|
|
||||||
site_id: str
|
|
||||||
site_name: str
|
|
||||||
sensors: SanteCapteurs
|
|
||||||
overall: OverallStatus
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True, slots=True)
|
|
||||||
class EtatCapteurs:
|
|
||||||
timestamp: datetime
|
|
||||||
sites: list[SanteSite]
|
|
||||||
|
|
||||||
|
|
||||||
class SensorService:
|
|
||||||
def __init__(self, sites: SiteRepository, readings: ReadingRepository) -> None:
|
|
||||||
self._sites = sites
|
|
||||||
self._readings = readings
|
|
||||||
|
|
||||||
async def status(self) -> EtatCapteurs:
|
|
||||||
sites = await self._sites.list_all()
|
|
||||||
dernieres = {lecture.site_id: lecture for lecture in await self._readings.latest_by_site()}
|
|
||||||
|
|
||||||
return EtatCapteurs(
|
|
||||||
timestamp=datetime.now(UTC),
|
|
||||||
sites=[_sante_site(site, dernieres.get(site.site_id)) for site in sites],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _sante_site(site: Site, derniere: Reading | None) -> SanteSite:
|
|
||||||
if derniere is None:
|
|
||||||
return SanteSite(
|
|
||||||
site_id=site.site_id,
|
|
||||||
site_name=site.site_name,
|
|
||||||
sensors=_tout_en_echec(since=None),
|
|
||||||
overall="critical",
|
|
||||||
)
|
|
||||||
|
|
||||||
qualite = derniere.data_quality if derniere.data_quality in QUALITES_CONNUES else "critical"
|
|
||||||
overall = _overall_depuis_qualite(qualite)
|
|
||||||
|
|
||||||
if overall == "critical":
|
|
||||||
return SanteSite(
|
|
||||||
site_id=site.site_id,
|
|
||||||
site_name=site.site_name,
|
|
||||||
sensors=_tout_en_echec(since=derniere.timestamp),
|
|
||||||
overall="critical",
|
|
||||||
)
|
|
||||||
|
|
||||||
raisons_signalees = {
|
|
||||||
RAISON_VERS_CAPTEUR[raison]
|
|
||||||
for raison in (derniere.null_reasons or [])
|
|
||||||
if raison in RAISON_VERS_CAPTEUR
|
|
||||||
}
|
|
||||||
|
|
||||||
return SanteSite(
|
|
||||||
site_id=site.site_id,
|
|
||||||
site_name=site.site_name,
|
|
||||||
sensors=SanteCapteurs(
|
|
||||||
consumption=_diagnostic("consumption", derniere, raisons_signalees),
|
|
||||||
electrical=_diagnostic("electrical", derniere, raisons_signalees),
|
|
||||||
temperature=_diagnostic("temperature", derniere, raisons_signalees),
|
|
||||||
humidity=_diagnostic("humidity", derniere, raisons_signalees),
|
|
||||||
network=_diagnostic("network", derniere, raisons_signalees),
|
|
||||||
),
|
|
||||||
overall=overall,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _overall_depuis_qualite(qualite: str) -> OverallStatus:
|
|
||||||
if qualite == "good":
|
|
||||||
return "ok"
|
|
||||||
if qualite in ("partial", "degraded"):
|
|
||||||
return "degraded"
|
|
||||||
return "critical"
|
|
||||||
|
|
||||||
|
|
||||||
def _diagnostic(capteur: str, derniere: Reading, raisons_signalees: set[str]) -> DiagnosticCapteur:
|
|
||||||
champs = CHAMPS_PAR_CAPTEUR.get(capteur, ())
|
|
||||||
en_echec = capteur in raisons_signalees or any(
|
|
||||||
getattr(derniere, champ) is None for champ in champs
|
|
||||||
)
|
|
||||||
return DiagnosticCapteur(
|
|
||||||
status="failing" if en_echec else "ok",
|
|
||||||
since=derniere.timestamp if en_echec else None,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _tout_en_echec(since: datetime | None) -> SanteCapteurs:
|
|
||||||
echec = DiagnosticCapteur(status="failing", since=since)
|
|
||||||
return SanteCapteurs(
|
|
||||||
consumption=echec, electrical=echec, temperature=echec, humidity=echec, network=echec
|
|
||||||
)
|
|
||||||
@@ -1227,62 +1227,6 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"/api/v1/sensors/status": {
|
|
||||||
"get": {
|
|
||||||
"tags": [
|
|
||||||
"sensors"
|
|
||||||
],
|
|
||||||
"summary": "État de santé des capteurs par site",
|
|
||||||
"operationId": "get_status_api_v1_sensors_status_get",
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "Successful Response",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/SensorStatusResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"500": {
|
|
||||||
"description": "Erreur interne. `correlation` identifie la trace côté serveur, qui n'est pas renvoyée au client.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/InternalErrorResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"401": {
|
|
||||||
"description": "Jeton absent, illisible, périmé, ou rendu caduc par un changement de rôle ou une désactivation. L'en-tête `WWW-Authenticate` porte la cause dans `error=`.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/ErrorResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"403": {
|
|
||||||
"description": "Droits insuffisants, ou mot de passe provisoire à changer quand `detail` vaut `password_change_required`.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/ErrorResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"security": [
|
|
||||||
{
|
|
||||||
"Jeton d'accès": []
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"components": {
|
"components": {
|
||||||
@@ -1628,59 +1572,6 @@
|
|||||||
],
|
],
|
||||||
"title": "Role"
|
"title": "Role"
|
||||||
},
|
},
|
||||||
"SensorDiagnosticResponse": {
|
|
||||||
"properties": {
|
|
||||||
"status": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"ok",
|
|
||||||
"failing"
|
|
||||||
],
|
|
||||||
"title": "Status"
|
|
||||||
},
|
|
||||||
"since": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"title": "Since",
|
|
||||||
"description": "Horodatage de la dernière lecture reçue pour ce site. Ce n'est pas le début de la panne : l'historique ne permet pas de le dater sans requête supplémentaire."
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"status",
|
|
||||||
"since"
|
|
||||||
],
|
|
||||||
"title": "SensorDiagnosticResponse"
|
|
||||||
},
|
|
||||||
"SensorStatusResponse": {
|
|
||||||
"properties": {
|
|
||||||
"timestamp": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time",
|
|
||||||
"title": "Timestamp"
|
|
||||||
},
|
|
||||||
"sites": {
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/SiteSensorStatusResponse"
|
|
||||||
},
|
|
||||||
"type": "array",
|
|
||||||
"title": "Sites"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"timestamp",
|
|
||||||
"sites"
|
|
||||||
],
|
|
||||||
"title": "SensorStatusResponse"
|
|
||||||
},
|
|
||||||
"SiteResponse": {
|
"SiteResponse": {
|
||||||
"properties": {
|
"properties": {
|
||||||
"site_id": {
|
"site_id": {
|
||||||
@@ -1740,66 +1631,6 @@
|
|||||||
],
|
],
|
||||||
"title": "SiteResponse"
|
"title": "SiteResponse"
|
||||||
},
|
},
|
||||||
"SiteSensorStatusResponse": {
|
|
||||||
"properties": {
|
|
||||||
"site_id": {
|
|
||||||
"type": "string",
|
|
||||||
"title": "Site Id"
|
|
||||||
},
|
|
||||||
"site_name": {
|
|
||||||
"type": "string",
|
|
||||||
"title": "Site Name"
|
|
||||||
},
|
|
||||||
"sensors": {
|
|
||||||
"$ref": "#/components/schemas/SiteSensorsResponse"
|
|
||||||
},
|
|
||||||
"overall": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"ok",
|
|
||||||
"degraded",
|
|
||||||
"critical"
|
|
||||||
],
|
|
||||||
"title": "Overall"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"site_id",
|
|
||||||
"site_name",
|
|
||||||
"sensors",
|
|
||||||
"overall"
|
|
||||||
],
|
|
||||||
"title": "SiteSensorStatusResponse"
|
|
||||||
},
|
|
||||||
"SiteSensorsResponse": {
|
|
||||||
"properties": {
|
|
||||||
"consumption": {
|
|
||||||
"$ref": "#/components/schemas/SensorDiagnosticResponse"
|
|
||||||
},
|
|
||||||
"electrical": {
|
|
||||||
"$ref": "#/components/schemas/SensorDiagnosticResponse"
|
|
||||||
},
|
|
||||||
"temperature": {
|
|
||||||
"$ref": "#/components/schemas/SensorDiagnosticResponse"
|
|
||||||
},
|
|
||||||
"humidity": {
|
|
||||||
"$ref": "#/components/schemas/SensorDiagnosticResponse"
|
|
||||||
},
|
|
||||||
"network": {
|
|
||||||
"$ref": "#/components/schemas/SensorDiagnosticResponse"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"consumption",
|
|
||||||
"electrical",
|
|
||||||
"temperature",
|
|
||||||
"humidity",
|
|
||||||
"network"
|
|
||||||
],
|
|
||||||
"title": "SiteSensorsResponse"
|
|
||||||
},
|
|
||||||
"SiteSummaryResponse": {
|
"SiteSummaryResponse": {
|
||||||
"properties": {
|
"properties": {
|
||||||
"site_id": {
|
"site_id": {
|
||||||
@@ -2128,10 +1959,6 @@
|
|||||||
{
|
{
|
||||||
"name": "stats",
|
"name": "stats",
|
||||||
"description": "Statistiques agrégées de consommation. Accessible à partir du rôle `lecteur`."
|
"description": "Statistiques agrégées de consommation. Accessible à partir du rôle `lecteur`."
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "sensors",
|
|
||||||
"description": "État de santé des capteurs par site. Réservé au rôle `admin`."
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -35,7 +35,6 @@ ROUTES_A_ROLE = {
|
|||||||
("GET", "/api/v1/recommendations"),
|
("GET", "/api/v1/recommendations"),
|
||||||
("GET", "/api/v1/recommendations/{recommendation_id}"),
|
("GET", "/api/v1/recommendations/{recommendation_id}"),
|
||||||
("GET", "/api/v1/stats/summary"),
|
("GET", "/api/v1/stats/summary"),
|
||||||
("GET", "/api/v1/sensors/status"),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,91 +0,0 @@
|
|||||||
from collections.abc import Callable, Iterator
|
|
||||||
from datetime import UTC, datetime
|
|
||||||
from uuid import uuid4
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
from fastapi import FastAPI
|
|
||||||
from httpx import AsyncClient
|
|
||||||
|
|
||||||
from app.api.deps import get_current_principal, get_sensor_service
|
|
||||||
from app.core.principal import Principal
|
|
||||||
from app.core.roles import AccountKind, Role
|
|
||||||
from app.services.sensor import DiagnosticCapteur, EtatCapteurs, SanteCapteurs, SanteSite
|
|
||||||
|
|
||||||
TIMESTAMP = datetime(2026, 9, 16, 12, 0, tzinfo=UTC)
|
|
||||||
|
|
||||||
|
|
||||||
def principal(role: Role = Role.ADMIN) -> Principal:
|
|
||||||
return Principal(
|
|
||||||
id=uuid4(),
|
|
||||||
email=f"{role.value}@enervision.fr",
|
|
||||||
role=role,
|
|
||||||
kind=AccountKind.HUMAIN,
|
|
||||||
must_change_password=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class FauxService:
|
|
||||||
def __init__(self) -> None:
|
|
||||||
ok = DiagnosticCapteur(status="ok", since=None)
|
|
||||||
en_echec = DiagnosticCapteur(status="failing", since=TIMESTAMP)
|
|
||||||
self.etat = EtatCapteurs(
|
|
||||||
timestamp=TIMESTAMP,
|
|
||||||
sites=[
|
|
||||||
SanteSite(
|
|
||||||
site_id="SITE001",
|
|
||||||
site_name="Bureau Paris La Défense",
|
|
||||||
sensors=SanteCapteurs(
|
|
||||||
consumption=ok,
|
|
||||||
electrical=ok,
|
|
||||||
temperature=en_echec,
|
|
||||||
humidity=ok,
|
|
||||||
network=ok,
|
|
||||||
),
|
|
||||||
overall="degraded",
|
|
||||||
)
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
async def status(self) -> EtatCapteurs:
|
|
||||||
return self.etat
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def admin_connecte(app: FastAPI) -> Iterator[None]:
|
|
||||||
app.dependency_overrides[get_current_principal] = lambda: principal()
|
|
||||||
yield
|
|
||||||
app.dependency_overrides.pop(get_current_principal, None)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def servi(app: FastAPI, admin_connecte: None) -> Iterator[Callable[[], FauxService]]:
|
|
||||||
def installe() -> FauxService:
|
|
||||||
service = FauxService()
|
|
||||||
app.dependency_overrides[get_sensor_service] = lambda: service
|
|
||||||
return service
|
|
||||||
|
|
||||||
yield installe
|
|
||||||
app.dependency_overrides.pop(get_sensor_service, None)
|
|
||||||
|
|
||||||
|
|
||||||
async def test_get_status_returns_the_service_result(
|
|
||||||
servi: Callable[[], FauxService], client: AsyncClient
|
|
||||||
) -> None:
|
|
||||||
servi()
|
|
||||||
|
|
||||||
response = await client.get("/api/v1/sensors/status")
|
|
||||||
|
|
||||||
assert response.status_code == 200
|
|
||||||
corps = response.json()
|
|
||||||
assert corps["sites"][0]["site_id"] == "SITE001"
|
|
||||||
assert corps["sites"][0]["overall"] == "degraded"
|
|
||||||
assert corps["sites"][0]["sensors"]["temperature"]["status"] == "failing"
|
|
||||||
assert corps["sites"][0]["sensors"]["consumption"]["status"] == "ok"
|
|
||||||
|
|
||||||
|
|
||||||
async def test_get_status_refuses_a_reader(app: FastAPI, client: AsyncClient) -> None:
|
|
||||||
app.dependency_overrides[get_current_principal] = lambda: principal(Role.LECTEUR)
|
|
||||||
|
|
||||||
response = await client.get("/api/v1/sensors/status")
|
|
||||||
|
|
||||||
assert response.status_code == 403
|
|
||||||
@@ -1,224 +0,0 @@
|
|||||||
from dataclasses import dataclass, field
|
|
||||||
from datetime import UTC, datetime
|
|
||||||
|
|
||||||
from app.services.sensor import SensorService
|
|
||||||
|
|
||||||
TIMESTAMP = datetime(2026, 9, 16, 12, 0, tzinfo=UTC)
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class FauxSite:
|
|
||||||
site_id: str
|
|
||||||
site_name: str
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class FauxLecture:
|
|
||||||
site_id: str
|
|
||||||
timestamp: datetime
|
|
||||||
data_quality: str | None
|
|
||||||
null_reasons: list[str] | None = field(default_factory=list)
|
|
||||||
consumption_kw: float | None = 10.0
|
|
||||||
voltage_v: float | None = 230.0
|
|
||||||
current_a: float | None = 5.0
|
|
||||||
power_factor: float | None = 0.95
|
|
||||||
temperature_celsius: float | None = 21.0
|
|
||||||
humidity_percent: float | None = 40.0
|
|
||||||
|
|
||||||
|
|
||||||
class FauxDepotSites:
|
|
||||||
def __init__(self, sites: list[FauxSite]) -> None:
|
|
||||||
self._sites = sites
|
|
||||||
|
|
||||||
async def list_all(self) -> list[FauxSite]:
|
|
||||||
return self._sites
|
|
||||||
|
|
||||||
|
|
||||||
class FauxDepotLectures:
|
|
||||||
def __init__(self, lectures: list[FauxLecture]) -> None:
|
|
||||||
self._lectures = lectures
|
|
||||||
|
|
||||||
async def latest_by_site(self) -> list[FauxLecture]:
|
|
||||||
return self._lectures
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_marks_a_site_without_any_reading_as_critical_with_every_sensor_failing() -> (
|
|
||||||
None
|
|
||||||
):
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures([]), # type: ignore[arg-type]
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.overall == "critical"
|
|
||||||
for capteur in (
|
|
||||||
site.sensors.consumption,
|
|
||||||
site.sensors.electrical,
|
|
||||||
site.sensors.temperature,
|
|
||||||
site.sensors.humidity,
|
|
||||||
site.sensors.network,
|
|
||||||
):
|
|
||||||
assert capteur.status == "failing"
|
|
||||||
assert capteur.since is None
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_marks_every_sensor_ok_on_a_good_quality_reading_with_no_null_field() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures([FauxLecture("A", TIMESTAMP, "good")]), # type: ignore[arg-type]
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.overall == "ok"
|
|
||||||
for capteur in (
|
|
||||||
site.sensors.consumption,
|
|
||||||
site.sensors.electrical,
|
|
||||||
site.sensors.temperature,
|
|
||||||
site.sensors.humidity,
|
|
||||||
site.sensors.network,
|
|
||||||
):
|
|
||||||
assert capteur.status == "ok"
|
|
||||||
assert capteur.since is None
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_flags_the_sensor_named_in_null_reasons() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures( # type: ignore[arg-type]
|
|
||||||
[
|
|
||||||
FauxLecture(
|
|
||||||
"A",
|
|
||||||
TIMESTAMP,
|
|
||||||
"partial",
|
|
||||||
null_reasons=["temperature_sensor_failure"],
|
|
||||||
temperature_celsius=None,
|
|
||||||
)
|
|
||||||
]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.overall == "degraded"
|
|
||||||
assert site.sensors.temperature.status == "failing"
|
|
||||||
assert site.sensors.temperature.since == TIMESTAMP
|
|
||||||
assert site.sensors.consumption.status == "ok"
|
|
||||||
assert site.sensors.electrical.status == "ok"
|
|
||||||
assert site.sensors.humidity.status == "ok"
|
|
||||||
assert site.sensors.network.status == "ok"
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_flags_a_sensor_from_a_null_field_even_without_a_null_reason() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures( # type: ignore[arg-type]
|
|
||||||
[FauxLecture("A", TIMESTAMP, "partial", null_reasons=[], humidity_percent=None)]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.sensors.humidity.status == "failing"
|
|
||||||
assert site.sensors.humidity.since == TIMESTAMP
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_flags_electrical_as_failing_when_any_of_its_three_fields_is_null() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures( # type: ignore[arg-type]
|
|
||||||
[FauxLecture("A", TIMESTAMP, "partial", null_reasons=[], power_factor=None)]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.sensors.electrical.status == "failing"
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_forces_every_sensor_to_failing_when_overall_is_critical() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures([FauxLecture("A", TIMESTAMP, "critical", null_reasons=[])]), # type: ignore[arg-type]
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.overall == "critical"
|
|
||||||
for capteur in (
|
|
||||||
site.sensors.consumption,
|
|
||||||
site.sensors.electrical,
|
|
||||||
site.sensors.temperature,
|
|
||||||
site.sensors.humidity,
|
|
||||||
site.sensors.network,
|
|
||||||
):
|
|
||||||
assert capteur.status == "failing"
|
|
||||||
assert capteur.since == TIMESTAMP
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_treats_an_unknown_data_quality_as_critical() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures([FauxLecture("A", TIMESTAMP, None, null_reasons=[])]), # type: ignore[arg-type]
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
assert etat.sites[0].overall == "critical"
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_ignores_an_unknown_null_reason() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures( # type: ignore[arg-type]
|
|
||||||
[FauxLecture("A", TIMESTAMP, "good", null_reasons=["something_else"])]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.overall == "ok"
|
|
||||||
for capteur in (
|
|
||||||
site.sensors.consumption,
|
|
||||||
site.sensors.electrical,
|
|
||||||
site.sensors.temperature,
|
|
||||||
site.sensors.humidity,
|
|
||||||
site.sensors.network,
|
|
||||||
):
|
|
||||||
assert capteur.status == "ok"
|
|
||||||
|
|
||||||
|
|
||||||
async def test_status_flags_network_from_null_reasons_only() -> None:
|
|
||||||
service = SensorService(
|
|
||||||
sites=FauxDepotSites([FauxSite("A", "Site A")]), # type: ignore[arg-type]
|
|
||||||
readings=FauxDepotLectures( # type: ignore[arg-type]
|
|
||||||
[
|
|
||||||
FauxLecture(
|
|
||||||
"A",
|
|
||||||
TIMESTAMP,
|
|
||||||
"partial",
|
|
||||||
null_reasons=["network_loss"],
|
|
||||||
)
|
|
||||||
]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
etat = await service.status()
|
|
||||||
|
|
||||||
site = etat.sites[0]
|
|
||||||
assert site.overall == "degraded"
|
|
||||||
assert site.sensors.network.status == "failing"
|
|
||||||
assert site.sensors.network.since == TIMESTAMP
|
|
||||||
assert site.sensors.consumption.status == "ok"
|
|
||||||
assert site.sensors.electrical.status == "ok"
|
|
||||||
assert site.sensors.temperature.status == "ok"
|
|
||||||
assert site.sensors.humidity.status == "ok"
|
|
||||||
@@ -12,10 +12,10 @@ Les quatre couches existent désormais, portées par l'authentification.
|
|||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart TB
|
flowchart TB
|
||||||
ep["endpoints<br/>health, auth, users, sites, alerts,<br/>recommendations, stats, sensors"]
|
ep["endpoints<br/>health, auth, users, sites,<br/>recommendations, stats"]
|
||||||
sc["schemas<br/>Pydantic"]
|
sc["schemas<br/>Pydantic"]
|
||||||
sv["services<br/>AuthService, UserService,<br/>SiteService, AlertService, RecommendationService,<br/>StatsService, SensorService"]
|
sv["services<br/>AuthService, UserService,<br/>SiteService, RecommendationService,<br/>StatsService"]
|
||||||
rp["repositories<br/>user, refresh_token,<br/>login_attempt, audit_log,<br/>site, alert, recommendation, reading"]
|
rp["repositories<br/>user, refresh_token,<br/>login_attempt, audit_log,<br/>site, recommendation, reading"]
|
||||||
md["models<br/>10 tables"]
|
md["models<br/>10 tables"]
|
||||||
db[("PostgreSQL")]
|
db[("PostgreSQL")]
|
||||||
|
|
||||||
@@ -146,7 +146,6 @@ Deux fichiers d'environnement, deux usages : `.env` à la racine alimente `docke
|
|||||||
| GET | `/api/v1/recommendations` | Liste les recommandations. `lecteur` | 401, 403, 500 |
|
| GET | `/api/v1/recommendations` | Liste les recommandations. `lecteur` | 401, 403, 500 |
|
||||||
| GET | `/api/v1/recommendations/{recommendation_id}` | Décrit une recommandation. `lecteur` | 401, 403, 404, 422, 500 |
|
| GET | `/api/v1/recommendations/{recommendation_id}` | Décrit une recommandation. `lecteur` | 401, 403, 404, 422, 500 |
|
||||||
| GET | `/api/v1/stats/summary` | Résume la consommation instantanée du parc. `lecteur` | 401, 403, 500 |
|
| GET | `/api/v1/stats/summary` | Résume la consommation instantanée du parc. `lecteur` | 401, 403, 500 |
|
||||||
| GET | `/api/v1/sensors/status` | État de santé des capteurs par site, dérivé de la dernière lecture. `admin` | 401, 403, 500 |
|
|
||||||
| GET | `/metrics` | Format Prometheus, hors du schéma. Jeton requis si `APP_METRICS_TOKEN` est posé | |
|
| GET | `/metrics` | Format Prometheus, hors du schéma. Jeton requis si `APP_METRICS_TOKEN` est posé | |
|
||||||
| GET | `/docs`, `/redoc`, `/openapi.json` | Hors du schéma. Fermés en `staging` et en `prod` | |
|
| GET | `/docs`, `/redoc`, `/openapi.json` | Hors du schéma. Fermés en `staging` et en `prod` | |
|
||||||
|
|
||||||
@@ -168,10 +167,9 @@ contrairement aux routes d'administration qui exigent `admin`. `SiteRepository`
|
|||||||
réelle. `GET /recommendations` et `GET /recommendations/{recommendation_id}` reprennent le même
|
réelle. `GET /recommendations` et `GET /recommendations/{recommendation_id}` reprennent le même
|
||||||
gabarit à la lettre, `recommendation_id` étant un entier plutôt qu'un texte. Une recommandation ne
|
gabarit à la lettre, `recommendation_id` étant un entier plutôt qu'un texte. Une recommandation ne
|
||||||
porte pas `site_id` : elle remonte à un site par sa seule `alert_id`, `alert` n'étant pas encore
|
porte pas `site_id` : elle remonte à un site par sa seule `alert_id`, `alert` n'étant pas encore
|
||||||
exposée. `GET /stats/summary` et `GET /sensors/status` agrègent chacune deux repositories
|
exposée. `GET /stats/summary` agrège deux repositories (`SiteRepository`, `ReadingRepository`)
|
||||||
(`SiteRepository`, `ReadingRepository`) dans un service dédié plutôt que d'exposer une table :
|
dans un service dédié plutôt que d'exposer une table : elle n'entre donc pas dans ce gabarit
|
||||||
elles n'entrent donc pas dans ce gabarit route-par-table. Le contrat détaillé pour le frontend est
|
route-par-table. Le contrat détaillé pour le frontend est dans
|
||||||
dans
|
|
||||||
[31-contrat-authentification.md](31-contrat-authentification.md).
|
[31-contrat-authentification.md](31-contrat-authentification.md).
|
||||||
|
|
||||||
### `/health/ready`
|
### `/health/ready`
|
||||||
@@ -248,8 +246,8 @@ Les modèles de `app/schemas/errors.py` décrivent ce que les gestionnaires renv
|
|||||||
|
|
||||||
### Ajouter une route métier
|
### Ajouter une route métier
|
||||||
|
|
||||||
Checklist pour toute nouvelle route sur le gabarit `sites`/`alerts`/`recommendations`/`stats`/
|
Checklist pour toute nouvelle route sur le gabarit `sites`/`alerts`/`recommendations`/`stats`
|
||||||
`sensors` (`reading`, `dataset`, `prediction`) :
|
(`reading`, `dataset`, `prediction`) :
|
||||||
|
|
||||||
1. Composer ses `responses=` depuis `app/api/openapi.py` : `REPONSES_LECTEUR`/`REPONSES_ADMIN`
|
1. Composer ses `responses=` depuis `app/api/openapi.py` : `REPONSES_LECTEUR`/`REPONSES_ADMIN`
|
||||||
au niveau de l'`include_router()` du routeur, `REPONSE_VALIDATION` et les codes locaux
|
au niveau de l'`include_router()` du routeur, `REPONSE_VALIDATION` et les codes locaux
|
||||||
|
|||||||
@@ -0,0 +1,67 @@
|
|||||||
|
locals {
|
||||||
|
frontend_environments = {
|
||||||
|
dev = {
|
||||||
|
source_dir = "${path.root}/../../../apps/frontend/dist/frontend-dev/browser"
|
||||||
|
domain = "dev.enervision"
|
||||||
|
}
|
||||||
|
|
||||||
|
rec = {
|
||||||
|
source_dir = "${path.root}/../../../apps/frontend/dist/frontend-rec/browser"
|
||||||
|
domain = "rec.enervision"
|
||||||
|
}
|
||||||
|
|
||||||
|
prod = {
|
||||||
|
source_dir = "${path.root}/../../../apps/frontend/dist/frontend-prod/browser"
|
||||||
|
domain = "enervision"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
selected_frontend = local.frontend_environments[var.deployment_environment]
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "null_resource" "frontend" {
|
||||||
|
depends_on = [module.k3s]
|
||||||
|
|
||||||
|
triggers = {
|
||||||
|
environment = var.deployment_environment
|
||||||
|
|
||||||
|
build_hash = sha256(join("", [
|
||||||
|
for file in fileset("${path.root}/../../../apps/frontend/dist/frontend/browser", "**") :
|
||||||
|
filesha256("${path.root}/../../../apps/frontend/dist/frontend/browser/${file}")
|
||||||
|
]))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Variables pour la connexion SSH
|
||||||
|
connection {
|
||||||
|
type = "ssh"
|
||||||
|
host = var.ssh_host
|
||||||
|
port = var.ssh_port
|
||||||
|
user = var.ssh_user
|
||||||
|
private_key = file(pathexpand(var.ssh_private_key_path))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lancement de script en SSH avec remote-exec
|
||||||
|
// Installation de Nginx et initialisation du répertoire du frontend
|
||||||
|
provisioner "remote-exec" {
|
||||||
|
inline = [
|
||||||
|
"sudo apt-get update",
|
||||||
|
"sudo apt-get install -y nginx",
|
||||||
|
"sudo mkdir -p /var/www/enervision",
|
||||||
|
"sudo rm -rf /var/www/enervision/*"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copie des fichiers vers le serveur
|
||||||
|
provisioner "file" {
|
||||||
|
source = "${path.root}/../../../apps/frontend/dist/frontend/browser/"
|
||||||
|
destination = "/tmp/enervision-frontend"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Déplacement des fichiers
|
||||||
|
provisioner "remote-exec" {
|
||||||
|
inline = [
|
||||||
|
"sudo cp -r /tmp/enervision-frontend/* /var/www/enervision/",
|
||||||
|
"sudo chown -R www-data:www-data /var/www/enervision"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user