Cómo hacer Mocks y Stubs con Sinon

Hola Para los que ven este video a mediados del 2018, les dejo este par de ajustes segun la actualización en documentación en sinon JS

Crear un sandbox:

 sandbox = sinon.createSandbox()

Restablecer un sandbox:

sandbox && sandbox.restore()

Documentación Sinon JS - Sandboxes

Agradezco este video va bien profundo en lo que es preparar unas pruebas unitarias.

Saludos!!

en las versiones recientes de sinon no se usa

sinon.sandbox.create()
sinon.sandbox.restore()

esto se convierte a

sinon.createSandbox()
sinon.resetHistory()

A partir de este vídeo me he dado cuenta que hace un buen rato que miro el código de Julián y lo copio en mi Visual Studio Code como un papagayo sin entender nada… Echo en falta quizás un vídeo que de vez en cuando haga un repaso-resumen de las cosas que se han ido implementando.

¿Quizás me he saltado un curso más liviano que explique los conceptos básicos de node.js antes de meterme en el curso avanzado?

O quizás yo soy más lento que el resto, no lo descarto xD.

Para versiones actuales de sinon me toco realizar los siguientes cambios:

let sanbox = null

test.beforeEach(async () => {
  sanbox = sinon.createSandbox()
  AgentStub = {
    hasMany:sanbox.spy()
  }
  ...
})

test.afterEach(() => {
  sanbox && sanbox.restore()
})

Hola, me aparecia error en sinon.sandbox.restore().
error sinon.sandbox.restore() is not a function.

Resuelto de la siguiente forma

sandbox.restore()

Adjunto enlace para consulta:

http://sinonjs.org/releases/v2.0.0/sandbox/

asi es como cambia el código en las versiones actuales, se llama directamente createSandbox en lugar de sinon.sandbox

de igual manera con afterEach(), directamente es sandbox.restore() sin necesidad de llamar a sinon

