feat(test): exclude files from coverage

Allow users to configure code-coverage excludes by setting the coverageExcludes property on their
app config section in the angular-cli.json.  The coverageExcludes property will accept a list of
globs and/or file paths relative to the app root.  The items are all processed with glob and
appended to the excludes sent to sourcemap-istanbul-instrumenter-loader.

Author: dpmorrow

packages/angular-cli/lib/config/schema.json

@@ -61,6 +61,12 @@
           "test": {
             "type": "string"
           },
+          "coverageExcludes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "tsconfig": {
             "type": "string",
             "default": "tsconfig.json"

packages/angular-cli/models/webpack-build-test.js

@@ -3,6 +3,7 @@
 const path = require('path');
 const webpack = require('webpack');
 const ngtools = require('@ngtools/webpack');
+const glob = require('glob');
 
 
 const g = global;
@@ -33,13 +34,28 @@ const getWebpackTestConfig = function (projectRoot, environment, appConfig, test
   const extraPlugins = [];
 
   if (testConfig.codeCoverage) {
+    var excludes = [
+      /\.(e2e|spec)\.ts$/,
+      /node_modules/
+    ];
+
+    // parse list of glob exclusions
+    if (appConfig.hasOwnProperty('coverageExcludes')) {
+      if (Object.prototype.toString.call(appConfig.coverageExcludes) === '[object Array]') {
+        appConfig.coverageExcludes.forEach(function (exclude) {
+          // get all files that will be ignored relative to appRoot
+          glob.sync(appRoot + '/' + exclude).forEach(function (file) {
+            // be sure to switch out to backslashes if on windows using path.resolve
+            excludes.push(path.resolve(file));
+          });
+        });
+      }
+    }
+
     extraRules.push({
       test: /\.(js|ts)$/, loader: 'sourcemap-istanbul-instrumenter-loader',
       enforce: 'post',
-      exclude: [
-        /\.(e2e|spec)\.ts$/,
-        /node_modules/
-      ],
+      exclude: excludes,
       query: { 'force-sourcemap': true }
     });
   }

tests/e2e/tests/misc/coverage.ts

@@ -1,9 +1,22 @@
-import {expectFileToExist} from '../../utils/fs';
+import {expectFileToExist, expectFileNotToMatch, writeFile} from '../../utils/fs';
 import {ng} from '../../utils/process';
+import {updateJsonFile} from '../../utils/project';
 
-
-export default function() {
-  return ng('test', '--single-run', '--code-coverage')
+export default function () {
+  let ignoredGlobFileName = 'src/app/ignore.glob.ts';
+  let ignoredExplicitFileName = 'src/app/ignore.explicit.ts';
+  let coverageFileName = 'coverage/coverage.lcov';
+  return updateJsonFile('angular-cli.json', configJson => {
+    const app = configJson['apps'][0];
+    app['configExcludes'] = ['**/*.glob.ts', ignoredExplicitFileName];
+  })
+    .then(() => writeFile(ignoredGlobFileName, ''))
+    .then(() => expectFileToExist(ignoredGlobFileName))
+    .then(() => writeFile(ignoredExplicitFileName, ''))
+    .then(() => expectFileToExist(ignoredExplicitFileName))
+    .then(() => ng('test', '--single-run', '--code-coverage'))
     .then(() => expectFileToExist('coverage/src/app'))
-    .then(() => expectFileToExist('coverage/coverage.lcov'));
+    .then(() => expectFileToExist(coverageFileName))
+    .then(() => expectFileNotToMatch(coverageFileName, ignoredGlobFileName))
+    .then(() => expectFileNotToMatch(coverageFileName, ignoredExplicitFileName));
 }

tests/e2e/utils/fs.ts

@@ -138,6 +138,29 @@ export function expectFileToMatch(fileName: string, regEx: RegExp | string) {
     });
 }
 
+export function expectFileNotToMatch(fileName: string, regEx: RegExp | string) {
+  return readFile(fileName)
+    .then(content => {
+      if (typeof regEx == 'string') {
+        if (content.indexOf(regEx) != -1) {
+          throw new Error(stripIndents`File "${fileName}" contained "${regEx}"...
+            Content:
+            ${content}
+            ------
+          `);
+        }
+      } else {
+        if (content.match(regEx)) {
+          throw new Error(stripIndents`File "${fileName}" contained "${regEx}"...
+            Content:
+            ${content}
+            ------
+          `);
+        }
+      }
+    });
+}
+
 export function expectFileSizeToBeUnder(fileName: string, sizeInBytes: number) {
   return readFile(fileName)
     .then(content => {