Cuando queremos simular módulos externos con Jest, podemos usar el método jest.mock() para simular funciones automáticamente en un módulo.
Luego podemos manipular e interrogar las funciones simuladas en nuestro módulo simulado como deseemos.
Por ejemplo, considere el siguiente ejemplo artificial para burlarse del módulo axios:
import myModuleThatCallsAxios from '../myModule'; import axios from 'axios'; jest.mock('axios'); it('Calls the GET method as expected', async () => { const expectedResult: string = 'result'; axios.get.mockReturnValueOnce({ data: expectedResult }); const result = await myModuleThatCallsAxios.makeGetRequest(); expect(axios.get).toHaveBeenCalled(); expect(result).toBe(expectedResult); });Lo anterior funcionará bien en Jest pero arrojará un error de mecanografiado:
La propiedad 'mockReturnValueOnce' no existe en el tipo '(url: string, config?: AxiosRequestConfig | undefined) => AxiosPromise'.
El typedef para axios.get correctamente no incluye una propiedad mockReturnValueOnce . Podemos obligar a Typescript a tratar axios.get como un objeto literal envolviéndolo como Object(axios.get) , pero:
¿Cuál es la forma idiomática de simular funciones manteniendo la seguridad de tipos?
Agregue esta línea de código const mockedAxios = axios as jest.Mocked<typeof axios> . Y luego use el mockedAxios para llamar al mockReturnValueOnce. Con su código, debe hacerse así:
import myModuleThatCallsAxios from '../myModule'; import axios from 'axios'; jest.mock('axios'); const mockedAxios = axios as jest.Mocked<typeof axios>; it('Calls the GET method as expected', async () => { const expectedResult: string = 'result'; mockedAxios.get.mockReturnValueOnce({ data: expectedResult }); const result = await myModuleThatCallsAxios.makeGetRequest(); expect(mockedAxios.get).toHaveBeenCalled(); expect(result).toBe(expectedResult); });Utilice la función mocked de ts-jest
El
mockedde prueba simulado proporciona escrituras en sus módulos simulados e incluso sus métodos profundos, en función de la escritura de su fuente. Hace uso de la última característica de TypeScript, por lo que incluso tiene tipos de argumentos completos en el IDE (a diferencia de jest.MockInstance).
import myModuleThatCallsAxios from '../myModule'; import axios from 'axios'; import { mocked } from 'ts-jest/utils' jest.mock('axios'); // OPTION - 1 const mockedAxios = mocked(axios, true) // your original `it` block it('Calls the GET method as expected', async () => { const expectedResult: string = 'result'; mockedAxios.mockReturnValueOnce({ data: expectedResult }); const result = await myModuleThatCallsAxios.makeGetRequest(); expect(mockedAxios.get).toHaveBeenCalled(); expect(result).toBe(expectedResult); }); // OPTION - 2 // wrap axios in mocked at the place you use it('Calls the GET method as expected', async () => { const expectedResult: string = 'result'; mocked(axios).get.mockReturnValueOnce({ data: expectedResult }); const result = await myModuleThatCallsAxios.makeGetRequest(); // notice how axios is wrapped in `mocked` call expect(mocked(axios).get).toHaveBeenCalled(); expect(result).toBe(expectedResult); }); No puedo enfatizar cuán grande es la mocked , no más encasillamiento nunca.
Para simular idiomáticamente la función manteniendo el tipo de seguridad, use spyOn en combinación con mockReturnValueOnce :
import myModuleThatCallsAxios from '../myModule'; import axios from 'axios'; it('Calls the GET method as expected', async () => { const expectedResult: string = 'result'; // set up mock for axios.get const mock = jest.spyOn(axios, 'get'); mock.mockReturnValueOnce({ data: expectedResult }); const result = await myModuleThatCallsAxios.makeGetRequest(); expect(mock).toHaveBeenCalled(); expect(result).toBe(expectedResult); // restore axios.get mock.mockRestore(); });