Vai al contenuto
code-to-code

Apro l'indice…

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

Codice pulito e test4. Prima il testp. 103

Prima il test, esercizi spiegati

Un ping-pong intero, turno per turno

  • 25 minuti di lettura

Cinque scene dello stesso ping-pong. Lucia Ferri, la capotreno, e Ivo Brambati, il manutentore, devono scrivere la funzione annuncio del tabellone di Largo Lista: dato un treno e i minuti che mancano, la frase da mostrare.

Le regole dell'annuncio, tutte da scoprire un test alla volta:

MinutiAnnuncio
0Il treno M12 è in arrivo.
1Il treno M12 arriva tra 1 minuto.
2 o piùIl treno M12 arriva tra 5 minuti.
meno di 0, o treno senza codiceun errore (ValueError)

Ogni scena ha lo stesso ritmo:

  1. Prevedi: leggi e scrivi su un foglio cosa dice pytest. Prima di aprire la risposta.
  2. In italiano: cosa succede, a parole.
  3. Passo per passo: chi fa cosa, nel giro.
  4. Cosa portiamo a casa: la cosa da ricordare.

I file sono due: test_annunci.py e annunci.py. I ruoli si scambiano a ogni rosso. Tutti gli output sono usciti davvero da pytest. Tolta solo l'intestazione con i percorsi del computer.


A · Il primo rosso (e quello sbagliato)

Lucia scrive il primo test. Il file annunci.py non c'è ancora.

Python
from annunci import annuncio


def test_con_zero_minuti_il_treno_e_in_arrivo():
    assert annuncio("M12", 0) == "Il treno M12 è in arrivo."
Terminale
pytest -v test_annunci.py
Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.
collecting ... collected 0 items / 1 error

==================================== ERRORS ====================================
_______________________ ERROR collecting test_annunci.py _______________________
Traceback:
test_annunci.py:1: in <module>
    from annunci import annuncio
E   ModuleNotFoundError: No module named 'annunci'
=========================== short test summary info ============================
ERROR test_annunci.py
!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
=============================== 1 error in 0.04s ===============================

Rosso, sì. Ma collected 0 items / 1 error: nessun test è partito. Il rosso è sbagliato.

In italiano. Il test chiede una funzione che non esiste. Non ha ancora parlato del codice, ha solo detto «manca il file». Tocca a Ivo creare la funzione, ma vuota: serve solo a far partire il test.

Python
def annuncio(treno, minuti):
    pass
Terminale
pytest -v test_annunci.py
collecting ... collected 1 item

test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo FAILED        [100%]

=================================== FAILURES ===================================
__________________ test_con_zero_minuti_il_treno_e_in_arrivo ___________________

    def test_con_zero_minuti_il_treno_e_in_arrivo():
>       assert annuncio("M12", 0) == "Il treno M12 è in arrivo."
E       AssertionError: assert None == 'Il treno M12 è in arrivo.'
E        +  where None = annuncio('M12', 0)

test_annunci.py:5: AssertionError
=========================== short test summary info ============================
FAILED test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo - Assertion...
============================== 1 failed in 0.01s ===============================

Adesso è il rosso giusto: collected 1 item, il test è partito, e la riga E dice quello che manca: la funzione dà None, e la frase non c'è.

Il disegno.

inizio scrivi un test lancia pytest se il test non parte sì: passo sistema l'import, funzione vuota finché il test è rosso passo scrivi il codice minimo lancia pytest passo pulisci, a test verdi passo commitscrivi un testlancia pytestil test non partesistema l'import, funzionevuotail test è rossoscrivi il codice minimolancia pytestpulisci, a test verdicommitnosìsìno
Il giro del ping-pong

Passo per passo.

TurnoChiCosapytest
1LuciaScrive il test1 errore: manca annunci
2Ivodef annuncio con pass1 rosso: None al posto della frase

Cosa portiamo a casa. Il primo rosso si guarda, non si dà per buono. Se pytest dice error o collected 0 items, il test non è partito: si sistema l'import, e solo poi si va avanti.


B · Il verde che bara, e il secondo test che lo smaschera

Ivo scrive il codice minimo per il primo test.

Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.

Qual è il codice più corto che fa passare questo test, e solo questo?

Python
def annuncio(treno, minuti):
    return "Il treno M12 è in arrivo."

La frase fissa. Il test chiede proprio quella.

collecting ... collected 1 item

