WIP: Add support for code coverage collection

Krinkle · Jul 24, 2023 · c254b02 · c254b02
1 parent 8e88ec7
commit c254b02
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 7 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -75,6 +75,21 @@ module.exports = function(grunt) {
           ]
         }
       },
+      coverFiles: {
+        options: {
+          coverage: true
+        },
+        src: 'test/qunit_cover.html'
+      },
+      coverUrls: {
+        options: {
+          coverage: true,
+          urls: [
+            'http://localhost:9000/test/qunit_cover.html',
+            // 'http://localhost:9000/test/qunit_cover2.html'
+          ]
+        }
+      },
       circularObject: {
         options: {
           urls: [

diff --git a/package.json b/package.json
@@ -27,6 +27,8 @@
     "grunt-contrib-internal": "^8.0.2",
     "grunt-contrib-jshint": "^3.2.0",
     "grunt-shell": "^4.0.0",
+    "nyc": "^15.1.0",
+    "puppeteer-to-istanbul": "^1.4.0",
     "qunit": "^2.19.4"
   },
   "keywords": [

diff --git a/tasks/qunit.js b/tasks/qunit.js
@@ -16,6 +16,7 @@ var EventEmitter = require('eventemitter2');
 // NPM libs.
 var pEachSeries = require('p-each-series');
 var puppeteer = require('puppeteer');
+var pti = require('puppeteer-to-istanbul');
 
 var Promise = global.Promise;
 
@@ -240,19 +241,20 @@ module.exports = function(grunt) {
 
   grunt.registerMultiTask('qunit', 'Run QUnit tests in Headless Chrome.', function() {
     // Chrome sandbox is incompatible with Docker and most CI environments
-    var defaultChromiumArgs = (
-      process.env.CHROMIUM_FLAGS || (process.env.CI ? '--no-sandbox' : '')
-    ).split(' ');
+    var chromiumFlags = process.env.CHROMIUM_FLAGS || (process.env.CI ? '--no-sandbox' : '');
+    var defaultChromiumArgs = chromiumFlags ? chromiumFlags.split(' '): [];
 
     // Merge task-specific and/or target-specific options with these defaults.
     options = this.options({
       // Default Chrome timeout.
       timeout: 5000,
-      // QUnit-Chrome bridge file to be injected.
+      // Bridge file to be injected.
       inject: asset('chrome/bridge.js'),
       // Explicit non-file URLs to test.
       urls: [],
       force: false,
+      coverage: false,
+      coverageDir: './.nyc_output',
       // Connect Chrome console output to Grunt output
       console: true,
       // Do not use an HTTP base by default
@@ -353,7 +355,7 @@ module.exports = function(grunt) {
           eventBus.emit.apply(eventBus, [].slice.call(arguments));
         });
       })
-      .then(function() {
+      .then(async function() {
         // Pass through the console logs if instructed
         if (options.console) {
           page.on('console', function(msg) {
@@ -395,12 +397,16 @@ module.exports = function(grunt) {
         // injected before any other DOMContentLoaded or window.load event handler.
         page.evaluateOnNewDocument('if (window.QUnit) {\n' + bridgContents.join(";") + '\n} else {\n' + 'document.addEventListener("DOMContentLoaded", function() {\n' + bridgContents.join(";") + '\n});\n}\n');
 
-        return pEachSeries(urls, function(url) {
+        if (options.coverage) {
+          await page.coverage.startJSCoverage();
+        }
+
+        return pEachSeries(urls, async function(url) {
           // Reset current module.
           grunt.event.emit('qunit.spawn', url);
           grunt.verbose.subhead('Testing ' + url + ' ').or.write('Testing ' + url + ' ');
 
-          return Promise.all([
+          await Promise.all([
             // Setup listeners for qunit.done / fail events
             new Promise(function(resolve, reject) {
               eventBus.once('qunit.on.runEnd', function() { resolve(); });
@@ -410,6 +416,11 @@ module.exports = function(grunt) {
             // Navigate to the url to be tested
             page.goto(getPath(url), { timeout: options.timeout })
           ]);
+
+          if (options.coverage) {
+            const jsCoverage = await page.coverage.stopJSCoverage();
+            pti.write(jsCoverage, { includeHostname: true , storagePath: options.coverageDir });
+          }
         });
       })
       .then(function() {

diff --git a/test/qunit_cover.html b/test/qunit_cover.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Test Suite</title>
+  <link rel="stylesheet" href="../node_modules/qunit/qunit/qunit.css" media="screen">
+</head>
+<body>
+  <div id="qunit"></div>
+  <div id="qunit-fixture"></div>
+  <script src="../node_modules/qunit/qunit/qunit.js"></script>
+  <script src="qunit_cover_src.js"></script>
+  <script src="qunit_cover_test.js"></script>
+</body>
+</html>
diff --git a/test/qunit_cover2.html b/test/qunit_cover2.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Test Suite</title>
+  <link rel="stylesheet" href="../node_modules/qunit/qunit/qunit.css" media="screen">
+</head>
+<body>
+  <div id="qunit"></div>
+  <div id="qunit-fixture"></div>
+  <script src="../node_modules/qunit/qunit/qunit.js"></script>
+  <script src="qunit_cover_src.js"></script>
+  <script src="qunit_cover_test2.js"></script>
+</body>
+</html>
diff --git a/test/qunit_cover_src.js b/test/qunit_cover_src.js
@@ -0,0 +1,22 @@
+class Foo {
+  constructor(id) {
+    this.id = id;
+    this.position = 0;
+  }
+  reset() {
+    // Untested
+    this.position = 0;
+  }
+  walk() {
+    this.position += 1;
+  }
+  run() {
+    this.position += 10;
+  }
+}
+
+globalThis.MyApp = {
+  makeFoo(id) {
+    return new Foo(id);
+  }
+};
diff --git a/test/qunit_cover_test.js b/test/qunit_cover_test.js
@@ -0,0 +1,9 @@
+/* global MyApp */
+
+QUnit.test('MyApp.run', function(assert) {
+  var foo = MyApp.makeFoo(42);
+  assert.strictEqual(foo.position, 0);
+
+  foo.run();
+  assert.strictEqual(foo.position, 10);
+});
diff --git a/test/qunit_cover_test2.js b/test/qunit_cover_test2.js
@@ -0,0 +1,9 @@
+/* global MyApp */
+
+QUnit.test('MyApp.walk', function(assert) {
+  var foo = MyApp.makeFoo(42);
+  assert.strictEqual(foo.position, 0);
+
+  foo.walk();
+  assert.strictEqual(foo.position, 1);
+});