Il test delle unità ti consente di verificare la qualità del codice dopo averlo scritto, ma puoi anche usare il test delle unità per migliorare il processo di sviluppo man mano che procedi. Anziché scrivere i test dopo aver completato lo sviluppo dell'applicazione, valuta la possibilità di scriverli man mano. In questo modo, puoi progettare unità di codice piccole, manutenibili e riutilizzabili. Inoltre, semplifica il test completo e rapido del codice.
Quando esegui test di unità locali, esegui test che rimangono all'interno del tuo ambiente di sviluppo senza coinvolgere componenti remoti. App Engine fornisce utilità di test che utilizzano implementazioni locali di datastore e altre applicazioni Engine. Ciò significa che puoi verificare l'utilizzo di questi servizi da parte del tuo codice localmente, senza eseguire il deployment del codice in App Engine, utilizzando gli stub di servizio.
Uno stub di servizio è un metodo che simula il comportamento del servizio. Ad esempio, lo stub del servizio Datastore mostrato in Scrivere test di Datastore e Memcache ti consente di testare il codice di Datastore senza effettuare richieste al Datastore reale. Qualsiasi archiviata durante un test delle unità del datastore è conservata in memoria, non e viene eliminato dopo l'esecuzione del test. Puoi eseguire piccoli test rapidi senza alcuna dipendenza dal datastore stesso.
Questo documento descrive come scrivere i test delle unità rispetto a diversi App Engine locali e fornisce alcune informazioni sulla configurazione di un framework di test.
Introduzione alle utilità di test di Python 2
Un modulo Python di App Engine chiamato
testbed
rende disponibili gli stub di servizio per i test di unità.
Gli stub di servizio sono disponibili per i seguenti servizi:
- Identità app
init_app_identity_stub
- Archivio BLOB (utilizza
init_blobstore_stub
) - Capacità (utilizza
init_capability_stub
) - Datastore (utilizza
init_datastore_v3_stub
) - File (utilizza
init_files_stub
) - Immagini (solo per
dev_appserver;
utilizza
init_images_stub
) - LogService (utilizza
init_logservice_stub
) - Posta (utilizza
init_mail_stub
) - Memcache (utilizza
init_memcache_stub
) - Coda di attività (utilizza
init_taskqueue_stub
) - Recupero URL (utilizza
init_urlfetch_stub
) - Servizio per gli utenti (utilizza
init_user_stub
)
Per inizializzare tutti gli stub contemporaneamente, puoi utilizzare init_all_stubs
.
Scrittura di test di Datastore e memcache
Questa sezione mostra un esempio di come scrivere codice che testa l'utilizzo dei servizi datastore e memcache.
Assicurati che l'esecutore del test disponga delle librerie appropriate sul caricamento Python
incluse le librerie di App Engine, yaml
(incluse in App Engine)
SDK), la directory principale dell'applicazione ed eventuali altre modifiche al percorso della libreria
previsto dal codice dell'applicazione (ad esempio una directory ./lib
locale, se disponi
uno). Ad esempio:
import sys
sys.path.insert(1, 'google-cloud-sdk/platform/google_appengine')
sys.path.insert(1, 'google-cloud-sdk/platform/google_appengine/lib/yaml/lib')
sys.path.insert(1, 'myapp/lib')
Importa il modulo unittest
Python e i moduli App Engine pertinenti
ai servizi in fase di test, in questo caso memcache
e ndb
, che utilizzano entrambi
datastore e memcache. Importa anche il modulo testbed
.
Poi crea un corso TestModel
. In questo esempio, una funzione controlla per vedere
se un'entità è archiviata in memcache. Se non viene trovata alcuna entità, controlla se è presente
nel datastore. Questo aspetto può spesso essere ridondante nella vita reale, poiché ndb
usa memcache dietro le tende, ma è comunque un modello OK per
test.
Ora crea uno scenario di test. A prescindere dai servizi che stai testando, lo scenario di test
devi creare un'istanza Testbed
e attivarla. Lo scenario di test deve inoltre
inizializzare gli stub di servizio pertinenti, in questo caso usando
init_datastore_v3_stub
e init_memcache_stub
. I metodi per l'inizializzazione
gli altri stub di servizio App Engine sono elencati in Introduzione al test Python
Utilità.
Il metodo init_datastore_v3_stub()
senza argomento utilizza un metodo in memoria
un datastore inizialmente vuoto. Se vuoi testare un datastore esistente
, includi il suo nome di percorso come argomento a init_datastore_v3_stub()
.
Oltre a setUp()
, includi un metodo tearDown()
che disattivi il parametro
testato. Questa operazione ripristina gli stub originali in modo che i test non interferiscano con
tra loro.
Poi implementa i test.
Ora puoi utilizzare TestModel
per scrivere test che utilizzano gli stub dei servizi datastore o memcache anziché i servizi reali.
Ad esempio, il metodo mostrato di seguito crea due entità: la prima utilizza il valore predefinito per l'attributo number
(42) e la seconda utilizza un valore non predefinito per number
(17). Il metodo crea quindi una query
TestModel
, ma solo per quelle con il valore predefinito di number
.
Dopo aver recuperato tutte le entità corrispondenti, il metodo verifica che esattamente un'entità
e che il valore dell'attributo number
di questa entità è il valore predefinito
valore.
Come altro esempio, il metodo seguente crea un'entità e la recupera
utilizzando la funzione GetEntityViaMemcache()
creata sopra. Il metodo
quindi verifica che un'entità sia stata restituita e che il suo valore number
sia lo stesso
per l'entità creata in precedenza.
Infine, invoca unittest.main()
.
Per eseguire i test, vedi Esecuzione dei test.
Scrittura dei test di Cloud Datastore
Se la tua app utilizza Cloud Datastore, ti consigliamo di scrivere test che verifichino il comportamento dell'applicazione in caso di eventuale coerenza.
db.testbed
offre opzioni che semplificano questa procedura:
La classe PseudoRandomHRConsistencyPolicy
ti consente di controllare la probabilità che un'operazione di scrittura venga applicata prima di ogni query globale (non principale). Impostando il parametro
probabilità pari allo 0%, stiamo istruendo lo stub del datastore in modo che operi
la massima coerenza finale. La coerenza finale massima indica che le scritture verranno committate, ma non verranno mai applicate, pertanto le query globali (non antecedenti) non riusciranno mai a vedere le modifiche. Ovviamente, questo non è rappresentativo della quantità di coerenza finale che la tua applicazione vedrà durante l'esecuzione in produzione, ma a scopo di test è molto utile poter configurare il datastore locale in modo che si comporti sempre in questo modo. Se utilizzi un valore diverso da zero
probabilità, PseudoRandomHRConsistencyPolicy
crea una sequenza deterministica di
decisioni in materia di coerenza in modo che i risultati dei test siano coerenti:
Le API di test sono utili per verificare che l'applicazione funzioni correttamente
a dispetto della coerenza finale, ma ricorda che l'Alta definizione locale
Il modello di coerenza della lettura della replica è un'approssimazione del modello
Modello a coerenza di lettura della replica, non una replica esatta. Nella regione
eseguendo un get()
di Entity
che appartiene a un gruppo di entità
con una scrittura non applicata, restituirà sempre i risultati della scrittura non applicata
visibile alle successive query globali. In fase di produzione non è così.
Scrivere test di posta
Puoi utilizzare lo stub del servizio di posta per testare il servizio mail. Analogamente ad altri servizi supportati da testbed, all'inizio si inizializza lo stub, si richiami il codice che utilizza l'API mail e infine si verifica se sono stati inviati i messaggi corretti.
Scrivere test delle code di attività
Puoi usare lo stub della coda di attività per scrivere test che usano lo stub taskqueue. Simile ad altri supportati da testbed, inizialmente si inizializza lo stub, quindi si richiama il che utilizza l'API Taskqueue, nonché per testare se le attività sono state correttamente aggiunto alla coda.
Impostazione del file di configurazione queue.yaml
Se vuoi eseguire test su codice che interagisce con una coda non predefinita,
devi creare e specificare un file queue.yaml
che l'applicazione possa utilizzare.
Di seguito è riportato un esempio di queue.yaml
:
Per ulteriori informazioni sulle opzioni disponibili per queue.yaml, consulta la configurazione della coda di attività.
La posizione di queue.yaml
viene specificata durante l'inizializzazione dello stub:
self.testbed.init_taskqueue_stub(root_path='.')
Nell'esempio, queue.yaml
si trova nella stessa directory dei test. Se fosse in un'altra cartella, il percorso dovrebbe essere specificato in root_path
.
Filtrare le attività
get_filtered_tasks
dello stub taskqueue consente di filtrare le attività in coda.
In questo modo è più facile scrivere test che devono verificare il codice che mette in coda più attività.
Scrivere test delle attività differite
Se il codice dell'applicazione utilizza la libreria differita, puoi usare la coda di attività
stub insieme a deferred
per verificare che le funzioni differite siano in coda
eseguito correttamente.
Modificare le variabili di ambiente predefinite
I servizi App Engine spesso dipendono dalle variabili di ambiente. Il metodo activate()
della classe testbed.Testbed
utilizza valori predefiniti, ma puoi impostare valori personalizzati
in base alle tue esigenze di test con setup_env
della classe testbed.Testbed
.
Ad esempio, supponiamo di avere un test che memorizza diverse entità
di Cloud Shell, tutti collegati allo stesso ID applicazione. Ora vuoi eseguire
gli stessi test, ma usando un ID applicazione diverso da quello
collegate alle entità archiviate. Per farlo, passa il nuovo valore
self.setup_env()
sotto forma di app_id
.
Ad esempio:
Simulazione di accesso
Un altro uso frequente di setup_env
è simulare l'accesso di un utente,
con o senza privilegi amministrativi, per verificare se i tuoi gestori operano
correttamente in ogni caso.
Ora i metodi di test possono chiamare, ad esempio, self.loginUser('', '')
per simulare l'assenza di un utente che ha eseguito l'accesso, self.loginUser('test@example.com', '123')
per simulare l'accesso di un utente non amministratore e self.loginUser('test@example.com',
'123', is_admin=True)
per simulare l'accesso di un utente amministratore.
Configurazione di un framework di test
Le utilità di test dell'SDK non sono legate a un framework specifico. Puoi eseguire i test delle unità con qualsiasi testrunner di App Engine disponibile, ad esempio nose- gae o ferrisnose. Puoi anche scrivere un testrunner di prova oppure usa quello mostrato di seguito.
I seguenti script utilizzano il modulo unittest di Python.
Puoi assegnare allo script il nome che preferisci. Quando lo esegui, fornisci il percorso
l'installazione di Google Cloud CLI o dell'SDK di Google App Engine e il percorso
moduli di test. Lo script rileverà tutti i test nel percorso specificato e stamperà i risultati nello stream di errori standard. I file di test seguono la convenzione di
con test
aggiunto come prefisso al nome.
Esecuzione dei test
Puoi eseguire questi test semplicemente eseguendo lo script runner.py
, che
descritto in dettaglio in Configurare un framework di test:
python runner.py <path-to-appengine-or-gcloud-SDK> .