Compare commits
25
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e47235bd7f | ||
|
|
4c72fbbb69 | ||
|
|
57c16c77f7 | ||
|
|
1103c6e1a6 | ||
|
|
b910e747ec | ||
|
|
4692f1d604 | ||
|
|
239efc8ee6 | ||
|
|
0ca429ff3d | ||
|
|
a2727f9b5a | ||
|
|
6aeaca8ed1 | ||
|
|
08ad3bbe34 | ||
|
|
50dfa72c9d | ||
|
|
d58647cad4 | ||
|
|
d14b3afc8e | ||
|
|
c95f4d3851 | ||
|
|
8f237f6d6f | ||
|
|
3db4419bdf | ||
|
|
3ca1866e93 | ||
|
|
98ec01c847 | ||
|
|
552391c9bd | ||
|
|
34890b2b04 | ||
|
|
06a8ae42d2 | ||
|
|
1fbacf2fa3 | ||
|
|
0be2418e02 | ||
|
|
49f46978b0 |
+5
-1
@@ -9,6 +9,7 @@ venv/
|
|||||||
.coverage
|
.coverage
|
||||||
coverage.xml
|
coverage.xml
|
||||||
htmlcov/
|
htmlcov/
|
||||||
|
test-results/
|
||||||
dist/
|
dist/
|
||||||
build/
|
build/
|
||||||
*.egg-info/
|
*.egg-info/
|
||||||
@@ -23,7 +24,7 @@ yarn-error.log*
|
|||||||
|
|
||||||
# Terraform
|
# Terraform
|
||||||
.terraform/
|
.terraform/
|
||||||
.terraform.lock.hcl
|
# .terraform.lock.hcl est versionne (pas ignore) pour figer les versions de provider entre contributeurs/CI
|
||||||
*.tfstate
|
*.tfstate
|
||||||
*.tfstate.*
|
*.tfstate.*
|
||||||
*.tfplan
|
*.tfplan
|
||||||
@@ -32,6 +33,9 @@ override.tf
|
|||||||
override.tf.json
|
override.tf.json
|
||||||
*_override.tf
|
*_override.tf
|
||||||
*_override.tf.json
|
*_override.tf.json
|
||||||
|
*.tfvars
|
||||||
|
!*.tfvars.example
|
||||||
|
kubeconfig
|
||||||
|
|
||||||
# Airflow
|
# Airflow
|
||||||
etl/airflow/logs/
|
etl/airflow/logs/
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
BACKEND := apps/backend
|
BACKEND := apps/backend
|
||||||
|
|
||||||
.DEFAULT_GOAL := help
|
.DEFAULT_GOAL := help
|
||||||
.PHONY: help install dev lint format typecheck test test-integration check docker-build \
|
.PHONY: help install dev lint format typecheck test test-cov test-integration check \
|
||||||
db-up db-down db-reset db-logs db-psql migrate
|
docker-build db-up db-down db-reset db-logs db-psql migrate
|
||||||
|
|
||||||
help: ## Liste les cibles disponibles
|
help: ## Liste les cibles disponibles
|
||||||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-16s\033[0m %s\n", $$1, $$2}'
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-16s\033[0m %s\n", $$1, $$2}'
|
||||||
@@ -23,7 +23,11 @@ typecheck: ## Verifie le typage du backend
|
|||||||
cd $(BACKEND) && uv run mypy app
|
cd $(BACKEND) && uv run mypy app
|
||||||
|
|
||||||
test: ## Execute les tests backend ne demandant pas de base
|
test: ## Execute les tests backend ne demandant pas de base
|
||||||
cd $(BACKEND) && uv run pytest
|
cd $(BACKEND) && uv run pytest --cov-fail-under=85
|
||||||
|
|
||||||
|
test-cov: ## Rapports de couverture HTML et XML, plus les resultats au format JUnit
|
||||||
|
cd $(BACKEND) && uv run pytest --cov-fail-under=85 --cov-report=html \
|
||||||
|
--cov-report=xml --junitxml=test-results/junit.xml
|
||||||
|
|
||||||
test-integration: ## Execute les tests exigeant une base joignable
|
test-integration: ## Execute les tests exigeant une base joignable
|
||||||
cd $(BACKEND) && uv run pytest -m integration
|
cd $(BACKEND) && uv run pytest -m integration
|
||||||
|
|||||||
@@ -3,20 +3,35 @@
|
|||||||
Monorepo de la plateforme EnerVision : collecte, stockage, analyse et restitution de
|
Monorepo de la plateforme EnerVision : collecte, stockage, analyse et restitution de
|
||||||
series temporelles energetiques, deployee sur une machine on-premise.
|
series temporelles energetiques, deployee sur une machine on-premise.
|
||||||
|
|
||||||
|
## Jalons
|
||||||
|
|
||||||
|
| Jalon | Intitulé |
|
||||||
|
|-------|----------------------------------------------------------|
|
||||||
|
| J1 | Valider la préparation de l'environnement et du repo |
|
||||||
|
| J2 | Valider le périmètre retenu et les choix technologiques |
|
||||||
|
| J3 | Valider l'architecture et la gestion de la sécurité |
|
||||||
|
| J4 | Valider la robustesse et assurer les livrables |
|
||||||
|
|
||||||
|
Ce que la documentation apporte à chacun : [docs/architecture/00-vue-ensemble.md](docs/architecture/00-vue-ensemble.md).
|
||||||
|
|
||||||
## Stack cible
|
## Stack cible
|
||||||
|
|
||||||
| Domaine | Technologie | Emplacement | Etat |
|
| Domaine | Technologie | Emplacement | Etat |
|
||||||
|------------|-------------------------------------|---------------------|---------------|
|
|------------|-------------------------------------|---------------------|---------------|
|
||||||
| Backend | FastAPI, Python 3.14 | `apps/backend` | Initialise |
|
| Backend | FastAPI, Python 3.14 | `apps/backend` | Initialise |
|
||||||
| Frontend | Angular, Node 24 LTS | `apps/frontend` | A initialiser |
|
| Frontend | Angular 22, Node 24 LTS | `apps/frontend` | Squelette |
|
||||||
| Base | PostgreSQL 17 + TimescaleDB | `db` | Initialise |
|
| Base | PostgreSQL 17 + TimescaleDB | `db` | Initialise |
|
||||||
| ETL | Apache Airflow | `etl/airflow` | A initialiser |
|
| ETL | Apache Airflow | `etl/airflow` | A initialiser |
|
||||||
| Infra | Terraform | `infra/terraform` | A initialiser |
|
| Infra | Terraform (k3s single-node) | `infra/terraform` | Initialise |
|
||||||
| CI/CD | GitHub Actions | `.github/workflows` | A initialiser |
|
| CI/CD | GitHub Actions | `.github/workflows` | A initialiser |
|
||||||
| Monitoring | Prometheus, Grafana, Alertmanager | `monitoring` | A initialiser |
|
| Monitoring | Prometheus, Grafana, Alertmanager | `monitoring` | A initialiser |
|
||||||
|
|
||||||
Le backend et la base sont initialises a ce stade. Les autres dossiers portent
|
Le backend, la base et l'infrastructure (Terraform/k3s) sont initialises a ce stade. Le frontend
|
||||||
l'arborescence et un README de cadrage, leur contenu fait l'objet d'un ticket dedie.
|
porte le squelette Angular, sans code metier : aucune route, aucun appel d'API. Les autres dossiers
|
||||||
|
portent l'arborescence et un README de cadrage, leur contenu fait l'objet d'un ticket dedie.
|
||||||
|
|
||||||
|
L'etat detaille de chaque brique et les vues d'architecture sont dans
|
||||||
|
[docs/architecture](docs/architecture/README.md).
|
||||||
|
|
||||||
## Arborescence
|
## Arborescence
|
||||||
|
|
||||||
@@ -79,6 +94,7 @@ curl -s localhost:8000/api/v1/health/ready
|
|||||||
|
|
||||||
## Conventions
|
## Conventions
|
||||||
|
|
||||||
- Branches : `feat/`, `fix/`, `chore/`, `docs/` suivi d'un libelle court.
|
- Branches : `feat/`, `fix/`, `chore/`, `docs/`, `test/` suivi d'un libelle court.
|
||||||
- Commits : Conventional Commits, portee = dossier de premier niveau concerne.
|
- Commits : Conventional Commits, portee = dossier de premier niveau concerne.
|
||||||
- Toute decision structurante donne lieu a un ADR dans `docs/adr`.
|
- Toute decision structurante donne lieu a un ADR dans `docs/adr`.
|
||||||
|
- Toute PR qui change un composant met a jour sa vue dans `docs/architecture`, dans la meme PR.
|
||||||
|
|||||||
@@ -41,6 +41,9 @@ uv run pytest # tests + couverture
|
|||||||
uv run pytest -m integration # tests exigeant une base joignable
|
uv run pytest -m integration # tests exigeant une base joignable
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Les conventions de tests, les gabarits et le detail des marqueurs sont dans
|
||||||
|
[`TESTING.md`](TESTING.md).
|
||||||
|
|
||||||
`pytest` ecarte par defaut les tests marques `integration`, pour que `make check` reste
|
`pytest` ecarte par defaut les tests marques `integration`, pour que `make check` reste
|
||||||
jouable sans Docker. Ces tests visent la base `enervision_test`, creee par
|
jouable sans Docker. Ces tests visent la base `enervision_test`, creee par
|
||||||
`db/init/110-test-database.sql` au premier demarrage du conteneur.
|
`db/init/110-test-database.sql` au premier demarrage du conteneur.
|
||||||
|
|||||||
@@ -0,0 +1,143 @@
|
|||||||
|
# Conventions de tests unitaires : Backend
|
||||||
|
|
||||||
|
## Outil
|
||||||
|
|
||||||
|
pytest, avec pytest-asyncio en mode `auto` : un `async def test_*` est collecte sans
|
||||||
|
decorateur. Les appels HTTP passent par httpx sur `ASGITransport`, qui parle a
|
||||||
|
l'application en memoire, sans serveur ni port ouvert.
|
||||||
|
|
||||||
|
## Ou ecrire les tests
|
||||||
|
|
||||||
|
`tests/` est le miroir de `app/` : un test de `app/services/consumption.py` va dans
|
||||||
|
`tests/services/test_consumption.py`. Les paquets `core`, `db`, `services` et
|
||||||
|
`repositories` existent deja, vides, pour cette raison.
|
||||||
|
|
||||||
|
## Nommage
|
||||||
|
|
||||||
|
- Fonctions en anglais : `test_<sujet>_<comportement>_when_<condition>`.
|
||||||
|
- `ids=` de `parametrize` en francais : `ids=["erreur_sqlalchemy", "erreur_reseau"]`.
|
||||||
|
- Pas de docstring : le nom porte l'intention.
|
||||||
|
|
||||||
|
## Structure attendue (Arrange / Act / Assert)
|
||||||
|
|
||||||
|
Une ligne vide separe les trois temps, sans commentaire pour les annoncer.
|
||||||
|
|
||||||
|
```python
|
||||||
|
async def test_readiness_returns_503_when_the_extension_is_missing(
|
||||||
|
fake_session: Callable[..., None], client: AsyncClient
|
||||||
|
) -> None:
|
||||||
|
fake_session(result=None)
|
||||||
|
|
||||||
|
response = await client.get("/api/v1/health/ready")
|
||||||
|
|
||||||
|
assert response.status_code == 503
|
||||||
|
assert response.json()["detail"] == "Extension TimescaleDB absente"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Ce qui doit etre teste en priorite
|
||||||
|
|
||||||
|
Le sens de dependance du backend est `endpoints -> services -> repositories -> models`.
|
||||||
|
|
||||||
|
| Couche | Ce qu'on teste |
|
||||||
|
|---|---|
|
||||||
|
| `services/` | La logique metier, cas nominal et cas d'erreur. C'est la priorite. |
|
||||||
|
| `repositories/` | Chaque branche de decision, sous le marqueur `integration`. |
|
||||||
|
| `endpoints/` | Le code de statut et la forme de la reponse, pas la logique metier. |
|
||||||
|
| `schemas/` | Rien, sauf si le schema porte une validation ecrite a la main. |
|
||||||
|
|
||||||
|
## Doubles
|
||||||
|
|
||||||
|
On remplace une dependance FastAPI par `app.dependency_overrides`, jamais par
|
||||||
|
`unittest.mock`. `tests/factories.py` fournit le necessaire.
|
||||||
|
|
||||||
|
- `fake_session(result=...)` : la session repond `result`.
|
||||||
|
- `fake_session(failure=...)` : la session leve l'exception.
|
||||||
|
- `make_settings(**overrides)` : fabrique une `Settings`, dont les valeurs priment sur
|
||||||
|
l'environnement et sur `.env`. C'est le moyen de tester `create_app` en `prod`.
|
||||||
|
|
||||||
|
## Gabarit : un endpoint
|
||||||
|
|
||||||
|
```python
|
||||||
|
from collections.abc import Callable
|
||||||
|
|
||||||
|
from httpx import AsyncClient
|
||||||
|
|
||||||
|
|
||||||
|
async def test_endpoint_returns_the_expected_payload(
|
||||||
|
fake_session: Callable[..., None], client: AsyncClient
|
||||||
|
) -> None:
|
||||||
|
fake_session(result=42)
|
||||||
|
|
||||||
|
response = await client.get("/api/v1/...")
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert response.json() == {"valeur": 42}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gabarit : un service avec repository factice
|
||||||
|
|
||||||
|
Un service ne connait que son repository : on lui en passe un faux, sans base ni session.
|
||||||
|
|
||||||
|
```python
|
||||||
|
from app.services.consumption import ConsumptionService
|
||||||
|
|
||||||
|
|
||||||
|
class FakeRepository:
|
||||||
|
async def total_for(self, site_id: int) -> float:
|
||||||
|
return 12.5
|
||||||
|
|
||||||
|
|
||||||
|
async def test_service_converts_the_total_to_kilowatt_hours() -> None:
|
||||||
|
service = ConsumptionService(FakeRepository())
|
||||||
|
|
||||||
|
total = await service.total_kwh(site_id=1)
|
||||||
|
|
||||||
|
assert total == 12.5
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gabarit : un repository sur la vraie base
|
||||||
|
|
||||||
|
Un repository parle du SQL : le tester sur un double ne prouve rien. Il porte donc le
|
||||||
|
marqueur `integration`, ecarte par defaut.
|
||||||
|
|
||||||
|
```python
|
||||||
|
import pytest
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncSession
|
||||||
|
|
||||||
|
from app.models.site import Site
|
||||||
|
from app.repositories.site import SiteRepository
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.integration
|
||||||
|
async def test_repository_reads_back_what_it_wrote(session: AsyncSession) -> None:
|
||||||
|
repository = SiteRepository(session)
|
||||||
|
|
||||||
|
await repository.add(Site(name="Toulouse"))
|
||||||
|
|
||||||
|
assert await repository.by_name("Toulouse") is not None
|
||||||
|
```
|
||||||
|
|
||||||
|
## Marqueurs
|
||||||
|
|
||||||
|
`integration` designe tout test exigeant une base joignable. `pytest` les ecarte par
|
||||||
|
defaut, ce qui garde `make check` jouable sans Docker. Tout autre marqueur doit etre
|
||||||
|
declare dans `pyproject.toml` : `--strict-markers` refuse les marqueurs inconnus.
|
||||||
|
|
||||||
|
## Couverture
|
||||||
|
|
||||||
|
Les branches sont mesurees, pas seulement les lignes. Le seuil de 85 % ne s'applique
|
||||||
|
qu'aux cibles qui jouent toute la suite, `make test` et `make test-cov` : un fichier
|
||||||
|
joue seul affiche sa couverture sans jamais echouer dessus. Le detail se lit dans
|
||||||
|
`htmlcov/index.html` apres `make test-cov`.
|
||||||
|
|
||||||
|
## Lancer les tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make test # suite unitaire, sans base
|
||||||
|
make test-cov # idem, plus les rapports HTML, XML et JUnit
|
||||||
|
make db-up && make test-integration # tests exigeant une base, demande Docker
|
||||||
|
make check # lint + typage + suite unitaire
|
||||||
|
|
||||||
|
uv run pytest tests/api/test_health.py # un seul fichier
|
||||||
|
uv run pytest -k readiness # par motif de nom
|
||||||
|
```
|
||||||
@@ -79,9 +79,14 @@ disallow_untyped_defs = false
|
|||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
testpaths = ["tests"]
|
testpaths = ["tests"]
|
||||||
asyncio_mode = "auto"
|
asyncio_mode = "auto"
|
||||||
|
asyncio_default_fixture_loop_scope = "function"
|
||||||
addopts = "-q --strict-markers -m 'not integration' --cov=app --cov-report=term-missing"
|
addopts = "-q --strict-markers -m 'not integration' --cov=app --cov-report=term-missing"
|
||||||
markers = ["integration: requiert une base PostgreSQL joignable, hors `make test`"]
|
markers = ["integration: requiert une base PostgreSQL joignable, hors `make test`"]
|
||||||
|
|
||||||
[tool.coverage.run]
|
[tool.coverage.run]
|
||||||
source = ["app"]
|
source = ["app"]
|
||||||
omit = ["app/main.py", "alembic/*"]
|
branch = true
|
||||||
|
omit = ["alembic/*"]
|
||||||
|
|
||||||
|
[tool.coverage.report]
|
||||||
|
show_missing = true
|
||||||
|
|||||||
@@ -1,12 +1,9 @@
|
|||||||
from collections.abc import AsyncIterator
|
from collections.abc import Callable
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from fastapi import FastAPI
|
|
||||||
from httpx import AsyncClient
|
from httpx import AsyncClient
|
||||||
from sqlalchemy.exc import OperationalError
|
from sqlalchemy.exc import OperationalError
|
||||||
|
|
||||||
from app.db.session import get_session
|
|
||||||
|
|
||||||
|
|
||||||
async def test_liveness_exposes_service_metadata(client: AsyncClient) -> None:
|
async def test_liveness_exposes_service_metadata(client: AsyncClient) -> None:
|
||||||
response = await client.get("/api/v1/health/live")
|
response = await client.get("/api/v1/health/live")
|
||||||
@@ -20,15 +17,10 @@ async def test_liveness_exposes_service_metadata(client: AsyncClient) -> None:
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
async def test_readiness_reports_the_timescaledb_version(app: FastAPI, client: AsyncClient) -> None:
|
async def test_readiness_reports_the_timescaledb_version(
|
||||||
class ReadySession:
|
fake_session: Callable[..., None], client: AsyncClient
|
||||||
async def scalar(self, *_: object, **__: object) -> str:
|
) -> None:
|
||||||
return "2.22.1"
|
fake_session(result="2.22.1")
|
||||||
|
|
||||||
async def override() -> AsyncIterator[ReadySession]:
|
|
||||||
yield ReadySession()
|
|
||||||
|
|
||||||
app.dependency_overrides[get_session] = override
|
|
||||||
|
|
||||||
response = await client.get("/api/v1/health/ready")
|
response = await client.get("/api/v1/health/ready")
|
||||||
|
|
||||||
@@ -41,16 +33,9 @@ async def test_readiness_reports_the_timescaledb_version(app: FastAPI, client: A
|
|||||||
|
|
||||||
|
|
||||||
async def test_readiness_returns_503_when_the_extension_is_missing(
|
async def test_readiness_returns_503_when_the_extension_is_missing(
|
||||||
app: FastAPI, client: AsyncClient
|
fake_session: Callable[..., None], client: AsyncClient
|
||||||
) -> None:
|
) -> None:
|
||||||
class SessionWithoutExtension:
|
fake_session(result=None)
|
||||||
async def scalar(self, *_: object, **__: object) -> None:
|
|
||||||
return None
|
|
||||||
|
|
||||||
async def override() -> AsyncIterator[SessionWithoutExtension]:
|
|
||||||
yield SessionWithoutExtension()
|
|
||||||
|
|
||||||
app.dependency_overrides[get_session] = override
|
|
||||||
|
|
||||||
response = await client.get("/api/v1/health/ready")
|
response = await client.get("/api/v1/health/ready")
|
||||||
|
|
||||||
@@ -67,16 +52,9 @@ async def test_readiness_returns_503_when_the_extension_is_missing(
|
|||||||
ids=["erreur_sqlalchemy", "erreur_reseau_asyncpg"],
|
ids=["erreur_sqlalchemy", "erreur_reseau_asyncpg"],
|
||||||
)
|
)
|
||||||
async def test_readiness_returns_503_when_database_is_unreachable(
|
async def test_readiness_returns_503_when_database_is_unreachable(
|
||||||
app: FastAPI, client: AsyncClient, failure: Exception
|
fake_session: Callable[..., None], client: AsyncClient, failure: Exception
|
||||||
) -> None:
|
) -> None:
|
||||||
class UnreachableSession:
|
fake_session(failure=failure)
|
||||||
async def scalar(self, *_: object, **__: object) -> None:
|
|
||||||
raise failure
|
|
||||||
|
|
||||||
async def override() -> AsyncIterator[UnreachableSession]:
|
|
||||||
yield UnreachableSession()
|
|
||||||
|
|
||||||
app.dependency_overrides[get_session] = override
|
|
||||||
|
|
||||||
response = await client.get("/api/v1/health/ready")
|
response = await client.get("/api/v1/health/ready")
|
||||||
|
|
||||||
|
|||||||
@@ -1,18 +1,30 @@
|
|||||||
import os
|
import os
|
||||||
from collections.abc import AsyncIterator, Iterator
|
from collections.abc import AsyncIterator, Callable, Iterator
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from fastapi import FastAPI
|
from fastapi import FastAPI
|
||||||
from httpx import ASGITransport, AsyncClient
|
from httpx import ASGITransport, AsyncClient
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncSession
|
||||||
|
|
||||||
from app.core.config import get_settings
|
from app.core.config import get_settings
|
||||||
from app.db.session import get_engine, get_session_factory
|
from app.db.session import get_engine, get_session, get_session_factory
|
||||||
from app.main import create_app
|
from app.main import create_app
|
||||||
|
from tests.factories import FakeSession
|
||||||
|
|
||||||
|
|
||||||
|
# Piege : les variables d'environnement priment sur apps/backend/.env. Celles qu'on ne
|
||||||
|
# pose pas ici, c'est le .env du poste qui les decide, et les assertions avec.
|
||||||
@pytest.fixture(autouse=True, scope="session")
|
@pytest.fixture(autouse=True, scope="session")
|
||||||
def environment() -> Iterator[None]:
|
def environment() -> Iterator[None]:
|
||||||
os.environ.setdefault("APP_SECRET_KEY", "secret-de-test")
|
os.environ.update(
|
||||||
|
{
|
||||||
|
"APP_ENV": "local",
|
||||||
|
"APP_DEBUG": "false",
|
||||||
|
"APP_LOG_LEVEL": "WARNING",
|
||||||
|
"APP_CORS_ORIGINS": "",
|
||||||
|
"APP_SECRET_KEY": "secret-de-test",
|
||||||
|
}
|
||||||
|
)
|
||||||
os.environ.setdefault(
|
os.environ.setdefault(
|
||||||
"DATABASE_URL", "postgresql+asyncpg://enervision:change_me@localhost:5433/enervision_test"
|
"DATABASE_URL", "postgresql+asyncpg://enervision:change_me@localhost:5433/enervision_test"
|
||||||
)
|
)
|
||||||
@@ -42,3 +54,21 @@ async def client(app: FastAPI) -> AsyncIterator[AsyncClient]:
|
|||||||
transport = ASGITransport(app=app)
|
transport = ASGITransport(app=app)
|
||||||
async with AsyncClient(transport=transport, base_url="http://test") as async_client:
|
async with AsyncClient(transport=transport, base_url="http://test") as async_client:
|
||||||
yield async_client
|
yield async_client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def fake_session(app: FastAPI) -> Callable[..., None]:
|
||||||
|
def install(result: object = None, failure: Exception | None = None) -> None:
|
||||||
|
async def override() -> AsyncIterator[FakeSession]:
|
||||||
|
yield FakeSession(result=result, failure=failure)
|
||||||
|
|
||||||
|
app.dependency_overrides[get_session] = override
|
||||||
|
|
||||||
|
return install
|
||||||
|
|
||||||
|
|
||||||
|
# Contrainte : ouvre une vraie connexion, donc reservee aux tests `integration`.
|
||||||
|
@pytest.fixture
|
||||||
|
async def session() -> AsyncIterator[AsyncSession]:
|
||||||
|
async with get_session_factory()() as async_session:
|
||||||
|
yield async_session
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from app.core.config import Settings
|
||||||
|
|
||||||
|
SETTINGS_DE_TEST: dict[str, Any] = {
|
||||||
|
"env": "local",
|
||||||
|
"debug": False,
|
||||||
|
"log_level": "WARNING",
|
||||||
|
"cors_origins": "",
|
||||||
|
"secret_key": "secret-de-test",
|
||||||
|
"database_url": "postgresql+asyncpg://enervision:change_me@localhost:5433/enervision_test",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class FakeSession:
|
||||||
|
"""Session factice : renvoie `result`, ou leve `failure` si elle est fournie."""
|
||||||
|
|
||||||
|
def __init__(self, result: object = None, failure: Exception | None = None) -> None:
|
||||||
|
self._result = result
|
||||||
|
self._failure = failure
|
||||||
|
|
||||||
|
async def scalar(self, *_: object, **__: object) -> object:
|
||||||
|
return self._repondre()
|
||||||
|
|
||||||
|
async def execute(self, *_: object, **__: object) -> object:
|
||||||
|
return self._repondre()
|
||||||
|
|
||||||
|
def _repondre(self) -> object:
|
||||||
|
if self._failure is not None:
|
||||||
|
raise self._failure
|
||||||
|
return self._result
|
||||||
|
|
||||||
|
|
||||||
|
# Piege : les arguments nommes priment sur l'environnement et sur .env, contrairement
|
||||||
|
# aux variables posees par la fixture `environment`, qui restent surchargeables.
|
||||||
|
def make_settings(**overrides: Any) -> Settings:
|
||||||
|
return Settings(**{**SETTINGS_DE_TEST, **overrides})
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Editor configuration, see https://editorconfig.org
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
charset = utf-8
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 2
|
||||||
|
insert_final_newline = true
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
|
||||||
|
[*.ts]
|
||||||
|
quote_type = single
|
||||||
|
ij_typescript_use_double_quotes = false
|
||||||
|
|
||||||
|
[*.md]
|
||||||
|
max_line_length = off
|
||||||
|
trim_trailing_whitespace = false
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files.
|
||||||
|
|
||||||
|
# Compiled output
|
||||||
|
/dist
|
||||||
|
/tmp
|
||||||
|
/out-tsc
|
||||||
|
/bazel-out
|
||||||
|
|
||||||
|
# Node
|
||||||
|
/node_modules
|
||||||
|
npm-debug.log
|
||||||
|
yarn-error.log
|
||||||
|
|
||||||
|
# IDEs and editors
|
||||||
|
.idea/
|
||||||
|
.project
|
||||||
|
.classpath
|
||||||
|
.c9/
|
||||||
|
*.launch
|
||||||
|
.settings/
|
||||||
|
*.sublime-workspace
|
||||||
|
|
||||||
|
# Visual Studio Code
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/settings.json
|
||||||
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
|
!.vscode/extensions.json
|
||||||
|
!.vscode/mcp.json
|
||||||
|
.history/*
|
||||||
|
|
||||||
|
# Miscellaneous
|
||||||
|
/.angular/cache
|
||||||
|
.sass-cache/
|
||||||
|
/connect.lock
|
||||||
|
/coverage
|
||||||
|
/libpeerconnection.log
|
||||||
|
testem.log
|
||||||
|
/typings
|
||||||
|
__screenshots__/
|
||||||
|
|
||||||
|
# System files
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"printWidth": 100,
|
||||||
|
"singleQuote": true,
|
||||||
|
"overrides": [
|
||||||
|
{
|
||||||
|
"files": "*.html",
|
||||||
|
"options": {
|
||||||
|
"parser": "angular"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
+63
-8
@@ -1,10 +1,62 @@
|
|||||||
# Frontend EnerVision
|
# Frontend EnerVision
|
||||||
|
|
||||||
Le squelette applicatif n'est pas versionne a la main : il est genere par Angular CLI.
|
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 22.1.8.
|
||||||
|
|
||||||
## Initialisation
|
## Development server
|
||||||
|
|
||||||
Depuis `apps/` :
|
To start a local development server, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ng serve
|
||||||
|
```
|
||||||
|
|
||||||
|
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
|
||||||
|
|
||||||
|
## Code scaffolding
|
||||||
|
|
||||||
|
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ng generate component component-name
|
||||||
|
```
|
||||||
|
|
||||||
|
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ng generate --help
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
To build the project run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ng build
|
||||||
|
```
|
||||||
|
|
||||||
|
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
|
||||||
|
|
||||||
|
## Running unit tests
|
||||||
|
|
||||||
|
To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ng test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Running end-to-end tests
|
||||||
|
|
||||||
|
For end-to-end (e2e) testing, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ng e2e
|
||||||
|
```
|
||||||
|
|
||||||
|
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
|
||||||
|
|
||||||
|
## Configuration spécifique au projet EnerVision
|
||||||
|
|
||||||
|
Le squelette applicatif n'est pas versionné à la main : il a été généré par Angular CLI avec la commande suivante, depuis `apps/` :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx --yes @angular/cli@latest new frontend \
|
npx --yes @angular/cli@latest new frontend \
|
||||||
@@ -16,11 +68,14 @@ npx --yes @angular/cli@latest new frontend \
|
|||||||
--skip-git
|
--skip-git
|
||||||
```
|
```
|
||||||
|
|
||||||
Le dossier `apps/frontend` doit etre vide (hors ce README) avant de lancer la commande.
|
Points à vérifier après toute regénération :
|
||||||
|
|
||||||
## Apres generation
|
|
||||||
|
|
||||||
1. Pointer l'API dans `src/environments/` sur `http://localhost:8000/api/v1`.
|
1. Pointer l'API dans `src/environments/` sur `http://localhost:8000/api/v1`.
|
||||||
2. Ajouter le proxy de developpement (`proxy.conf.json`) vers le backend.
|
2. Ajouter le proxy de développement (`proxy.conf.json`) vers le backend.
|
||||||
3. Verifier que `npm start` sert bien sur le port 4200 attendu par `docker-compose.yml`.
|
3. Vérifier que `npm start` sert bien sur le port 4200, valeur par défaut d'`APP_CORS_ORIGINS`
|
||||||
|
côté backend. Le `docker-compose.yml` n'a aucun service frontend.
|
||||||
4. Ajouter le `Dockerfile` multi-stage (build Angular puis service statique nginx).
|
4. Ajouter le `Dockerfile` multi-stage (build Angular puis service statique nginx).
|
||||||
|
|
||||||
|
## Additional Resources
|
||||||
|
|
||||||
|
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|
||||||
|
|||||||
@@ -0,0 +1,85 @@
|
|||||||
|
# Conventions de tests unitaires — Frontend
|
||||||
|
|
||||||
|
## Outil
|
||||||
|
Vitest (intégré nativement à Angular CLI, pas d'installation à faire).
|
||||||
|
|
||||||
|
## Où écrire les tests
|
||||||
|
Un fichier `*.spec.ts` à côté de chaque fichier testé (convention Angular CLI
|
||||||
|
par défaut, respectée automatiquement par `ng generate`).
|
||||||
|
|
||||||
|
## Structure attendue (Arrange / Act / Assert)
|
||||||
|
```typescript
|
||||||
|
it('devrait faire X quand Y', () => {
|
||||||
|
// Arrange : préparer les données et les mocks
|
||||||
|
const input = { valeur: 42 };
|
||||||
|
|
||||||
|
// Act : exécuter le code testé
|
||||||
|
const result = service.doSomething(input);
|
||||||
|
|
||||||
|
// Assert : vérifier le résultat
|
||||||
|
expect(result).toBe(true);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Ce qui doit être testé en priorité
|
||||||
|
- Services (`core/services/`) : logique métier, gestion des erreurs
|
||||||
|
- Guards et interceptors (`core/guards/`, `core/interceptors/`) : chaque branche de décision
|
||||||
|
- Composants avec logique (formulaires, conditions d'affichage) — pas nécessaire pour
|
||||||
|
un composant 100% template, sans logique
|
||||||
|
|
||||||
|
`core/services/`, `core/guards/` et `core/interceptors/` n'existent pas encore : c'est
|
||||||
|
l'arborescence cible, décrite dans
|
||||||
|
[docs/architecture/30-frontend.md](../../docs/architecture/30-frontend.md).
|
||||||
|
|
||||||
|
## Gabarit — tester un service avec appel HTTP
|
||||||
|
```typescript
|
||||||
|
import { TestBed } from '@angular/core/testing';
|
||||||
|
import { provideHttpClient } from '@angular/common/http';
|
||||||
|
import { provideHttpClientTesting, HttpTestingController } from '@angular/common/http/testing';
|
||||||
|
import { MonService } from './mon.service';
|
||||||
|
|
||||||
|
describe('MonService', () => {
|
||||||
|
let service: MonService;
|
||||||
|
let httpMock: HttpTestingController;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
providers: [MonService, provideHttpClient(), provideHttpClientTesting()],
|
||||||
|
});
|
||||||
|
service = TestBed.inject(MonService);
|
||||||
|
httpMock = TestBed.inject(HttpTestingController);
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => httpMock.verify());
|
||||||
|
|
||||||
|
it('devrait récupérer les données', () => {
|
||||||
|
service.getData().subscribe();
|
||||||
|
const req = httpMock.expectOne('/api/v1/...');
|
||||||
|
expect(req.request.method).toBe('GET');
|
||||||
|
req.flush({ /* réponse simulée */ });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gabarit — tester un composant standalone
|
||||||
|
```typescript
|
||||||
|
import { TestBed } from '@angular/core/testing';
|
||||||
|
import { MonComposant } from './mon-composant';
|
||||||
|
|
||||||
|
describe('MonComposant', () => {
|
||||||
|
beforeEach(async () => {
|
||||||
|
await TestBed.configureTestingModule({
|
||||||
|
imports: [MonComposant],
|
||||||
|
}).compileComponents();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('devrait se créer', () => {
|
||||||
|
const fixture = TestBed.createComponent(MonComposant);
|
||||||
|
expect(fixture.componentInstance).toBeTruthy();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Lancer les tests
|
||||||
|
- Développement (mode watch) : `npm test`
|
||||||
|
- Rapport de couverture (CI) : `npm run test:ci -- --coverage`, puis ouvrir `coverage/index.html`
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
{
|
||||||
|
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
|
||||||
|
"version": 1,
|
||||||
|
"cli": {
|
||||||
|
"packageManager": "npm"
|
||||||
|
},
|
||||||
|
"newProjectRoot": "projects",
|
||||||
|
"projects": {
|
||||||
|
"frontend": {
|
||||||
|
"projectType": "application",
|
||||||
|
"schematics": {
|
||||||
|
"@schematics/angular:component": {
|
||||||
|
"style": "scss"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": "",
|
||||||
|
"sourceRoot": "src",
|
||||||
|
"prefix": "app",
|
||||||
|
"architect": {
|
||||||
|
"build": {
|
||||||
|
"builder": "@angular/build:application",
|
||||||
|
"options": {
|
||||||
|
"browser": "src/main.ts",
|
||||||
|
"tsConfig": "tsconfig.app.json",
|
||||||
|
"inlineStyleLanguage": "scss",
|
||||||
|
"assets": [
|
||||||
|
{
|
||||||
|
"glob": "**/*",
|
||||||
|
"input": "public"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"styles": ["src/styles.scss"]
|
||||||
|
},
|
||||||
|
"configurations": {
|
||||||
|
"production": {
|
||||||
|
"budgets": [
|
||||||
|
{
|
||||||
|
"type": "initial",
|
||||||
|
"maximumWarning": "500kB",
|
||||||
|
"maximumError": "1MB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "anyComponentStyle",
|
||||||
|
"maximumWarning": "4kB",
|
||||||
|
"maximumError": "8kB"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"outputHashing": "all"
|
||||||
|
},
|
||||||
|
"development": {
|
||||||
|
"optimization": false,
|
||||||
|
"extractLicenses": false,
|
||||||
|
"sourceMap": true,
|
||||||
|
"fileReplacements": [
|
||||||
|
{
|
||||||
|
"replace": "src/environments/environment.ts",
|
||||||
|
"with": "src/environments/environment.development.ts"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultConfiguration": "production"
|
||||||
|
},
|
||||||
|
"serve": {
|
||||||
|
"builder": "@angular/build:dev-server",
|
||||||
|
"options": {
|
||||||
|
"proxyConfig": "proxy.conf.json"
|
||||||
|
},
|
||||||
|
"configurations": {
|
||||||
|
"production": {
|
||||||
|
"buildTarget": "frontend:build:production"
|
||||||
|
},
|
||||||
|
"development": {
|
||||||
|
"buildTarget": "frontend:build:development"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultConfiguration": "development"
|
||||||
|
},
|
||||||
|
"test": {
|
||||||
|
"builder": "@angular/build:unit-test",
|
||||||
|
"options": {
|
||||||
|
"coverage": true,
|
||||||
|
"coverageReporters": [
|
||||||
|
"text-summary",
|
||||||
|
"lcov",
|
||||||
|
"html"
|
||||||
|
],
|
||||||
|
"reporters": [
|
||||||
|
"default",
|
||||||
|
[
|
||||||
|
"junit",
|
||||||
|
{
|
||||||
|
"outputFile": "test-results/junit.xml"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Generated
+8270
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
"name": "frontend",
|
||||||
|
"version": "0.0.0",
|
||||||
|
"scripts": {
|
||||||
|
"ng": "ng",
|
||||||
|
"start": "ng serve",
|
||||||
|
"build": "ng build",
|
||||||
|
"watch": "ng build --watch --configuration development",
|
||||||
|
"test": "ng test",
|
||||||
|
"test:ci": "ng test --watch=false"
|
||||||
|
},
|
||||||
|
"private": true,
|
||||||
|
"packageManager": "npm@11.19.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@angular/common": "^22.1.0",
|
||||||
|
"@angular/compiler": "^22.1.0",
|
||||||
|
"@angular/core": "^22.1.0",
|
||||||
|
"@angular/forms": "^22.1.0",
|
||||||
|
"@angular/platform-browser": "^22.1.0",
|
||||||
|
"@angular/router": "^22.1.0",
|
||||||
|
"rxjs": "~7.8.0",
|
||||||
|
"tslib": "^2.3.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@angular/build": "^22.1.8",
|
||||||
|
"@angular/cli": "^22.1.8",
|
||||||
|
"@angular/compiler-cli": "^22.1.0",
|
||||||
|
"@vitest/coverage-v8": "^4.1.11",
|
||||||
|
"jsdom": "^28.0.0",
|
||||||
|
"prettier": "^3.8.1",
|
||||||
|
"typescript": "~6.0.2",
|
||||||
|
"vitest": "^4.0.8"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"/api": {
|
||||||
|
"target": "http://localhost:8000",
|
||||||
|
"secure": false,
|
||||||
|
"changeOrigin": true,
|
||||||
|
"logLevel": "debug"
|
||||||
|
}
|
||||||
|
}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
@@ -0,0 +1,7 @@
|
|||||||
|
import { ApplicationConfig, provideBrowserGlobalErrorListeners } from '@angular/core';
|
||||||
|
import { provideRouter } from '@angular/router';
|
||||||
|
import { routes } from './app.routes';
|
||||||
|
|
||||||
|
export const appConfig: ApplicationConfig = {
|
||||||
|
providers: [provideBrowserGlobalErrorListeners(), provideRouter(routes)],
|
||||||
|
};
|
||||||
@@ -0,0 +1,353 @@
|
|||||||
|
<!-- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * * The content below * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * is only a placeholder * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * and can be replaced. * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * Delete the template below * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * to get started with your project! * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -->
|
||||||
|
|
||||||
|
<style>
|
||||||
|
:host {
|
||||||
|
--bright-blue: oklch(51.01% 0.274 263.83);
|
||||||
|
--electric-violet: oklch(53.18% 0.28 296.97);
|
||||||
|
--french-violet: oklch(47.66% 0.246 305.88);
|
||||||
|
--vivid-pink: oklch(69.02% 0.277 332.77);
|
||||||
|
--hot-red: oklch(61.42% 0.238 15.34);
|
||||||
|
--orange-red: oklch(63.32% 0.24 31.68);
|
||||||
|
|
||||||
|
--gray-900: oklch(19.37% 0.006 300.98);
|
||||||
|
--gray-700: oklch(36.98% 0.014 302.71);
|
||||||
|
--gray-400: oklch(70.9% 0.015 304.04);
|
||||||
|
|
||||||
|
--red-to-pink-to-purple-vertical-gradient: linear-gradient(
|
||||||
|
180deg,
|
||||||
|
var(--orange-red) 0%,
|
||||||
|
var(--vivid-pink) 50%,
|
||||||
|
var(--electric-violet) 100%
|
||||||
|
);
|
||||||
|
|
||||||
|
--red-to-pink-to-purple-horizontal-gradient: linear-gradient(
|
||||||
|
90deg,
|
||||||
|
var(--orange-red) 0%,
|
||||||
|
var(--vivid-pink) 50%,
|
||||||
|
var(--electric-violet) 100%
|
||||||
|
);
|
||||||
|
|
||||||
|
--pill-accent: var(--bright-blue);
|
||||||
|
|
||||||
|
font-family:
|
||||||
|
'Inter',
|
||||||
|
-apple-system,
|
||||||
|
BlinkMacSystemFont,
|
||||||
|
'Segoe UI',
|
||||||
|
Roboto,
|
||||||
|
Helvetica,
|
||||||
|
Arial,
|
||||||
|
sans-serif,
|
||||||
|
'Apple Color Emoji',
|
||||||
|
'Segoe UI Emoji',
|
||||||
|
'Segoe UI Symbol';
|
||||||
|
box-sizing: border-box;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
-moz-osx-font-smoothing: grayscale;
|
||||||
|
display: block;
|
||||||
|
height: 100dvh;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 3.125rem;
|
||||||
|
color: var(--gray-900);
|
||||||
|
font-weight: 500;
|
||||||
|
line-height: 100%;
|
||||||
|
letter-spacing: -0.125rem;
|
||||||
|
margin: 0;
|
||||||
|
font-family:
|
||||||
|
'Inter Tight',
|
||||||
|
-apple-system,
|
||||||
|
BlinkMacSystemFont,
|
||||||
|
'Segoe UI',
|
||||||
|
Roboto,
|
||||||
|
Helvetica,
|
||||||
|
Arial,
|
||||||
|
sans-serif,
|
||||||
|
'Apple Color Emoji',
|
||||||
|
'Segoe UI Emoji',
|
||||||
|
'Segoe UI Symbol';
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin: 0;
|
||||||
|
color: var(--gray-700);
|
||||||
|
}
|
||||||
|
|
||||||
|
main {
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100%;
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
align-items: center;
|
||||||
|
padding: 1rem;
|
||||||
|
box-sizing: inherit;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.angular-logo {
|
||||||
|
max-width: 9.2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-around;
|
||||||
|
width: 100%;
|
||||||
|
max-width: 700px;
|
||||||
|
margin-bottom: 3rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content h1 {
|
||||||
|
margin-top: 1.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content p {
|
||||||
|
margin-top: 1.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.divider {
|
||||||
|
width: 1px;
|
||||||
|
background: var(--red-to-pink-to-purple-vertical-gradient);
|
||||||
|
margin-inline: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pill-group {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: start;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 1.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pill {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
--pill-accent: var(--bright-blue);
|
||||||
|
background: color-mix(in srgb, var(--pill-accent) 5%, transparent);
|
||||||
|
color: var(--pill-accent);
|
||||||
|
padding-inline: 0.75rem;
|
||||||
|
padding-block: 0.375rem;
|
||||||
|
border-radius: 2.75rem;
|
||||||
|
border: 0;
|
||||||
|
transition: background 0.3s ease;
|
||||||
|
font-family: var(--inter-font);
|
||||||
|
font-size: 0.875rem;
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 500;
|
||||||
|
line-height: 1.4rem;
|
||||||
|
letter-spacing: -0.00875rem;
|
||||||
|
text-decoration: none;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pill:hover {
|
||||||
|
background: color-mix(in srgb, var(--pill-accent) 15%, transparent);
|
||||||
|
}
|
||||||
|
|
||||||
|
.pill-group .pill:nth-child(6n + 1) {
|
||||||
|
--pill-accent: var(--bright-blue);
|
||||||
|
}
|
||||||
|
.pill-group .pill:nth-child(6n + 2) {
|
||||||
|
--pill-accent: var(--electric-violet);
|
||||||
|
}
|
||||||
|
.pill-group .pill:nth-child(6n + 3) {
|
||||||
|
--pill-accent: var(--french-violet);
|
||||||
|
}
|
||||||
|
|
||||||
|
.pill-group .pill:nth-child(6n + 4),
|
||||||
|
.pill-group .pill:nth-child(6n + 5),
|
||||||
|
.pill-group .pill:nth-child(6n + 6) {
|
||||||
|
--pill-accent: var(--hot-red);
|
||||||
|
}
|
||||||
|
|
||||||
|
.pill-group svg {
|
||||||
|
margin-inline-start: 0.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.social-links {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.73rem;
|
||||||
|
margin-top: 1.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.social-links path {
|
||||||
|
transition: fill 0.3s ease;
|
||||||
|
fill: var(--gray-400);
|
||||||
|
}
|
||||||
|
|
||||||
|
.social-links a:hover svg path {
|
||||||
|
fill: var(--gray-900);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 650px) {
|
||||||
|
.content {
|
||||||
|
flex-direction: column;
|
||||||
|
width: max-content;
|
||||||
|
}
|
||||||
|
|
||||||
|
.divider {
|
||||||
|
height: 1px;
|
||||||
|
width: 100%;
|
||||||
|
background: var(--red-to-pink-to-purple-horizontal-gradient);
|
||||||
|
margin-block: 1.5rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<main class="main">
|
||||||
|
<div class="content">
|
||||||
|
<div class="left-side">
|
||||||
|
<svg
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
viewBox="0 0 982 239"
|
||||||
|
fill="none"
|
||||||
|
class="angular-logo"
|
||||||
|
>
|
||||||
|
<g clip-path="url(#a)">
|
||||||
|
<path
|
||||||
|
fill="url(#b)"
|
||||||
|
d="M388.676 191.625h30.849L363.31 31.828h-35.758l-56.215 159.797h30.848l13.174-39.356h60.061l13.256 39.356Zm-65.461-62.675 21.602-64.311h1.227l21.602 64.311h-44.431Zm126.831-7.527v70.202h-28.23V71.839h27.002v20.374h1.392c2.782-6.71 7.2-12.028 13.255-15.956 6.056-3.927 13.584-5.89 22.503-5.89 8.264 0 15.465 1.8 21.684 5.318 6.137 3.518 10.964 8.673 14.319 15.382 3.437 6.71 5.074 14.81 4.992 24.383v76.175h-28.23v-71.92c0-8.019-2.046-14.237-6.219-18.819-4.173-4.5-9.819-6.791-17.102-6.791-4.91 0-9.328 1.063-13.174 3.272-3.846 2.128-6.792 5.237-9.001 9.328-2.046 4.009-3.191 8.918-3.191 14.728ZM589.233 239c-10.147 0-18.82-1.391-26.103-4.091-7.282-2.7-13.092-6.382-17.511-10.964-4.418-4.582-7.528-9.655-9.164-15.219l25.448-6.136c1.145 2.372 2.782 4.663 4.991 6.954 2.209 2.291 5.155 4.255 8.837 5.81 3.683 1.554 8.428 2.291 14.074 2.291 8.019 0 14.647-1.964 19.884-5.81 5.237-3.845 7.856-10.227 7.856-19.064v-22.665h-1.391c-1.473 2.946-3.601 5.892-6.383 9.001-2.782 3.109-6.464 5.645-10.965 7.691-4.582 2.046-10.228 3.109-17.101 3.109-9.165 0-17.511-2.209-25.039-6.545-7.446-4.337-13.42-10.883-17.757-19.474-4.418-8.673-6.628-19.473-6.628-32.565 0-13.091 2.21-24.301 6.628-33.383 4.419-9.082 10.311-15.955 17.839-20.7 7.528-4.746 15.874-7.037 25.039-7.037 7.037 0 12.846 1.145 17.347 3.518 4.582 2.373 8.182 5.236 10.883 8.51 2.7 3.272 4.746 6.382 6.137 9.327h1.554v-19.8h27.821v121.749c0 10.228-2.454 18.737-7.364 25.447-4.91 6.709-11.538 11.7-20.048 15.055-8.509 3.355-18.165 4.991-28.884 4.991Zm.245-71.266c5.974 0 11.047-1.473 15.302-4.337 4.173-2.945 7.446-7.118 9.573-12.519 2.21-5.482 3.274-12.027 3.274-19.637 0-7.609-1.064-14.155-3.274-19.8-2.127-5.646-5.318-10.064-9.491-13.255-4.174-3.11-9.329-4.746-15.384-4.746s-11.537 1.636-15.792 4.91c-4.173 3.272-7.365 7.772-9.492 13.418-2.128 5.727-3.191 12.191-3.191 19.392 0 7.2 1.063 13.745 3.273 19.228 2.127 5.482 5.318 9.736 9.573 12.764 4.174 3.027 9.41 4.582 15.629 4.582Zm141.56-26.51V71.839h28.23v119.786h-27.412v-21.273h-1.227c-2.7 6.709-7.119 12.191-13.338 16.446-6.137 4.255-13.747 6.382-22.748 6.382-7.855 0-14.81-1.718-20.783-5.237-5.974-3.518-10.72-8.591-14.075-15.382-3.355-6.709-5.073-14.891-5.073-24.464V71.839h28.312v71.921c0 7.609 2.046 13.664 6.219 18.083 4.173 4.5 9.655 6.709 16.365 6.709 4.173 0 8.183-.982 12.111-3.028 3.927-2.045 7.118-5.072 9.655-9.082 2.537-4.091 3.764-9.164 3.764-15.218Zm65.707-109.395v159.796h-28.23V31.828h28.23Zm44.841 162.169c-7.61 0-14.402-1.391-20.457-4.091-6.055-2.7-10.883-6.791-14.32-12.109-3.518-5.319-5.237-11.946-5.237-19.801 0-6.791 1.228-12.355 3.765-16.773 2.536-4.419 5.891-7.937 10.228-10.637 4.337-2.618 9.164-4.664 14.647-6.055 5.4-1.391 11.046-2.373 16.856-3.027 7.037-.737 12.683-1.391 17.102-1.964 4.337-.573 7.528-1.555 9.574-2.782 1.963-1.309 3.027-3.273 3.027-5.973v-.491c0-5.891-1.718-10.391-5.237-13.664-3.518-3.191-8.51-4.828-15.056-4.828-6.955 0-12.356 1.473-16.447 4.5-4.009 3.028-6.71 6.546-8.183 10.719l-26.348-3.764c2.046-7.282 5.483-13.336 10.31-18.328 4.746-4.909 10.638-8.59 17.511-11.045 6.955-2.455 14.565-3.682 22.912-3.682 5.809 0 11.537.654 17.265 2.045s10.965 3.6 15.711 6.71c4.746 3.109 8.51 7.282 11.455 12.6 2.864 5.318 4.337 11.946 4.337 19.883v80.184h-27.166v-16.446h-.9c-1.719 3.355-4.092 6.464-7.201 9.328-3.109 2.864-6.955 5.237-11.619 6.955-4.828 1.718-10.229 2.536-16.529 2.536Zm7.364-20.701c5.646 0 10.556-1.145 14.729-3.354 4.173-2.291 7.364-5.237 9.655-9.001 2.292-3.763 3.355-7.854 3.355-12.273v-14.155c-.9.737-2.373 1.391-4.5 2.046-2.128.654-4.419 1.145-7.037 1.636-2.619.491-5.155.9-7.692 1.227-2.537.328-4.746.655-6.628.901-4.173.572-8.019 1.472-11.292 2.781-3.355 1.31-5.973 3.11-7.855 5.401-1.964 2.291-2.864 5.318-2.864 8.918 0 5.237 1.882 9.164 5.728 11.782 3.682 2.782 8.51 4.091 14.401 4.091Zm64.643 18.328V71.839h27.412v19.965h1.227c2.21-6.955 5.974-12.274 11.292-16.038 5.319-3.763 11.456-5.645 18.329-5.645 1.555 0 3.355.082 5.237.163 1.964.164 3.601.328 4.91.573v25.938c-1.227-.41-3.109-.819-5.646-1.146a58.814 58.814 0 0 0-7.446-.49c-5.155 0-9.738 1.145-13.829 3.354-4.091 2.209-7.282 5.236-9.655 9.164-2.373 3.927-3.519 8.427-3.519 13.5v70.448h-28.312ZM222.077 39.192l-8.019 125.923L137.387 0l84.69 39.192Zm-53.105 162.825-57.933 33.056-57.934-33.056 11.783-28.556h92.301l11.783 28.556ZM111.039 62.675l30.357 73.803H80.681l30.358-73.803ZM7.937 165.115 0 39.192 84.69 0 7.937 165.115Z"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
fill="url(#c)"
|
||||||
|
d="M388.676 191.625h30.849L363.31 31.828h-35.758l-56.215 159.797h30.848l13.174-39.356h60.061l13.256 39.356Zm-65.461-62.675 21.602-64.311h1.227l21.602 64.311h-44.431Zm126.831-7.527v70.202h-28.23V71.839h27.002v20.374h1.392c2.782-6.71 7.2-12.028 13.255-15.956 6.056-3.927 13.584-5.89 22.503-5.89 8.264 0 15.465 1.8 21.684 5.318 6.137 3.518 10.964 8.673 14.319 15.382 3.437 6.71 5.074 14.81 4.992 24.383v76.175h-28.23v-71.92c0-8.019-2.046-14.237-6.219-18.819-4.173-4.5-9.819-6.791-17.102-6.791-4.91 0-9.328 1.063-13.174 3.272-3.846 2.128-6.792 5.237-9.001 9.328-2.046 4.009-3.191 8.918-3.191 14.728ZM589.233 239c-10.147 0-18.82-1.391-26.103-4.091-7.282-2.7-13.092-6.382-17.511-10.964-4.418-4.582-7.528-9.655-9.164-15.219l25.448-6.136c1.145 2.372 2.782 4.663 4.991 6.954 2.209 2.291 5.155 4.255 8.837 5.81 3.683 1.554 8.428 2.291 14.074 2.291 8.019 0 14.647-1.964 19.884-5.81 5.237-3.845 7.856-10.227 7.856-19.064v-22.665h-1.391c-1.473 2.946-3.601 5.892-6.383 9.001-2.782 3.109-6.464 5.645-10.965 7.691-4.582 2.046-10.228 3.109-17.101 3.109-9.165 0-17.511-2.209-25.039-6.545-7.446-4.337-13.42-10.883-17.757-19.474-4.418-8.673-6.628-19.473-6.628-32.565 0-13.091 2.21-24.301 6.628-33.383 4.419-9.082 10.311-15.955 17.839-20.7 7.528-4.746 15.874-7.037 25.039-7.037 7.037 0 12.846 1.145 17.347 3.518 4.582 2.373 8.182 5.236 10.883 8.51 2.7 3.272 4.746 6.382 6.137 9.327h1.554v-19.8h27.821v121.749c0 10.228-2.454 18.737-7.364 25.447-4.91 6.709-11.538 11.7-20.048 15.055-8.509 3.355-18.165 4.991-28.884 4.991Zm.245-71.266c5.974 0 11.047-1.473 15.302-4.337 4.173-2.945 7.446-7.118 9.573-12.519 2.21-5.482 3.274-12.027 3.274-19.637 0-7.609-1.064-14.155-3.274-19.8-2.127-5.646-5.318-10.064-9.491-13.255-4.174-3.11-9.329-4.746-15.384-4.746s-11.537 1.636-15.792 4.91c-4.173 3.272-7.365 7.772-9.492 13.418-2.128 5.727-3.191 12.191-3.191 19.392 0 7.2 1.063 13.745 3.273 19.228 2.127 5.482 5.318 9.736 9.573 12.764 4.174 3.027 9.41 4.582 15.629 4.582Zm141.56-26.51V71.839h28.23v119.786h-27.412v-21.273h-1.227c-2.7 6.709-7.119 12.191-13.338 16.446-6.137 4.255-13.747 6.382-22.748 6.382-7.855 0-14.81-1.718-20.783-5.237-5.974-3.518-10.72-8.591-14.075-15.382-3.355-6.709-5.073-14.891-5.073-24.464V71.839h28.312v71.921c0 7.609 2.046 13.664 6.219 18.083 4.173 4.5 9.655 6.709 16.365 6.709 4.173 0 8.183-.982 12.111-3.028 3.927-2.045 7.118-5.072 9.655-9.082 2.537-4.091 3.764-9.164 3.764-15.218Zm65.707-109.395v159.796h-28.23V31.828h28.23Zm44.841 162.169c-7.61 0-14.402-1.391-20.457-4.091-6.055-2.7-10.883-6.791-14.32-12.109-3.518-5.319-5.237-11.946-5.237-19.801 0-6.791 1.228-12.355 3.765-16.773 2.536-4.419 5.891-7.937 10.228-10.637 4.337-2.618 9.164-4.664 14.647-6.055 5.4-1.391 11.046-2.373 16.856-3.027 7.037-.737 12.683-1.391 17.102-1.964 4.337-.573 7.528-1.555 9.574-2.782 1.963-1.309 3.027-3.273 3.027-5.973v-.491c0-5.891-1.718-10.391-5.237-13.664-3.518-3.191-8.51-4.828-15.056-4.828-6.955 0-12.356 1.473-16.447 4.5-4.009 3.028-6.71 6.546-8.183 10.719l-26.348-3.764c2.046-7.282 5.483-13.336 10.31-18.328 4.746-4.909 10.638-8.59 17.511-11.045 6.955-2.455 14.565-3.682 22.912-3.682 5.809 0 11.537.654 17.265 2.045s10.965 3.6 15.711 6.71c4.746 3.109 8.51 7.282 11.455 12.6 2.864 5.318 4.337 11.946 4.337 19.883v80.184h-27.166v-16.446h-.9c-1.719 3.355-4.092 6.464-7.201 9.328-3.109 2.864-6.955 5.237-11.619 6.955-4.828 1.718-10.229 2.536-16.529 2.536Zm7.364-20.701c5.646 0 10.556-1.145 14.729-3.354 4.173-2.291 7.364-5.237 9.655-9.001 2.292-3.763 3.355-7.854 3.355-12.273v-14.155c-.9.737-2.373 1.391-4.5 2.046-2.128.654-4.419 1.145-7.037 1.636-2.619.491-5.155.9-7.692 1.227-2.537.328-4.746.655-6.628.901-4.173.572-8.019 1.472-11.292 2.781-3.355 1.31-5.973 3.11-7.855 5.401-1.964 2.291-2.864 5.318-2.864 8.918 0 5.237 1.882 9.164 5.728 11.782 3.682 2.782 8.51 4.091 14.401 4.091Zm64.643 18.328V71.839h27.412v19.965h1.227c2.21-6.955 5.974-12.274 11.292-16.038 5.319-3.763 11.456-5.645 18.329-5.645 1.555 0 3.355.082 5.237.163 1.964.164 3.601.328 4.91.573v25.938c-1.227-.41-3.109-.819-5.646-1.146a58.814 58.814 0 0 0-7.446-.49c-5.155 0-9.738 1.145-13.829 3.354-4.091 2.209-7.282 5.236-9.655 9.164-2.373 3.927-3.519 8.427-3.519 13.5v70.448h-28.312ZM222.077 39.192l-8.019 125.923L137.387 0l84.69 39.192Zm-53.105 162.825-57.933 33.056-57.934-33.056 11.783-28.556h92.301l11.783 28.556ZM111.039 62.675l30.357 73.803H80.681l30.358-73.803ZM7.937 165.115 0 39.192 84.69 0 7.937 165.115Z"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
<defs>
|
||||||
|
<radialGradient
|
||||||
|
id="c"
|
||||||
|
cx="0"
|
||||||
|
cy="0"
|
||||||
|
r="1"
|
||||||
|
gradientTransform="rotate(118.122 171.182 60.81) scale(205.794)"
|
||||||
|
gradientUnits="userSpaceOnUse"
|
||||||
|
>
|
||||||
|
<stop stop-color="#FF41F8" />
|
||||||
|
<stop offset=".707" stop-color="#FF41F8" stop-opacity=".5" />
|
||||||
|
<stop offset="1" stop-color="#FF41F8" stop-opacity="0" />
|
||||||
|
</radialGradient>
|
||||||
|
<linearGradient id="b" x1="0" x2="982" y1="192" y2="192" gradientUnits="userSpaceOnUse">
|
||||||
|
<stop stop-color="#F0060B" />
|
||||||
|
<stop offset="0" stop-color="#F0070C" />
|
||||||
|
<stop offset=".526" stop-color="#CC26D5" />
|
||||||
|
<stop offset="1" stop-color="#7702FF" />
|
||||||
|
</linearGradient>
|
||||||
|
<clipPath id="a"><path fill="#fff" d="M0 0h982v239H0z" /></clipPath>
|
||||||
|
</defs>
|
||||||
|
</svg>
|
||||||
|
<h1>Hello, {{ title() }}</h1>
|
||||||
|
<p>Congratulations! Your app is running. 🎉</p>
|
||||||
|
</div>
|
||||||
|
<div class="divider" role="separator" aria-label="Divider"></div>
|
||||||
|
<div class="right-side">
|
||||||
|
<div class="pill-group">
|
||||||
|
@for (
|
||||||
|
item of [
|
||||||
|
{ title: 'Explore the Docs', link: 'https://angular.dev' },
|
||||||
|
{ title: 'Learn with Tutorials', link: 'https://angular.dev/tutorials' },
|
||||||
|
{
|
||||||
|
title: 'Prompt and best practices for AI',
|
||||||
|
link: 'https://angular.dev/ai/develop-with-ai',
|
||||||
|
},
|
||||||
|
{ title: 'CLI Docs', link: 'https://angular.dev/tools/cli' },
|
||||||
|
{
|
||||||
|
title: 'Angular Language Service',
|
||||||
|
link: 'https://angular.dev/tools/language-service',
|
||||||
|
},
|
||||||
|
{ title: 'Angular DevTools', link: 'https://angular.dev/tools/devtools' },
|
||||||
|
];
|
||||||
|
track item.title
|
||||||
|
) {
|
||||||
|
<a class="pill" [href]="item.link" target="_blank" rel="noopener">
|
||||||
|
<span>{{ item.title }}</span>
|
||||||
|
<svg
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
height="14"
|
||||||
|
viewBox="0 -960 960 960"
|
||||||
|
width="14"
|
||||||
|
fill="currentColor"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M200-120q-33 0-56.5-23.5T120-200v-560q0-33 23.5-56.5T200-840h280v80H200v560h560v-280h80v280q0 33-23.5 56.5T760-120H200Zm188-212-56-56 372-372H560v-80h280v280h-80v-144L388-332Z"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
<div class="social-links">
|
||||||
|
<a
|
||||||
|
href="https://github.com/angular/angular"
|
||||||
|
aria-label="Github"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener"
|
||||||
|
>
|
||||||
|
<svg
|
||||||
|
width="25"
|
||||||
|
height="24"
|
||||||
|
viewBox="0 0 25 24"
|
||||||
|
fill="none"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
alt="Github"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M12.3047 0C5.50634 0 0 5.50942 0 12.3047C0 17.7423 3.52529 22.3535 8.41332 23.9787C9.02856 24.0946 9.25414 23.7142 9.25414 23.3871C9.25414 23.0949 9.24389 22.3207 9.23876 21.2953C5.81601 22.0377 5.09414 19.6444 5.09414 19.6444C4.53427 18.2243 3.72524 17.8449 3.72524 17.8449C2.61064 17.082 3.81137 17.0973 3.81137 17.0973C5.04697 17.1835 5.69604 18.3647 5.69604 18.3647C6.79321 20.2463 8.57636 19.7029 9.27978 19.3881C9.39052 18.5924 9.70736 18.0499 10.0591 17.7423C7.32641 17.4347 4.45429 16.3765 4.45429 11.6618C4.45429 10.3185 4.9311 9.22133 5.72065 8.36C5.58222 8.04931 5.16694 6.79833 5.82831 5.10337C5.82831 5.10337 6.85883 4.77319 9.2121 6.36459C10.1965 6.09082 11.2424 5.95546 12.2883 5.94931C13.3342 5.95546 14.3801 6.09082 15.3644 6.36459C17.7023 4.77319 18.7328 5.10337 18.7328 5.10337C19.3942 6.79833 18.9789 8.04931 18.8559 8.36C19.6403 9.22133 20.1171 10.3185 20.1171 11.6618C20.1171 16.3888 17.2409 17.4296 14.5031 17.7321C14.9338 18.1012 15.3337 18.8559 15.3337 20.0084C15.3337 21.6552 15.3183 22.978 15.3183 23.3779C15.3183 23.7009 15.5336 24.0854 16.1642 23.9623C21.0871 22.3484 24.6094 17.7341 24.6094 12.3047C24.6094 5.50942 19.0999 0 12.3047 0Z"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
<a href="https://x.com/angular" aria-label="X" target="_blank" rel="noopener">
|
||||||
|
<svg
|
||||||
|
width="24"
|
||||||
|
height="24"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
fill="none"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
alt="X"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
href="https://www.youtube.com/channel/UCbn1OgGei-DV7aSRo_HaAiw"
|
||||||
|
aria-label="Youtube"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener"
|
||||||
|
>
|
||||||
|
<svg
|
||||||
|
width="29"
|
||||||
|
height="20"
|
||||||
|
viewBox="0 0 29 20"
|
||||||
|
fill="none"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
alt="Youtube"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
fill-rule="evenodd"
|
||||||
|
clip-rule="evenodd"
|
||||||
|
d="M27.4896 1.52422C27.9301 1.96749 28.2463 2.51866 28.4068 3.12258C29.0004 5.35161 29.0004 10 29.0004 10C29.0004 10 29.0004 14.6484 28.4068 16.8774C28.2463 17.4813 27.9301 18.0325 27.4896 18.4758C27.0492 18.9191 26.5 19.2389 25.8972 19.4032C23.6778 20 14.8068 20 14.8068 20C14.8068 20 5.93586 20 3.71651 19.4032C3.11363 19.2389 2.56449 18.9191 2.12405 18.4758C1.68361 18.0325 1.36732 17.4813 1.20683 16.8774C0.613281 14.6484 0.613281 10 0.613281 10C0.613281 10 0.613281 5.35161 1.20683 3.12258C1.36732 2.51866 1.68361 1.96749 2.12405 1.52422C2.56449 1.08095 3.11363 0.76113 3.71651 0.596774C5.93586 0 14.8068 0 14.8068 0C14.8068 0 23.6778 0 25.8972 0.596774C26.5 0.76113 27.0492 1.08095 27.4896 1.52422ZM19.3229 10L11.9036 5.77905V14.221L19.3229 10Z"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<!-- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * * The content above * * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * is only a placeholder * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * and can be replaced. * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * End of Placeholder * * * * * * * * * * * * -->
|
||||||
|
<!-- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -->
|
||||||
|
|
||||||
|
<router-outlet />
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
import { Routes } from '@angular/router';
|
||||||
|
|
||||||
|
export const routes: Routes = [];
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import { TestBed } from '@angular/core/testing';
|
||||||
|
import { App } from './app';
|
||||||
|
|
||||||
|
describe('App', () => {
|
||||||
|
beforeEach(async () => {
|
||||||
|
await TestBed.configureTestingModule({
|
||||||
|
imports: [App],
|
||||||
|
}).compileComponents();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should create the app', () => {
|
||||||
|
const fixture = TestBed.createComponent(App);
|
||||||
|
const app = fixture.componentInstance;
|
||||||
|
expect(app).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should render title', async () => {
|
||||||
|
const fixture = TestBed.createComponent(App);
|
||||||
|
await fixture.whenStable();
|
||||||
|
const compiled = fixture.nativeElement as HTMLElement;
|
||||||
|
expect(compiled.querySelector('h1')?.textContent).toContain('Hello, frontend');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
import { Component, signal } from '@angular/core';
|
||||||
|
import { RouterOutlet } from '@angular/router';
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
imports: [RouterOutlet],
|
||||||
|
selector: 'app-root',
|
||||||
|
styleUrl: './app.scss',
|
||||||
|
templateUrl: './app.html',
|
||||||
|
})
|
||||||
|
export class App {
|
||||||
|
protected readonly title = signal('frontend');
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
export const environment = {
|
||||||
|
production: false,
|
||||||
|
apiUrl: '/api/v1'
|
||||||
|
};
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
export const environment = {
|
||||||
|
production: true,
|
||||||
|
apiUrl: 'http://localhost:8000/api/v1'
|
||||||
|
};
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<title>Frontend</title>
|
||||||
|
<base href="/" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
|
<link rel="icon" type="image/x-icon" href="favicon.ico" />
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<app-root></app-root>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { bootstrapApplication } from '@angular/platform-browser';
|
||||||
|
import { appConfig } from './app/app.config';
|
||||||
|
import { App } from './app/app';
|
||||||
|
|
||||||
|
bootstrapApplication(App, appConfig).catch((err) => console.error(err));
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
/* You can add global styles to this file, and also import other style files */
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
<testsuites name="vitest tests" tests="2" failures="0" errors="0" time="0.0699261">
|
||||||
|
<testsuite name="src/app/app.spec.ts" timestamp="2026-09-14T14:27:28.895Z" hostname="76SE37-GL5HHZ3" tests="2" failures="0" errors="0" skipped="0" time="0.0699261">
|
||||||
|
<testcase classname="src/app/app.spec.ts" name="App > should create the app" time="0.0527847">
|
||||||
|
</testcase>
|
||||||
|
<testcase classname="src/app/app.spec.ts" name="App > should render title" time="0.015831">
|
||||||
|
</testcase>
|
||||||
|
</testsuite>
|
||||||
|
</testsuites>
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
|
||||||
|
/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
|
||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"types": []
|
||||||
|
},
|
||||||
|
"include": ["src/**/*.ts"],
|
||||||
|
"exclude": ["src/**/*.spec.ts"]
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
|
||||||
|
/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
|
||||||
|
{
|
||||||
|
"compileOnSave": false,
|
||||||
|
"compilerOptions": {
|
||||||
|
"noImplicitOverride": true,
|
||||||
|
"noPropertyAccessFromIndexSignature": true,
|
||||||
|
"noImplicitReturns": true,
|
||||||
|
"noFallthroughCasesInSwitch": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"isolatedModules": true,
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"importHelpers": true,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "preserve"
|
||||||
|
},
|
||||||
|
"angularCompilerOptions": {
|
||||||
|
"enableI18nLegacyMessageIdFormat": false,
|
||||||
|
"strictInjectionParameters": true,
|
||||||
|
"strictInputAccessModifiers": true
|
||||||
|
},
|
||||||
|
"files": [],
|
||||||
|
"references": [
|
||||||
|
{
|
||||||
|
"path": "./tsconfig.app.json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./tsconfig.spec.json"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
|
||||||
|
/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
|
||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"types": ["vitest/globals"]
|
||||||
|
},
|
||||||
|
"include": ["src/**/*.d.ts", "src/**/*.spec.ts"]
|
||||||
|
}
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# Documentation
|
# Documentation
|
||||||
|
|
||||||
- `adr` : decisions d'architecture, une par fichier, numerotees et immuables.
|
- `adr` : decisions d'architecture, une par fichier, numerotees et immuables.
|
||||||
- `architecture` : schemas et vues d'ensemble.
|
- `architecture` : les vues du systeme. Point d'entree : [architecture/README.md](architecture/README.md).
|
||||||
|
|||||||
@@ -0,0 +1,137 @@
|
|||||||
|
# Vue d'ensemble
|
||||||
|
|
||||||
|
EnerVision collecte, stocke, analyse et restitue des séries temporelles énergétiques, sur une
|
||||||
|
machine on-premise.
|
||||||
|
|
||||||
|
## Cadre du projet
|
||||||
|
|
||||||
|
Quatre jalons ont été posés à l'ouverture du projet. Ils ont disparu du `README.md` lors de la
|
||||||
|
réécriture de l'arborescence (`2670483`) et ne subsistaient que sur `main`. Ils sont repris ici
|
||||||
|
parce qu'ils disent ce que le projet doit prouver, et donc à quoi sert chaque décision technique.
|
||||||
|
|
||||||
|
| Jalon | Intitulé | Ce que la documentation apporte |
|
||||||
|
|---|---|---|
|
||||||
|
| J1 | Valider la préparation de l'environnement et du repo | `10-infra.md` décrit la stack du poste de développement et la commande qui la démarre |
|
||||||
|
| J2 | Valider le périmètre retenu et les choix technologiques | Les ADR (`../adr/`) portent les choix ; `40-data.md` liste les questions de périmètre encore ouvertes |
|
||||||
|
| J3 | Ingestion & backend | `20-backend.md` |
|
||||||
|
| J4 | Architecture, sécurité & frontend | Les cinq vues, et la section « Sécurité » ci-dessous qui consolide les surfaces exposées |
|
||||||
|
| J5 | Valider la robustesse et assurer les livrables | `20-backend.md` et `30-frontend.md` renvoient aux conventions de tests de chaque application |
|
||||||
|
|
||||||
|
## Contexte
|
||||||
|
|
||||||
|
Statut : `Cible`. Les acteurs et les sources de mesures ne sont pas arrêtés, c'est l'objet du
|
||||||
|
jalon J2.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
exploitant["Exploitant<br/>consulte les courbes"]
|
||||||
|
admin["Administrateur<br/>exploite la plateforme"]
|
||||||
|
sources["Sources de mesures<br/>à définir en J2"]
|
||||||
|
|
||||||
|
subgraph systeme["EnerVision"]
|
||||||
|
plateforme["Collecte, stockage,<br/>analyse et restitution<br/>de séries temporelles"]
|
||||||
|
end
|
||||||
|
|
||||||
|
sources -.-> plateforme
|
||||||
|
exploitant -.-> plateforme
|
||||||
|
admin -.-> plateforme
|
||||||
|
```
|
||||||
|
|
||||||
|
## Conteneurs
|
||||||
|
|
||||||
|
Trait plein pour ce qui tourne, pointillé pour ce qui est cible.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TB
|
||||||
|
navigateur["Navigateur"]
|
||||||
|
|
||||||
|
subgraph machine["Machine on-premise"]
|
||||||
|
front["Frontend Angular 22<br/>apps/frontend"]
|
||||||
|
api["API FastAPI<br/>apps/backend"]
|
||||||
|
db[("PostgreSQL 17<br/>TimescaleDB")]
|
||||||
|
airflow["Airflow<br/>etl/airflow"]
|
||||||
|
prom["Prometheus"]
|
||||||
|
grafana["Grafana"]
|
||||||
|
end
|
||||||
|
|
||||||
|
navigateur --> front
|
||||||
|
front -.-> api
|
||||||
|
api --> db
|
||||||
|
airflow -.-> db
|
||||||
|
prom -.-> api
|
||||||
|
grafana -.-> db
|
||||||
|
grafana -.-> prom
|
||||||
|
```
|
||||||
|
|
||||||
|
Le lien `front -.-> api` est en pointillé à dessein : le frontend n'appelle aujourd'hui aucune
|
||||||
|
API, `provideHttpClient` n'est pas encore installé. Voir [30-frontend.md](30-frontend.md).
|
||||||
|
|
||||||
|
Le lien `prom -.-> api` de même : l'API expose bien `/metrics` au format Prometheus, mais aucun
|
||||||
|
collecteur ne vient le lire.
|
||||||
|
|
||||||
|
## État de la stack
|
||||||
|
|
||||||
|
| Domaine | Technologie | Emplacement | Statut | Ce qui existe réellement |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| Backend | FastAPI, Python 3.14 | `apps/backend` | `En cours` | Factory, configuration, journalisation, 2 sondes de santé, `/metrics`. Aucune couche métier |
|
||||||
|
| Frontend | Angular 22, Node 24 | `apps/frontend` | `En cours` | Squelette `ng new` standalone, routes vides, aucun service HTTP |
|
||||||
|
| Base | PostgreSQL 17 + TimescaleDB | `db` | `Fait` | Bootstrap de l'extension, base de test, chaîne Alembic. Aucune table applicative |
|
||||||
|
| Infra | Terraform, k3s single-node | `infra/terraform` | `En cours` | Module d'installation du cluster. Jamais appliqué, aucune ressource Kubernetes déclarée |
|
||||||
|
| Monitoring | Prometheus, Grafana, Alertmanager | `monitoring` | `Cible` | Rien, hors le `/metrics` exposé par l'API |
|
||||||
|
| ETL | Apache Airflow | `etl/airflow` | `Cible` | Rien |
|
||||||
|
| CI/CD | GitHub Actions | `.github/workflows` | `Cible` | Rien |
|
||||||
|
|
||||||
|
## Flux bout en bout
|
||||||
|
|
||||||
|
Statut : `Cible`. Aucun maillon de cette chaîne n'existe aujourd'hui, à l'exception de la base.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant S as Source de mesures
|
||||||
|
participant A as Airflow
|
||||||
|
participant T as TimescaleDB
|
||||||
|
participant API as FastAPI
|
||||||
|
participant U as Angular
|
||||||
|
|
||||||
|
S->>A: mesures horodatées
|
||||||
|
A->>T: insertion dans l'hypertable
|
||||||
|
T->>T: rafraîchissement de l'agrégat continu
|
||||||
|
U->>API: GET /api/v1/...
|
||||||
|
API->>T: agrégation sur la fenêtre demandée
|
||||||
|
T-->>API: lignes
|
||||||
|
API-->>U: JSON
|
||||||
|
```
|
||||||
|
|
||||||
|
## Sécurité
|
||||||
|
|
||||||
|
Section rattachée au jalon J3. Le détail par brique est dans chaque document ; voici la vue
|
||||||
|
consolidée.
|
||||||
|
|
||||||
|
### En place
|
||||||
|
|
||||||
|
- **Les secrets n'ont pas de valeur par défaut.** `APP_SECRET_KEY` et `DATABASE_URL` sont requis
|
||||||
|
sans repli : l'application refuse de démarrer si l'un manque, plutôt que de tourner avec une
|
||||||
|
valeur de démonstration. `.env` reste hors dépôt, `.env.example` est versionné.
|
||||||
|
- **CORS conditionnel** : le middleware n'est ajouté que si `APP_CORS_ORIGINS` est renseigné.
|
||||||
|
- **Documentation interactive fermée en production** : `/docs`, `/redoc` et `/openapi.json` sont
|
||||||
|
désactivés dès que `APP_ENV=prod`.
|
||||||
|
- **Conteneur backend non-root**, déclaré dans `apps/backend/Dockerfile`.
|
||||||
|
- **Côté infrastructure** : la clé SSH est marquée `sensitive`, le kubeconfig reste en `600/root`
|
||||||
|
sur la machine cible et n'est lu que par `sudo`, `*.tfvars` est ignoré par git sauf les
|
||||||
|
`.example`.
|
||||||
|
|
||||||
|
### Absent
|
||||||
|
|
||||||
|
- **Aucune authentification ni autorisation.** Les deux endpoints exposés sont publics. Rien
|
||||||
|
n'est encore décidé sur ce point.
|
||||||
|
- Pas de TLS, pas de limitation de débit, pas de journalisation des accès, pas de rotation des
|
||||||
|
secrets.
|
||||||
|
- Aucune analyse de dépendances ni de conteneur, faute de CI.
|
||||||
|
|
||||||
|
## Décisions structurantes
|
||||||
|
|
||||||
|
Elles vivent dans `../adr/`, pas ici.
|
||||||
|
|
||||||
|
| ADR | Objet |
|
||||||
|
|---|---|
|
||||||
|
| [0001](../adr/0001-postgresql-timescaledb.md) | PostgreSQL 17 avec l'extension TimescaleDB, et la frontière `db/` vs `alembic/` |
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
# Infrastructure
|
||||||
|
|
||||||
|
Deux topologies coexistent et ne servent pas la même chose. Ce document dit laquelle vaut dans
|
||||||
|
quel contexte, quelles décisions sont arrêtées, et ce qui manque encore entre les deux.
|
||||||
|
|
||||||
|
| Topologie | Sert à | Statut |
|
||||||
|
|---|---|---|
|
||||||
|
| Docker Compose | Développer et recetter sur le poste | `Fait` |
|
||||||
|
| k3s single-node | Déployer sur le serveur on-premise | `En cours` |
|
||||||
|
|
||||||
|
## Poste de développement
|
||||||
|
|
||||||
|
Statut : `Fait`. Défini par `docker-compose.yml`, projet `enervision`.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TB
|
||||||
|
subgraph poste["Poste de développement"]
|
||||||
|
ng["ng serve<br/>:4200"]
|
||||||
|
api["uvicorn --reload<br/>:8000"]
|
||||||
|
end
|
||||||
|
|
||||||
|
subgraph compose["docker compose"]
|
||||||
|
back["service backend<br/>image construite depuis apps/backend"]
|
||||||
|
db[("service db<br/>timescale/timescaledb-ha:pg17")]
|
||||||
|
end
|
||||||
|
|
||||||
|
ng -.->|"proxy /api"| api
|
||||||
|
api -->|"hôte :5433 vers conteneur :5432"| db
|
||||||
|
back -->|"réseau interne, db:5432"| db
|
||||||
|
```
|
||||||
|
|
||||||
|
| Service | Image | Points notables |
|
||||||
|
|---|---|---|
|
||||||
|
| `db` | `timescale/timescaledb-ha:pg17` | Publié sur **5433** côté hôte, 5432 souvent déjà pris. `healthcheck` `pg_isready`, 12 tentatives, `start_period` 40s |
|
||||||
|
| `backend` | Construite depuis `apps/backend` | `depends_on: db, condition: service_healthy`. **N'embarque pas le source** : toute modification impose `docker compose up -d --build backend` |
|
||||||
|
|
||||||
|
**La boucle de développement n'utilise pas le service `backend`.** `make db-up` puis `make dev` :
|
||||||
|
seule la base tourne en conteneur, l'API tourne sur le poste avec le rechargement à chaud. Le
|
||||||
|
service `backend` sert la stack complète et la recette. Les deux occupent le port 8000, ils ne se
|
||||||
|
lancent donc pas ensemble.
|
||||||
|
|
||||||
|
Deux pièges sont documentés en tête du `docker-compose.yml`, ils ne se devinent pas :
|
||||||
|
|
||||||
|
- `PGDATA` vaut `/home/postgres/pgdata/data` pour l'image `-ha`, et non le chemin habituel de
|
||||||
|
l'image `postgres`. Monté ailleurs, le volume ne retient rien, sans le moindre message.
|
||||||
|
- `db/init` est monté **fichier par fichier**. Monter le dossier masquerait les scripts d'init de
|
||||||
|
l'image, dont `timescaledb-tune`. Ajouter un fichier dans `db/init/` impose donc une ligne dans
|
||||||
|
le compose. Voir [`db/README.md`](../../db/README.md).
|
||||||
|
|
||||||
|
## Cible de déploiement
|
||||||
|
|
||||||
|
Statut : `En cours`. Le module `infra/terraform/modules/k3s/` installe le cluster. Il n'a jamais
|
||||||
|
été appliqué.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
poste["Poste<br/>terraform apply"]
|
||||||
|
kube["kubeconfig local"]
|
||||||
|
|
||||||
|
subgraph serveur["Serveur on-premise"]
|
||||||
|
k3s["k3s server single-node<br/>Traefik désactivé"]
|
||||||
|
charges["Charges de travail<br/>aucune déclarée"]
|
||||||
|
end
|
||||||
|
|
||||||
|
poste -->|"SSH, get.k3s.io"| k3s
|
||||||
|
k3s -->|"cat /etc/rancher/k3s/k3s.yaml"| kube
|
||||||
|
k3s -.-> charges
|
||||||
|
```
|
||||||
|
|
||||||
|
### Ce que le Terraform fait
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant TF as terraform apply
|
||||||
|
participant SRV as Serveur on-premise
|
||||||
|
participant L as Poste local
|
||||||
|
|
||||||
|
TF->>SRV: SSH, curl get.k3s.io puis install server
|
||||||
|
TF->>SRV: attend /etc/rancher/k3s/k3s.yaml
|
||||||
|
TF->>SRV: ssh cat k3s.yaml
|
||||||
|
SRV-->>L: kubeconfig, 127.0.0.1 réécrit en ssh_host
|
||||||
|
```
|
||||||
|
|
||||||
|
### Ce que le Terraform ne fait pas
|
||||||
|
|
||||||
|
Il déclare le provider `null` et **lui seul** : ni `kubernetes`, ni `helm`. Aucun namespace,
|
||||||
|
aucun déploiement, aucun service, aucun ingress. À l'issue d'un `apply`, on dispose d'un cluster
|
||||||
|
vide et d'un kubeconfig, rien de plus.
|
||||||
|
|
||||||
|
## Décisions figées
|
||||||
|
|
||||||
|
Ces arbitrages sont pris. Ils ne vivaient jusqu'ici que dans des commentaires de code et des
|
||||||
|
`description` de variables, c'est-à-dire qu'ils ne survivaient pas au premier remaniement.
|
||||||
|
|
||||||
|
| Décision | Raison | Où elle est appliquée |
|
||||||
|
|---|---|---|
|
||||||
|
| k3s single-node plutôt que Kubernetes complet | Une seule machine on-premise, pas de plan de contrôle à répartir | `modules/k3s/main.tf` |
|
||||||
|
| `k3s_version` obligatoire, valeur vide refusée | Sans épinglage, `get.k3s.io` installe la dernière version à chaque exécution : le déploiement cesse d'être reproductible | `validation` dans `modules/k3s/variables.tf` |
|
||||||
|
| Traefik désactivé | Le choix d'ingress reste ouvert, on ne veut pas en subir un par défaut | `k3s_disable_components`, défaut `["traefik"]` |
|
||||||
|
| Kubeconfig laissé en `600/root`, lu par `sudo` | `--write-kubeconfig-mode 644` exposerait `cluster-admin` à tout utilisateur local de la machine | Commentaire et `fetch_kubeconfig` dans `modules/k3s/main.tf` |
|
||||||
|
| State Terraform en backend `local` | Un seul opérateur, pas d'exécution concurrente, pas de dépendance à un stockage distant | `environments/dev/versions.tf` |
|
||||||
|
| `.terraform.lock.hcl` versionné | Fige les versions de provider entre contributeurs et future CI | Commentaire dans `.gitignore` |
|
||||||
|
| `*.tfvars` ignoré, `*.tfvars.example` versionné | Les tfvars portent l'adresse du serveur et le chemin de la clé | `.gitignore` |
|
||||||
|
| Désinstallation gérée au `destroy` | `k3s-uninstall.sh` en `on_failure = continue` : un serveur injoignable ne bloque pas le `destroy` | `modules/k3s/main.tf` |
|
||||||
|
| Deux racines, `dev` et `prod` | Séparation des états et des variables par environnement | `environments/` |
|
||||||
|
|
||||||
|
## Ports et noms
|
||||||
|
|
||||||
|
| Quoi | Valeur | Remarque |
|
||||||
|
|---|---|---|
|
||||||
|
| PostgreSQL, côté hôte | `5433` | Redirigé vers 5432 dans le conteneur. 5432 est souvent déjà pris |
|
||||||
|
| PostgreSQL, côté réseau Compose | `db:5432` | Nom de service, utilisé par `DATABASE_URL` du service `backend` |
|
||||||
|
| API | `8000` | Identique en conteneur et hors conteneur |
|
||||||
|
| Frontend, `ng serve` | `4200` | Valeur par défaut d'`APP_CORS_ORIGINS`. Le compose n'a aucun service frontend |
|
||||||
|
| SSH du serveur | `22` par défaut | `ssh_port`, redéfinissable |
|
||||||
|
| Base applicative | `enervision` | Variable `POSTGRES_DB` |
|
||||||
|
| Base de test | `enervision_test` | Créée par `db/init/110-test-database.sql`, nom attendu en dur par `apps/backend/tests/conftest.py` |
|
||||||
|
|
||||||
|
## Le trou entre les deux topologies
|
||||||
|
|
||||||
|
Rien ne relie aujourd'hui ce qui est construit par Compose et ce qui tournerait sur k3s. Compose
|
||||||
|
construit une image backend localement ; k3s ne saurait pas où la trouver. C'est la première
|
||||||
|
question à trancher, avant toute ressource Kubernetes.
|
||||||
|
|
||||||
|
## Questions ouvertes
|
||||||
|
|
||||||
|
- **Quel ingress** remplace Traefik, et qui termine le TLS.
|
||||||
|
- **Quel registre d'images**, et comment il est alimenté sans CI.
|
||||||
|
- **Quel stockage persistant** côté Kubernetes pour PostgreSQL, et si la base tourne dans le
|
||||||
|
cluster ou à côté.
|
||||||
|
- **Quelle stratégie de sauvegarde et de restauration** des données de mesure.
|
||||||
|
- **Que devient `environments/prod/`**, aujourd'hui réduit à un `.gitkeep`.
|
||||||
@@ -0,0 +1,163 @@
|
|||||||
|
# Backend
|
||||||
|
|
||||||
|
API FastAPI, Python 3.14, SQLAlchemy asynchrone sur `asyncpg`. Source dans `apps/backend`.
|
||||||
|
|
||||||
|
## Couches
|
||||||
|
|
||||||
|
La doctrine est posée dans [`apps/backend/README.md`](../../apps/backend/README.md) et
|
||||||
|
[`TESTING.md`](../../apps/backend/TESTING.md) : `endpoints` appelle `services`, qui appelle
|
||||||
|
`repositories`, qui seuls touchent les `models`. Le sens de dépendance ne s'inverse jamais.
|
||||||
|
|
||||||
|
Dans les faits, trois de ces couches sont des dossiers vides.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TB
|
||||||
|
ep["endpoints<br/>2 routes"]
|
||||||
|
sc["schemas<br/>2 modèles Pydantic"]
|
||||||
|
sv["services<br/>vide"]
|
||||||
|
rp["repositories<br/>vide"]
|
||||||
|
md["models<br/>vide"]
|
||||||
|
db[("PostgreSQL")]
|
||||||
|
|
||||||
|
ep --> sc
|
||||||
|
ep -.-> sv
|
||||||
|
sv -.-> rp
|
||||||
|
rp -.-> md
|
||||||
|
ep -->|"SQL brut, état actuel"| db
|
||||||
|
rp -.-> db
|
||||||
|
```
|
||||||
|
|
||||||
|
Le trait plein de `endpoints` vers la base n'est pas une erreur de dessin : `/health/ready`
|
||||||
|
exécute aujourd'hui son `SELECT` directement, sans repository. C'est acceptable pour une sonde
|
||||||
|
d'infrastructure, qui vérifie la base elle-même et non une donnée métier. Ce raccourci ne doit
|
||||||
|
pas servir de modèle au premier endpoint métier.
|
||||||
|
|
||||||
|
`app/models/__init__.py` ne contient qu'un avertissement, qui mérite d'être connu avant la
|
||||||
|
première migration : tout modèle absent de ce module reste invisible d'un
|
||||||
|
`alembic revision --autogenerate`, qui produirait alors un `drop` de sa table.
|
||||||
|
|
||||||
|
## Démarrage
|
||||||
|
|
||||||
|
Point d'entrée : **une factory**, `uvicorn app.main:create_app --factory`. Aucune configuration
|
||||||
|
n'est lue à l'import du module, ce qui rend l'application testable et les migrations
|
||||||
|
indépendantes de l'environnement d'exécution.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant U as uvicorn --factory
|
||||||
|
participant F as create_app
|
||||||
|
participant S as get_settings
|
||||||
|
participant A as FastAPI
|
||||||
|
|
||||||
|
U->>F: create_app()
|
||||||
|
F->>S: Settings depuis .env et variables APP_*
|
||||||
|
S-->>F: resolved
|
||||||
|
F->>F: configure_logging(resolved)
|
||||||
|
F->>A: FastAPI, docs fermés si prod
|
||||||
|
F->>A: CORSMiddleware, seulement si allowed_origins
|
||||||
|
F->>A: Instrumentator, expose /metrics
|
||||||
|
F->>A: include_router, préfixe /api/v1
|
||||||
|
A-->>U: application
|
||||||
|
```
|
||||||
|
|
||||||
|
**Le `lifespan` n'ouvre aucune connexion.** Au démarrage il journalise le nom, la version et
|
||||||
|
l'environnement ; à l'arrêt il libère l'engine. L'engine lui-même est construit paresseusement au
|
||||||
|
premier appel de `get_engine()`, mis en cache par `lru_cache`. Conséquence directe : une API qui
|
||||||
|
démarre ne prouve rien sur la base, la première connexion réelle a lieu au premier
|
||||||
|
`GET /api/v1/health/ready`. C'est ce qui rend cette sonde indispensable.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
`Settings` est un `BaseSettings` Pydantic, lu depuis `.env` avec le préfixe `APP_`.
|
||||||
|
|
||||||
|
| Variable | Défaut | Rôle |
|
||||||
|
|---|---|---|
|
||||||
|
| `APP_SECRET_KEY` | **aucun** | Secret applicatif, `SecretStr` |
|
||||||
|
| `DATABASE_URL` | **aucun** | Chaîne de connexion, `postgresql+asyncpg://...` |
|
||||||
|
| `APP_ENV` | `local` | `local`, `dev`, `staging` ou `prod` |
|
||||||
|
| `APP_DEBUG` | `false` | Active aussi l'écho SQL de l'engine |
|
||||||
|
| `APP_LOG_LEVEL` | `INFO` | |
|
||||||
|
| `APP_CORS_ORIGINS` | `""` | Liste séparée par des virgules. Vide, aucun middleware CORS n'est posé |
|
||||||
|
| `APP_API_PREFIX` | `/api/v1` | |
|
||||||
|
| `APP_DATABASE_POOL_SIZE` | `5` | |
|
||||||
|
| `APP_DATABASE_MAX_OVERFLOW` | `10` | |
|
||||||
|
|
||||||
|
Deux pièges :
|
||||||
|
|
||||||
|
- **`DATABASE_URL` ne prend pas le préfixe `APP_`.** C'est le seul réglage dans ce cas, par
|
||||||
|
`validation_alias`, pour rester compatible avec la convention d'Alembic et des hébergeurs.
|
||||||
|
- **`APP_SECRET_KEY` et `DATABASE_URL` n'ont pas de valeur par défaut.** L'application refuse de
|
||||||
|
démarrer si l'un manque. C'est délibéré : mieux vaut un échec au démarrage qu'un service qui
|
||||||
|
tourne avec un secret de démonstration.
|
||||||
|
|
||||||
|
Deux fichiers d'environnement, deux usages : `.env` à la racine alimente `docker-compose.yml`,
|
||||||
|
`apps/backend/.env` alimente l'API lancée sur le poste.
|
||||||
|
|
||||||
|
## Routes exposées
|
||||||
|
|
||||||
|
| Méthode | Chemin | Dans l'OpenAPI | Rôle |
|
||||||
|
|---|---|---|---|
|
||||||
|
| GET | `/api/v1/health/live` | oui | Le processus répond. Ne touche pas la base |
|
||||||
|
| GET | `/api/v1/health/ready` | oui | La base répond **et** l'extension TimescaleDB est chargée |
|
||||||
|
| GET | `/metrics` | non | Format Prometheus, exposé par l'instrumentator |
|
||||||
|
| GET | `/docs`, `/redoc`, `/openapi.json` | non | Désactivés quand `APP_ENV=prod` |
|
||||||
|
|
||||||
|
Aucune route métier n'existe à ce jour.
|
||||||
|
|
||||||
|
### `/health/ready`
|
||||||
|
|
||||||
|
Cette sonde porte une garde décrite dans l'[ADR 0001](../adr/0001-postgresql-timescaledb.md) : un
|
||||||
|
bootstrap de base sauté ne se voit pas au démarrage de l'API, elle le rend visible.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant C as Client
|
||||||
|
participant R as readiness
|
||||||
|
participant E as get_engine
|
||||||
|
participant D as PostgreSQL
|
||||||
|
|
||||||
|
C->>R: GET /api/v1/health/ready
|
||||||
|
R->>E: session, engine créé au premier appel
|
||||||
|
R->>D: SELECT extversion FROM pg_extension WHERE extname = 'timescaledb'
|
||||||
|
alt base injoignable
|
||||||
|
D--xR: SQLAlchemyError ou OSError
|
||||||
|
R-->>C: 503 Base de donnees injoignable
|
||||||
|
else extension absente
|
||||||
|
D-->>R: NULL
|
||||||
|
R-->>C: 503 Extension TimescaleDB absente
|
||||||
|
else
|
||||||
|
D-->>R: version de l'extension
|
||||||
|
R-->>C: 200 status ready
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
## Sécurité
|
||||||
|
|
||||||
|
Voir la vue consolidée dans [00-vue-ensemble.md](00-vue-ensemble.md). Côté backend :
|
||||||
|
|
||||||
|
- **Aucune authentification, aucune autorisation.** Les deux routes sont publiques. Le premier
|
||||||
|
endpoint métier imposera de trancher ce point.
|
||||||
|
- Le CORS n'autorise que les origines listées, et n'existe pas si la liste est vide.
|
||||||
|
- `/docs`, `/redoc` et `/openapi.json` disparaissent en production.
|
||||||
|
- Le conteneur tourne en utilisateur non-root, avec un `HEALTHCHECK` sur `/api/v1/health/live`.
|
||||||
|
- Ni limitation de débit, ni journalisation des accès, ni en-têtes de sécurité.
|
||||||
|
|
||||||
|
## Observabilité
|
||||||
|
|
||||||
|
- Journalisation par `dictConfig` : format console en développement, JSON dès `APP_ENV=prod`.
|
||||||
|
`sqlalchemy.engine` est forcé à `WARNING` pour ne pas noyer les journaux.
|
||||||
|
- `/metrics` au format Prometheus. **Aucun collecteur ne le lit** : `monitoring/` est vide.
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
Conventions, gabarits et arborescence : [`apps/backend/TESTING.md`](../../apps/backend/TESTING.md).
|
||||||
|
Deux points structurants y sont fixés : les doubles passent par `app.dependency_overrides` et
|
||||||
|
jamais par `unittest.mock`, et les tests qui touchent la vraie base portent le marqueur
|
||||||
|
`integration`, exclu par défaut.
|
||||||
|
|
||||||
|
## Questions ouvertes
|
||||||
|
|
||||||
|
- **Authentification et autorisation** : quel mécanisme, quelle granularité.
|
||||||
|
- **Pagination et fenêtrage** des lectures de séries temporelles, qui conditionnent la forme des
|
||||||
|
endpoints métier.
|
||||||
|
- **Politique de versionnement de l'API** au-delà du préfixe `/api/v1`.
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
# Frontend
|
||||||
|
|
||||||
|
Application Angular 22, 100 % standalone, testée avec Vitest. Source dans `apps/frontend`.
|
||||||
|
|
||||||
|
## État actuel
|
||||||
|
|
||||||
|
Statut : `En cours`. Le projet est un `ng new` intact. Le tableau de la
|
||||||
|
[vue d'ensemble](00-vue-ensemble.md) le classe désormais correctement, le `README.md` racine le
|
||||||
|
disait encore « à initialiser » alors que le squelette existe depuis `49f4697`.
|
||||||
|
|
||||||
|
Ce qui est en place :
|
||||||
|
|
||||||
|
- Bootstrap par `bootstrapApplication(App, appConfig)`, **aucun `NgModule`** dans le dépôt.
|
||||||
|
- `app.config.ts` fournit `provideBrowserGlobalErrorListeners()` et `provideRouter(routes)`.
|
||||||
|
- Vitest via le builder `@angular/build:unit-test`, couverture activée, un fichier de test.
|
||||||
|
- Prettier configuré, parser `angular` pour les gabarits HTML.
|
||||||
|
|
||||||
|
Ce qui n'existe pas encore :
|
||||||
|
|
||||||
|
- `routes` est un tableau vide. Aucune page, aucune navigation.
|
||||||
|
- **`provideHttpClient` n'est pas fourni** et `@angular/common/http` n'est importé nulle part :
|
||||||
|
l'application n'appelle aucune API.
|
||||||
|
- `app.html` est la page d'accueil Angular par défaut, commentaires de remplacement compris.
|
||||||
|
- Aucune bibliothèque de graphiques, aucun kit d'interface, aucune gestion d'état.
|
||||||
|
- Aucun lint : ESLint n'est pas installé.
|
||||||
|
|
||||||
|
## Arborescence cible
|
||||||
|
|
||||||
|
Statut : `Cible`. Elle n'est pas inventée ici : [`TESTING.md`](../../apps/frontend/TESTING.md) la
|
||||||
|
prescrit déjà dans ses gabarits de tests.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TB
|
||||||
|
subgraph src["src/app"]
|
||||||
|
core["core/<br/>services, guards, interceptors"]
|
||||||
|
features["features/<br/>un dossier par domaine"]
|
||||||
|
shared["shared/<br/>composants réutilisables"]
|
||||||
|
end
|
||||||
|
|
||||||
|
features -.-> core
|
||||||
|
features -.-> shared
|
||||||
|
core -.-> env["environments/<br/>apiUrl"]
|
||||||
|
```
|
||||||
|
|
||||||
|
Un service HTTP par domaine dans `core/services`, les composants de page dans `features`, et rien
|
||||||
|
d'autre que du réutilisable dans `shared`. Les composants n'appellent jamais `HttpClient`
|
||||||
|
directement : ils passent par un service, ce qui rend le double de test trivial.
|
||||||
|
|
||||||
|
## Flux HTTP
|
||||||
|
|
||||||
|
Statut : `Cible`. Le chemin est câblé, rien ne l'emprunte encore.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant C as Composant
|
||||||
|
participant S as Service Angular
|
||||||
|
participant P as ng serve, proxy
|
||||||
|
participant A as FastAPI
|
||||||
|
|
||||||
|
C->>S: appel de méthode
|
||||||
|
S->>P: GET /api/v1/...
|
||||||
|
P->>A: http://localhost:8000/api/v1/...
|
||||||
|
A-->>S: JSON
|
||||||
|
S-->>C: modèle typé
|
||||||
|
```
|
||||||
|
|
||||||
|
En développement, `proxy.conf.json` redirige tout `/api` vers `http://localhost:8000`. C'est ce
|
||||||
|
qui évite le CORS sur le poste, et c'est pourquoi `environment.development.ts` se contente d'un
|
||||||
|
`apiUrl` relatif, `/api/v1`.
|
||||||
|
|
||||||
|
En production, il n'y a pas de proxy : `environment.ts` porte une URL absolue. Angular substitue
|
||||||
|
le fichier via `fileReplacements`, et la configuration `production` est celle par défaut.
|
||||||
|
|
||||||
|
**Dette connue.** `src/environments/environment.ts`, qui est la configuration de production,
|
||||||
|
pointe `http://localhost:8000/api/v1` en dur. La valeur est celle du poste de développement :
|
||||||
|
telle quelle, un build de production ne joindra jamais l'API. À corriger avant le premier
|
||||||
|
déploiement, en même temps que sera tranchée la question de l'ingress dans
|
||||||
|
[10-infra.md](10-infra.md).
|
||||||
|
|
||||||
|
## Exécution
|
||||||
|
|
||||||
|
| Commande | Effet |
|
||||||
|
|---|---|
|
||||||
|
| `npm ci` | Installe les dépendances. `node_modules/` n'est pas présent par défaut |
|
||||||
|
| `npm start` | `ng serve` sur le port 4200, proxy actif |
|
||||||
|
| `npm run build` | Build de production |
|
||||||
|
| `npm run test` | Vitest en mode observateur |
|
||||||
|
| `npm run test:ci` | Vitest en une passe |
|
||||||
|
|
||||||
|
Le frontend **n'a pas de cible dans le `Makefile` racine** et **aucun service dans
|
||||||
|
`docker-compose.yml`** : il se pilote uniquement par `npm`, depuis `apps/frontend`. Le port 4200
|
||||||
|
n'apparaît dans le compose que comme valeur par défaut d'`APP_CORS_ORIGINS`, côté backend.
|
||||||
|
|
||||||
|
Un `Dockerfile` frontend existe sur la branche `feat/pipeline-cd`, mais il est mono-étage et sans
|
||||||
|
`CMD` : il construit sans rien servir. Le `README.md` de l'application demande un multi-étage
|
||||||
|
avec un service statique, il reste à écrire.
|
||||||
|
|
||||||
|
## Sécurité
|
||||||
|
|
||||||
|
- Le frontend ne détient aucun secret : `environment.ts` ne porte qu'une URL.
|
||||||
|
- L'authentification n'existe pas côté API, donc pas de garde ni d'intercepteur de jeton à ce
|
||||||
|
stade. `core/guards` et `core/interceptors` sont prévus pour cela.
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
Conventions et gabarits : [`apps/frontend/TESTING.md`](../../apps/frontend/TESTING.md).
|
||||||
|
|
||||||
|
## Questions ouvertes
|
||||||
|
|
||||||
|
- **Quelle bibliothèque de graphiques** pour les séries temporelles, et si Grafana en couvre déjà
|
||||||
|
une partie du besoin.
|
||||||
|
- **Gestion d'état** : signaux seuls, ou une bibliothèque dédiée.
|
||||||
|
- **Comment `apiUrl` est injecté en production** : build par environnement, ou configuration lue
|
||||||
|
au démarrage.
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
# Données
|
||||||
|
|
||||||
|
PostgreSQL 17 avec l'extension TimescaleDB. Le choix, ses alternatives et ses conséquences sont
|
||||||
|
dans l'[ADR 0001](../adr/0001-postgresql-timescaledb.md), qui fait foi. Ce document décrit le
|
||||||
|
système qui en découle.
|
||||||
|
|
||||||
|
## Avertissement
|
||||||
|
|
||||||
|
**Aucune table applicative n'existe à ce jour.** `Base.metadata` est vide, `app/models/` ne
|
||||||
|
contient qu'un commentaire, l'unique révision Alembic ne crée aucune table, et aucune hypertable
|
||||||
|
n'a été déclarée. Tout ce qui suit sous le statut `Cible` est une proposition de structure, pas un
|
||||||
|
relevé du code. Le modèle sera arrêté au jalon J2.
|
||||||
|
|
||||||
|
## Trois emplacements, trois rôles
|
||||||
|
|
||||||
|
C'est la règle que l'ADR 0001 existe surtout pour fixer. La confondre coûte cher : un script placé
|
||||||
|
au mauvais endroit ne s'exécute jamais, ou s'exécute deux fois.
|
||||||
|
|
||||||
|
| Emplacement | Contenu | Quand ça s'exécute |
|
||||||
|
|---|---|---|
|
||||||
|
| `db/init/` | Extensions, bases annexes | **Une seule fois**, à la première initialisation du conteneur, quand `PGDATA` est vide. Ne rejoue jamais |
|
||||||
|
| `db/migrations/` | SQL versionné qui ne découle pas du schéma applicatif : rétention, compression | À la main, aujourd'hui vide |
|
||||||
|
| `apps/backend/alembic/` | Le schéma exposé par l'API, et lui seul | `alembic upgrade head`, c'est `Base.metadata` qui fait foi |
|
||||||
|
|
||||||
|
Une hypertable relève des deux derniers : **Alembic crée la table, et le `create_hypertable()`
|
||||||
|
vit dans la même révision**. Les séparer rendrait le schéma irreproductible depuis un seul
|
||||||
|
`alembic upgrade head`.
|
||||||
|
|
||||||
|
Détail de `db/init/` et du piège de montage : [`db/README.md`](../../db/README.md).
|
||||||
|
|
||||||
|
## Ce qui existe
|
||||||
|
|
||||||
|
Statut : `Fait`.
|
||||||
|
|
||||||
|
- `db/init/100-extensions.sql` crée l'extension `timescaledb`.
|
||||||
|
- `db/init/110-test-database.sql` crée `enervision_test`, dont le nom est attendu en dur par
|
||||||
|
`apps/backend/tests/conftest.py`.
|
||||||
|
- Une révision Alembic, `5353c0e4f094`, qui **ne crée aucune table**. Elle établit
|
||||||
|
`alembic_version` et refuse de s'appliquer si l'extension manque :
|
||||||
|
|
||||||
|
```sql
|
||||||
|
IF NOT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'timescaledb') THEN
|
||||||
|
RAISE EXCEPTION 'extension timescaledb absente, voir db/init et db/README.md';
|
||||||
|
END IF;
|
||||||
|
```
|
||||||
|
|
||||||
|
Cette garde forme paire avec le 503 de `/api/v1/health/ready`. Un bootstrap sauté ne se voit pas
|
||||||
|
au démarrage de l'API : ces deux gardes le rendent visible tôt, des deux côtés.
|
||||||
|
|
||||||
|
## Cycle de vie d'une mesure
|
||||||
|
|
||||||
|
Statut : `Cible`. Aucun de ces maillons n'existe.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
src["Source de mesures"] -.-> ing["Ingestion Airflow"]
|
||||||
|
ing -.-> hy[("Hypertable mesure")]
|
||||||
|
hy -.-> agg[("Agrégat continu")]
|
||||||
|
hy -.-> comp["Compression"]
|
||||||
|
hy -.-> ret["Rétention"]
|
||||||
|
agg -.-> api["API FastAPI"]
|
||||||
|
agg -.-> graf["Grafana"]
|
||||||
|
```
|
||||||
|
|
||||||
|
Les lectures de l'API et de Grafana visent l'agrégat continu, pas la table brute : c'est tout
|
||||||
|
l'intérêt de TimescaleDB, et cela doit rester vrai quand les volumes augmenteront.
|
||||||
|
|
||||||
|
## Modèle
|
||||||
|
|
||||||
|
Statut : `Cible`. Les entités ci-dessous sont des **candidates**, à valider en J2. Elles
|
||||||
|
s'appuient sur les gabarits de [`apps/backend/TESTING.md`](../../apps/backend/TESTING.md), qui
|
||||||
|
évoquent déjà un modèle `Site`, un `SiteRepository` et un `ConsumptionService` exposant un
|
||||||
|
`total_kwh(site_id)`.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
erDiagram
|
||||||
|
SITE ||--o{ POINT_DE_MESURE : porte
|
||||||
|
POINT_DE_MESURE ||--o{ MESURE : produit
|
||||||
|
|
||||||
|
SITE {
|
||||||
|
int id PK
|
||||||
|
string nom
|
||||||
|
}
|
||||||
|
POINT_DE_MESURE {
|
||||||
|
int id PK
|
||||||
|
int site_id FK
|
||||||
|
string libelle
|
||||||
|
string unite
|
||||||
|
}
|
||||||
|
MESURE {
|
||||||
|
timestamptz horodatage PK
|
||||||
|
int point_id PK
|
||||||
|
double valeur
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`MESURE` est la table destinée à devenir une hypertable, partitionnée sur `horodatage`. Sa clé
|
||||||
|
primaire doit inclure la colonne de temps : TimescaleDB l'exige, une clé sur le seul identifiant
|
||||||
|
de point serait refusée.
|
||||||
|
|
||||||
|
## Gabarit de révision créant une hypertable
|
||||||
|
|
||||||
|
Conforme à la règle de l'ADR 0001 : table et hypertable dans la même révision.
|
||||||
|
|
||||||
|
```python
|
||||||
|
def upgrade() -> None:
|
||||||
|
op.create_table(
|
||||||
|
"mesure",
|
||||||
|
sa.Column("horodatage", sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.Column("point_id", sa.Integer(), sa.ForeignKey("point_de_mesure.id"), nullable=False),
|
||||||
|
sa.Column("valeur", sa.Float(), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("horodatage", "point_id"),
|
||||||
|
)
|
||||||
|
op.execute("SELECT create_hypertable('mesure', by_range('horodatage'))")
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
op.drop_table("mesure")
|
||||||
|
```
|
||||||
|
|
||||||
|
`drop_table` suffit au retour arrière : supprimer la table supprime l'hypertable et ses partitions.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- **Noms au singulier**, en minuscules, sans préfixe de table.
|
||||||
|
- **Toute colonne de temps en `timestamptz`.** Jamais de `timestamp` nu : une mesure sans fuseau
|
||||||
|
devient ininterprétable dès le premier changement d'heure.
|
||||||
|
- **La colonne de partitionnement s'appelle `horodatage`** et entre dans la clé primaire.
|
||||||
|
- **Les politiques de rétention et de compression** vont dans `db/migrations/`, pas dans Alembic :
|
||||||
|
elles ne découlent pas du schéma applicatif.
|
||||||
|
- **Tout modèle doit être importé dans `app/models/__init__.py`**, sans quoi
|
||||||
|
`alembic revision --autogenerate` ne le voit pas et génère un `drop` de sa table.
|
||||||
|
|
||||||
|
## Questions ouvertes
|
||||||
|
|
||||||
|
Elles relèvent du jalon J2, « valider le périmètre retenu », et bloquent le modèle définitif.
|
||||||
|
|
||||||
|
- **Quelles sources de mesures**, et selon quel protocole elles sont collectées.
|
||||||
|
- **Quelle granularité** à l'ingestion : la seconde, la minute, le quart d'heure.
|
||||||
|
- **Quels agrégats continus**, et sur quelles fenêtres.
|
||||||
|
- **Quelle profondeur de rétention** en données brutes, et à partir de quand on compresse.
|
||||||
|
- **Quelles unités** sont manipulées, et si une même table les mélange.
|
||||||
|
- **Multi-tenant ou non** : un site appartient-il à un client, et faut-il cloisonner les lectures.
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
Les vues d'architecture d'EnerVision. Un ADR (`../adr/`) **décide** et date une décision
|
||||||
|
structurante ; une vue d'architecture **décrit** le système qui en résulte. Quand les deux se
|
||||||
|
contredisent, c'est l'ADR qui fait foi et la vue qui est en retard.
|
||||||
|
|
||||||
|
## Les documents
|
||||||
|
|
||||||
|
| Document | Ce qu'il couvre |
|
||||||
|
|---|---|
|
||||||
|
| [00-vue-ensemble.md](00-vue-ensemble.md) | Jalons du projet, contexte, conteneurs, sécurité, flux bout en bout |
|
||||||
|
| [10-infra.md](10-infra.md) | Poste de développement, cible k3s, décisions figées, ports et noms |
|
||||||
|
| [20-backend.md](20-backend.md) | Couches FastAPI, séquence de démarrage, routes, configuration |
|
||||||
|
| [30-frontend.md](30-frontend.md) | Angular, arborescence cible, flux HTTP |
|
||||||
|
| [40-data.md](40-data.md) | Frontières `db/` et `alembic/`, cycle de vie d'une mesure, modèle |
|
||||||
|
|
||||||
|
L'observabilité, la sécurité et la CI/CD n'ont pas de document propre : ce sont des sections des
|
||||||
|
cinq ci-dessus, tant que `monitoring/`, `.github/workflows/` et `etl/airflow/` ne contiennent que
|
||||||
|
des `.gitkeep`. Elles en sortiront le jour où elles auront de la matière. Un fichier vide de plus
|
||||||
|
n'aide personne.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
### Mermaid, et rien d'autre
|
||||||
|
|
||||||
|
GitHub rend Mermaid nativement dans les fichiers `.md`. Un diagramme est donc du texte : il se
|
||||||
|
relit en revue, il se diffe, et il ne se périme pas dans un binaire que plus personne ne sait
|
||||||
|
rouvrir six mois plus tard. Aucune image exportée, aucun `.drawio`, aucun `.png`.
|
||||||
|
|
||||||
|
### Chaque section porte son statut
|
||||||
|
|
||||||
|
Une large part de la stack n'est pas écrite. Une vue qui mélange l'existant et la cible sans le
|
||||||
|
dire devient fausse sans prévenir.
|
||||||
|
|
||||||
|
| Statut | Sens |
|
||||||
|
|---|---|
|
||||||
|
| `Fait` | Le code existe et tourne |
|
||||||
|
| `En cours` | Commencé, incomplet |
|
||||||
|
| `Cible` | Décidé, pas encore écrit |
|
||||||
|
|
||||||
|
### Légende des diagrammes
|
||||||
|
|
||||||
|
Trait plein pour ce qui tourne, trait pointillé pour ce qui est cible.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
A[Composant en place] --> B[Composant en place]
|
||||||
|
B -.-> C[Composant cible]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Maintenance
|
||||||
|
|
||||||
|
**Toute PR qui change un composant met à jour sa vue dans la même PR.** Une vue qu'on promet de
|
||||||
|
mettre à jour plus tard ne l'est jamais.
|
||||||
|
|
||||||
|
Une documentation fausse coûte plus cher qu'une documentation absente : on la lit, on la croit, et
|
||||||
|
on construit dessus. Si une section ne peut plus être tenue à jour, elle est supprimée plutôt que
|
||||||
|
laissée à dériver.
|
||||||
+17
-1
@@ -1,6 +1,22 @@
|
|||||||
# Infrastructure
|
# Infrastructure
|
||||||
|
|
||||||
Provisionnement Terraform de la machine on-premise. Non initialise, voir le ticket dedie.
|
Provisionnement Terraform de la machine on-premise (serveur physique, accessible en SSH).
|
||||||
|
|
||||||
- `terraform/modules` : modules reutilisables.
|
- `terraform/modules` : modules reutilisables.
|
||||||
|
- `k3s` : installe un cluster k3s single-node sur une machine distante via SSH
|
||||||
|
(script officiel `get.k3s.io`) et rapatrie le kubeconfig en local.
|
||||||
- `terraform/environments/<env>` : racines Terraform, une par environnement.
|
- `terraform/environments/<env>` : racines Terraform, une par environnement.
|
||||||
|
- `dev` : instancie le module `k3s` sur le serveur de l'ecole.
|
||||||
|
- `prod` : non initialise, voir le ticket dedie.
|
||||||
|
|
||||||
|
## Usage (environments/dev)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd infra/terraform/environments/dev
|
||||||
|
cp terraform.tfvars.example terraform.tfvars # renseigner ssh_host / ssh_private_key_path
|
||||||
|
terraform init
|
||||||
|
terraform apply
|
||||||
|
```
|
||||||
|
|
||||||
|
Le kubeconfig est ecrit localement au chemin defini par `kubeconfig_output_path`
|
||||||
|
(par defaut `./kubeconfig`, ignore par git).
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
module "k3s" {
|
||||||
|
source = "../../modules/k3s"
|
||||||
|
|
||||||
|
ssh_host = var.ssh_host
|
||||||
|
ssh_port = var.ssh_port
|
||||||
|
ssh_user = var.ssh_user
|
||||||
|
ssh_private_key_path = var.ssh_private_key_path
|
||||||
|
k3s_version = var.k3s_version
|
||||||
|
k3s_disable_components = var.k3s_disable_components
|
||||||
|
kubeconfig_output_path = var.kubeconfig_output_path
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
output "kubeconfig_path" {
|
||||||
|
description = "Chemin local du kubeconfig recupere apres installation."
|
||||||
|
value = module.k3s.kubeconfig_path
|
||||||
|
}
|
||||||
|
|
||||||
|
output "node_host" {
|
||||||
|
description = "Adresse du serveur sur lequel k3s est installe."
|
||||||
|
value = module.k3s.node_host
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
ssh_host = "10.0.0.10"
|
||||||
|
ssh_port = 22
|
||||||
|
ssh_user = "root"
|
||||||
|
ssh_private_key_path = "~/.ssh/id_ed25519_enervision"
|
||||||
|
# Epingler une version reelle avant apply : https://github.com/k3s-io/k3s/releases
|
||||||
|
k3s_version = "v1.31.5+k3s1"
|
||||||
|
k3s_disable_components = ["traefik"]
|
||||||
|
kubeconfig_output_path = "./kubeconfig"
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
variable "ssh_host" {
|
||||||
|
type = string
|
||||||
|
description = "Adresse IP ou nom d'hote du serveur on-premise de l'ecole."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_port" {
|
||||||
|
type = number
|
||||||
|
description = "Port SSH du serveur."
|
||||||
|
default = 22
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_user" {
|
||||||
|
type = string
|
||||||
|
description = "Utilisateur SSH utilise pour l'installation."
|
||||||
|
default = "root"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_private_key_path" {
|
||||||
|
type = string
|
||||||
|
description = "Chemin local vers la cle privee SSH."
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "k3s_version" {
|
||||||
|
type = string
|
||||||
|
description = "Version k3s a epingler pour un deploiement reproductible (ex: v1.31.5+k3s1). Voir https://github.com/k3s-io/k3s/releases."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "k3s_disable_components" {
|
||||||
|
type = list(string)
|
||||||
|
description = "Composants embarques k3s a desactiver."
|
||||||
|
default = ["traefik"]
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "kubeconfig_output_path" {
|
||||||
|
type = string
|
||||||
|
description = "Chemin local ou ecrire le kubeconfig recupere apres installation."
|
||||||
|
default = "./kubeconfig"
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
terraform {
|
||||||
|
required_version = ">= 1.7"
|
||||||
|
|
||||||
|
required_providers {
|
||||||
|
null = {
|
||||||
|
source = "hashicorp/null"
|
||||||
|
version = "~> 3.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
backend "local" {
|
||||||
|
path = "terraform.tfstate"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
locals {
|
||||||
|
sudo_prefix = var.ssh_user == "root" ? "" : "sudo "
|
||||||
|
install_env = "INSTALL_K3S_VERSION=${var.k3s_version} "
|
||||||
|
disable_flags = join(" ", [for c in var.k3s_disable_components : "--disable=${c}"])
|
||||||
|
kubeconfig_cmd = "${local.sudo_prefix}cat /etc/rancher/k3s/k3s.yaml"
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "null_resource" "k3s_install" {
|
||||||
|
triggers = {
|
||||||
|
ssh_host = var.ssh_host
|
||||||
|
k3s_version = var.k3s_version
|
||||||
|
disable_components = join(",", var.k3s_disable_components)
|
||||||
|
}
|
||||||
|
|
||||||
|
connection {
|
||||||
|
type = "ssh"
|
||||||
|
host = var.ssh_host
|
||||||
|
port = var.ssh_port
|
||||||
|
user = var.ssh_user
|
||||||
|
private_key = file(var.ssh_private_key_path)
|
||||||
|
}
|
||||||
|
|
||||||
|
provisioner "remote-exec" {
|
||||||
|
inline = [
|
||||||
|
"${local.sudo_prefix}sh -c 'curl -sfL https://get.k3s.io | ${local.install_env}sh -s - server ${local.disable_flags}'",
|
||||||
|
"until ${local.sudo_prefix}test -f /etc/rancher/k3s/k3s.yaml; do sleep 2; done",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
# Le kubeconfig est lu via sudo (fetch_kubeconfig), pas besoin de --write-kubeconfig-mode :
|
||||||
|
# il reste 600/root par defaut, ce qui evite d'exposer les droits cluster-admin a tout utilisateur local.
|
||||||
|
provisioner "remote-exec" {
|
||||||
|
when = destroy
|
||||||
|
on_failure = continue
|
||||||
|
inline = [
|
||||||
|
"${local.sudo_prefix}sh -c 'test -x /usr/local/bin/k3s-uninstall.sh && /usr/local/bin/k3s-uninstall.sh || true'",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "null_resource" "fetch_kubeconfig" {
|
||||||
|
depends_on = [null_resource.k3s_install]
|
||||||
|
|
||||||
|
triggers = {
|
||||||
|
install_id = null_resource.k3s_install.id
|
||||||
|
}
|
||||||
|
|
||||||
|
provisioner "local-exec" {
|
||||||
|
interpreter = ["bash", "-c"]
|
||||||
|
command = <<-EOT
|
||||||
|
ssh -i "${var.ssh_private_key_path}" -p ${var.ssh_port} -o StrictHostKeyChecking=accept-new ${var.ssh_user}@${var.ssh_host} '${local.kubeconfig_cmd}' \
|
||||||
|
| sed 's/127.0.0.1/${var.ssh_host}/' > "${var.kubeconfig_output_path}"
|
||||||
|
EOT
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
output "kubeconfig_path" {
|
||||||
|
description = "Chemin local du kubeconfig recupere apres installation."
|
||||||
|
value = var.kubeconfig_output_path
|
||||||
|
}
|
||||||
|
|
||||||
|
output "node_host" {
|
||||||
|
description = "Adresse de la machine sur laquelle k3s est installe."
|
||||||
|
value = var.ssh_host
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
variable "ssh_host" {
|
||||||
|
type = string
|
||||||
|
description = "Adresse IP ou nom d'hote de la machine on-premise cible."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_port" {
|
||||||
|
type = number
|
||||||
|
description = "Port SSH de la machine cible."
|
||||||
|
default = 22
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_user" {
|
||||||
|
type = string
|
||||||
|
description = "Utilisateur SSH. Si different de root, les commandes d'installation sont prefixees par sudo."
|
||||||
|
default = "root"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "ssh_private_key_path" {
|
||||||
|
type = string
|
||||||
|
description = "Chemin local vers la cle privee SSH utilisee pour se connecter a la machine cible."
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "k3s_version" {
|
||||||
|
type = string
|
||||||
|
description = "Version k3s a epingler pour un deploiement reproductible (ex: v1.31.5+k3s1). Voir https://github.com/k3s-io/k3s/releases."
|
||||||
|
|
||||||
|
validation {
|
||||||
|
condition = length(trimspace(var.k3s_version)) > 0
|
||||||
|
error_message = "k3s_version doit etre epinglee explicitement, pas de valeur vide (sinon k3s.io installerait la derniere version a chaque run, non reproductible)."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "k3s_disable_components" {
|
||||||
|
type = list(string)
|
||||||
|
description = "Composants embarques a desactiver a l'installation (ex: traefik, servicelb)."
|
||||||
|
default = ["traefik"]
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "kubeconfig_output_path" {
|
||||||
|
type = string
|
||||||
|
description = "Chemin local ou ecrire le kubeconfig recupere apres installation."
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
terraform {
|
||||||
|
required_version = ">= 1.7"
|
||||||
|
|
||||||
|
required_providers {
|
||||||
|
null = {
|
||||||
|
source = "hashicorp/null"
|
||||||
|
version = "~> 3.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user