From 85e6e502e5d63183fbce25ddb92364ad1db0aa55 Mon Sep 17 00:00:00 2001 From: Antoine Van Elstraete Date: Thu, 13 Aug 2026 16:13:18 +0200 Subject: [PATCH] =?UTF-8?q?feat(config):=20ajouter=20la=20configuration=20?= =?UTF-8?q?Home=20Assistant=20(=C3=A9tape=201)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Ajoute la section [home_assistant] au TOML et sa validation au chargement via get_home_assistant_config(). La section est facultative pour préserver la compatibilité avec les configurations existantes, mais si elle est présente elle doit être complète et référencer un type de journée, un trajet et un véhicule à moteur existants, sous peine de refuser le démarrage de l'application. La configuration validée est exposée dans app.config['HOME_ASSISTANT']. Co-authored-by: OpenAI/GPT-5.6-Luna-Pro --- app/__init__.py | 5 ++ app/config_loader.py | 80 +++++++++++++++++++++++++++ config.toml | 6 ++ docs/onboarding.md | 11 ++++ tests/conftest.py | 6 ++ tests/test_config_loader.py | 106 ++++++++++++++++++++++++++++++++++++ 6 files changed, 214 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 04f75a5..843056a 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -159,6 +159,11 @@ def create_app(config_path=None): else: app.config["TOML"] = {} + from app.config_loader import get_home_assistant_config + + with app.app_context(): + app.config["HOME_ASSISTANT"] = get_home_assistant_config() + db.init_app(app) app.jinja_env.filters["date_fr"] = _date_fr app.jinja_env.filters["day_type_fr"] = _day_type_fr diff --git a/app/config_loader.py b/app/config_loader.py index 28176dd..f5ed815 100644 --- a/app/config_loader.py +++ b/app/config_loader.py @@ -21,8 +21,28 @@ Contrat TOML : - Certains types de journées (Télétravail, Maladie, Congé, RTT, Férié) n'impliquent aucun déplacement physique. """ +from zoneinfo import ZoneInfo, ZoneInfoNotFoundError + from flask import current_app +_HOME_ASSISTANT_REQUIRED_KEYS = { + "timezone", + "default_day_type", + "default_journey_profile_id", + "default_motor_vehicle_id", +} +_VALID_DAY_TYPES = { + "WORK", + "TT", + "GARDE", + "ASTREINTE", + "FORMATION", + "RTT", + "CONGE", + "MALADE", + "FERIE", +} + def get_vehicles(): """Récupère l'ensemble des véhicules configurés dans le fichier TOML. @@ -58,6 +78,66 @@ def get_journeys(): return current_app.config.get("TOML", {}).get("journeys", {}) +def get_home_assistant_config() -> dict[str, str] | None: + """Retourne la configuration Home Assistant, après validation. + + L'absence de section désactive la future intégration et reste compatible avec + les anciens fichiers TOML. Une section présente doit en revanche être + complète et cohérente avec les véhicules, trajets et types de journées + connus de l'application. + """ + config = current_app.config.get("TOML", {}).get("home_assistant") + if config is None: + return None + if not isinstance(config, dict): + raise ValueError("Configuration [home_assistant] invalide : la section doit être une table") + + missing = _HOME_ASSISTANT_REQUIRED_KEYS - config.keys() + if missing: + missing_keys = ", ".join(sorted(missing)) + raise ValueError( + f"Configuration [home_assistant] incomplète : clé(s) manquante(s) {missing_keys}" + ) + + if any( + not isinstance(config[key], str) or not config[key] for key in _HOME_ASSISTANT_REQUIRED_KEYS + ): + raise ValueError( + "Configuration [home_assistant] invalide : toutes les valeurs doivent être des chaînes non vides" + ) + + timezone = config["timezone"] + try: + ZoneInfo(timezone) + except (ZoneInfoNotFoundError, ValueError) as exc: + raise ValueError( + f"Configuration [home_assistant] invalide : fuseau horaire inconnu {timezone!r}" + ) from exc + + day_type = config["default_day_type"] + if day_type not in _VALID_DAY_TYPES: + raise ValueError( + f"Configuration [home_assistant] invalide : type de journée inconnu {day_type!r}" + ) + + journey_id = config["default_journey_profile_id"] + if journey_id not in get_journeys(): + raise ValueError(f"Configuration [home_assistant] invalide : trajet inconnu {journey_id!r}") + + vehicle_id = config["default_motor_vehicle_id"] + vehicle = get_vehicles().get(vehicle_id) + if vehicle is None: + raise ValueError( + f"Configuration [home_assistant] invalide : véhicule inconnu {vehicle_id!r}" + ) + if vehicle.get("type") != "moteur": + raise ValueError( + f"Configuration [home_assistant] invalide : le véhicule {vehicle_id!r} n'est pas un véhicule moteur" + ) + + return {key: config[key] for key in _HOME_ASSISTANT_REQUIRED_KEYS} + + def journey_has_motor(journey_profile_id: str | None) -> bool: """Vérifie si un profil de trajet donné inclut une distance pour véhicule à moteur. diff --git a/config.toml b/config.toml index 35f7edf..6db7bb5 100644 --- a/config.toml +++ b/config.toml @@ -37,6 +37,12 @@ distances = { moteur = 14, velo = 8 } name = "Vélo seul" distances = { velo = 24 } +[home_assistant] +timezone = "Europe/Paris" +default_day_type = "WORK" +default_journey_profile_id = "moteur_seul" +default_motor_vehicle_id = "citadine" + # --- Barème kilométrique voitures 2025 (revenus 2024) --- # Source : https://www.service-public.gouv.fr/particuliers/actualites/A14686 # Majoration +20% pour véhicules électriques gérée dans travel_calc.py diff --git a/docs/onboarding.md b/docs/onboarding.md index 55af268..52f29a5 100644 --- a/docs/onboarding.md +++ b/docs/onboarding.md @@ -101,9 +101,20 @@ Ce fichier contient les paramètres qui ne changent pas fréquemment et qui déf - **Véhicules (`[vehicles.*]`)** : Nom, type (moteur ou velo), carburant (electric, diesel, essence, none), émissions de CO₂ par km, et puissance fiscale (CV). - **Trajets (`[journeys.*]`)** : Profils de trajets prédéfinis (ex: "moteur_seul", "moteur_velo") avec les distances associées par type de moyen de transport. - **Barème kilométrique (`[bareme_kilometrique.YYYY.*]`)** : Les tranches fiscales officielles de remboursement par année et par puissance fiscale (CV). +- **Home Assistant (`[home_assistant]`)** : Les valeurs par défaut et le fuseau utilisés par la future API de présence : + ```toml + [home_assistant] + timezone = "Europe/Paris" + default_day_type = "WORK" + default_journey_profile_id = "moteur_seul" + default_motor_vehicle_id = "citadine" + ``` + Cette section est facultative pour préserver le fonctionnement de l'interface Web sur les configurations existantes. Si elle est présente, elle doit être complète et référencer un type de journée, un trajet et un véhicule à moteur existants ; l'application refuse alors de démarrer en cas d'erreur. La configuration est accessible via `get_home_assistant_config()` dans `app/config_loader.py`. *Note : Ces données sont chargées en mémoire au démarrage de l'application dans `app.config["TOML"]`.* +Le secret de la future API ne doit pas être ajouté au fichier TOML. Il proviendra de la variable d'environnement `WORKLOG_API_TOKEN` lorsqu'elle sera implémentée ; cette étape ne le stocke ni ne le gère. + ### SQLite / `instance/worklog.db` (Données dynamiques) La base de données stocke l'activité saisie par l'utilisateur : - **`work_entries`** : Une ligne par jour saisi (date, type de jour, ID du trajet, ID du véhicule, commentaire, timestamps). diff --git a/tests/conftest.py b/tests/conftest.py index d1436bd..d85b90b 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -48,6 +48,12 @@ distances = { moteur = 14, velo = 8 } name = "Vélo seul" distances = { velo = 24 } +[home_assistant] +timezone = "Europe/Paris" +default_day_type = "WORK" +default_journey_profile_id = "moteur_seul" +default_motor_vehicle_id = "citadine" + [[bareme_kilometrique.2025.cv_5.tranches]] km_max = 3000 taux = 0.548 diff --git a/tests/test_config_loader.py b/tests/test_config_loader.py index 38abe35..c86d35f 100644 --- a/tests/test_config_loader.py +++ b/tests/test_config_loader.py @@ -1,3 +1,34 @@ +import pytest + +from app import create_app + +_MINIMAL_CONFIG = """ +[vehicles.citadine] +name = "Citadine" +type = "moteur" + +[vehicles.velo] +name = "Vélo" +type = "velo" + +[journeys.moteur_seul] +name = "Moteur seul" +distances = {{ moteur = 1 }} + +[home_assistant] +timezone = "{timezone}" +default_day_type = "{day_type}" +default_journey_profile_id = "{journey_id}" +default_motor_vehicle_id = "{vehicle_id}" +""" + + +def _create_app_with_home_assistant_config(tmp_path, **values): + config_path = tmp_path / "config.toml" + config_path.write_text(_MINIMAL_CONFIG.format(**values), encoding="utf-8") + return create_app(config_path=str(config_path)) + + def test_get_vehicles_returns_configured_vehicles(app): with app.app_context(): from app.config_loader import get_vehicles @@ -59,3 +90,78 @@ def test_day_types_without_journey(app): types = day_types_without_journey() assert "TT" in types assert "WORK" not in types + + +def test_get_home_assistant_config_returns_validated_defaults(app): + with app.app_context(): + from app.config_loader import get_home_assistant_config + + assert get_home_assistant_config() == { + "timezone": "Europe/Paris", + "default_day_type": "WORK", + "default_journey_profile_id": "moteur_seul", + "default_motor_vehicle_id": "citadine", + } + assert app.config["HOME_ASSISTANT"]["default_motor_vehicle_id"] == "citadine" + + +def test_home_assistant_section_absent_is_allowed(app): + with app.app_context(): + from app.config_loader import get_home_assistant_config + + app.config["TOML"].pop("home_assistant") + assert get_home_assistant_config() is None + + +@pytest.mark.parametrize( + ("field", "value", "message"), + [ + ("timezone", "Mars/NoSuchPlace", "fuseau horaire"), + ("day_type", "UNKNOWN", "type de journée"), + ("journey_id", "unknown_journey", "trajet inconnu"), + ("vehicle_id", "unknown_vehicle", "véhicule inconnu"), + ], +) +def test_invalid_home_assistant_config_prevents_startup(tmp_path, field, value, message): + values = { + "timezone": "Europe/Paris", + "day_type": "WORK", + "journey_id": "moteur_seul", + "vehicle_id": "citadine", + } + values[field] = value + + with pytest.raises(ValueError, match=message): + _create_app_with_home_assistant_config(tmp_path, **values) + + +def test_home_assistant_default_vehicle_must_be_motor_vehicle(tmp_path): + values = { + "timezone": "Europe/Paris", + "day_type": "WORK", + "journey_id": "moteur_seul", + "vehicle_id": "velo", + } + + with pytest.raises(ValueError, match="véhicule moteur"): + _create_app_with_home_assistant_config(tmp_path, **values) + + +def test_incomplete_home_assistant_config_prevents_startup(tmp_path): + config_path = tmp_path / "config.toml" + config_path.write_text( + """ +[vehicles.citadine] +type = "moteur" + +[journeys.moteur_seul] +distances = { moteur = 1 } + +[home_assistant] +timezone = "Europe/Paris" +""", + encoding="utf-8", + ) + + with pytest.raises(ValueError, match="clé.*manquante"): + create_app(config_path=str(config_path))