implement coverage reports

Author: fyockm

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 node_modules
+coverage

lib/child.js

@@ -1,7 +1,8 @@
 var QUnit = require('../support/qunit/qunit/qunit.js'),
     path = require('path'),
     _ = require('underscore'),
-    trace = require('tracejs').trace;
+    trace = require('tracejs').trace,
+    coverage = require('./coverage');
 
 // cycle.js: This file contains two functions, JSON.decycle and JSON.retrocycle,
 // which make it possible to encode cyclical structures and dags in JSON, and to
@@ -134,4 +135,4 @@ function run() {
     });
 }
 
-options.coverage ? require('./coverage').cover(options, run) : run();
+options.coverage ? coverage.instrument(options, run) : run();

lib/coverage.js

@@ -11,15 +11,25 @@ exports.setup = function() {
     collector = new istanbul.Collector();
 };
 
-exports.append = function(coverage) {
+exports.add = function(coverage) {
     collector && coverage && collector.add(coverage);
 };
 
+exports.get = function() {
+    if (collector) {
+        var summaries = [];
+        collector.files().forEach(function (file) {
+            summaries.push(istanbul.utils.summarizeFileCoverage(collector.fileCoverageFor(file)));
+        });
+        return istanbul.utils.mergeSummaryObjects.apply(null, summaries);
+    }
+};
+
 exports.report = function() {
     if (collector) {
         var opts = { dir: path.resolve('coverage') },
             Report = istanbul.Report,
-            reports = [ Report.create('lcov', opts), Report.create('json', opts), Report.create('text-summary', opts) ];
+            reports = [ Report.create('lcov', opts), Report.create('json', opts) ];
         reports.forEach(function (rep) {
             rep.writeReport(collector, true);
         });
@@ -33,15 +43,15 @@ function resolvePaths(files) {
     return [files.path];
 }
 
-exports.cover = function(options, run) {
+exports.instrument = function(options, cb) {
     istanbul.matcherFor({
         includes: resolvePaths(options.code),
         excludes: resolvePaths(options.tests)
     }, function (err, matcher) {
         if (err) { throw err; }
         var instrumenter = new istanbul.Instrumenter();
         istanbul.hook.hookRequire(matcher, instrumenter.instrumentSync.bind(instrumenter));
-        run();
+        cb();
     });
 };
 

lib/log.js

@@ -1,49 +1,34 @@
 var Table = require('cli-table');
 
 var data,
-    log = console.log;
+    log = console.log,
+    fileColWidth = 50;
 
 data = {
     assertions: [],
     tests: [],
-    summaries: []
+    summaries: [],
+    coverages: []
 };
 
-exports.assertion = function(d) {
+exports.add = function(t, d) {
     if (d) {
-        data.assertions.push(d);
+        data[t].push(d);
     }
-
-    return data.assertions;
-};
-
-exports.test = function(d) {
-    if (d) {
-        data.tests.push(d);
-    }
-
-    return data.tests;
-};
-
-exports.summary = function(d) {
-    if (d) {
-        data.summaries.push(d);
-    }
-
-    return data.summaries;
+    return data[t];
 };
 
 /**
  * Get global tests stats in unified format
  */
 exports.stats = function() {
     var stats = {
-            files: 0,
-            assertions: 0,
-            failed: 0,
-            passed: 0,
-            runtime: 0
-        };
+        files: 0,
+        assertions: 0,
+        failed: 0,
+        passed: 0,
+        runtime: 0
+    };
 
     data.summaries.forEach(function(file) {
         stats.files++;
@@ -55,6 +40,26 @@ exports.stats = function() {
 
     stats.tests = data.tests.length;
 
+    stats.coverage = {
+        files: 0,
+        statements: { covered: 0, total: 0 },
+        branches: { covered: 0, total: 0 },
+        functions: { covered: 0, total: 0 },
+        lines: { covered: 0, total: 0 }
+    };
+
+    data.coverages.forEach(function(file) {
+        stats.coverage.files++;
+        stats.coverage.statements.covered += file.statements.covered;
+        stats.coverage.statements.total += file.statements.total;
+        stats.coverage.branches.covered += file.branches.covered;
+        stats.coverage.branches.total += file.branches.total;
+        stats.coverage.functions.covered += file.functions.covered;
+        stats.coverage.functions.total += file.functions.total;
+        stats.coverage.lines.covered += file.lines.covered;
+        stats.coverage.lines.total += file.lines.total;
+    });
+
     return stats;
 };
 
@@ -65,7 +70,8 @@ exports.reset = function() {
     data = {
         assertions: [],
         tests: [],
-        summaries: []
+        summaries: [],
+        coverages: []
     };
 };
 
@@ -159,23 +165,22 @@ print.tests = function() {
     log('\nTests:\n' + table.toString());
 };
 
-print.summary = function() {
-    var table, fileColWidth = 50;
+// truncate file name
+function truncfile(code) {
+    if (code && code.length > fileColWidth) {
+        code = '...' + code.slice(code.length - fileColWidth + 3);
+    }
+    return code;
+}
 
-    table = new Table({
+print.summary = function() {
+    var table = new Table({
         head: ['File', 'Failed', 'Passed', 'Total', 'Runtime'],
         colWidths: [fileColWidth + 2, 10, 10, 10, 10]
     });
 
     data.summaries.forEach(function(data) {
-        var code = data.code;
-
-        // truncate file name
-        if (code.length > fileColWidth) {
-            code = '...' + code.slice(code.length - fileColWidth + 3);
-        }
-
-        table.push([code, data.failed, data.passed, data.total, data.runtime]);
+        table.push([truncfile(data.code), data.failed, data.passed, data.total, data.runtime]);
     });
 
     log('\nSummary:\n' + table.toString());
@@ -195,3 +200,43 @@ print.globalSummary = function() {
 
     log('\nGlobal summary:\n' + table.toString());
 };
+
+function getMet(metric) {
+    function percent(covered, total) {
+        var tmp;
+        if (total > 0) {
+            tmp = 1000 * 100 * covered / total + 5;
+            return Math.floor(tmp / 10) / 100;
+        } else {
+            return 100.00;
+        }
+    }
+    if (!metric.pct) metric.pct = percent(metric.covered, metric.total);
+    return metric.pct + '% (' + metric.covered + '/' + metric.total + ')';
+}
+
+print.coverage = function() {
+    var table = new Table({
+        head: ['File', 'Statements', 'Branches', 'Functions', 'Lines'],
+        colWidths: [fileColWidth + 2, 14, 14, 14, 14]
+    });
+
+    data.coverages.forEach(function(data) {
+        table.push([truncfile(data.code), getMet(data.statements), getMet(data.branches), getMet(data.functions), getMet(data.lines)]);
+    });
+
+    log('\nCoverage:\n' + table.toString());
+};
+
+print.globalCoverage = function() {
+    var data = exports.stats().coverage;
+
+    var table = new Table({
+        head: ['Files', 'Statements', 'Branches', 'Functions', 'Lines'],
+        colWidths: [8, 14, 14, 14, 14]
+    });
+
+    table.push([data.files, getMet(data.statements), getMet(data.branches), getMet(data.functions), getMet(data.lines)]);
+
+    log('\nGlobal coverage:\n' + table.toString());
+};

lib/testrunner.js

@@ -29,6 +29,12 @@ options = exports.options = {
         // log global summary (all files)
         globalSummary: true,
 
+        // log coverage
+        coverage: true,
+
+        // log global coverage (all files)
+        globalCoverage: true,
+
         // log currently testing code file
         testing: true
     },
@@ -64,12 +70,18 @@ function runOne(opts, callback) {
 
     child.on('message', function(msg) {
         if (msg.event === 'assertionDone') {
-            log.assertion(msg.data);
+            log.add('assertions', msg.data);
         } else if (msg.event === 'testDone') {
-            log.test(msg.data);
+            log.add('tests', msg.data);
         } else if (msg.event === 'done') {
             msg.data.code = opts.code.path;
-            log.summary(msg.data);
+            log.add('summaries', msg.data);
+            if (opts.coverage) {
+                coverage.add(msg.data.coverage);
+                msg.data.coverage = coverage.get();
+                msg.data.coverage.code = msg.data.code;
+                log.add('coverages', msg.data.coverage);
+            }
             if (opts.log.testing) {
                 util.print('done');
             }
@@ -152,7 +164,6 @@ exports.run = function(files, callback) {
             if (err) {
                 return callback(err, log.stats());
             }
-            stat && coverage.append(stat.coverage);
 
             filesCount++;
 
@@ -162,7 +173,7 @@ exports.run = function(files, callback) {
                         log.print[name]();
                     }
                 });
-
+                // write coverage report(s)
                 coverage.report();
                 callback(null, log.stats());
             }