Actualizar readme

Refactorizar funciones

Author: baumannzone

README.md

@@ -1,5 +1,14 @@
-# Testing con Javascript
+# Introducción al Testing con Javascript
 
-> Ejemplo básico de tests con Javascript
+> Ejemplo básico de pruebas (tests) con Javascript
 
-  
+## Contexto
+Hace un mes aproximadamente (Julio 2019), escribí un artículo en Medium que hablaba sobre la importancia de los test en nuestras aplicaciones: [Sobre Pruebas (Testing)](https://medium.com/@baumannsito/about-testing-304fac4034c3)  
+Este repositorio, además de ser la continuación de dicho artículo, es también la motivación de continuar hablando (en esta ocasión, de manera más práctica) acerca de las pruebas automáticas de nuestras aplicaciones. 
+
+## Requisitos
+- Conocimientos básicos de javascript 
+
+
+- Node.js (actualmente tengo la `v. 12.8`)
+- npm (actualmente tengo la `v. 6.10)

funcionesMatematicas.js

@@ -0,0 +1,26 @@
+/**
+ * funciones.js
+ * Listado con las funciones a utilizar en los tests
+ */
+const assert = require( 'assert' )
+
+
+/**
+ * Suma 2 números y retorna su valor
+ * @param num1 {number}
+ * @param num2 {number}
+ * @returns {*}
+ */
+const suma = ( num1, num2 ) => num1 + num2
+
+
+/**
+ * Resta 2 números y retorna su valor
+ * @param num1 {number}
+ * @param num2 {number}
+ * @returns {number}
+ */
+const resta = ( num1, num2 ) => num1 - num2
+
+
+module.exports = { suma, resta }

funciones.js funcionesTesting.jsfunciones.js renamed to funcionesTesting.js

@@ -1,31 +1,5 @@
 /**
- * funciones.js
- * Listado con las funciones a utilizar en los tests
- */
-const assert = require( 'assert' )
-
-
-/**
- * Suma 2 números y retorna su valor
- * @param num1 {number}
- * @param num2 {number}
- * @returns {*}
- */
-const suma = ( num1, num2 ) => num1 + num2
-
-
-/**
- * Resta 2 números y retorna su valor
- * @param num1 {number}
- * @param num2 {number}
- * @returns {number}
- */
-const resta = ( num1, num2 ) => num1 - num2
-
-
-/**
- * Pequeña funcionalidad que comprueba si `dato` es igual a `esperado`
- * Es "encadenable"
+ * Comprueba si `dato` es igual a `esperado`. Es encadenable.
  * @param dato {number} Dato de entrada, el resultado.
  * @returns {{seaIgualQue: seaIgualQue}}
  */
@@ -41,6 +15,13 @@ const esperoQue = ( dato ) => {
   }
 }
 
+/**
+ * Ejecuta el test (funcion) y require una descripcion (titulo) de dicho test
+ * Si el test falla, logea el titulo del test y el error
+ * Si el test se completa correctamente, logea el titulo del test
+ * @param titulo {string}
+ * @param funcion {function}
+ */
 const prueba = ( titulo, funcion ) => {
   try {
     funcion()
@@ -51,4 +32,4 @@ const prueba = ( titulo, funcion ) => {
   }
 }
 
-module.exports = { suma, resta, esperoQue, prueba }
+module.exports = { esperoQue, prueba }

test-1.js

@@ -2,7 +2,7 @@
  * test-1.js
  */
 
-const { suma, resta } = require( './funciones' )
+const { suma, resta } = require( './funcionesMatematicas' )
 
 let resultado, esperado
 

test-2.js

@@ -3,7 +3,7 @@
  * https://nodejs.org/api/assert.html#assert_assert
  */
 const assert = require( 'assert' )
-const { suma, resta } = require( './funciones' )
+const { suma, resta } = require( './funcionesMatematicas' )
 
 let resultado, esperado
 

test-3.js

@@ -1,7 +1,8 @@
 /**
  * test-3.js
  */
-const { suma, resta, esperoQue } = require( './funciones' )
+const { suma, resta } = require( './funcionesMatematicas' )
+const { esperoQue } = require( './funcionesTesting' )
 
 let resultado, esperado
 

test-4.js

@@ -1,7 +1,8 @@
 /**
  * test-4.js
  */
-const { suma, resta, esperoQue, prueba } = require( './funciones' )
+const { suma, resta } = require( './funcionesMatematicas' )
+const { esperoQue, prueba } = require( './funcionesTesting' )
 
 prueba( 'Suma 2 números positivos correctamente', () => {
   const resultado = suma( 2, 3 )

test-5.js

@@ -0,0 +1,28 @@
+/**
+ * test-4.js
+ */
+const { suma, resta, esperoQue, prueba } = require( './funcionesMatematicas' )
+
+prueba( 'Suma 2 números positivos correctamente', () => {
+  const resultado = suma( 2, 3 )
+  const esperado = 5
+  esperoQue( resultado ).seaIgualQue( esperado )
+} )
+
+prueba( 'Suma 2 números negativos correctamente', () => {
+  const resultado = suma( -2, -3 )
+  const esperado = -5
+  esperoQue( resultado ).seaIgualQue( esperado )
+} )
+
+prueba( 'Resta 2 números correctamente', () => {
+  const resultado = resta( 8, 3 )
+  const esperado = 5
+  esperoQue( resultado ).seaIgualQue( esperado )
+} )
+
+prueba( 'Resta 2 números negativos correctamente', () => {
+  const resultado = resta( -8, -3 )
+  const esperado = -5
+  esperoQue( resultado ).seaIgualQue( esperado )
+} )