Pruebas unitarias en JavaScript (Creación de una librería JavaScript 3ª parte)

En esta entrada continúa la serie en la que se explica cómo crear una librería JavaScript desde cero. Hoy se va a explicar cómo se pueden añadir pruebas unitarias en JavaScript con Mocha y Chai. Mocha es un framework de pruebas unitarias en JavaScript que proporciona las utilidades de ejecución y reporte. Chai es una librería de aserciones BDD/TDD que dispone de varias interfaces.

Esta entrada pertenece a la serie “Creación de una librería JavaScript” cuyo código se puede encontrar en la cuenta de GitHub de Analytics Lane. Serie compuesta por las siguientes entradas:

• Creación de una librería JavaScript
• Estructurar las funciones JavaScript
• Pruebas unitarias en JavaScript
• Rango en pruebas unitarias en JavaScript
• Cobertura de las pruebas unitarias en JavaScript
• Medir la calidad del código JavaScript
• Compresión del código JavaScript
• Ejecutar múltiples scripts npm

Instalación de Mocha y Chai

Antes de poder utilizar Mocha y Chai es necesario instalarlos en el proyecto. Lo que se puede hacer en la terminal escribiendo el siguiente comando dentro del proyecto:

npm install chai mocha --save-dev

La opción --save-dev indica a npm que instale las librerías y guarde las dependencias en el archivo package.json. Al abrir este se puede ver que ahora existe una nueva propiedad devDependencies en la que se puede ver las dos librerías. Esto permite mover los paquetes entre ordenadores e instalar las dependencias necesarias en cada caso.

Además, se puede observar una nueva carpeta llamada node_modules en el proyecto. En la que se almacenan todas las librerías que se han instalado y sus dependencias.

Creación de las pruebas unitarias en JavaScript

Una vez instaladas las librerías en el proyecto se pueden crear las primeras pruebas unitarias. Para lo que se crea una carpeta llamada test en las que se guardarán todas las pruebas. Las primeras pruebas deberían cubrir la función ya escrita en la entrada anterior: sum. Esta función implementa la suma de todos los elementos de un vector, por lo que se puede probar que sume correctamente los valores de un par de vectores. Para ello se puede crear un archivo array.test.js con el siguiente código.

var expect = require('chai').expect;
var jslane = require('../index.js');

suite('Array test', function () {
  test('Array sum test', function (done) {
    expect(jslane.array.sum([1, 1, 1])).to.be.equal(3);
    expect(jslane.array.sum([1, 2, 3])).to.be.equal(6);

    done();
  });
});

Importación de las librerías

En la primera línea se imploran los métodos expect de Chai, con los que se puede comprobar los resultados en las pruebas. Chai permite escribir las pruebas tanto en formato TDD, el que se va a utilizar, como DBB. Esto es importante tenerlo en cuenta ya que el comando para ejecutar las pruebas depende del formato. En la segunda línea se importa la librería.

Creación de una suite de pruebas

Posteriormente se crear una suite con las pruebas. suite requiere dos parámetros un nombre que permita identificar la suite y una función con las pruebas. Las pruebas se crean con test, que también requiere un nombre y una función como parámetros de entrada. Las funciones de las pruebas tienen un parámetro done que se ha de ejecutar para indicar la finalización de la prueba. Un error típico es olvidar esto, lo que provoca que las pruebas fallan al no finalizar.

Comprobar el comportamiento de las funciones

Ahora, dentro de las pruebas, simplemente es necesario escribir el código y comprobar que genera los resultados deseados. Para ello se usa los expect de Chai. Aquí dentro del expect se escribirá el código y se comprobará que este sea igual a un valor con .to.be.equal().

Lanzamiento de las pruebas

El lanzamiento de las pruebas se realiza con el comando mocha. En la línea de comando se ha de escribir:

mocha tests/array.test.js --ui tdd

La opción --ui tdd es necesario porque las pruebas utilizan el formato TDD en lugar de BDD. Una vez ejecutado el comando se obtendrá

Sum test
     ✓ Basic sum test
1 passing (10ms)

Es decir, la prueba ha sido superada.

Creación de un script

En el archivo package.json se puede guardar un nuevo script que permita simplificar el lanzamiento de pruebas unitarias. Ya que es un proceso que se ejecutar continuamente. Para ello se agrega la propiedad test a scripts con el siguiente código:

./node_modules/mocha/bin/mocha tests/**/*test.js --ui tdd

A diferencia del ejemplo anterior en este caso se utiliza tests/**/*test.js para indicar que se ejecuten todos los archivos de la carpeta test que tengan la extensión test.js. Así se ejecutarán todas las pruebas actuales y futuras al lanzar este script.

Como se ha visto en las entradas anteriores, ahora se pueden lanzar las pruebas mediante el comando npm run test.

Aquellos que trabajen en Windows se encontrarán que el comando anterior no funciona, ya que se utilizan rutas de UNIX. Para solucionar este problema se puede incluir el comando node al inicio. Con lo que consigue un script válido tanto en sistemas UNIX (Linux y Mac) como Windows. Es decir, el nuevo script seria

node ./node_modules/mocha/bin/mocha tests/**/*test.js --ui tdd

Conclusiones

En esta tercera entrada de la serie se ha explicado cómo se pueden añadir pruebas unitarias en JavaScript con Mocha y Chai. Esto es importante a medida que el proyecto crezca ya que garantiza una red de seguridad a la hora de actualizar las funciones. En una próxima entrada se verá cómo agregar pruebas unitarias más avanzadas.

Imágenes: Pixabay (skylarvision)