Para el desarrollo de tests, se van a seguir dos metodologías:
- TDD: determina cuándo se escriben los tests (antes de escribir el código de la app)
- BDD: determina el tipo de aserciones utilizadas (la elección final debe poder usar una sintaxis más cercana al lenguaje natural)
Se han tenido en cuenta los siguientes criterios para la elección de herramientas:
- Estándares y conformidad: que cumpla los estándares relevantes de la industria de desarrollo de software, que sea compatible con el lenguaje (TypeScript) y el runtime (Node.js) elegidos.
- Comunidad y mantenimiento: según Snyk Advisor, se considerá a una comunidad grande y activa aquella con una alta cantidad de contribuidores y un elevado índice de uso entre los usuarios. Tendrá buen mantenimiento o no en base a a la frecuencia de actualizaciones y últimas versiones de la herramienta a evaluar.
- Mejores prácticas: que las herramientas sigan buenas prácticas de software como la capacidad de mantener casos de prueba de forma eficiente, la ejecución paralela y la creación de informes concisos.
Las aserciones o matchers son funciones que comparan la salida obtenida con la esperada, incluyendo mensajes si la comparación es positiva.
Teniendo en cuenta que debe ser compatible con el enfoque de BDD, las opciones consideradas han sido las siguientes:
- Chai: es una biblioteca de aserciones flexible que se puede utilizar con diversos estilos de BDD. Ofrece las interfaces expect, should, y assert, lo que permite elegir el estilo que mejor se adapte a las preferencias de uno.
- Assert Node.js: Node.js incluye un módulo de aserciones nativo llamado assert. Este módulo proporciona funciones simples para realizar aserciones en entornos Node.js, aunque es básico en comparación con algunas bibliotecas externas.
- Hamjest: biblioteca de aserciones para JavaScript y TypeScript que sigue el estilo BDD y proporciona una sintaxis expresiva para realizar afirmaciones sobre valores en las pruebas.
- Typed-Assert: biblioteca específica para TS que proporciona funciones de aserciones con tipos fuertemente tipados. Es algo popular en cuanto a uso, pero por desgracia ha dejado de actualizarse.
- Assertive-ts: biblioteca de aserciones específica para TS, segura en cuanto a tipos y fluida. Desafortunadamente, ha dejado de actualizarse y no cuenta con gran popularidad.
- Hein: otra biblioteca de aserciones específica para TypeScript y Node.js, que difiere con la de Chai en pequeños detalles de typechecking para valores y métodos, haciéndola más especializada a la hora de detectar errores concretos de TypeScript.
Otras de las bibliotecas que han sido examinadas son unexpected y earl, que pese a su reducida
comunidad/popularidad, cuentan con un mantenimiento aceptable, otrogándoles alrededor de 70/100
puntos de salud.
Por otro lado, se han descartado las bibliotecas de aserciones Expect.js, Should.js y Power Assert
debido a su completa falta de mantenimiento. También otras bibliotecas como zod y typanion, ya que no son
bibliotecas de aserciones como tal, sino que se centran en definir y validar estructuras de datos y tipos
en TypeScript.
La elección final entre las aserciones anteriores ha sido las de Chai, con una sorprendente puntuación de 97/100 según Snyk Advisor, debido a los siguientes factores:
- Estándares y conformidad: Chai se destaca por sus aserciones expresivas y legibles, facilitando la
comprensión de las pruebas. Permite adoptar varios estilos de aserciones, entre ellos el que interesa,
BDD, con funciones como
describe,it,expect... - Comunidad y mantenimiento: Chai es muy adoptado en la comunidad, con una media de 8.386.880 descargas semanales, localizándose en el top 5% más utilizado y con alrededor de 160 contribuidores. Además, es actualizado con gran frecuencia, su última versión fue hace dos meses desde el 27/11.
- Mejores prácticas: Chai se integra bien con otras herramientas y marcos comunes. Permite agregar aserciones personalizadas, lo que fomenta la adaptación a casos de uso específicos y la creación de pruebas más específicas y significativas. Chai tiene tipos de TypeScript oficialmente mantenidos (@types/chai), lo que facilita la integración y proporciona una experiencia de desarrollo más sólida.
Una vez escogidas las aserciones de Chai, se pueden utilizar un conjunto de herramientas que se integren bien con este entorno. Se han considerado los siguientes frameworks de testing:
- Jest: es un marco de prueba conocido por su configuración fácil y rápida. Aunque tiene su propio conjunto de aserciones (basadas en las de Jasmine), también es compatible con las de Chai.
- Mocha: es un framework de pruebas popular que ofrece flexibilidad y soporte para aserciones de diferentes bibliotecas, pudiendo usar Mocha con aserciones Chai para las pruebas.
- Jasmine: puede ejecutarse directamente en Node.js sin necesidad de un test runner externo,
instalando el paquete
jasmine. - AVA: es un marco de pruebas que destaca por su simplicidad, velocidad y capacidad de ejecución concurrente de tests. Es compatible con las aserciones de Chai.
- Tape: es un framework de pruebas todo en uno caracterizado por ser simple, liviano y seguir el formato TAP (Test Anything Protocol). Puede usarse junto con las aserciones de Chai.
La elección final entre los test runners anteriores ha sido Mocha con una postiva puntuación de 87/100 según Snyk Advisor, debido a los siguientes factores:
- Estándares y conformidad: Mocha admite múltiples estilos de escritura de pruebas y permite adoptar convenciones que se adapten a distintas preferencias (describe, it, suite, test...). Chai y Mocha se integran muy bien entre sí, y ambos son compatibles con TypeScript y Node.js.
- Comunidad y mantenimiento: Mocha cuenta con un ecosistema robusto, compuesto por unos 430 contribuidores, financiación y una base de usuarios amplia (media de 7.195.110 descargas por semana), situándose en el top 5% de herramientas más utilizadas. Su mantenimiento es aceptable y dentro de lo que se consideraría saludable, siendo su última versión hace 12 meses y la última actualización, hace 8 desde el 27/11.
- Mejores prácticas: Mocha dispone de soporte eficiente para pruebas asíncronas, utilización de hooks y suites jerárquicas para configuración y limpieza... En general, permite adoptar buenas prácticas en el desarrollo de tests.
Para poder ejecutar los tests escritos no se requiere la instalación adicional de más herramientas. La interfaz de línea de comandos ya viene integrada en el test runner, así que bastaría con la terminal y los gestores ya configurados (pnpm y grunt) para poder realizar la ejecución de tests.