test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo PASSED        [100%]

============================== 1 passed in 0.00s ===============================

Verde. Ivo fa un commit (Primo test: il treno in arrivo). Poi i ruoli si scambiano: tocca a Ivo scrivere il test, e a Lucia il codice. Ivo prova un altro treno.

Python
def test_il_codice_del_treno_cambia_nell_annuncio():
    assert annuncio("T28", 0) == "Il treno T28 è in arrivo."
Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.

Con il codice che bara, cosa succede a questo test?

test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo PASSED        [ 50%]
test_annunci.py::test_il_codice_del_treno_cambia_nell_annuncio FAILED    [100%]

>       assert annuncio("T28", 0) == "Il treno T28 è in arrivo."
E       AssertionError: assert 'Il treno M12 è in arrivo.' == 'Il treno T28 è in arrivo.'
E         
E         - Il treno T28 è in arrivo.
E         ?          ^ -
E         + Il treno M12 è in arrivo.
E         ?          ^^

========================= 1 failed, 1 passed in 0.01s ==========================

Un rosso solo, quello nuovo; il primo test resta verde. Le righe con ^ mostrano dove le due frasi sono diverse: il codice del treno.

In italiano. La frase fissa non basta più: il codice del treno deve entrare nella frase. Lucia scrive il minimo per farlo:

Python
def annuncio(treno, minuti):
    return f"Il treno {treno} è in arrivo."
test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo PASSED        [ 50%]
test_annunci.py::test_il_codice_del_treno_cambia_nell_annuncio PASSED    [100%]

============================== 2 passed in 0.00s ===============================

Passo per passo.

TurnoChiCosapytest
3IvoIl codice con la frase fissaverde (bara)
4IvoTest per T28rosso: M12 al posto di T28
5LuciaLa f-string con {treno}verde

Cosa portiamo a casa. Il secondo test costringe il codice a crescere. E il verde che «bara» non è un difetto: è il modo più sicuro di partire, perché ogni passo è provato.


C · Il test che nasce verde

Lucia vuole ora il caso «mancano cinque minuti».

Python
def test_con_cinque_minuti_si_dice_quanto_manca():
    assert annuncio("M12", 5) == "Il treno M12 arriva tra 5 minuti."
Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.
test_annunci.py::test_con_cinque_minuti_si_dice_quanto_manca FAILED      [100%]

>       assert annuncio("M12", 5) == "Il treno M12 arriva tra 5 minuti."
E       AssertionError: assert 'Il treno M12 è in arrivo.' == 'Il treno M12...tra 5 minuti.'
E         
E         - Il treno M12 arriva tra 5 minuti.
E         + Il treno M12 è in arrivo.

========================= 1 failed, 2 passed in 0.01s ==========================

Rosso per il motivo giusto: il codice risponde sempre «è in arrivo», anche con cinque minuti.

Ivo (tocca a lui il codice) aggiunge un ramo e lascia il resto:

Python
def annuncio(treno, minuti):
    if minuti == 0:
        return f"Il treno {treno} è in arrivo."
    return f"Il treno {treno} arriva tra {minuti} minuti."

Verde (3 passed). Si scambiano i ruoli: Ivo scrive il test per il singolare.

Python
def test_con_un_minuto_si_dice_minuto_al_singolare():
    assert annuncio("M12", 1) == "Il treno M12 arriva tra 1 minuto."

Rosso, e anche stavolta per il motivo giusto:

E       AssertionError: assert 'Il treno M12...tra 1 minuti.' == 'Il treno M12...tra 1 minuto.'
E         
E         - Il treno M12 arriva tra 1 minuto.
E         ?                                ^
E         + Il treno M12 arriva tra 1 minuti.
E         ?                                ^

Lucia aggiunge il caso, minimo:

Python
def annuncio(treno, minuti):
    if minuti == 0:
        return f"Il treno {treno} è in arrivo."
    if minuti == 1:
        return f"Il treno {treno} arriva tra 1 minuto."
    return f"Il treno {treno} arriva tra {minuti} minuti."

Verde (4 passed). Ora Lucia vuole essere sicura che il plurale regga anche subito dopo il singolare:

Python
def test_con_due_minuti_si_torna_al_plurale():
    assert annuncio("M12", 2) == "Il treno M12 arriva tra 2 minuti."
Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.

Questo test è rosso o verde, senza toccare il codice?

