La chiave, la palestra
Otto esercizi da scaricare, con i test
- 90–120 minuti di lavoro
Otto esercizi, dal ★ al ★★★, tutti sulla stessa idea: una chiave nell'header, e un controllore che la guarda. Cambiano la storia e il pezzo che scrivi: fare la chiave, leggerla dall'ambiente, mandarla, controllarla, proteggere una rotta, tenere più chiavi, proteggere due rotte e non la terza, dare a una chiave il permesso di leggere ma non di scrivere. In ogni esercizio hai già pronto quasi tutto: scrivi una cosa sola.
Gli esercizi da scaricare
Una cartella con i file da completare e i test già pronti. Come si usa: la guida in cinque passi.
Prima di iniziare
Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install, code .. I test usano chiavi loro e non hanno bisogno del file .env: serve solo se accendi un'API con fastapi dev per provarla dal vivo (il README dice come, in una riga).
Ogni esercizio, sempre gli stessi quattro passi:
- Apri il file in
palestra/. In alto: la storia, cosa fai, come provi. - Al posto di
pass(o della rigaraise HTTPException(status_code=501, …)) scrivi il codice. In commento, sopra, trovi cosa deve rispondere ogni caso. pytest palestra/test_<nome>.py -v, oppure la provetta di VS Code.- Rosso? Leggi l'ultima riga del messaggio: dice cosa fare. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.
7 allenatori, poi il capopalestra
I test di una sfida sono verdi? Tocca il suo pallino: è battuta.
- 1Fare la chiave
secrets.token_hex, la riga del.env★allenatore - 2La chiave dall'ambiente
os.environ, un errore chiaro★allenatore - 3Il programma che chiama
headers={"X-API-Key": …}★★allenatore - 4Il controllorei due 401, il
return★★allenatore - 5La rotta protetta
Depends(controlla_chiave)★allenatore - 6Una chiave per programmadizionario
chiave → chi è★★allenatore - 7Un controllore, due rotteproteggere due rotte su tre★★allenatore
- 8Una chiave che legge, una che scriveil 403★★★capopalestra
La medaglia · La chiave: API Key
0 su 8: si accende quando le hai battute tutte.
1 · Fare la chiave ★
palestra/genera_chiave.py
Ponte Ciclo, il sistema delle biciclette in prestito, vuole far leggere le sue colonnine all'app Sella Verde. Serve una chiave: lunga, a caso, mai uguale a quella di prima. Scrivi due funzioni: una fa la chiave, l'altra la riga da mettere nel .env.
fai_chiave() # "3f9c4e7a1b6d0e83c5a2f4b7d9e1c3a5" 32 caratteri, cifre e lettere da a a f
riga_env("CHIAVE_SELLA_VERDE") # "CHIAVE_SELLA_VERDE=3f9c4e7a1b6d0e83c5a2f4b7d9e1c3a5"Come provi: pytest palestra/test_genera_chiave.py -v
Aiutino 1
secrets, e va importato. Non random: un test controlla anche questo.Aiutino 2
secrets.token_hex(16) dà proprio 32 caratteri esadecimali. Lo hai visto nell'esempio A degli esercizi spiegati.Aiutino 3
riga_env non deve rifare la chiave per conto suo: chiama fai_chiave() e mette il nome, un uguale e la chiave. Niente spazi.2 · La chiave dall'ambiente ★
palestra/ambiente.py
Il tabellone di Piazza Query chiede i ritardi al server della Linea Menta, e per farlo gli serve la sua chiave. La chiave sta nel .env. Se manca, il tabellone deve dirlo chiaro subito, non partire e rompersi dopo. Scrivi chiave_dal_ambiente(nome).
la variabile c'è → restituisce il suo valore, com'è
la variabile non c'è, o è vuota → RuntimeError("Manca CHIAVE_RITARDI: crea il file .env")Il nome nel messaggio è quello che ti passano, non sempre CHIAVE_RITARDI.
Come provi: pytest palestra/test_ambiente.py -v
Aiutino 1
os.environ è un dizionario. Quale lettura non si ferma con un errore se la chiave manca? Lo sai dai dizionari.Aiutino 2
os.environ.get(nome) dà None se non c'è. E se c'è ma è vuota, dà "". Una stringa vuota e None hanno qualcosa in comune quando li metti in un if.Aiutino 3
if not chiave: è vero sia per None sia per "". Dentro, il raise RuntimeError(f"Manca {nome}: crea il file .env").3 · Il programma che chiama ★★
palestra/client_ritardi.py
Il tabellone di Piazza Query è il client: il server dei ritardi apre solo a chi manda la chiave nell'header X-API-Key. Il server, qui, è finto ma risponde come uno vero: lo trovi già nel file. Scrivi le due funzioni del tabellone.
chiedi_ritardi(client, chiave) → GET /ritardi con la chiave nell'header; restituisce la risposta intera, anche se è un 401
ritardo_massimo(client, chiave) → i minuti del treno più in ritardo
se la risposta non è 200: RuntimeError("Il server ha risposto 401")Come provi: pytest palestra/test_client_ritardi.py -v
Aiutino 1
client.get("/ritardi", headers={…}): headers è un dizionario con il nome dell'header e il valore.Aiutino 2
X-API-Key, il valore la chiave. Non nell'indirizzo e non in Authorization: quello è un altro capitolo.Aiutino 3
ritardo_massimo chiama chiedi_ritardi, guarda risposta.status_code, e solo se è 200 calcola il massimo dei minuti in risposta.json() (una lista di dizionari). Se guardi il codice prima di usare il corpo, la chiave sbagliata non ti rompe il programma.4 · Il controllore ★★
palestra/controllore.py
Ponte Ciclo ha un'API con le biciclette libere in ogni stazione, e vuole farla leggere solo a Sella Verde, che ha la sua chiave. Alla porta manca il controllore: GET /biciclette c'è già, ma controlla_chiave risponde 501 a tutti. Scrivilo tu.
header X-API-Key assente (chiave vale None) → 401 "Manca la chiave"
chiave diversa da quella nel .env (anche vuota) → 401 "Chiave sbagliata"
chiave giusta → restituisce "App Sella Verde"Come provi: pytest palestra/test_controllore.py -v
Aiutino 1
raise HTTPException(status_code=401, …).Aiutino 2
chiave is None. Un header vuoto non è assente: è "", quindi per lui il messaggio è «Chiave sbagliata».Aiutino 3
CHIAVE_PONTE_CICLO. Dopo le due domande, return CLIENTE: è quello che arriva alla rotta.5 · La rotta protetta ★
palestra/rotta_protetta.py
Taxi Cobalto, un'azienda di taxi, manda le sue auto fuori da Porta Codice, e per sapere quali uscite sono aperte chiede GET /uscite con la sua chiave. Il controllore è pronto, ma la rotta non lo usa: risponde a chiunque. Cambia la rotta, e fai dire alla risposta chi ha chiesto.
senza chiave, o con la chiave sbagliata → 401, e la rotta non parte
chiave giusta → 200 {"cliente": "Taxi Cobalto", "uscite": {...}}Come provi: pytest palestra/test_rotta_protetta.py -v
Aiutino 1
controlla_chiave, che c'è già. A te serve solo chiamarlo.Aiutino 2
Depends. La forma è nome: str = Depends(funzione), senza parentesi dopo il nome della funzione.Aiutino 3
"nessuno", scrivi il nome del parametro.6 · Una chiave per programma ★★
palestra/piu_chiavi.py
Il calendario delle manutenzioni lo leggono tre officine, e ognuna ha la sua chiave (nel dizionario CHIAVI). Se l'Officina Sud perde la sua, la si toglie dall'elenco e le altre due continuano. Questa volta scrivi tutto il controllore, firma compresa: la rotta è già fatta.
header assente → 401 "Manca la chiave"
chiave che non è nel dizionario CHIAVI → 401 "Chiave sbagliata"
chiave del dizionario → restituisce l'officina di quella chiaveCome provi: pytest palestra/test_piu_chiavi.py -v
Aiutino 1
chiave, di tipo str | None, che viene dall'header. Ripassala dalla teoria: ci sono Header, default=None e alias.Aiutino 2
CHIAVI.get(chiave) dà l'officina, oppure None se la chiave non c'è. Con le quadre sarebbe un KeyError, cioè un 500.Aiutino 3
CHIAVI dentro la funzione, a ogni richiesta, e non farne una copia all'inizio del file.7 · Un controllore, due rotte ★★
palestra/due_rotte.py
L'ufficio oggetti smarriti ha tre rotte. Il programma interno (con la chiave) legge l'elenco e il singolo oggetto. L'orario di apertura lo può leggere chiunque. Il controllore c'è già: due rotte su tre lo aspettano, una no. Trova quali.
GET /orari → chiunque, senza chiave → 200
GET /smarriti → solo con la chiave giusta → 200, altrimenti 401
GET /smarriti/{numero} → solo con la chiave giusta → 200; 404 se non c'è; senza chiave 401Come provi: pytest palestra/test_due_rotte.py -v
Aiutino 1
if dentro le rotte. Serve il parametro con Depends, come nell'esercizio 5, in due rotte.Aiutino 2
/orari non si tocca: se la proteggi, chi vuole sapere quando apre l'ufficio prende un 401.Aiutino 3
/smarriti/99 senza chiave: deve rispondere 401, non 404. Non devi scrivere niente: il controllore parte prima della rotta, e la ferma lui. Se vedi 404, la rotta non ha il suo Depends.8 · Una chiave che legge, una che scrive ★★★
palestra/sola_lettura.py
Il deposito bagagli di Porta Codice ha gli armadietti. L'app dei viaggiatori può solo guardare quali sono liberi; il banco bagagli deve anche poterli liberare. Due chiavi, due permessi: nel dizionario CHIAVI, ogni chiave ha "scrive": False o True. Il controllore e la rotta di lettura ci sono già. Scrivi POST /armadietti/{numero}/libera.
chiave che non può scrivere → 403 "Questa chiave non può scrivere"
armadietto che non c'è (chiave che può) → 404 "Armadietto non trovato"
altrimenti: l'armadietto diventa "libero" → 200 {"numero": "A2", "stato": "libero"}Il 401 (senza chiave, o chiave sbagliata) lo manda già il controllore. Il 403 è nuovo: «so chi sei, ma questo non lo puoi fare». Il capitolo sui permessiin arrivo lo spiega a fondo; qui è un assaggio.
Come provi: pytest palestra/test_sola_lettura.py -v
Aiutino 1
programma è già il dizionario della chiave: programma["scrive"] dice True o False.Aiutino 2
Aiutino 3
"scrive": True e un nome mai visto, e si aspetta che funzioni. Se confronti il nome di chi chiama invece del permesso, non passa.