Vai al contenuto
code-to-code

Apro l'indice…

↑ ↓ per scegliere, Invio per aprire, Esc per chiudere

HTTP e API8. Il contrattop. 251

Il contratto, se qualcosa va storto

I messaggi dei test, uno per uno

Gli errori che vedrai di più in questo capitolo. Quasi tutti arrivano dai test, che leggono il contratto. Si leggono dal basso, come un traceback: la riga AssertionError: dice quale rotta e cosa non torna; la riga assert sotto dice cosa ha trovato il test al posto di quello che cercava.

Per esempio, con il controllo degli estintori scritto come POST /estintori/{estintore_id}/controllo:

E                   AssertionError: POST /estintori/{estintore_id}/controllo: «controllo» non è una cosa del canvas (estintori). Le cose vanno al plurale, e l'azione la dice il verbo
E                   assert (False or 'controllo' in {'estintori'})

palestra/test_estintori.py:101: AssertionError

Il pezzo controllo non è tra graffe (False) e non è una cosa del canvas: è un verbo, e il suo posto è il verbo HTTP.

LeggiVuol direCosa fai
AssertionError: Registrare un estintore nuovo: POST /estintori e sotto assert None is not NoneIl test ha cercato quella rotta nel contratto e ha trovato None: manca, oppure il verbo o il percorso sono diversiConfronta il decoratore con il messaggio, lettera per lettera: il verbo, il plurale, la barra in fondo
… non è una cosa del canvas …Nel percorso c'è un pezzo fisso che non è una cosa del riquadro 6: un verbo, un singolare, un filtroIl verbo va nel verbo HTTP, il filtro nella query, la cosa al plurale
… tra graffe va solo un id, e un id è un numero … e assert 'string' == 'integer'Tra graffe c'è un filtro (/interventi/{stato}), oppure l'id è senza intUn id: intervento_id: int. Un filtro: fuori dal percorso, nel def con = None
… il nome tra graffe va anche nel def, uguale lettera per lettera e assert [] == ['estintore_id']{estintore_id} nel decoratore e id nel def: FastAPI non li collega, e id finisce nella queryLo stesso nome nei due posti
… solo minuscole, numeri e trattini, e niente barra in fondoUna maiuscola, un trattino basso, o la barra alla fine: /estintori//estintori, tutto minuscolo
… una GET non ha il corpo …Nel def di una GET (o di una DELETE) c'è uno stampo, e FastAPI lo legge come corpoI dati per cercare vanno nella query; lo stampo serve alla POST e alla PUT
Ha creato qualcosa: status_code=status.HTTP_201_CREATED nel decoratoreLa POST promette un 200status_code= nel decoratore. Per la DELETE: status.HTTP_204_NO_CONTENT
assert 'Estintore' == 'EstintoreNuovo'Nel corpo c'è lo stampo con l'iddati: EstintoreNuovo: l'id lo sceglie il server, o sta già nel percorso
assert 'Estintore' == 'list[Estintore]'La freccia dice «uno» dove torna una lista. Oppure ci sono due rotte con lo stesso verbo e percorso (qui sotto)-> list[Estintore]; e cerca il doppione
assert 'niente' == 'Estintore'Nel def manca la freccia: il contratto non sa cosa torna-> Estintore, -> list[Estintore], oppure -> None
assert '409' in …Il 409 non è nel contrattoresponses={409: {"description": "Posti esauriti"}} nel decoratore
Il contratto è vuoto: non c'è ancora nessuna rottaNel file non c'è ancora nessuna rottaComincia dalla prima azione del canvas
ERROR collecting e AssertionError: Status code 204 must not have a response bodyUna rotta con il 204 non può restituire niente, ma la freccia dice -> Estintore. FastAPI si ferma già mentre legge il file, prima di ogni test-> None

L'ultima è l'unica che non viene dai test ma da FastAPI. Si legge dal basso, e la riga del tuo file è quella con il decoratore:

palestra/estintori.py:68: in <module>
    @app.delete("/estintori/{estintore_id}", status_code=status.HTTP_204_NO_CONTENT)
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
…
E   AssertionError: Status code 204 must not have a response body

Gli errori che non danno errori

Due rotte con lo stesso verbo e lo stesso percorso. Python non dice niente, il server parte. Quando chiami, risponde la prima; il contratto, e quindi /docs, mostra la seconda. Succede quando l'id finisce nella query: @app.get("/estintori") scritto due volte, una per la lista e una per «un estintore». Se ne accorgono i test, perché leggono il contratto:

E       AssertionError: Torna la lista degli estintori: -> list[Estintore]
E       assert 'Estintore' == 'list[Estintore]'

La lista dice di restituire un estintore solo: è la scheda della seconda rotta. Cerca nel file il decoratore ripetuto (Cmd+F, su Windows Ctrl+F) e rimetti l'id nel percorso.

Il 501 da curl o da /docs. Non è un errore: dentro le rotte del contratto c'è solo la riga del 501. Il codice arriva dopo.

Un 422 o un 404 da una rotta del contratto. Non è un errore neanche questo: FastAPI controlla l'id, la query e il corpo prima di entrare nella funzione, e un percorso che non è nel contratto non esiste. È l'esempio C degli esercizi spiegati.

/docs mostra 200 dove volevi 201. Sotto Responses c'è 200 Successful Response: nel decoratore manca status_code=.

/docs non mostra il Request body. Nel def della POST o della PUT manca lo stampo. E se il Request body compare in una GET, lo stampo è nel posto sbagliato.

«login: sì» non protegge niente. È un commento, un promemoria per quando arriverà il login: Login e rotte protette. Per ora chiunque chiami la rotta riceve il 501.

I test sono verdi, ma la tabella dice un'altra cosa. I test controllano il contratto in FastAPI, non ROTTE.md. Rileggile insieme, una riga accanto all'altra: devono dire la stessa cosa.

Se il problema non è il codice

pytest: command not found, No module named pytest, No module named 'estintori', il pannello Testing vuoto: non è il tuo contratto, è l'ambiente. Ha una pagina sua nel Pronto soccorso: pytest non parte, o non trova niente. Per command not found: fastapi, Address already in use e /docs che da Windows non si apre, cerca il messaggio nel Pronto soccorso, sezione FastAPI.