ember-cli-code-coverage

ember-cli-code-coverage

Code coverage using Istanbul for Ember apps.

Requirements

• If using Mocha, Testem >= 1.6.0 for which you need ember-cli > 2.4.3
• If using Mirage you need ember-cli-mirage >= 0.1.13
• If using Pretender (even as a dependency of Mirage) you need pretender >= 0.11.0
• If using Mirage or Pretender, you need to set up a passthrough for coverage to be written.
• ember-cli-babel >= 6.0.0

Installation

• ember install ember-cli-code-coverage

Usage

Coverage will only be generated when an environment variable is true (by default COVERAGE) and running your test command like normal.

For example:

COVERAGE=true ember test

If you want your coverage to work on both Unix and Windows, you can do this:

npm install cross-env --save-dev

and then:

cross-env COVERAGE=true ember test

When running with parallel set to true, the final reports can be merged by using ember coverage-merge. The final merged output will be stored in the coverageFolder.

If you intend to use ember test with the --path flag, you should generate the build with coverageEnvVar set as true. This is because the code is instrumented for coverage during the build.

For example:

COVERAGE=true ember build --environment=test --output-path=dist

followed by

COVERAGE=true ember test --path=dist

TypeScript integration

Steps:

• in tsconfig.json

  {
    "compilerOptions": {
      "inlineSourceMap": true,
      "inlineSources": true
    }
  }

• in ember-cli-build.js

  const app = new EmberApp(defaults, {
    babel: {
      sourceMaps: 'inline'
    },
    sourcemaps: {
      enabled: true,
      extensions: ['js']
    }
  });

• in package.json specify latest available version

  {
    devDependencies: {
      "ember-cli-code-coverage": "^1.0.0-beta.9"
    }
  }

Configuration

Configuration is optional. It should be put in a file at config/coverage.js (configPath configuration in package.json is honored). In addition to this you can configure Istanbul by adding a .istanbul.yml file to the root directory of your app (See https://github.com/gotwarlost/istanbul#configuring)

Options

• coverageEnvVar: Defaults to COVERAGE. This is the environment variable that when set will cause coverage metrics to be generated.

• reporters: Defaults to ['lcov', 'html']. The json-summary reporter will be added to anything set here, it is required. This can be any reporters supported by Istanbul.

• excludes: Defaults to ['*/mirage/**/*']. An array of globs to exclude from instrumentation. Useful to exclude files from coverage statistics.

• coverageFolder: Defaults to coverage. A folder relative to the root of your project to store coverage results.

• parallel: Defaults to false. Should be set to true if parallel testing is being used for separate test runs, for example when using ember-exam with the --partition flag. This will generate the coverage reports in directories suffixed with _<random_string> to avoid overwriting other threads reports. These reports can be joined by using the ember coverage-merge command (potentially as part of the posttest hook in your package.json).

Example

  module.exports = {
    coverageEnvVar: 'COV'
  }

Create a passthrough when intercepting all ajax requests in tests

To work, this addon has to post coverage results back to a middleware at /write-coverage.

If you are using ember-cli-mirage you should add the following:

// in mirage/config.js

  this.passthrough('/write-coverage');
  this.namespace = 'api';  // It's important that the passthrough for coverage is before the namespace, otherwise it will be prefixed.

If you are using ember-cli-pretender you should add the following:

// where ever you set up the Pretender Server

  var server = new Pretender(function () {
    this.post('/write-coverage', this.passthrough);
  });

Inspiration

This addon was inspired by ember-cli-blanket. The primary differences are that this addon uses Istanbul rather than Blanket for coverage and it instruments your application code as part of the build, when enabled.

Changelog

v1.0.0 (2020-08-31)

:boom: Breaking Change

• #252 Drop Node 8 and 11 support. (@rwjblue)

:rocket: Enhancement

• #263 Remove deprecated istanbul-api package. (@rwjblue)
• #261 Replace extend package with Object.assign (@rwjblue)
• #259 Remove lodash.concat dependency (@rwjblue)
• #258 Remove RSVP dependency. (@rwjblue)
• #255 Update dependencies to latest (@rwjblue)

:bug: Bug Fix

• #262 Fix issue with coverage report. (@rwjblue)
• #260 Ensure coverage build is parallelizable (@rwjblue)
• #257 Remove unused babel-plugin-transform-async-to-generator package (@rwjblue)
• #248 test cases fail with --path option in 1.0.0-beta.8 version (@abishek-srinivasan)
• #251 fix InvalidStateError exception (@brokenalarms)

:memo: Documentation

• #273 Update instructions for Typescript integration to use 1.0.0-beta.9 (@tomichal)

:house: Internal

• #282 Use .includes() instead of .indexOf() (@Turbo87)
• #281 Simplify _isCoverageEnabled() method (@Turbo87)
• #280 Remove unused _parentName() method (@Turbo87)
• #279 tests: Use async/await (@Turbo87)
• #278 mocha: Remove unnecessary Babel integration (@Turbo87)
• #277 Use shorthand methods and named functions (@Turbo87)
• #274 Use Prettier for code formatting (@Turbo87)
• #276 Use GitHub Actions for CI/CD (@Turbo87)
• #272 Fix node-tests (@Turbo87)
• #256 Remove co usage (@rwjblue)
• #254 Migrate to more modern linting setup. (@rwjblue)
• #253 Update release process (@rwjblue)
• #249 Update to 3.16 ember-cli blueprint (@rajasegar)

Committers: 6

• Daniel (@brokenalarms)
• Rajasegar Chandran (@rajasegar)
• Robert Jackson (@rwjblue)
• Tobias Bieniek (@Turbo87)
• @tomichal
• abishek-srinivasan (@abishek-srinivasan)