7.2. Introduzione al modulo romantest.py

7.2. Introduzione al modulo `romantest.py`

Ora che abbiamo completamente definito il comportamento che ci aspettiamo dalle nostre funzioni di conversione, faremo qualcosa di inaspettato: scriveremo un modulo di test che faccia eseguire a queste funzioni il proprio codice e verifichi che esse si comportino come vogliamo. Avete letto bene: andremo a scrivere del codice per verificare altro codice che non abbiamo ancora scritto.

Questo si chiama “test delle unità di codice”, visto che l'insieme delle due funzioni di conversione può essere verificato come un'unità indipendente, separato da qualsiasi programma di cui esse potranno fare parte in seguito. Python ha una infrastruttura per effettuare il test delle unità di codice, appropriatamente chiamato modulo unittest.


	`unittest` è incluso con Python 2.1 e successivi. Gli utilizzatori di Python 2.0 possono scaricarlo da `pyunit.sourceforge.net`.

Validare le unità di codice è una parte importante di una strategia di sviluppo largamente basata sui test. Se decidete di scrivere i test delle unità di codice, fatelo dall'inizio (preferibilmente prima di scrivere il codice da verificare) e manteneteli aggiornati rispetto ai cambi dei requisiti e del codice. Il test delle unità di codice non è un'alternativa per i test funzionali o di sistema, di più alto livello di quelli delle unità, ma è comunque importante in tutte le fasi dello sviluppo:

Prima di scrivere codice, obbliga a dettagliare utilmente i requisiti.
Mentre si scrive codice, impedisce di esagerare nell'implementazione. Quando tutti i test sono eseguiti con successo, la funzione è completa.
Mentre si riorganizza il codice, assicura che la nuova versione si comporti come la vecchia.
Durante la manutenzione del codice, aiuta a pararsi il sedere quando qualcuno arriva gridando che la vostra ultima implementazione causa problemi al loro vecchio codice (“Scusi, ma tutti i test delle unità di codice hanno avuto successo quando ho registrato la nuova versione ...”)

Questo è l'insieme completo dei test per le nostre funzioni di conversione dei numeri romani, che non abbiamo ancora scritto ma che alla fine saranno nel modulo roman.py. Non è immediatamente ovvio come le varie parti siano collegate; nessuna di queste classi o metodi fa riferimento alle altre. Ci sono buone ragioni per questo comportamento, tra breve saranno chiarite.

Esempio 7.1. Il modulo `romantest.py`

Se non lo avete ancora fatto, potete scaricare questo ed altri esempi usati in questo libro.

"""Unit test for roman.py"""

import roman
import unittest

class KnownValues(unittest.TestCase):                          
    knownValues = ( (1, 'I'),
                    (2, 'II'),
                    (3, 'III'),
                    (4, 'IV'),
                    (5, 'V'),
                    (6, 'VI'),
                    (7, 'VII'),
                    (8, 'VIII'),
                    (9, 'IX'),
                    (10, 'X'),
                    (50, 'L'),
                    (100, 'C'),
                    (500, 'D'),
                    (1000, 'M'),
                    (31, 'XXXI'),
                    (148, 'CXLVIII'),
                    (294, 'CCXCIV'),
                    (312, 'CCCXII'),
                    (421, 'CDXXI'),
                    (528, 'DXXVIII'),
                    (621, 'DCXXI'),
                    (782, 'DCCLXXXII'),
                    (870, 'DCCCLXX'),
                    (941, 'CMXLI'),
                    (1043, 'MXLIII'),
                    (1110, 'MCX'),
                    (1226, 'MCCXXVI'),
                    (1301, 'MCCCI'),
                    (1485, 'MCDLXXXV'),
                    (1509, 'MDIX'),
                    (1607, 'MDCVII'),
                    (1754, 'MDCCLIV'),
                    (1832, 'MDCCCXXXII'),
                    (1993, 'MCMXCIII'),
                    (2074, 'MMLXXIV'),
                    (2152, 'MMCLII'),
                    (2212, 'MMCCXII'),
                    (2343, 'MMCCCXLIII'),
                    (2499, 'MMCDXCIX'),
                    (2574, 'MMDLXXIV'),
                    (2646, 'MMDCXLVI'),
                    (2723, 'MMDCCXXIII'),
                    (2892, 'MMDCCCXCII'),
                    (2975, 'MMCMLXXV'),
                    (3051, 'MMMLI'),
                    (3185, 'MMMCLXXXV'),
                    (3250, 'MMMCCL'),
                    (3313, 'MMMCCCXIII'),
                    (3408, 'MMMCDVIII'),
                    (3501, 'MMMDI'),
                    (3610, 'MMMDCX'),
                    (3743, 'MMMDCCXLIII'),
                    (3844, 'MMMDCCCXLIV'),
                    (3888, 'MMMDCCCLXXXVIII'),
                    (3940, 'MMMCMXL'),
                    (3999, 'MMMCMXCIX'))                       

    def testToRomanKnownValues(self):                          
        """toRoman should give known result with known input"""
        for integer, numeral in self.knownValues:              
            result = roman.toRoman(integer)                    
            self.assertEqual(numeral, result)                  

    def testFromRomanKnownValues(self):                          
        """fromRoman should give known result with known input"""
        for integer, numeral in self.knownValues:                
            result = roman.fromRoman(numeral)                    
            self.assertEqual(integer, result)                    

