How to get karma-coverage (istanbul) to check coverage of ALL source files?

Question

The code structure I have an `app` directory structure like ``` scripts/sequoia/ ├── GraphToolbar.js ├── nodes │ ├── activityNode.js │ └── annotationNode.js ├── OverviewCanvasControl.js └── settings ├── GraphControlSettingsFactory.js └── SnapContextFactory.js ``` My `test` directory current looks thus ``` test/spec/ ├── GraphToolbarSpec.js ├── settings │ ├── graphControlSettingsFactorySpec.js │ └── snapContextFactorySpec.js └── test-main.js ``` Note that I only have `GraphToolbar` and the `settings/` files covered so far; there are no tests yet for `OverviewCanvasControl.js` or the `nodes/` files. The karma config In my `karma.conf.js` (`coverage` refers to `karma-coverage`): ``` preprocessors: { 'scripts/sequoia/**/*.js': ['coverage'] }, reporters: ['progress','coverage'], ``` The problem When I run karma, the coverage preprocessor & reporter run, but it only checks the files that already have specs written. I want to be reporting 0% coverage for `OverviewCanvasControl.js` and the `n…

Accepted Answer

Solution I came up with: walk source tree & check that a spec file exists for each source JS file. This assumes that each source file has a corresponding `Spec.js` file (residing in a corresponding directory structure).

- `app/scripts/moduleFoo.js` → `test/spec/moduleFooSpec.js`

- `app/scripts/ns1/Utils/foo_bar.js` →`test/spec/ns1/Utils/foo_barSpec.js`

Task relies on fs-tools npm module.

```
var fsTools = require('fs-tools');
//... module.exports = function(grunt) { ... etc. (gruntfile setup)

grunt.registerTask('checkspecs', 'ensure that all js files have Specs', function(){
    var done = this.async();
    var srcPath = './'+cfg.app+'/scripts/'; //Where are your scripts?
    var testPath = './test/spec/';          //Where are your specs?
    var missingSpecs = [];
    fsTools.walk(srcPath, '.js$', function(path,stats,callback){
      var specPath = testPath + path.substring(path.indexOf('ptc')+4);
      //strip .js, add Spec.js
      specPath = specPath.split('').slice(0,-3).join('') + 'Spec.js';
      if(!grunt.file.exists(specPath)){
        missingSpecs.push(path);
      }
      callback();
    }, function (err){
      if(err){
        grunt.log.error(err);
        done(false);
      }
      if(missingSpecs.length > 0){
        grunt.log.warn('`Spec.js` files are missing for the following files!!');
        missingSpecs.forEach(function(path){
          grunt.log.warn(path);
        });
      }else{
        grunt.log.ok('Spec files present for all source files');
      }
      done(!err);                   //fail only if fsTools.walk throws
      //done(!missingSpecs.length); //fail if any specs are "missing"
    });
  });
```

Why don't you package this as a grunt task and publish to NPM?

Mostly because it relies a lot on the specific paths & naming conventions in your project. It doesn't exclude directories/files yet (this may be necessary) & if you don't do `*Spec.js` it won't work. Imo it's probably easier to take this snippet & customize it than to externalize everything & make it a configurable task. Might change this later.

How to get karma-coverage (istanbul) to check coverage of ALL source files?

Solution

Problem