test_annunci.py::test_con_due_minuti_si_torna_al_plurale PASSED          [100%]

============================== 5 passed in 0.00s ===============================

Verde subito. Il codice già gestiva i due minuti: con 2 non scatta né il ramo dello 0 né quello dell'1, e si arriva alla riga con {minuti} minuti.

In italiano. Un test che nasce verde dice una di due cose: o il codice faceva già quello che chiedevi, o il test non prova niente di nuovo. Qui è la prima. Lucia lo tiene lo stesso, per un buon motivo: documenta il confine tra singolare e plurale, e proteggerà il codice quando Ivo lo pulirà.

Passo per passo.

TurnoChiCosapytest
6LuciaTest con 5 minutirosso: «è in arrivo»
7Ivoif minuti == 0 e il ramo generaleverde
8IvoTest con 1 minutorosso: minuti al posto di minuto
9Luciaif minuti == 1verde
10LuciaTest con 2 minutiverde subito

Cosa portiamo a casa. Un test che nasce verde non è un errore, ma una domanda: «mi serve?». Se serve a segnare un confine, si tiene. Se non prova niente di nuovo, si cancella.


D · Pulisci, solo sul verde

Cinque test verdi. Lucia e Ivo guardano il codice con gli occhi delle sette regole:

Python
def annuncio(treno, minuti):
    if minuti == 0:
        return f"Il treno {treno} è in arrivo."
    if minuti == 1:
        return f"Il treno {treno} arriva tra 1 minuto."
    return f"Il treno {treno} arriva tra {minuti} minuti."
Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.

Cosa cambieresti? Cerca la cosa ripetuta.

La frase Il treno {treno} arriva tra … compare due volte, e cambia solo la parola «minuto» o «minuti». Il resto è uguale: è un pezzo che si può tirare fuori. Mancano anche i tipi e la docstring.

Un cambiamento alla volta, con pytest dopo ognuno. Il codice, pulito:

Python
def annuncio(treno: str, minuti: int) -> str:
    """L'annuncio del tabellone per un treno che arriva tra `minuti` minuti."""
    if minuti == 0:
        return f"Il treno {treno} è in arrivo."
    parola = "minuti"
    if minuti == 1:
        parola = "minuto"
    return f"Il treno {treno} arriva tra {minuti} {parola}."

Il disegno.

inizio annuncio(treno, minuti) se minuti == 0 sì: restituisci Il treno è in arrivo parola = "minuti" se minuti == 1 sì: parola = "minuto" restituisci arriva tra minuti parolaannuncio(treno, minuti)minuti == 0restituisci Il treno è inarrivoparola = "minuti"minuti == 1parola = "minuto"restituisci arriva traminuti parolanosìnosì
L'annuncio dopo la pulizia
collecting ... collected 5 items

test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo PASSED        [ 20%]
test_annunci.py::test_il_codice_del_treno_cambia_nell_annuncio PASSED    [ 40%]
test_annunci.py::test_con_cinque_minuti_si_dice_quanto_manca PASSED      [ 60%]
test_annunci.py::test_con_un_minuto_si_dice_minuto_al_singolare PASSED   [ 80%]
test_annunci.py::test_con_due_minuti_si_torna_al_plurale PASSED          [100%]

============================== 5 passed in 0.00s ===============================

Tutto verde. Le regole di chi legge sono state rispettate: un nome (parola) al posto di un pezzo ripetuto, i tipi, la docstring. E il comportamento non è cambiato di una virgola: lo dicono i cinque test.

Il registro dei commit, uno per passo (i codici sono quelli veri usciti da git log --oneline):

638bef5 Pulisci: la parola minuto o minuti ha un nome
3c5f7a1 Provo anche due minuti: il plurale regge
10599b3 Un minuto è al singolare
c1ac740 Con più di zero minuti si dice quanto manca
a45382e Il codice del treno entra nell'annuncio
827b34f Primo test: il treno in arrivo

In italiano. «Pulisci» è un giro a sé: non si aggiunge niente di nuovo, non si cambia nessun test. Se durante la pulizia un test diventa rosso, l'ultima modifica ha cambiato il comportamento: si torna indietro (git restore), come in Rimettere a posto.

Passo per passo.

TurnoChiCosapytest
11InsiemeTirano fuori parola, aggiungono tipi e docstring5 verdi
12InsiemeCommit—

Cosa portiamo a casa. Pulire è sicuro perché i test sono verdi. Senza di loro, ogni ritocco sarebbe a occhio.


