Couverture de code avec Mocha

Question

J'utilise Mocha pour tester mon application NodeJS. Je ne parviens pas à comprendre comment utiliser sa fonction de couverture de code. J'ai essayé de le googler mais je n'ai pas trouvé de tutoriel approprié. Veuillez m'aider.

Answer 1

Vous avez besoin d'une bibliothèque supplémentaire pour la couverture de code, et vous allez être époustouflé par la puissance et la facilité avec lesquelles istanbul est. Essayez ce qui suit, après avoir réussi vos tests mocha :

npm install nyc

Maintenant, il suffit de placer la commande nyc devant votre commande de test existante, par exemple :

{
  "scripts": {
    "test": "nyc mocha"
  }
}

Answer 2

Maintenant ( 2021 ) la manière préférée d'utiliser istanbul se fait par l'intermédiaire de son "interface de ligne de commande de pointe" nycole .

Configuration

Tout d'abord, installez-le dans votre projet avec

npm i nyc --save-dev

Ensuite, si vous avez un projet basé sur npm, il suffit de modifier le test script à l'intérieur de la balise scripts l'objet de votre paquet.json pour exécuter la couverture de code de votre moka tests :

{
  "scripts": {
    "test": "nyc --reporter=text mocha"
  }
}

Exécuter

Maintenant, exécutez vos tests

npm test

et vous verrez un tableau comme celui-ci dans votre console, juste après la sortie de vos tests :

Personnalisation

Rapport Html

Il suffit d'utiliser

nyc --reporter=html

au lieu de text . Maintenant, il produira un rapport dans ./coverage/index.html .

Formats des rapports

Istanbul prend en charge un large éventail de formats de rapports. Il suffit de regarder ses bibliothèque des rapports pour trouver le plus utile pour vous. Il suffit d'ajouter un --reporter=REPORTER_NAME pour chaque format que vous souhaitez. Par exemple, avec

nyc --reporter=html --reporter=text

vous aurez à la fois la console et le rapport html.

Ne pas exécuter la couverture avec npm test

Il suffit d'ajouter un autre script dans votre package.json et laisser le test script avec seulement votre exécuteur de test (par exemple mocha) :

{
  "scripts": {
    "test": "mocha",
    "test-with-coverage": "nyc --reporter=text mocha"
  }
}

Maintenant, exécutez ce script personnalisé.

npm run test-with-coverage

pour exécuter des tests avec couverture de code.

Forcer l'échec du test si la couverture du code est faible

Échec si la couverture totale du code est inférieure à 90% :

nyc --check-coverage --lines 90 

Échec si la couverture de code d'au moins un fichier est inférieure à 90% :

nyc --check-coverage --lines 90 --per-file

Answer 3

La réponse acceptée (nyc) ne fonctionne pas si vous utilisez des modules ESM.

C8 semble être la meilleure solution actuellement, qui exploite les capacités intégrées de NodeJS et utilise istanbul (comme nyc, et partage les mêmes fichiers de configuration).

npm install -g c8
c8 mocha

Il utilisera le fichier .nycrc pour la configuration. Un exemple de configuration que j'utilise est :

{
    "all": true,
    "exclude": ["test"],
    "output": "reports",
    "reporter" : [
        "html",
        "text"
    ]
}

(Note : J'ai été dirigé vers c8 par une réponse à une autre question. https://stackoverflow.com/a/69846825/1949430 )

Answer 4

Blanket.js fonctionne aussi parfaitement.

npm install --save-dev blanket

devant votre test/tests.js

require('blanket')({
    pattern: function (filename) {
        return !/node_modules/.test(filename);
    }
});

exécuter mocha -R html-cov > coverage.html