README.md

Introducción al Testing Automatizado

Este repositorio muestra un ejemplo básico del uso de herramientas automáticas para ejecutar pruebas estáticas y dinámicas en un proyecto.

Uso del repositorio

Este repositorio utiliza NodeJS para ejecutar el código JavaScript en forma local, npm para gestionar las dependencias y pre-commit para las validaciones de formato. Para trabajar con el mismo usted debería tener instalado:

1. NodeJS (https://nodejs.org/es/download)
2. pre-commit (https://pre-commit.com/#install)

Después de clonar el repositorio usted debería ejecutar el siguiente comando:

npm install

Para generar la documentación del proyecto se utiliza el siguiente comando:

make doc

Creación del repositorio

Para la creación del repositorio

1. Creación del proyecto JavaScript

   npm init
   

2. Creación del archivo .gitignore usando con la herramienta de Toptal

3. Instalación de Prettier, la herramienta para verificación de formato

   npm install --save-dev --save-exact prettier
   node --eval "fs.writeFileSync('.prettierrc','{}\n')"
   

4. Ajuste de la configuración de Prettier usando los archivos .prettierrc y .prettierignore

5. Verificación del funcionamiento de Prettier

    npx prettier . --check
   

6. Instalación y configuración del plugin para Visual Studio Code

7. Instalación de ESLint, la herramienta para verificación estática del código JavaScript, junto con los plugins para integrar la revisión de formato con Prettier, la importación de dependencias y la inclusión de la cabecera con la licencia

   npm install --save-dev eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-import eslint-plugin-license-header
   

8. Creación de la plantilla con la cabecera de licencia en el archivo resources/license.js

9. Ajuste de la configuración de ESLint usando los archivos .eslintrc y .eslintignore

10. Instalación y configuración del plugin para Visual Studio Code

11. Instalación mocha, chai, sinon, proxyquire y nyc, las herramientas para automatizar las pruebas

    npm install --save-dev mocha chai nyc sinon proxyquire
    

12. Ajustes en el archivo `package.json``

    "scripts": {
       "test": "mocha --reporter spec",
       "coverage": "nyc --reporter=html mocha"
    },
    

13. Creación del archivo pre-commit-config.yaml

14. Instalación de pre-commit como hook en el repositorio git

    pre-commit install
    

Bibliografia

Chai Assertion Library - Official Site

Getting Started with Node.js and Mocha

Aprende a hacer Testing en Node.js: Mocha, Chai, Sinon, Proxyquire... WTF

A quick and complete guide to Mocha testing

Sinon JS Tutorial: A Beginner’s Guide to Mocking