coverage-average


Computes the average coverage from a text-summary file like:

``TEXT

=============================== Coverage summary ===============================
Statements : 94.55% ( 52/55 )
Branches : 100% ( 6/6 )
Functions : 85% ( 17/20 )
Lines : 94.44% ( 51/54 )
================================================================================
`

Why

Use it in your CI builds to force a failure if test coverage falls below your desired percentage.

Usage

Output average:

`BASH
$ coverage-average path/to/text-summary.txt
Coverage average is 93.50%
`

Output average, exit 1 if average is below threshold

`BASH
$ coverage-average path/to/text-summary.txt --limit 95
FAIL Coverage average of 93.50% is below limit of 95.00%
`

`BASH
$ coverage-average path/to/text-summary.txt --limit 90
PASS Coverage average of 93.50% is above limit of 95.00%
`

Example

To have this module calculate the average coverage based on karma-coverage generated results, use a karma.conf.js file similar to:

`JavaScript
module.exports = function(config) {
config.set({
frameworks: ['jasmine'],
files: [
'bower_components/angular/angular.js',
'bower_components/angular-mocks/angular-mocks.js',
'src/*/.js,
'test/unit/*/.js'
],
browsers: ['PhantomJS'],
reporters: ['dots', 'coverage'],
preprocessors: {
'src/*/.js': ['coverage']
},
plugins: [
'karma-phantomjs-launcher',
'karma-coverage',
'karma-jasmine'
],
coverageReporter: {
reporters: [{
type: 'text-summary',
subdir: '.',
file: 'text-summary.txt'
}]
}
});
};
`

The summary file will be located at coverage/text-summary/text-summary.txt.

Calculate the average with:

`BAsh
$ coverage-average coverage/text-summary/text-summary.txt --limit 95
```

See sn-sticky-table-header for a working example.