Comment réinitialiser ou effacer un espion dans Jest ?

Question

J'ai un espion qui est utilisé dans plusieurs assertions à travers plusieurs tests dans une suite.

Comment puis-je effacer ou réinitialiser l'espion de sorte que dans chaque test la méthode que l'espion intercepte soit considérée comme n'ayant pas été invoquée?

Par exemple, comment rendre l'assertion dans 'ne pas exécuter la méthode' vraie?

const methods = {
  run: () => {}
}

const spy = jest.spyOn(methods, 'run')

describe('espion', () => {
  it('exécute la méthode', () => {
    methods.run()
    expect(spy).toHaveBeenCalled() //=> true
  })

  it('ne pas exécuter la méthode', () => {
    // comment rendre ceci vrai?
    expect(spy).not.toHaveBeenCalled() //=> false
  })
})

Answer 1

Merci à @sdgluck pour la réponse, bien que je voudrais ajouter à cette réponse que dans mon cas, je voulais un état clair après chaque test car j'ai plusieurs tests avec le même espion. Donc au lieu d'appeler mockClear() dans le(s) test(s) précédent(s), je l'ai déplacé dans le afterEach() (ou vous pouvez l'utiliser avec beforeEach) comme ceci :

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

Et enfin, mes tests fonctionnent comme ils le devraient sans que l'espion ne soit appelé depuis le test précédent. Vous pouvez également consulter leur documentation à propos de cette fonctionnalité.

Option 2

Si vous souhaitez le faire au niveau global, vous pourriez également mettre à jour votre jest.config.js (ou depuis package.json) ce qui effacera l'espion à chaque test sans avoir à appeler jest.clearAllMocks() à chaque test.

module.exports = {
  clearMocks: true,
  // ...
}

Vous pouvez consulter la documentation de Jest à propos de cette fonctionnalité.

Answer 2

Les espions Jest ont la même API que les mocks. La documentation des mocks se trouve ici et spécifie une méthode mockClear qui:

Réinitialise toutes les informations stockées dans les tableaux mockFn.mock.calls et mockFn.mock.instances.

Très souvent, cela est utile lorsque vous souhaitez nettoyer les données d'utilisation d'un mock entre deux assertions.

(mes propres emphases)

Nous pouvons donc utiliser mockClear pour "réinitialiser" un espion. En utilisant votre exemple:

const methods = {
  run: () => {}
}

const spy = jest.spyOn(methods, 'run')

describe('spy', () => {
  it('exécute la méthode', () => {
    methods.run()
    expect(spy).toHaveBeenCalled() //=> true
    /* nettoyer l'espion pour que les assertions futures
       ne soient pas affectées par les invocations de la méthode
       dans ce test */
    spy.mockClear()
  })

  it('n'exécute pas la méthode', () => {
    expect(spy).not.toHaveBeenCalled() //=> true
  })
})

Voici un exemple sur CodeSandbox.

Answer 3

Si vous souhaitez restaurer le comportement d'origine d'une méthode que vous aviez précédemment ajoutée à un espion, vous pouvez utiliser la méthode mockRestore.

Jetez un œil à l'exemple ci-dessous:

class MyClass {
    get myBooleanMethod(): boolean {
        return true;
    }
}

const myObject = new MyClass();
const mockMyBooleanMethod = jest.spyOn(myObject, 'myBooleanMethod', 'get');
// mock myBooleanMethod to return false
mockMyBooleanMethod.mockReturnValue(false);
// restore myBooleanMethod to its original behavior
mockMyBooleanMethod.mockRestore();

Answer 4

En approfondissant la réponse de @ghiscoding, vous pouvez spécifier clearMocks dans la configuration de Jest, ce qui équivaut à appeler jest.clearAllMocks() entre chaque test :

{
...
    clearMocks: true,
...
}

Voir la documentation ici.

Answer 5

MODIFIER : Dans jest.config.js ajoutez resetMocks - pas clearMocks, car cela ne supprimera pas toute implémentation simulée entre les tests (c'est-à-dire que resetMocks est l'option plus prudente et supprimera l'implémentation entre les tests - ce qui, à mon avis, est la bonne chose à faire puisque chaque test est censé être isolé).

Référence : https://jestjs.io/docs/configuration#resetmocks-boolean

{
...
    resetMocks: true,
...
}

En plus de cela, vous pourriez également appeler jest.resetAllMocks() dans beforeEach ou afterEach.