Full Gulp Istanbul Coverage Report

javascript unit-testing mocha.js gulp istanbul
Scott picture Scott · Mar 28, 2014 · Viewed 10.8k times · Source

I am using gulp-istanbul to generate JavaScript unit test coverage reports through Gulp. Is there a way to configure Istanbul to generate a full coverage report of all the JS files in my gulp stream, and not just the files touched by a test case.

I'm working on a project with a lot of JS, but no unit tests, and we are trying to increase the test coverage. I would like to have a coverage report that starts by show 0% coverage for most of our files, but over time will present an increasing coverage percentage.

gulp.task( 'test', function () {
    gulp.src( [ my source glob ] )
        .pipe( istanbul() )
        .on( 'end', function () {
            gulp.src( [ my test spec glob ] )
                .pipe( mocha( {
                    reporter: 'spec'
                } ) )
                .pipe( istanbul.writeReports(
                    [ output location ]
                ) );
        } );
} );

Answer

Romain Braun picture Romain Braun · Oct 17, 2014

It actually is much more simple now and you just have to add includeUntested to your istanbul() call.

gulp.task('test', function () {
    return gulp.src('./assets/**/js/*.js')
      // Right there
      .pipe(istanbul({includeUntested: true}))
      .on('finish', function () {
        gulp.src('./assets/js/test/test.js')
          .pipe(mocha({reporter: 'spec'}))
          .pipe(istanbul.writeReports({
            dir: './assets/unit-test-coverage',
            reporters: [ 'lcov' ],
            reportOpts: { dir: './assets/unit-test-coverage'}
          }));
      });
  });

Source : https://github.com/SBoudrias/gulp-istanbul#includeuntested

Related questions

Mocha unit tests running with Karma - done() is not defined

I'm trying to get tests written with Mocha to work running Karma, and they sort of work, but I cannot use the done() method to implement async tests, which essentially makes the tools useless to me. What am I missing? …

Read More
how to unit test contents of a callback function with sinon.js

how does one test a code inside a callback function using sinon.js framework for mocking? JSFiddle: http://jsfiddle.net/ruslans/CE5e2/ var service = function () { return { getData: function (callback) { return callback([1, 2, 3, 4, 5]); } } }; var model = function (svc) { return { data: [], init: function () { …

Read More
JavaScript unit test tools for TDD

I've looked into and considered many JavaScript unit tests and testing tools, but have been unable to find a suitable option to remain fully TDD compliant. So, is there a JavaScript unit test tool that is fully TDD compliant?

Read More