Testeo Unitario

Introducción

La idea del testeo unitario es evitar los programitas "main()" ya que

• Requieren intervención humana (por ejemplo leer los prints de consola e interpretar si estuvo bien la ejecución o no)
• A medida que el sistema crece se hace dificil tener uno o varios mains que prueben realmente todo el comportamiento.
• Suelen venir acompañados de prints en el código lo cual ensucia al sistema.

Entonces la idea del testeo unitario es:

• Codificar una "pieza" de software que sea ejecutable y que se asegure de ciertas condiciones de resultado de nuestro software. Cada uno de estos será un Test
• Pero además, los Tests no van a probar cualquier cosa ni cosas mezcladas, sino que vamos a hacer Test Unitarios es decir, test chiquitos que prueben una única unidad o comportamiento, por ejemplo una función.

Qué es un Test ?

En general cuando testeamos algo (incluso dentro de un main()) realizamos una serie de pasos:

• Setup:
  • Configuramos o armamos el ambiente/datos para ejecutar la lógica.
  • Por ejemplo para probar la implementación de Pila en Python, y específicamente para testear el apilar() necesitamos:
  • una Pila
  • un elemento para apilar.
  • Ejecución de la lógica: luego sí procedemos a ejecutar la lógica que queremos testear, en nuestro caso invocamos a la función apilar.
• Asserts:
  • Finalmente nos "aseguramos" de ciertas post condiciones, es decir, que el estado se haya alterado como esperábamos. Ésto obviamente que depende de lo que estemos testeando.
  • En general son comparaciones, por ejemplo:
    • Asegurarse que tal variable no sea null (o None en Python)
    • Asegurarse que tal variable SEA None
    • Asegurarse que dos valores son iguales
    • Asegurares que dos valores sean distintos.
    • etc.

Herramientas de Unit Testing

Entonces, si pudimos encontrarle un forma o patrón a la idea de testear, también la podemos codificar. Y para eso existen herramientas o frameworks útiles para simplificarnos un poco la vida.

La idea original surgió para Java con la herramienta JUnit (o era para Smalltalk la original ?). Como nosotros trabajamos en Python vamos a utilizar un módulo especial llamado unittest.

Pero en general los conceptos son iguales para todas las herramientas, varían algunas cositas nada más.

TestCase

Un testcase es una clase que agrupa varios Test Methods (o funciones de test). Y se puede ejecutar con una herramienta del IDE. La idea es que nosotros creamos nuestros propios tescases. Es decir clases que "son" TestCases. Para eso existe una particularidad relacionada con la programación orientada objetos. Y es que las clases a diferencia de los Structs de C, pueden heredar. Así como decimos que un Perro es un Animal, y por lo tal comparte ciertas características de todos los animales, así podemos definir que una clase "es un" o, mejor dicho hereda de otra clase, con lo cual tendrá todas las propiedades y atributos de ésta.

En fin, no hace falta comprender esto del todo, podrían aprenderse la sintaxis de memoria y listo.

Veamos entonces como escribo un TestCase:

from prog2.py.collections.pilaycola.pila import *

import unittest

class TestPila(unittest.TestCase):

    pass

Acá este test no está haciendo nada todavía, pero es para ir de a poco.

Entonces lo que notamos es que:

• debemos importar el módulo unittest
• Nuestra clase lleva a continuación de su nombre entre paréntesis unittest.TestCase. Así es como le decimos que esta es una clase de test.

TestMethod

Por ahora no pasa nada. Sin embargo la idea es dentro de esta clase escribir funciones pequeñas que sean las que se van a ejecutar y testear algo. Estos son los test methods..

Veamos cómo haríamos nuestro test para apilar en una pila:

class TestPila(unittest.TestCase):

    def test_apilar(self):

        pila = Pila()

        elemento = "unElemento"

        apilar(pila, elemento)

        self.assertEquals(tope(pila), elemento, "La pila no inserto' bien")

        self.assertFalse(vacia(pila))

Veamos entonces hay un par de cosas a saber:

• La función debe ir indentada dentro de la clase
• Su nombre debe comenzar con la palabra test y luego podemos completar con el nombre que querramos que debería explicar qué testea esa función.
• Debe recibir como parámetro self (y solo self! no podemos pasar parámetros)
• Luego dentro de la función vemos el patrón que decíamos:
• Setup:
  • se crea la pila
  • se define un elemento
• Lógica de negocio:
  • se invoca el apilar
• Assert:
  • las dos últimas lineas se aseguran condiciones:
    • Luego de apilar, la función vacia(pila) tiene que devolver false (porque acabamos de apilar un elemento, no puede ser vacía!)
    • Además, si llamamos a tope(pila) nos debería dar el elemento que acabamos de apilar.

Ahora sí, que definimos qué hacer y de qué asegurarnos podemos ejecutar el Test.

Ejecución del Test

Dependiendo del IDE en que trabajen esto va a variar. En eclipse con PyDev, símplemente pueden hacer botón derecho sobre el código y "Run As...> Python Unit Test".

Esto ejecutará todas las funciones de test que ustedes tengan en esa clase (Como dijimos un TestCase puede tener muchos test methods dentro).

Y luego pueden ir a la vista PyUnit donde verán una barra:

• si es verde, es que todos los tests se ejecutaron bien:
  • no explotó nada
  • y los asserts dieron true !
• si es rojo, algo se rompió y hay que mirar el mensaje y la consola

Referencias y Material

Si quieren leer más o ver más ejemplos recomendamos:

• La documentación oficial de Python sobre unittest: http://docs.python.org/2/library/unittest.html
• Éste tutorial en castellano: http://pet.tzulberti.com.ar/1/html/unittest.html

Por otro lado el test de nuestra pila está acá: http://xp-dev.com/svn/uqbar/examples/prog2/unidad1-python/prog2/py/collections/pilaycola/pilaTest.py