Jest test coverage does not fail when threshold is not met

user_1202630 0
Viewed 10650

Utilizing create-react-app, when running tests in my CI pipeline, if the code coverage thresholds are not met, I expect the console to return a non-zero response.

package.json

"scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "test:coverage": "npm run test -- --coverage --watchAll=false",
  },
  "jest": {
    "collectCoverageFrom": [
      "src/components/**/*.js",
      "src/state/**/*.js",
      "src/templates/**/*.js",
      "src/routes/**/*.js"
    ],
    "coverageThreshold": {
      "global": {
        "branches": 80,
        "functions": 80,
        "lines": 80,
        "statements": 80
      }
    }
  }

When running test:coverage the console reports that thresholds were not met, but still returns 0. My understanding from the Jest documentation is that an error should be returned when coverage thresholds are not met.

https://jestjs.io/docs/en/configuration#coveragethreshold-object

Specifically...

If thresholds aren't met, jest will fail.

Is anyone familiar with this issue? I have been through Jest and CRA github issues with mixed results and most findings are related to outdated versions.

create-react-app jestjs code-coverage
4 Answers
user_58713400

Defining the config in the packjage.json file did not fail the jest command when coverage threshold was not met. But it worked when I defined it through the jest.config.js file!

user_65814880

Add "collectCoverage": true, in your jest configuration. After that jest run operation will fail, if the coverage is not met.

user_89536130

This will make the test fail if the conditions are not met, but please note that this will slow down your tests:

 "scripts": {
        "test": "jest --collectCoverage=true",
        "coverage" : "jest --coverage"
      },
user_58563320
Related