diff --git a/.gitea/workflows/build.yaml b/.gitea/workflows/build.yaml new file mode 100644 index 0000000..e878dfb --- /dev/null +++ b/.gitea/workflows/build.yaml @@ -0,0 +1,51 @@ +# Cada push a main: construye y publica las imágenes de api y web en el registro de Gitea +# y actualiza el tag en k8s/kustomization.yaml (commit del bot) para que Argo CD despliegue. +name: publicar +on: + push: + branches: [main] + paths-ignore: ["k8s/kustomization.yaml", "**.md"] + +jobs: + publicar: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + + - name: Preparar variables + run: | + HOST="${GITHUB_SERVER_URL#*://}" + HOST="${HOST%/}" + echo "HOST=$HOST" >> "$GITHUB_ENV" + echo "REPO=${GITHUB_REPOSITORY,,}" >> "$GITHUB_ENV" + echo "TAG=$(git rev-parse --short=8 HEAD)" >> "$GITHUB_ENV" + + - name: Construir y publicar imágenes + env: + REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} + run: | + set -euo pipefail + echo "$REGISTRY_TOKEN" | docker login "$HOST" -u ci-bot --password-stdin + docker build -t "$HOST/$REPO/api:$TAG" -f api/Dockerfile . + docker build -t "$HOST/$REPO/web:$TAG" web + docker push "$HOST/$REPO/api:$TAG" + docker push "$HOST/$REPO/web:$TAG" + + - name: Desplegar (nuevo tag en k8s/kustomization.yaml) + env: + REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} + run: | + set -euo pipefail + REMOTO="https://ci-bot:${REGISTRY_TOKEN}@${HOST}/${GITHUB_REPOSITORY}.git" + git config user.name "ci-bot" + git config user.email "ci-bot@taller.local" + for intento in 1 2 3 4 5; do + git fetch -q "$REMOTO" main && git checkout -q -B main FETCH_HEAD + sed -i -E "s/^( *newTag: ).*/\1\"$TAG\"/" k8s/kustomization.yaml + git commit -qam "despliegue $TAG [skip ci]" || { echo "Nada que desplegar"; exit 0; } + git push -q "$REMOTO" HEAD:main && { echo "Desplegando $TAG"; exit 0; } + echo "Otro push se adelantó; reintento ($intento)"; sleep 3 + done + exit 1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..92a93f3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +__pycache__/ +*.pyc +.pytest_cache/ +.venv/ +*.db +node_modules/ +LEEME-PAREJA.md +.sembrado diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..2b6054b --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,14 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Claude Code", + "type": "shell", + "command": "claude", + "isBackground": true, + "problemMatcher": [], + "presentation": {"reveal": "always", "focus": true, "panel": "dedicated", "showReuseMessage": false}, + "runOptions": {"runOn": "folderOpen"} + } + ] +} diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..155e164 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,37 @@ +# Votación del viaje de fin de curso · Escuadrón + +Sois un escuadrón de dos parejas: **web** (carpeta `web/`) y **app** (carpeta `api/`). +Lo único que compartís es el contrato de la API: `CONTRATO.md` y `openapi.yaml`. +Cada pareja tiene además su encargo: `CONTRATO-WEB.md` o `CONTRATO-APP.md`. + +Responde siempre en español. + +## Flujo de trabajo (obligatorio) +1. **Arquitectura antes que código.** Ante cada tarea, lee el contrato y propón un plan corto + (qué ficheros, qué cambia, cómo se prueba). No escribas código hasta que la pareja diga "adelante". +2. **Tests primero.** Escribe o amplía el test que demuestra el fallo, comprueba que falla y luego arréglalo. +3. **Cambios pequeños.** Un cambio, sus tests, `git diff` revisado por la pareja, commit. +4. **Publicar = push a main.** `git pull --rebase && git push`. El CI construye y Argo CD despliega en 1-2 minutos. +5. Cuando cambiéis de tarea, la pareja hará `/clear` para empezar con el contexto limpio. + +## Normas +- **No modifiques los tests existentes para que pasen.** Si un test parece incorrecto, dilo y para. +- **Pregunta antes de instalar cualquier librería** o añadir dependencias. +- **No toques secretos** ni ficheros de credenciales, y no los muestres por pantalla. +- **No toques la carpeta de la otra pareja** salvo que lo pidan las dos. +- **No cambies el contrato** (`CONTRATO.md`, `openapi.yaml`) sin que lo acuerden las dos parejas. +- Nada de trazas ni mensajes internos en las respuestas de la API: errores en JSON, cortos. +- No toques `.gitea/` ni `k8s/kustomization.yaml` (los usa el despliegue automático). + +## Comandos +- Tests de la API: `cd api && pip install -r requirements.txt && python -m pytest -q` +- API en local: `cd api && DB_PATH=/tmp/votos.db CENSO_PATH=../alumnos.csv python app.py` (puerto 8000) +- Probar la API: `curl -s localhost:8000/api/resultados` +- Web en local: `cd web && python3 -m http.server 8080` (cambia `config.js` solo en local, no lo subas) +- Validar Kubernetes: `kubectl kustomize k8s` +- Publicar: `git add -A && git commit -m "..." && git pull --rebase && git push` + +## Dónde mirar +- La API y la web desplegadas: ver `CONTRATO.md` (direcciones del escuadrón). +- Estado del despliegue: Argo CD (dirección en la tarjeta de la pareja). +- El marcador del taller se proyecta en clase: allí aparece qué niveles superáis. diff --git a/CONTRATO-APP.md b/CONTRATO-APP.md new file mode 100644 index 0000000..2bcd6f8 --- /dev/null +++ b/CONTRATO-APP.md @@ -0,0 +1,15 @@ +# Encargo de la pareja APP (backend, carpeta `api/`) + +Sois responsables de la API. La web de vuestro escuadrón depende de vosotros: cumplid `CONTRATO.md` al pie de la letra. + +Por orden (cada paso es un nivel del marcador): +1. Que un voto válido responda **201** y `GET /api/resultados` devuelva las dos opciones y el `total`. +2. Validaciones: **409** si el código ya votó, **403** si no está en el censo, **400** si la opción no existe. + Los tests de `api/tests/` ya describen estos dos niveles: hacedlos pasar sin tocarlos. +3. El esqueleto tiene un fallo de seguridad grave (mirad cómo se construye el SQL). Arregladlo y añadid un test. +4. Muchos votos simultáneos no deben perder ni duplicar votos. Pensad dónde se comprueba el "ya ha votado". +5. Si el pod se reinicia, los votos se pierden: mirad `k8s/api.yaml` (hay dos salidas comentadas). +6. CORS: la web de vuestro escuadrón tiene que poder llamar a la API desde el navegador. + +Podéis reescribir la API en otro lenguaje (Java, Node) si os sentís más cómodos, siempre que cumpla el contrato, +tenga su `api/Dockerfile` (se construye desde la raíz del repo) y escuche en el puerto 8000 con `/healthz`. diff --git a/CONTRATO-WEB.md b/CONTRATO-WEB.md new file mode 100644 index 0000000..1860720 --- /dev/null +++ b/CONTRATO-WEB.md @@ -0,0 +1,15 @@ +# Encargo de la pareja WEB (frontend, carpeta `web/`) + +Sois responsables de la web de votación. Solo habláis con la API de vuestro escuadrón (la dirección está en `web/config.js`). + +Por orden: +1. Pintar las opciones que devuelve `GET /api/opciones` (no las escribáis a mano en el HTML). +2. Enviar el voto con `POST /api/votos` y explicar al usuario cada respuesta: 201, 400, 403 y 409. +3. Mostrar los resultados y refrescarlos tras votar (y cada pocos segundos). +4. Nada de errores en la consola del navegador. Si veis un error de CORS, es cosa de la pareja APP: avisadles. +5. Accesibilidad básica: etiquetas en los campos, mensajes legibles, que se pueda usar con teclado. + +El árbitro abrirá vuestra web con un navegador automático, votará con un código del censo y comprobará +que el resultado cambia. Usad estos identificadores para que pueda encontrar los elementos: +`#codigo` (campo del código), un botón por opción o radios con `name="opcion"`, el botón de enviar +`#formulario-voto button[type=submit]`, el mensaje `#mensaje` y los resultados `#resultados`. diff --git a/CONTRATO.md b/CONTRATO.md new file mode 100644 index 0000000..ee2141a --- /dev/null +++ b/CONTRATO.md @@ -0,0 +1,26 @@ +# Contrato de la API (lo comparten web y app) + +La especificación formal está en `openapi.yaml`. Este fichero la resume. + +- API del escuadrón: `https://escuadron-4-api.tallerprompt.org` +- Web del escuadrón: `https://escuadron-4-web.tallerprompt.org` + +| Método y ruta | Cuerpo | Respuestas | +|---|---|---| +| `GET /api/opciones` | — | `200` `["Ibiza","Praga"]` | +| `POST /api/votos` | `{"codigo": "A0001", "opcion": "Ibiza"}` | `201` voto guardado · `400` opción no válida · `403` código fuera del censo · `409` ese código ya ha votado | +| `GET /api/resultados` | — | `200` `{"Ibiza": 12, "Praga": 3, "total": 15}` (las dos opciones siempre, aunque tengan 0) | +| `GET /healthz` | — | `200` | + +Reglas: +- El censo son los 600 códigos de `alumnos.csv`. Un voto por código. +- Las respuestas de error son JSON: `{"error": "mensaje corto"}`. Nunca trazas internas. +- La API debe permitir CORS desde la web del escuadrón (`https://escuadron-4-web.tallerprompt.org`). + +## Niveles del árbitro (se proyectan en el marcador) +1. **El voto cuenta:** un voto válido responde 201 y aparece en los resultados. +2. **Un voto por alumno:** 409 al repetir, 403 fuera del censo, 400 con opción desconocida. +3. **El pucherazo:** la API resiste inyección SQL y no enseña trazas. +4. **El recreo:** muchos votos a la vez y el recuento sigue siendo exacto. +5. **Se cae un pod:** al reiniciarse la API, los votos siguen ahí. +6. **Web y API juntas:** desde la web se vota y se ve el resultado, sin errores de CORS ni de consola. diff --git a/alumnos.csv b/alumnos.csv new file mode 100644 index 0000000..ff4b3c6 --- /dev/null +++ b/alumnos.csv @@ -0,0 +1,601 @@ +codigo +A0001 +A0002 +A0003 +A0004 +A0005 +A0006 +A0007 +A0008 +A0009 +A0010 +A0011 +A0012 +A0013 +A0014 +A0015 +A0016 +A0017 +A0018 +A0019 +A0020 +A0021 +A0022 +A0023 +A0024 +A0025 +A0026 +A0027 +A0028 +A0029 +A0030 +A0031 +A0032 +A0033 +A0034 +A0035 +A0036 +A0037 +A0038 +A0039 +A0040 +A0041 +A0042 +A0043 +A0044 +A0045 +A0046 +A0047 +A0048 +A0049 +A0050 +A0051 +A0052 +A0053 +A0054 +A0055 +A0056 +A0057 +A0058 +A0059 +A0060 +A0061 +A0062 +A0063 +A0064 +A0065 +A0066 +A0067 +A0068 +A0069 +A0070 +A0071 +A0072 +A0073 +A0074 +A0075 +A0076 +A0077 +A0078 +A0079 +A0080 +A0081 +A0082 +A0083 +A0084 +A0085 +A0086 +A0087 +A0088 +A0089 +A0090 +A0091 +A0092 +A0093 +A0094 +A0095 +A0096 +A0097 +A0098 +A0099 +A0100 +A0101 +A0102 +A0103 +A0104 +A0105 +A0106 +A0107 +A0108 +A0109 +A0110 +A0111 +A0112 +A0113 +A0114 +A0115 +A0116 +A0117 +A0118 +A0119 +A0120 +A0121 +A0122 +A0123 +A0124 +A0125 +A0126 +A0127 +A0128 +A0129 +A0130 +A0131 +A0132 +A0133 +A0134 +A0135 +A0136 +A0137 +A0138 +A0139 +A0140 +A0141 +A0142 +A0143 +A0144 +A0145 +A0146 +A0147 +A0148 +A0149 +A0150 +A0151 +A0152 +A0153 +A0154 +A0155 +A0156 +A0157 +A0158 +A0159 +A0160 +A0161 +A0162 +A0163 +A0164 +A0165 +A0166 +A0167 +A0168 +A0169 +A0170 +A0171 +A0172 +A0173 +A0174 +A0175 +A0176 +A0177 +A0178 +A0179 +A0180 +A0181 +A0182 +A0183 +A0184 +A0185 +A0186 +A0187 +A0188 +A0189 +A0190 +A0191 +A0192 +A0193 +A0194 +A0195 +A0196 +A0197 +A0198 +A0199 +A0200 +A0201 +A0202 +A0203 +A0204 +A0205 +A0206 +A0207 +A0208 +A0209 +A0210 +A0211 +A0212 +A0213 +A0214 +A0215 +A0216 +A0217 +A0218 +A0219 +A0220 +A0221 +A0222 +A0223 +A0224 +A0225 +A0226 +A0227 +A0228 +A0229 +A0230 +A0231 +A0232 +A0233 +A0234 +A0235 +A0236 +A0237 +A0238 +A0239 +A0240 +A0241 +A0242 +A0243 +A0244 +A0245 +A0246 +A0247 +A0248 +A0249 +A0250 +A0251 +A0252 +A0253 +A0254 +A0255 +A0256 +A0257 +A0258 +A0259 +A0260 +A0261 +A0262 +A0263 +A0264 +A0265 +A0266 +A0267 +A0268 +A0269 +A0270 +A0271 +A0272 +A0273 +A0274 +A0275 +A0276 +A0277 +A0278 +A0279 +A0280 +A0281 +A0282 +A0283 +A0284 +A0285 +A0286 +A0287 +A0288 +A0289 +A0290 +A0291 +A0292 +A0293 +A0294 +A0295 +A0296 +A0297 +A0298 +A0299 +A0300 +A0301 +A0302 +A0303 +A0304 +A0305 +A0306 +A0307 +A0308 +A0309 +A0310 +A0311 +A0312 +A0313 +A0314 +A0315 +A0316 +A0317 +A0318 +A0319 +A0320 +A0321 +A0322 +A0323 +A0324 +A0325 +A0326 +A0327 +A0328 +A0329 +A0330 +A0331 +A0332 +A0333 +A0334 +A0335 +A0336 +A0337 +A0338 +A0339 +A0340 +A0341 +A0342 +A0343 +A0344 +A0345 +A0346 +A0347 +A0348 +A0349 +A0350 +A0351 +A0352 +A0353 +A0354 +A0355 +A0356 +A0357 +A0358 +A0359 +A0360 +A0361 +A0362 +A0363 +A0364 +A0365 +A0366 +A0367 +A0368 +A0369 +A0370 +A0371 +A0372 +A0373 +A0374 +A0375 +A0376 +A0377 +A0378 +A0379 +A0380 +A0381 +A0382 +A0383 +A0384 +A0385 +A0386 +A0387 +A0388 +A0389 +A0390 +A0391 +A0392 +A0393 +A0394 +A0395 +A0396 +A0397 +A0398 +A0399 +A0400 +A0401 +A0402 +A0403 +A0404 +A0405 +A0406 +A0407 +A0408 +A0409 +A0410 +A0411 +A0412 +A0413 +A0414 +A0415 +A0416 +A0417 +A0418 +A0419 +A0420 +A0421 +A0422 +A0423 +A0424 +A0425 +A0426 +A0427 +A0428 +A0429 +A0430 +A0431 +A0432 +A0433 +A0434 +A0435 +A0436 +A0437 +A0438 +A0439 +A0440 +A0441 +A0442 +A0443 +A0444 +A0445 +A0446 +A0447 +A0448 +A0449 +A0450 +A0451 +A0452 +A0453 +A0454 +A0455 +A0456 +A0457 +A0458 +A0459 +A0460 +A0461 +A0462 +A0463 +A0464 +A0465 +A0466 +A0467 +A0468 +A0469 +A0470 +A0471 +A0472 +A0473 +A0474 +A0475 +A0476 +A0477 +A0478 +A0479 +A0480 +A0481 +A0482 +A0483 +A0484 +A0485 +A0486 +A0487 +A0488 +A0489 +A0490 +A0491 +A0492 +A0493 +A0494 +A0495 +A0496 +A0497 +A0498 +A0499 +A0500 +A0501 +A0502 +A0503 +A0504 +A0505 +A0506 +A0507 +A0508 +A0509 +A0510 +A0511 +A0512 +A0513 +A0514 +A0515 +A0516 +A0517 +A0518 +A0519 +A0520 +A0521 +A0522 +A0523 +A0524 +A0525 +A0526 +A0527 +A0528 +A0529 +A0530 +A0531 +A0532 +A0533 +A0534 +A0535 +A0536 +A0537 +A0538 +A0539 +A0540 +A0541 +A0542 +A0543 +A0544 +A0545 +A0546 +A0547 +A0548 +A0549 +A0550 +A0551 +A0552 +A0553 +A0554 +A0555 +A0556 +A0557 +A0558 +A0559 +A0560 +A0561 +A0562 +A0563 +A0564 +A0565 +A0566 +A0567 +A0568 +A0569 +A0570 +A0571 +A0572 +A0573 +A0574 +A0575 +A0576 +A0577 +A0578 +A0579 +A0580 +A0581 +A0582 +A0583 +A0584 +A0585 +A0586 +A0587 +A0588 +A0589 +A0590 +A0591 +A0592 +A0593 +A0594 +A0595 +A0596 +A0597 +A0598 +A0599 +A0600 diff --git a/api/Dockerfile b/api/Dockerfile new file mode 100644 index 0000000..37b2423 --- /dev/null +++ b/api/Dockerfile @@ -0,0 +1,11 @@ +# Se construye desde la RAÍZ del repo (el CI hace: docker build -f api/Dockerfile .) +FROM python:3.12-slim +WORKDIR /app +COPY api/requirements.txt . +RUN pip install --no-cache-dir -r requirements.txt +COPY api/ . +COPY alumnos.csv . +ENV DB_PATH=/data/votos.db CENSO_PATH=/app/alumnos.csv +RUN mkdir -p /data +EXPOSE 8000 +CMD ["gunicorn", "-b", "0.0.0.0:8000", "-w", "2", "--threads", "4", "app:app"] diff --git a/api/app.py b/api/app.py new file mode 100644 index 0000000..69c47bc --- /dev/null +++ b/api/app.py @@ -0,0 +1,64 @@ +"""API de la votación del viaje de fin de curso (Ibiza contra Praga). + +Esqueleto de partida: ARRANCA, pero no cumple el contrato (mirad CONTRATO.md y openapi.yaml). +Hay al menos un fallo de seguridad grave a propósito. Encontradlo antes que el árbitro. +""" +import csv +import os +import sqlite3 + +from flask import Flask, jsonify, request + +DB_PATH = os.environ.get("DB_PATH", "/data/votos.db") +CENSO_PATH = os.environ.get("CENSO_PATH", "alumnos.csv") +OPCIONES = ["Ibiza", "Praga"] + +app = Flask(__name__) + + +def conectar(): + con = sqlite3.connect(DB_PATH) + con.execute("CREATE TABLE IF NOT EXISTS votos (codigo TEXT, opcion TEXT)") + return con + + +def cargar_censo(): + with open(CENSO_PATH, newline="") as f: + return {fila["codigo"] for fila in csv.DictReader(f)} + + +CENSO = cargar_censo() + + +@app.get("/healthz") +def healthz(): + return "ok", 200 + + +@app.get("/api/opciones") +def opciones(): + return jsonify(OPCIONES) + + +@app.post("/api/votos") +def votar(): + datos = request.get_json(force=True) + codigo = datos["codigo"] + opcion = datos["opcion"] + # TODO nivel 2: un voto por alumno, solo alumnos del censo, solo opciones válidas + con = conectar() + con.execute(f"INSERT INTO votos VALUES ('{codigo}', '{opcion}')") + con.commit() + return jsonify({"ok": True}) # TODO nivel 1: ¿qué código HTTP pide el contrato? + + +@app.get("/api/resultados") +def resultados(): + con = conectar() + filas = con.execute("SELECT opcion, COUNT(*) FROM votos GROUP BY opcion").fetchall() + cuenta = {opcion: n for opcion, n in filas} + return jsonify(cuenta) # TODO nivel 1: faltan las opciones con 0 votos y el "total" + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000, debug=True) diff --git a/api/requirements.txt b/api/requirements.txt new file mode 100644 index 0000000..48df4bc --- /dev/null +++ b/api/requirements.txt @@ -0,0 +1,3 @@ +flask==3.1.2 +gunicorn==23.0.0 +pytest==8.4.2 diff --git a/api/tests/test_contrato.py b/api/tests/test_contrato.py new file mode 100644 index 0000000..6273dcb --- /dev/null +++ b/api/tests/test_contrato.py @@ -0,0 +1,46 @@ +"""Tests del contrato (niveles 1 y 2). NO los modifiquéis para que pasen: arreglad la API. +Ejecutar desde api/: python -m pytest -q +""" +import importlib +import sys +from pathlib import Path + +import pytest + +API_DIR = Path(__file__).resolve().parents[1] +sys.path.insert(0, str(API_DIR)) + + +@pytest.fixture() +def cliente(tmp_path, monkeypatch): + monkeypatch.setenv("DB_PATH", str(tmp_path / "votos.db")) + monkeypatch.setenv("CENSO_PATH", str(API_DIR.parent / "alumnos.csv")) + import app as modulo + importlib.reload(modulo) + return modulo.app.test_client() + + +def test_opciones(cliente): + assert cliente.get("/api/opciones").get_json() == ["Ibiza", "Praga"] + + +def test_nivel1_voto_valido_cuenta(cliente): + r = cliente.post("/api/votos", json={"codigo": "A0001", "opcion": "Ibiza"}) + assert r.status_code == 201 + assert cliente.get("/api/resultados").get_json() == {"Ibiza": 1, "Praga": 0, "total": 1} + + +def test_nivel2_repetir_codigo_da_409(cliente): + cliente.post("/api/votos", json={"codigo": "A0002", "opcion": "Praga"}) + r = cliente.post("/api/votos", json={"codigo": "A0002", "opcion": "Ibiza"}) + assert r.status_code == 409 + + +def test_nivel2_codigo_fuera_del_censo_da_403(cliente): + r = cliente.post("/api/votos", json={"codigo": "Z9999", "opcion": "Ibiza"}) + assert r.status_code == 403 + + +def test_nivel2_opcion_desconocida_da_400(cliente): + r = cliente.post("/api/votos", json={"codigo": "A0003", "opcion": "Roma"}) + assert r.status_code == 400 diff --git a/k8s/api.yaml b/k8s/api.yaml new file mode 100644 index 0000000..52bdba7 --- /dev/null +++ b/k8s/api.yaml @@ -0,0 +1,73 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: api + labels: {app: api} +spec: + replicas: 1 + selector: + matchLabels: {app: api} + template: + metadata: + labels: {app: api} + spec: + containers: + - name: api + image: api + ports: + - containerPort: 8000 + readinessProbe: + httpGet: {path: /healthz, port: 8000} + periodSeconds: 3 + resources: + requests: {cpu: 50m, memory: 96Mi} + limits: {cpu: "1", memory: 384Mi} + volumeMounts: + - {name: datos, mountPath: /data} + volumes: + # OJO: emptyDir se BORRA cuando muere el pod (y los votos con él). Salidas posibles: + # (a) Un PVC: descomenta el PersistentVolumeClaim de abajo y cambia este volumen por + # persistentVolumeClaim: {claimName: votos} + # y añade al Deployment "strategy: {type: Recreate}" (el disco solo se monta en un pod a la vez). + # (b) Postgres en su propio Deployment con PVC, y la API conectándose a él. + - name: datos + emptyDir: {} +--- +# apiVersion: v1 +# kind: PersistentVolumeClaim +# metadata: +# name: votos +# spec: +# accessModes: ["ReadWriteOnce"] +# resources: +# requests: +# storage: 1Gi +# --- +apiVersion: v1 +kind: Service +metadata: + name: api +spec: + selector: {app: api} + ports: + - {port: 80, targetPort: 8000} +--- +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: api + annotations: + cert-manager.io/cluster-issuer: letsencrypt +spec: + ingressClassName: traefik + tls: + - hosts: ["escuadron-4-api.tallerprompt.org"] + secretName: api-tls + rules: + - host: escuadron-4-api.tallerprompt.org + http: + paths: + - path: / + pathType: Prefix + backend: + service: {name: api, port: {number: 80}} diff --git a/k8s/kustomization.yaml b/k8s/kustomization.yaml new file mode 100644 index 0000000..3ccb0b3 --- /dev/null +++ b/k8s/kustomization.yaml @@ -0,0 +1,13 @@ +# Lo aplica Argo CD en el namespace escuadron-4. El CI actualiza "newTag" en cada push a main. +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization +resources: + - api.yaml + - web.yaml +images: + - name: api + newName: gitea.tallerprompt.org/taller/escuadron-4/api + newTag: "inicial" + - name: web + newName: gitea.tallerprompt.org/taller/escuadron-4/web + newTag: "inicial" diff --git a/k8s/web.yaml b/k8s/web.yaml new file mode 100644 index 0000000..3e2d592 --- /dev/null +++ b/k8s/web.yaml @@ -0,0 +1,53 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: web + labels: {app: web} +spec: + replicas: 1 + selector: + matchLabels: {app: web} + template: + metadata: + labels: {app: web} + spec: + containers: + - name: web + image: web + ports: + - containerPort: 8080 + readinessProbe: + httpGet: {path: /healthz, port: 8080} + periodSeconds: 3 + resources: + requests: {cpu: 10m, memory: 16Mi} + limits: {cpu: 200m, memory: 64Mi} +--- +apiVersion: v1 +kind: Service +metadata: + name: web +spec: + selector: {app: web} + ports: + - {port: 80, targetPort: 8080} +--- +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: web + annotations: + cert-manager.io/cluster-issuer: letsencrypt +spec: + ingressClassName: traefik + tls: + - hosts: ["escuadron-4-web.tallerprompt.org"] + secretName: web-tls + rules: + - host: escuadron-4-web.tallerprompt.org + http: + paths: + - path: / + pathType: Prefix + backend: + service: {name: web, port: {number: 80}} diff --git a/openapi.yaml b/openapi.yaml new file mode 100644 index 0000000..b6013d2 --- /dev/null +++ b/openapi.yaml @@ -0,0 +1,60 @@ +openapi: 3.0.3 +info: + title: Votación del viaje de fin de curso + version: "1.0" + description: Contrato común entre la web y la API de cada escuadrón. +paths: + /api/opciones: + get: + summary: Opciones de viaje + responses: + "200": + description: Lista de opciones + content: + application/json: + schema: {type: array, items: {type: string}, example: ["Ibiza", "Praga"]} + /api/votos: + post: + summary: Emitir un voto + requestBody: + required: true + content: + application/json: + schema: + type: object + required: [codigo, opcion] + properties: + codigo: {type: string, example: "A0001"} + opcion: {type: string, example: "Ibiza"} + responses: + "201": {description: Voto guardado} + "400": {description: Opción no válida (o cuerpo mal formado), content: {application/json: {schema: {$ref: "#/components/schemas/Error"}}}} + "403": {description: Código fuera del censo, content: {application/json: {schema: {$ref: "#/components/schemas/Error"}}}} + "409": {description: Ese código ya ha votado, content: {application/json: {schema: {$ref: "#/components/schemas/Error"}}}} + /api/resultados: + get: + summary: Recuento + responses: + "200": + description: Votos por opción y total + content: + application/json: + schema: + type: object + required: [Ibiza, Praga, total] + properties: + Ibiza: {type: integer} + Praga: {type: integer} + total: {type: integer} + example: {Ibiza: 12, Praga: 3, total: 15} + /healthz: + get: + summary: Salud + responses: + "200": {description: La API está viva} +components: + schemas: + Error: + type: object + properties: + error: {type: string, example: "Ese código ya ha votado"} diff --git a/web/Dockerfile b/web/Dockerfile new file mode 100644 index 0000000..be8be76 --- /dev/null +++ b/web/Dockerfile @@ -0,0 +1,4 @@ +FROM nginx:1.29-alpine +COPY nginx.conf /etc/nginx/conf.d/default.conf +COPY . /usr/share/nginx/html +EXPOSE 8080 diff --git a/web/app.js b/web/app.js new file mode 100644 index 0000000..fdb8fea --- /dev/null +++ b/web/app.js @@ -0,0 +1,22 @@ +// Web de la votación. Esqueleto: muestra los resultados, pero votar aún no está hecho. +const API = window.API_URL; + +async function cargarResultados() { + const caja = document.getElementById("resultados"); + try { + const respuesta = await fetch(`${API}/api/resultados`); + const datos = await respuesta.json(); + caja.textContent = JSON.stringify(datos); + } catch (error) { + caja.textContent = "No se pueden cargar los resultados (¿está la API en marcha? ¿CORS?)"; + } +} + +// TODO (equipo web): pintar las opciones de /api/opciones, enviar el voto con POST /api/votos +// y explicar al usuario cada respuesta del contrato (201, 400, 403, 409). +document.getElementById("formulario-voto").addEventListener("submit", (evento) => { + evento.preventDefault(); + document.getElementById("mensaje").textContent = "Votar todavía no funciona."; +}); + +cargarResultados(); diff --git a/web/config.js b/web/config.js new file mode 100644 index 0000000..e4a0182 --- /dev/null +++ b/web/config.js @@ -0,0 +1,2 @@ +// Dirección de la API de vuestro escuadrón. La genera el taller; no hace falta tocarla. +window.API_URL = "https://escuadron-4-api.tallerprompt.org"; diff --git a/web/index.html b/web/index.html new file mode 100644 index 0000000..7717932 --- /dev/null +++ b/web/index.html @@ -0,0 +1,29 @@ + + + + + + Viaje de fin de curso + + + +
+

¿Ibiza o Praga?

+

Vota el destino del viaje de fin de curso. Un voto por alumno.

+ + +
+ + +
+ +
+

+ +

Resultados

+
Cargando…
+
+ + + + diff --git a/web/nginx.conf b/web/nginx.conf new file mode 100644 index 0000000..69f0ba5 --- /dev/null +++ b/web/nginx.conf @@ -0,0 +1,6 @@ +server { + listen 8080; + root /usr/share/nginx/html; + location = /healthz { return 200 "ok"; } + location / { try_files $uri $uri/ /index.html; } +} diff --git a/web/style.css b/web/style.css new file mode 100644 index 0000000..1fa9fcd --- /dev/null +++ b/web/style.css @@ -0,0 +1,4 @@ +body { font-family: system-ui, sans-serif; margin: 0; background: #f6f7f9; color: #1d2433; } +main { max-width: 32rem; margin: 2rem auto; padding: 0 1rem; } +form { display: grid; gap: .5rem; margin: 1rem 0; } +input, button { font: inherit; padding: .5rem; }