class ToRomanBadInput(unittest.TestCase):                            
    def testTooLarge(self):                                          
        """toRoman should fail with large input"""                   
        self.assertRaises(roman.OutOfRangeError, roman.toRoman, 4000)

    def testZero(self):                                              
        """toRoman should fail with 0 input"""                       
        self.assertRaises(roman.OutOfRangeError, roman.toRoman, 0)   

    def testNegative(self):                                          
        """toRoman should fail with negative input"""                
        self.assertRaises(roman.OutOfRangeError, roman.toRoman, -1)  

    def testDecimal(self):                                           
        """toRoman should fail with non-integer input"""             
        self.assertRaises(roman.NotIntegerError, roman.toRoman, 0.5) 

class FromRomanBadInput(unittest.TestCase):                                      
    def testTooManyRepeatedNumerals(self):                                       
        """fromRoman should fail with too many repeated numerals"""              
        for s in ('MMMM', 'DD', 'CCCC', 'LL', 'XXXX', 'VV', 'IIII'):             
            self.assertRaises(roman.InvalidRomanNumeralError, roman.fromRoman, s)

    def testRepeatedPairs(self):                                                 
        """fromRoman should fail with repeated pairs of numerals"""              
        for s in ('CMCM', 'CDCD', 'XCXC', 'XLXL', 'IXIX', 'IVIV'):               
            self.assertRaises(roman.InvalidRomanNumeralError, roman.fromRoman, s)

    def testMalformedAntecedent(self):                                           
        """fromRoman should fail with malformed antecedents"""                   
        for s in ('IIMXCC', 'VX', 'DCM', 'CMM', 'IXIV',
                  'MCMC', 'XCX', 'IVI', 'LM', 'LD', 'LC'):                       
            self.assertRaises(roman.InvalidRomanNumeralError, roman.fromRoman, s)

class SanityCheck(unittest.TestCase):        
    def testSanity(self):                    
        """fromRoman(toRoman(n))==n for all n"""
        for integer in range(1, 4000):       
            numeral = roman.toRoman(integer) 
            result = roman.fromRoman(numeral)
            self.assertEqual(integer, result)

class CaseCheck(unittest.TestCase):                   
    def testToRomanCase(self):                        
        """toRoman should always return uppercase"""  
        for integer in range(1, 4000):                
            numeral = roman.toRoman(integer)          
            self.assertEqual(numeral, numeral.upper())

    def testFromRomanCase(self):                      
        """fromRoman should only accept uppercase input"""
        for integer in range(1, 4000):                
            numeral = roman.toRoman(integer)          
            roman.fromRoman(numeral.upper())          
            self.assertRaises(roman.InvalidRomanNumeralError,
                              roman.fromRoman, numeral.lower())

if __name__ == "__main__":
    unittest.main()

Ulteriori letture

La pagina web di PyUnit contiene un'approfondita descrizione di come usare l'infrastruttura del modulo unittest, incluse speciali caratteristiche non discusse in questo capitolo.
La FAQ di PyUnit spiega perché il codice di test è salvato separatamente dal codice da validare.
Il Python Library Reference riassume le caratteristiche del modulo unittest.
ExtremeProgramming.org tratta del perché è oppportuno scrivere i test delle unità di codice.
Il Portland Pattern Repository contiene una discussione in continuo aggiornamento sui test di unità, inclusa una loro definizione standard, ragioni per cui si dovrebbe cominciare con lo scrivere i test delle unità di codice e molti altri studi approfonditi.

Dive Into Python