ßeta perpetua

El blog personal de Juan Manuel Barroso

Predicando sobre Clean Code

3 Comments »

El pasado mes tuvo lugar el CodeMotion, un eventazo al que desafortunadamente no pude asistir, y que sirvió de sinergia para que en la semana anterior al evento las comunidades locales crearán eventos/charlas/talleres a modo de “calentamiento”.

El grupo local AgileCanarias se unió al llamamiento, y con la colaboración de la ETSII,  organizó un pequeño evento de dos días. La idea era hablar de temas con un nivel introductorio para que pudieran asistir alumnos o cualquier persona interesada.

En vista a que yo siempre he tenido la firme convicción de que el libro Clean Code debería impartirse en la universidad, me animé a dar una charla sobre el tema. No tenía demasiado tiempo para prepararla, ni tampoco podía ser una charla muy larga así que plasmé en una presentación lo que me pareció más básico del libro.

A continuación se muestran las diapositivas usadas en la charla:

 

En testing lo primero es F.I.R.S.T

No Comments »

El testing es un pilar fundamental del desarrollo de software pues es lo único que nos garantiza que dicho software funciona. Pero no es suficiente con hacer testing, hay que hacerlo bien. Si hay algo peor que no tener pruebas, es tener pruebas mal hechas.

Malas pruebas nos dan la falsa seguridad de que las cosas funcionan, nos hacen mantener un código que no aporta valor y si están mal diseñadas, y tenemos que mantenerlas, son un auténtico dolor de cabeza.

Creo que los principios que plantea Robert C. Martin en su libro Clean Code son perfectos para comenzar. Me voy a centrar en los principios F.I.R.S.T añadiendo algunos elementos con los cuales me he tropezado en proyectos heredados, con código legacy que obligan a desviarse del camino ideal, y sobre todo desde un punto de vista de testing de integración.

Es conveniente recordar que el código de los test es tan importante como el de producción, el esfuerzo por mantener un código limpio, legible, sin duplicidad debe hacerse sin distinguir el objetivo del código que estamos escribiendo.

Las siglas F.I.R.S.T son 5 reglas que significan: Fast, Independent, Repeatable, Self-validating y Timely.

Fast: Los test deberían ser rápidos. Baterias de test lentos nos rompen el flujo de trabajo y generan indisposición a  ejecutarlos. Si no los ejecutamos no podremos detectar fallos con frecuencia, ni a tiempo.
A esta regla me gustaría añadirle un aspecto más. Es cierto que debemos intentar que los test sean rápidos en su ejecución pero en ocasiones no podemos evitar que un gran número de pruebas de integración/funcionales en sistemas complejos tarden un quantum de tiempo mayor al deseado. En estos casos debemos considerar la importancia de que la acción de lanzar los test se pueda hacer de manera sencilla y que se pueda llevar a cabo rápidamente.
Algunas ideas en este punto son la creación de suites de prueba que permitan desde un único punto ejecutar todos los test relacionados, o contar con una herramienta como Jenkins en la que a golpe de click se puedan lanzar todos los tests para en un instante posterior consultar los resultados.
De esta manera conseguimos que no sea tedioso lanzar las pruebas, e incluso que se puedan ejecutar en background mientras nosotros seguimos trabajando.
En sistemas compuestos por diferentes módulos, o equipos divididos por dominios de la aplicación, la inclusión de las baterías de pruebas de integración de los diferentes módulos de nuestro sistema en Jenkins puede ser un gran acierto, porque hacen que todo el equipo tenga acceso a las pruebas de todos los módulos, y que se pueda comprobar el impacto de nuestros cambios en los módulos relacionados sin necesidad de tener un conocimiento profundo de todos esos módulos.

Independent: Los test no deberían depender entre ellos, ningún test debería ser una pre-condición de otro test. Partiendo de esta regla tenemos un sistema en el que podemos lanzar cualquier test de manera independiente y en cualquier orden.
Si nos encontramos nuevamente con test de integración/funcionales podemos extender esta regla a otros recursos que pudieran necesitar los test. Cada test debería preparar de manera independiente las pre-condiciones, y debería evitar dar por sentado que los recursos que necesitan estarán disponibles en el sistema. Si el test tiene como pre-requisito que exista un registro en BBDD se debería crear ese registro en el momento previo de lanzar el test, si el test necesita que exista un documento previo en el gestor documental se debería subir ese documento en el momento previo de lanzar el test, y cuando sea realmente imposible crear esa pre-condición deberíamos controlarla generando errores que fácilmente nos informen de que el problema es la pre-condición, y que no de lugar a pensar que la funcionalidad que comprueba el test se ha roto.
Con esto buscamos que nuestro tests se independicen del entorno y de las circunstancias. Podemos comprobar la funcionalidad  en desarrollo, en producción, con una nueva BBDD sin registros o incluso no vernos afectados si alguien borra los documentos del gestor documental.

Repeteable: El test debería ser repetible en cualquier entorno y para cualquier desarrollador del equipo. Este apartado guarda relación con la regla anterior, cada test debería preparar su entorno para que todos los recursos estén controlados en el propio test.
El punto más común de fallo es que el test pasa en el ordenador de la persona que lo desarrolló pero no al resto de miembros. Los motivos pueden ser varios, desde configuración hasta recursos no sincronizados correctamente en la herramienta de control de versiones del código.
La mejor medicina para evitar este gran problema es disponer de una maquina independiente que corra un servidor de integración como Jenkins para que ejecute los test de manera automática. Todos los test deberán poder ser lanzados por Jenkins cada vez que se realiza un cambio, y a poder ser crear señales visuales que mantengan al equipo informado ;-) .

Self-Validating: Los test deben tener una salida booleana, pasan o no pasan. Pruebas que dejen su resultado en una cadena de texto que debemos revisar, o tests sin asserts deben evitarse.
Me gustaría extender este apartado con otra mala costumbre que me he encontrado muchas veces, y que probablemente alguna vez padecí, que es que el test no valida lo que está probando. Ejemplos bastante significativos de esto pueden ser los tests de búsquedas que no comprueban que los elementos recibidos cumplen los requisitos de la búsqueda o test sin asserts que sólo fallan cuando el código genera una preciosa excepción.
Es importante que tengamos claro el objetivo del test para crear las validaciones acorde a dicho objetivo.

Timely: Los tests deben ser creados antes que le código de producción, cuando hacemos TDD esto está implicito, pero tambien debemos hacerlo con el resto de tipos de tests (funcionales, integración). Cuando un usuario nos reporta un bug, o cuando queremos cambiar el comportamiento de una funcionalidad debemos reflejar ese bug o ese nuevo comportamiento en uno o varios tests, de esta manera sabremos realmente cuando la funcionalidad esta terminada o cuando el bug está solucionado. Además que es mucho más sencillo escribir el test sin pensar en una implementación que ya hemos codificado.

Pueden haber excepciones que nos obliguen a romper alguna de las reglas, estas excepciones deberían estar documentadas y sobre todo no debemos permitir que se generalicen.

Si tenemos un test de un caso muy particular no deberíamos mezclarlo con el resto del tests, para estas cosas suelo usar un test case denominado SandBoxTests que se excluye de los test automatizados, o usar la notación de JUnit @Ignore con una descripción que explique la circunstancias especiales que me llevaron a escribir el test, por ejemplo que el usuario Julio no puede subir el fichero comic.pdf pero si cualquier otro.