UnitTesting.md

Unit Testing

I test automatici sono "oggetti" software che vengono scritti con l'obbiettivo di verificare che una porzione di una applicazione sia corretta (secondo qualche criterio di corretteza definito nel test stesso). Quando gli oggetti testati sono "piccoli" e autocontenuti, essi vengono chiamati "unit" e il test automatico di essi è detto "unit testing". Cosa sia una unit non è definito con precisione, in alcuni contesti può essere una classe, in altri può essere un piccolo modulo, più spesso sono singoli metodi, etc.

I test automatici in genere predispongono un input, invocano la unit e verificano che l'output (o l'eventuale side-effect) sia corretto. La verifica è fatta per mezzo di asserzioni che indicano quale sia il risultato atteso, quando tali asserzioni falliscono viene interrotto il test e restituito un messaggio d'errore appropriato.

I vantaggi dello unit testing sono molteplici:

• debugging: il testing indipendente di piccole unità di codice permette di isolare la porzione di codice in cui è presente il bug, semplificando così la soluzione del problema;

• qualità del codice: l'avere una test suite che automaticamente verifica la correttezza delle unit crea la serenità necessaria perché il codice venga mantenuto e ripulito con la dovuta frequenza. Supponiamo ad esempio di avere una funzione mal scritta, ma critica (ad esempio un suo problema potrebbe portare a danni per migliaia di euro). Sappiamo che la funzione è corretta (ha sempre funzionato perfettamente), ma è lunga, scritta male, e contiente tante parti che sarebbe bene astrarre in modo che possano essere riutilizzate dal resto dell'applicazione. Senza una suite di test affidabile difficilmente si procederà agli interventi necessari a risolvere la situazione. L'avere una suite di test non necessariamente garantisce di non introdurre bug, ne riduce però drasticamente la probabilità.

  Inoltre scrivere test è più semplice quando le unit sono piccole e ben focalizzate e questo incoraggia un miglior stile di programmazione;

• documentazione: i test di unità forniscono anche una (seppur limitata) fonte di documentazione per il codice. Essi mostrano come si intende che le unit vengano utilizzate e quale sia la relazione attesa tra input e output.

Affinché gli unit test possano essere efficaci è necessario che godano delle seguenti proprietà:

• i test devono essere focalizzati: uno unit-test deve testare un singolo caso d'uso di una singola unit. Un test che prende in considerazione più unit o più casi d'uso è meno utile perché eventuali problemi sono più difficilmente ricollegabili a una porzione ristretta di codice.

  Esempi di test correttamente focalizzati:

  • test di un metodo di sort su un array vuoto
  • test di un metodo di sort su un array dato
  • test di un metodo di sort su un array con tutti elementi uguali

  Esempi di test non correttamente focalizzati:

  • test di un metodo di sort
  • test del funzionamento di più metodi contemporaneamente

  In genere un test poco focalizzato si riconosce perché contiene più asserzioni. Prima di scrivere un test di unità che contenente più asserzioni è bene verificare l'opportunità di procedere in questa direzione.

• i test devono essere indipendenti: l'ordine di esecuzione dei test non deve influire sul loro risultato. JUnit impone questa caratteristica ricaricando l'intera classe in memoria prima di eseguire ciascun metodo di test e eseguendo i test in ordine casuale.

  L'indipendenza dei test è importante perché in caso contrario un baco potrebbe essere nascosto dall'esecuzione di un test precedente. Inoltre il debugging dei problemi diventa più complicato perché è necessario prendere in considerazione tutto il contesto.

• i test non devono richiedere l'intervento umano: i test devono essere automatici, non devono richiedere che un essere umano ispezioni il valore di una variabile o ispezioni quanto stampato a video. Un test che passa non deve generare nessun output degno di attenzione, un test fallito deve permettere di risalire velocemente alla porzione di codice da esaminare.

  Non scrivere pertanto nulla su console durante un test.