test.beforeEach(async () => {
  sandbox = sinon.createSandbox()
  ...
}
test.afterEach( () => {
  sandbox && sandbox.restore()
})

Algunas definiciones de la clase:

• Stub, objeto que es similar en su funcionalidad al objeto original (nuestro modelo), pero que la respuesta y los argumentos de entrada están previamente especificados con una librería o estrategia. Objetos falsos que se van a comportar de manera similar a los objetos reales.

• Spy es una función específica que permite hacer preguntas como: ¿Cuantas veces fue llamada una función?, ¿con que argumentos?, es muy útil a la hora de hacer pruebas.

• Sandbox ambiente especifico de sinon que va a funcionar para un caso particular (no de manera global). Cuando se termine de ejecutar la prueba se reinicia el sandbox.

Instalate un paquetico por NPM

Me gustaría una clase bonus sólo sobre testing. tengo que ver el video varias veces para darle sentido al serial, beforeEach afterEach, sandbox, proxyquire y sinon

Hola, para los que se atreven a realizar este excelente curso con un poco de desactualización como yo. En esta época ya existe un test runner llamado jest, mantenido por facebook que facilita un poco la construcción de las pruebas automatizadas. Para aquellos que quieran lanzarse con ello y no esten tan empapados, pueden ver el curso de Jest que está más adelante en la escuela de backend con JS o mirar mi implementación en mi repositorio.

Este test runner, no necesita la creación de un isolated env como lo es el sandbox ni un proxyquire. El realiza esa gestión internamente. Y para la restauración o limpieza de ese “sandbox”, jest ofrece la función clearAllMocks la cual puede ser llamada en los hooks muy similar a como se hace en esta clase.

Esas son algunas conclusiones que he sacado personalmente al hacer ese update de algunas dependencias como el test runner. Si alguien es más experto en el tema agradezco me corriga.

Hola Para lo que estén viendo este video en 2021 hay dos pequeños cambios en sinon “sinon.createSandbox()” y “sinon.restore()”

test.beforeEach(async () => {
  sandbox = sinon.createSandbox()

  AgentStub = {
    hasMany: sandbox.spy()
  }

  const setupDatabase = proxyquire('../', {
    './models/agent': () => AgentStub,
    './models/metric': () => MetricStub
  })

  db = await setupDatabase(config)
})

para que el test pase sin errores es necesario cambiar:

test.afterEach(t => {
  sandbox && sinon.sandbox.restore()
})

por

test.afterEach(t => {
  sandbox && sandbox.restore()
})

y tambien:

test.beforeEach(async () => {
  sandbox = sinon.sandbox.create()
  AgentStub = {
    hasMany: sandbox.spy()
  }

por

test.beforeEach(async () => {
  sandbox = sinon.createSandbox()
  AgentStub = {
    hasMany: sandbox.spy()
  }

Otra definición de STUBS: “en el contexto del testeo del software, un trozo de código usado como sustituto de alguna otra funcionalidad. Un stub puede simular el comportamiento de código existente (tal como un procedimiento en una máquina remota) o ser el sustituto temporal para un código aún no desarrollado”

Y comparto el link del sitio de SINONjs en el que se encuentra un poco más de documentación sobre el tema.

Usamos los stubs para garantizar que se hacen llamadas a las funciones adecuadas, abstraiendo asi las llamadas de sequelize, las cuales como son de una libreria externa ya testeada no debemos preocuparnos por testearla.

Instalación de sinon

creo que sería genial y muy útil tener cursos de sólo pruebas unitarias… ese tema me hace sentir muy muy muy perdido 😦

Creo que el msj que pasamos al método t.true() debería ser negando. Es decir que el AgentModel.hasMany no fue llamado.

test.serial('Setup' , () => {
  t.true(AgentStub.hasMany.called , "AgentModel.hasMany wasn't executed")
   t.true(AgentStub.hasMany.calledWith(MetricStub), 'Argument should be the model')
   t.true(MetricStub.belongsTo.called, `MetricModel.belongsTo wasn't executed`)
   t.true(MetricStub.belongsTo.calledWith(AgentStub), 'Argument should be the model')
})

Ya que este se imprime solo cuando AgentStub.hasMany.called retorna el valor false

demasiada información en muy poco tiempo. me frustre 😞

Por si alguien lo está haciendo con jest, este código me funciona

'use strict'

let config = {
    logging: function(){},
}

let mockMetricModel = {
    belongsTo: jest.fn(),
}

let mockAgentModel = null
let db = null

beforeEach(async () => {
  mockAgentModel = {
    hasMany: jest.fn(),
  }

  const setupDatabase = require('../../index')

  jest.mock('../../models/agent', () => jest.fn(() => mockAgentModel))
  jest.mock('../../models/metric', () => jest.fn(() => mockMetricModel))

  db = await setupDatabase(config)
})

afterEach(() => {
    jest.resetModules()
    jest.clearAllMocks()
})

describe('Agent', () => {
  test('The agent should exists', () => {
    expect(db.Agent).toBeDefined()
  })

  test('setupAgentModel.hasMany should be called', () => {
    expect(mockAgentModel.hasMany).toHaveBeenCalled()  
  })

  test('setupMetricModel.belongsTo should be called', () => {
    expect(mockMetricModel.belongsTo).toHaveBeenCalled()  
  })

  test('setupAgentModel.hasMany should be called with mockMetricModel', () => {
    expect(mockAgentModel.hasMany).toHaveBeenCalledWith(mockMetricModel)
  })
  
  test('setupMetricModel.belongsTo should be called with mockAgentModel', () => {
    expect(mockMetricModel.belongsTo).toHaveBeenCalledWith(mockAgentModel)
  })
})

✌

Error diciendo, sinon.sandbox.restore is not a function, en vez cambie esa linea a lo siguiente.

test.afterEach(() => {
  sandbox && sandbox.restore() // Eqv: if (sandbox) sinon.sandbox.restore();
})

que significa &&?

sandbox && sinon.sandbox.restore()

Le pone mucho color el profe con las pruebas, y los alumnos más se enredan

el contenido esta muy interesante y se nota que el lo comenta desde la experiencia por eso aveces uno como que se queda por que como no lo ha hecho o no ha hecho las malas practicas no sabe el por que de algunas razones , sin embargo leer la documentación de lo que usa es una buena opción

el npm test me bota que la prueba no paso, a qué se debe?

• ‘setupAgentModel is not a function’

Por si ayuda! https://solidgeargroup.com/tests-unitarios-en-javascript-sinon?lang=es

VSCode en Windows 10, al lado de la línea

const sinon = require('sinon')

muestra “677.4k (gzipped: 235k)” en rojo, me imagino que debe ser una advertencia sobre el tamaño de la librería, es problemático eso?

Como serian las pruebas para la liberia request-promise-native usando sinon.?

Este seria mi implementacion pero no esta funcionando correctamente

const request = require(‘request-promise-native’)
let resolveStub = sandbox.stub(request, ‘Request’).withArgs(options).resolves(data)

Donde “options” son los datos del conexion a la API y “data” es el resultado esperado.

¿a todos los imports del modelo en index se le deben de crear un stub?

Quise probar los stubs en un proyecto diferente y cuando hago el test me aparece el siguiente error

TypeError {
    message: 'Cannot read property \'belongsTo\' of undefined',
  }```
aca esta el codigo:
https://github.com/chaqui/backendLibreria/blob/master/backendLibreria-db/tests/TC_Persona-tests.js

Estoy intentando conseguir hacer los “stubs” con Jest y no consigo hacerlos funcionar

Les dejo el codigo sin los stubs por si alguien sabe como implementarlo, Gracias!

import setupDatabase from '..';

const config = {
  logging() {},
};

let db = null;

beforeEach(async () => {
  db = await setupDatabase(config);
});

describe('Agent', () => {
  test('Agent service should exist', () => {
    expect(db.Agent).toBeTruthy();
  });

  test('Setup', () => {
    // expect(MetricStub.belongsTo).toHaveBeenCalled();
    // expect(Agent).toHaveBeenCalled();
  });
});

Me parece interesante compartir esto que esta en la documentacion de AVA

Mocha requires you to use implicit globals like describe and it with the default interface (which most people use). It's not very opinionated and executes tests serially without process isolation, making it slow.

Me quedó una duda con respecto a cual es la función del sandbox, lo único que entendí es que es una forma de depurar mis stub, para que sean “limpiados” cada vez que se realice mi test. Pero estuve haciendo unas pruebas, removí todo lo que era sandbox e incluso quité mi hooks .afterEach()

test.beforeEach(async () => {
    /*sandbox = sinon.createSandbox()*/
    AgentStub = {
        hasMany: sinon.spy()
    }
    const setupDatabase = proxyquire('../', {
        './models/agent': () => AgentStub,
        './models/metric': () => MetricStub
    })
    db = await setupDatabase(config)
})

test('Agent' , t => {
    t.truthy(db.Agent , 'Agent should exist')
}) 

test.serial('Setup', t => {
    t.true(AgentStub.hasMany.called, `AgentModel.hasMany wasn't executed`)
    t.true(AgentStub.hasMany.calledWith(MetricStub), 'Argument should be the model')
    t.true(MetricStub.belongsTo.called, `MetricModel.belongsTo wasn't executed`)
    t.true(MetricStub.belongsTo.calledWith(AgentStub), 'Argument should be the model')
})

/*test.afterEach(async () => {
           sandbox && sinon.resetHistory()
}) */ 

realicé la primera prueba, y todo sucedió okay, como debía ser, pero ahora hice lo siguiente.

 // AgentModel.hasMany(MetricModel)
  MetricModel.belongsTo(AgentModel)

Como se supone que el sinon está ya “llamado” debería recordar el test anterior ¿o no? Resulta que al realizar el prueba, me marcó que el has many no fue llamado. Entonces me hace creer que el sandbox no cumple ninguna función y me confunde todo esto.

También investigué que mi objeto sinon a partir de la versión 5.0, ya es un sandbox por defecto, pero recuerda que nunca hice el reset de este, ya que comenté el afterEach()

no se que error tengo este es mi codigo:

'use strict'

const test = require('ava')
const proxyquire = require('proxyquire')

let config = {
  logging: function () {}
}

let MetricStub = {
  belongsTo: function () {}
}

let AgentStub = null
let db = null

test.beforeEach(async () => {
  AgentStub = {
    hasMany: function () {}
  }

  const setupDatabase = proxyquire('../', {
    './models/agent': () => AgentStub,
    './models/metric': () => MetricStub
  })

  db = await setupDatabase(config)
})

test('Agent', t => {
  t.truthy(db.Agent, 'Agent service should exist')
})

y me sigue diciendo que proxyquire no esta definido:

 C:\Users\Hewllet\Videos\aaa\platziverse\platziverse-db\tests\agent-tests.js:21:25: 'proxyquire' is not defined.

Proxyquire sobreescribe los modelos

Estoy teniendo problemas con proxyquire, tengo la dependencia instalada pero al correr el test me sigue diciendo que proxyquire no esta definido, ya he desinstalado y vuelto a instalar proxyquire y no se que hacer

"dependencies": {
    "chalk": "^2.4.1",
    "debug": "^3.1.0",
    "defaults": "^1.0.3",
    "inquirer": "^6.0.0",
    "pg": "^7.4.3",
    "pg-hstore": "^2.3.2",
    "sequelize": "^4.38.0"
  }
}

'use strict'

const test = require('ava')
const proxyquire = require('proxyquire')

let config = {
  logging: function () {}
}

let MetricStub = {
  belongsTo: function () {}
}

let AgentStub = null
let db = null

test.beforeEach(async () => {
  AgentStub = {
    hasMany: function () {}
  }

  const setupDatabase = proxyquire('../', {
    './models/agent': () => AgentStub,
    './models/metric': () => MetricStub
  })

  db = await setupDatabase(config)
})

test('Agent', t => {
  t.truthy(db.Agent, 'Agent service should exist')
})

C:\Users\Hewllet\Videos\aaa\platziverse\platziverse-db>npm run lint

> [email protected] lint C:\Users\Hewllet\Videos\aaa\platziverse\platziverse-db
> standard

standard: Use JavaScript Standard Style (https://standardjs.com)
  C:\Users\Hewllet\Videos\aaa\platziverse\platziverse-db\tests\agent-tests.js:21:25: 'proxyquire' is not defined.

Corro el comando npm i sinon --save-dev y el comando npm i --save-dev proxyquire y no se agregan a las dependencias de desarrollo. Alguien sabe porque?

{
  "name": "platziverse-db",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "DEBUG=platziverse:* nyc --reporter=lcov ava tests/* --verbose",
    "setup": "DEBUG=platziverse:* node setup.js",
    "lint": "standard",
    "lint-fix": "standard --fix"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "ava": "^3.8.2",
    "nyc": "^15.0.1",
    "sqlite3": "^4.2.0",
    "standard": "^14.3.4"
  },
  "dependencies": {
    "chalk": "^4.0.0",
    "debug": "^4.1.1",
    "defaults": "^1.0.3",
    "inquirer": "^7.1.0",
    "pg": "^8.2.0",
    "pg-hstore": "^2.3.3",
    "sequelize": "^5.21.9"
  }
}

npm i proxyquire -D

Tambien pueden cambiar el
`sandbox= sinon.sandbox.create()``
por

``sandbox= sinon.createSandbox()

Wow, cada vez me sorprendo mas en Platzi, este curso está a un nivel profesional

Tener en cuenta cambiar sinon.sandbox.create() por sinon.createSandbox() ya que sandbox.create() ahora es obsoleto

test.beforeEach(async () => {
  sandbox = sinon.createSandbox()
....

Dejo asentado que hay un posible problema entre sqlite 3.1.9 y la instalacion de sinon

Me salió error al querer instalar sinon. La solución la encontré en stackoverflow.

Sólo tienes que borrar el archivo package-lock.json e intentar de nuevo instalar sinon.

No entendí la diferencia entre las aserciones true y thuty en AVA

Apartir de la instalacion del modulo de sqlite3 estoy teniendo problemas con la instalacion de los modulos, esto a que se debe?

saludos

Hola, el test.beforeEach(async () => { … Podríamos quitarle lo de async? No parece que tenga que ser asyncrono necesariamente, no? En el afterEach no hemos puesto que sea asyncrona

En caso de querer hacer el stub pero ES6 sin usar proxyquire, es posible realizar de alguna forma tal stub, ya que al crear el stub de AgentModel el test no reconoce el metodo findById.
Alguna guía al respecto? se agradece de antemano

Creo que nos tardamos más en realizar pruebas que en implementar el módulo. Pero sin duda hacer pruebas hace que escribas mejor código.

Buenas, tengo un par de dudas:

1. No termino de entender cual es la diferencia del objeto sandbox con respecto al método spy de sinon y porque tengo que generar un stub del modelo Agent por cada test y no hago lo mismo con el de Metric.
2. ¿No puedo definir el objeto sandbox por fuera del beforeEach? Si de todas formas lo estoy reiniciando cada vez que finaliza cada test.
3. No me termina de cerrar que hace la siguiente linea de código:

sandbox && sinon.sandbox.restore()

Perdón por tantas preguntas, esta muy bueno el curso.

¡Muchas gracias!

Si sientes que estas perdido apartir de este video es porque probablemente lo estes, yo tambien me sentí asi. Lo que hice para dejar de sentirme asi fue regresar al código y cambiar líneas para hacer fallar el test, comentar cada paso que se está haciendo en los tests y en los otro módulos, volver a ver los videos, tomará tiempo pero vale la pena.

Para los que no estamos muy familiarizados con la parte de pruebas, les recomiendo este enlace

Me ayudó a entender un poco que son exactamente los Stubs y Mocks y así pude ver porque el profe hacia las cosas en el código!

Hay algo fundamental que aun no se entiende, el concepto de “uni-test”. Cualquiera que realmente quiera entender porque se hace mocking y stub primero tiene que entender este concepto.

Creo que de estos temas de testeo podria salir un curso completo que creo debe ser obligatorio en la carrera de js

Buenas, que alternativas tengo a proxyquiere si estoy usando modules de ES6 (import, export) ??