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 afin 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 fonctionne pas la méthode' vraie?

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

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

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

  it('ne fonctionne pas la méthode', () => {
    // comment rendre cela 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 puisque 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 devraient sans que l'espion soit appelé à partir du test précédent. Vous pouvez également lire leur documentation à propos de cette fonctionnalité.

Option 2

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

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

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

Answer 2

Les espions Jest ont la même API que les mocks. La documentation pour les 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.

Cela est souvent utile lorsque vous souhaitez nettoyer les données d'utilisation d'un mock entre deux assertions.

(mise en emphase de ma part)

Donc nous pouvons 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 afin que les assertions futures
       ne soient pas affectées par les appels 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 dans CodeSandbox.

Answer 3

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

Consultez l'exemple ci-dessous:

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

const myObject = new MyClass();
const mockMyBooleanMethod = jest.spyOn(myObject, 'myBooleanMethod', 'get');
// simuler que myBooleanMethod renvoie false
mockMyBooleanMethod.mockReturnValue(false);
// restaurer myBooleanMethod à son comportement d'origine
mockMyBooleanMethod.mockRestore();

Answer 4

En allant plus loin dans 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,
...
}

Consultez la documentation ici.

Answer 5

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

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

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

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