Generate code coverage reports for packages (#4946)

Add a `yarn coverage` command to packages to generate coverage reports. Coverage is not yet automated in CI.

Author: mattsoulanille

e2e/karma.conf.js

@@ -32,6 +32,14 @@ const karmaTypescriptConfig = {
   }
 };
 
+// Enable coverage reports and instrumentation under KARMA_COVERAGE=1 env
+const coverageEnabled = !!process.env.KARMA_COVERAGE;
+if (coverageEnabled) {
+  karmaTypescriptConfig.coverageOptions.instrumentation = true;
+  karmaTypescriptConfig.coverageOptions.exclude = /_test\.ts$/;
+  karmaTypescriptConfig.reports = {html: 'coverage', 'text-summary': ''};
+}
+
 const devConfig = {
   frameworks: ['jasmine', 'karma-typescript'],
   files: [

e2e/package.json

@@ -65,6 +65,7 @@
     "lint": "tslint -p . -t verbose",
     "run-browserstack": "karma start --browserstack",
     "test": "./scripts/test.sh",
+    "coverage": "KARMA_COVERAGE=1 ./scripts/test.sh",
     "test-ci": "./scripts/test-ci.sh",
     "update-dependency": "ts-node ./scripts/update-dependency.ts"
   },

tfjs-automl/karma.conf.js

@@ -35,6 +35,18 @@ const karmaTypescriptConfig = {
   }
 };
 
+// Enable coverage reports and instrumentation under KARMA_COVERAGE=1 env
+const coverageEnabled = !!process.env.KARMA_COVERAGE;
+if (coverageEnabled) {
+  karmaTypescriptConfig.coverageOptions.instrumentation = true;
+  karmaTypescriptConfig.coverageOptions.exclude = [
+    /test_browser\.ts/,
+    /test_util\.ts/,
+    /_test\.ts/
+  ];
+  karmaTypescriptConfig.reports = {html: 'coverage', 'text-summary': ''};
+}
+
 module.exports = function(config) {
   const args = [];
   if (config.testEnv) {

tfjs-automl/package.json

@@ -13,6 +13,7 @@
     "test": "yarn && yarn build && karma start",
     "test-dev": "karma start",
     "test-node": "tsc && ts-node --transpile-only --skip-ignore --project tsconfig.test.json src/test_node.ts",
+    "coverage": "KARMA_COVERAGE=1 karma start --singleRun",
     "run-flaky": "node ../scripts/run_flaky.js",
     "run-browserstack": "karma start --singleRun --reporters='dots,karma-typescript,BrowserStack' --hostname='bs-local.com'",
     "test-ci": "./scripts/test-ci.sh",

tfjs-backend-cpu/.nycrc

@@ -0,0 +1,19 @@
+{
+    "extension": [
+      ".ts"
+    ],
+    "reporter": [
+      "html",
+      "text-summary"
+    ],
+    "include": [
+      "src/**/*"
+    ],
+    "exclude": [
+      "src/run_tests.ts",
+      "src/**/*_test.ts"
+    ],
+    "cache": false,
+    "sourceMap": true,
+    "instrument": true
+}

tfjs-backend-cpu/package.json

@@ -33,6 +33,7 @@
     "karma-jasmine": "~1.1.0",
     "karma-typescript": "~5.5.1",
     "npm-run-all": "~4.1.3",
+    "nyc": "^15.1.0",
     "rimraf": "~2.6.2",
     "rollup": "~2.3.2",
     "rollup-plugin-terser": "~5.3.0",
@@ -57,6 +58,7 @@
     "publish-local": "rimraf dist/ && yarn build && rollup -c && yalc push",
     "publish-npm": "npm publish",
     "lint": "tslint -p . -t verbose",
+    "coverage": "yarn nyc yarn ts-node --transpile-only -P tsconfig.test.json src/run_tests.ts",
     "test": "yarn && yarn build-deps && yarn build && ts-node --transpile-only --project tsconfig.test.json src/run_tests.ts",
     "test-dev": "tsc && ts-node --transpile-only --project tsconfig.test.json src/run_tests.ts",
     "test-ci": "ts-node --transpile-only --skip-ignore --project tsconfig.test.json src/run_tests.ts"