E · Un rosso alla volta

Restano due regole: i minuti negativi e il treno senza codice sono errori. Ivo, di fretta, scrive tutti e due i test insieme.

Python
def test_i_minuti_negativi_sono_un_errore():
    with pytest.raises(ValueError, match="negativi"):
        annuncio("M12", -1)


def test_un_treno_senza_codice_e_un_errore():
    with pytest.raises(ValueError, match="codice"):
        annuncio("", 3)

(Il file ha in cima import pytest. pytest.raises e match sono quelli del capitolo sui test.)

Prevedi Scrivi su un foglio cosa ti aspetti, poi apri.
test_annunci.py .....FF                                                  [100%]

=================================== FAILURES ===================================
____________________ test_i_minuti_negativi_sono_un_errore _____________________

    def test_i_minuti_negativi_sono_un_errore():
>       with pytest.raises(ValueError, match="negativi"):
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       Failed: DID NOT RAISE ValueError

test_annunci.py:27: Failed
____________________ test_un_treno_senza_codice_e_un_errore ____________________

    def test_un_treno_senza_codice_e_un_errore():
>       with pytest.raises(ValueError, match="codice"):
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       Failed: DID NOT RAISE ValueError

test_annunci.py:32: Failed
=========================== short test summary info ============================
FAILED test_annunci.py::test_i_minuti_negativi_sono_un_errore - Failed: DID N...
FAILED test_annunci.py::test_un_treno_senza_codice_e_un_errore - Failed: DID ...
========================= 2 failed, 5 passed in 0.01s ==========================

Due rossi insieme. Il motivo è giusto (la funzione non solleva niente), ma con due rossi non sai da quale prendere.

In italiano. Meglio un rosso alla volta. Lucia, che deve scrivere il codice, guarda il primo da solo, con :: dopo il nome del file:

Terminale
pytest test_annunci.py::test_i_minuti_negativi_sono_un_errore -v
collecting ... collected 1 item

test_annunci.py::test_i_minuti_negativi_sono_un_errore FAILED            [100%]

=================================== FAILURES ===================================
____________________ test_i_minuti_negativi_sono_un_errore _____________________

    def test_i_minuti_negativi_sono_un_errore():
>       with pytest.raises(ValueError, match="negativi"):
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       Failed: DID NOT RAISE ValueError

test_annunci.py:27: Failed
=========================== short test summary info ============================
FAILED test_annunci.py::test_i_minuti_negativi_sono_un_errore - Failed: DID N...
============================== 1 failed in 0.01s ===============================

Il codice minimo per questo, e per questo solo:

Python
    if minuti < 0:
        raise ValueError("I minuti non possono essere negativi")

messo in cima alla funzione. Poi di nuovo quel test solo (verde, 1 passed), e il giro completo: resta rosso solo l'altro.

test_annunci.py ......F                                                  [100%]
...
FAILED test_annunci.py::test_un_treno_senza_codice_e_un_errore - Failed: DID ...
========================= 1 failed, 6 passed in 0.01s ==========================

Un'altra riga per il codice vuoto, if treno == "": raise ValueError("Manca il codice del treno"), e tutto è verde:

test_annunci.py::test_con_zero_minuti_il_treno_e_in_arrivo PASSED        [ 14%]
test_annunci.py::test_il_codice_del_treno_cambia_nell_annuncio PASSED    [ 28%]
test_annunci.py::test_con_cinque_minuti_si_dice_quanto_manca PASSED      [ 42%]
test_annunci.py::test_con_un_minuto_si_dice_minuto_al_singolare PASSED   [ 57%]
test_annunci.py::test_con_due_minuti_si_torna_al_plurale PASSED          [ 71%]
test_annunci.py::test_i_minuti_negativi_sono_un_errore PASSED            [ 85%]
test_annunci.py::test_un_treno_senza_codice_e_un_errore PASSED           [100%]

============================== 7 passed in 0.00s ===============================

Passo per passo.

TurnoChiCosapytest
13IvoDue test insieme2 rossi
14LuciaGuarda il primo da solo (::)1 rosso
15Luciaraise per i minuti negativiprimo verde, resta 1 rosso
16Luciaraise per il treno senza codicetutto verde

Cosa portiamo a casa. Un test nuovo alla volta: così il rosso sullo schermo è uno, e sai già cosa stai cercando di far passare.