Si noti che scrivere i test di unità è diverso dallo scrivere un programma di prova per il proprio software. Gli unit test sono pensati per essere eseguiti automaticamente e non richiedere attenzione da parte dell'utente.

Unit testing in Java

La libreria di unit testing più usata in ambito Java è JUnit.

La versione più recente di JUnit è JUnit 5. Per semplicità, nell'esecuzione di questo laboratorio, suggeriamo l'uso della versione JUnit 4 immediatamente precedente.

Nel seguito, faremo riferimento a JUnit 4.

Un test in JUnit è un metodo marcato con l'annotazione @Test. Tali metodi possono usare un certo numero di funzioni messe a disposizione dalla libreria per verificare la correttezza del programma. Ad esempio:

import org.junit.Test;
import static org.junit.Assert.assertArrayEquals;

public class TestSorting {
  @Test
  public void testSortEmptyArray() {
    MySortingAlgorithm sorter = new MySortingAlgorithm();
    int[] a = {};
    assertArrayEquals( new int[]{}, sorter.sort(a) );
  }

  @Test
  public void testSortNullArray() {
    MySortingAlgorithm sorter = new MySortingAlgorithm();
    int[] a = null;
    assertArrayEquals( null, sorter.sort(a) );
  }
}

JUnit provvederà ad eseguire i test in ordine casuale ricaricando la classe prima di ogni singolo test. Nel caso in questione quest'ultima operazione non influisce sul risultato. Le cose sarebbero state però diverse nel caso la classe di test avesse memorizzato i dati in qualche variabile di istanza (o di classe).

Compilazione ed esecuzione

Potete trovare le librerie JUnit (junit e hamcrest-core) nella cartella Resources/Java/JUnit di questo repository. In alternativa, potete scaricarle dal sito di JUnit 4 (https://junit.org/junit4/), dove trovate anche altre informazioni interessanti.

Al fine di poter compilare ed eseguire le classi di test è necessario aggiungere le librerie JUnit al classpath di Java.

Esempio (unix):

setenv CLASSPATH /usr/NFS/Linux/labalgoritmi/lib/junit-4.12.jar:/usr/NFS/Linux/labalgoritmi/lib/hamcrest-core-1.3.jar:.

Per lanciare i test si può usare la classe JUnitCore messa a disposizione dalla libreria JUnit. Assumendo che il CLASSPATH sia stato impostato correttamente, è sufficiente lanciare il seguente comando:

java org.junit.runner.JUnitCore <nome classe da eseguire>

Dove è la classe che contiene i test. Il nome deve essere comprensivo del path (i.e., del package) alla classe stessa.

Unit testing in C

Purtroppo nel caso del C non c'è una libreria che possa essere definita "standard" e in genere usare tali librerie richiede l'installazione di software aggiuntivo. Date queste difficoltà è ammesso utilizzare un programma ad-hoc per effettuare il test, a patto che si scrivano le funzioni di test prestando attenzione ai punti indicati sopra. Chi volesse utilizzare qualche libreria è libero di farlo, ma sarà sua responsabilità installare e utilizzare correttamente la libreria. Una possibile libreria (che, tuttavia, non rappresenta uno standard) è Unity. Per vostra comodità, potete trovare Unity nella cartella Resources/C/Unity di questo repository. L'uso di Unity in questo laboratorio è comunque facoltativo.

Esempio di programma di test in C:

#include <assert.h>
#include <stdlib.h>
#include "my_sorter.h"

void test_sort_empty_array() {
  int a[] = {};
  assert( a == my_sorter(a, 0) );
}

void test_sort_null_array() {
  int* a = NULL;
  assert( NULL == my_sorter(a, 0) );
}

...

int main(int argc, char** argv) {
  test_sort_empty_array();
  test_sort_null_array();
  ...
}

Si noti che la funzione assert usata nell'esempio non è stata pensata per fare unit testing in C e fornisce solo funzionalità molto limitate in questo senso. Dati i vincoli e i problemi spiegati sopra, un'implementazione lungo la linea mostrata sarà comunque considerata pienamente accettabile.