Merge pull request #2621 from cdr/issue-2550-add-coverage

feat(testing): add code coverage

Author: jsjoeio

.gitignore

@@ -14,3 +14,4 @@ node-*
 /plugins
 /lib/coder-cloud-agent
 .home
+coverage

README.md

@@ -1,5 +1,7 @@
 # code-server · [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
 
+![Lines](https://img.shields.io/badge/Coverage-46.71%25-green.svg)
+
 Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
 
 ![Screenshot](./doc/assets/screenshot.png)

ci/README.md

@@ -21,6 +21,7 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub)
       - Remember to update the chart version as well on top of appVersion in `Chart.yaml`.
       - Run `rg -g '!yarn.lock' -g '!*.svg' '3\.7\.5'` to ensure all values have been
         changed. Replace the numbers as needed.
+   4. Update the code coverage badge (see [here](#updating-code-coverage-in-readme) for instructions)
 2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.
    1. You do not have to wait for these.
 3. Run `yarn release:github-draft` to create a GitHub draft release from the template with
@@ -43,6 +44,19 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub)
 11. Update the homebrew package.
     - Send a pull request to [homebrew-core](https://github.com/Homebrew/homebrew-core) with the URL in the [formula](https://github.com/Homebrew/homebrew-core/blob/master/Formula/code-server.rb) updated.
 
+## Updating Code Coverage in README
+
+Currently, we run a command to manually generate the code coverage shield. Follow these steps:
+
+1. Run `yarn badges`
+2. Go into the README and change the color from `red` to `green` in this line:
+
+```
+![Lines](https://img.shields.io/badge/Coverage-46.71%25-red.svg)
+```
+
+NOTE: we have to manually change the color because the default is red if coverage is less than 80. See code [here](https://github.com/olavoparno/istanbul-badges-readme/blob/develop/src/editor.ts#L24-L33).
+
 ## dev
 
 This directory contains scripts used for the development of code-server.

ci/dev/postinstall.sh

@@ -5,6 +5,11 @@ main() {
   cd "$(dirname "$0")/../.."
   source ./ci/lib.sh
 
+  # This installs the dependencies needed for testing
+  cd test
+  yarn
+  cd ..
+
   cd lib/vscode
   yarn ${CI+--frozen-lockfile}
 

ci/dev/test.sh

@@ -3,12 +3,13 @@ set -euo pipefail
 
 main() {
   cd "$(dirname "$0")/../.."
-
   cd test/test-plugin
   make -s out/index.js
-  cd "$OLDPWD/test"
-  yarn
-  yarn test "$@"
+  # We must keep jest in a sub-directory. See ../../test/package.json for more
+  # information. We must also run it from the root otherwise coverage will not
+  # include our source files.
+  cd "$OLDPWD"
+  ./test/node_modules/.bin/jest "$@"
 }
 
 main "$@"

package.json

@@ -26,7 +26,8 @@
     "test": "./ci/dev/test.sh",
     "ci": "./ci/dev/ci.sh",
     "watch": "VSCODE_IPC_HOOK_CLI= NODE_OPTIONS=--max_old_space_size=32384 ts-node ./ci/dev/watch.ts",
-    "icons": "./ci/dev/gen_icons.sh"
+    "icons": "./ci/dev/gen_icons.sh",
+    "badges": "istanbul-badges-readme"
   },
   "main": "out/node/entry.js",
   "devDependencies": {
@@ -37,7 +38,6 @@
     "@types/http-proxy": "^1.17.4",
     "@types/js-yaml": "^3.12.3",
     "@types/node": "^12.12.7",
-    "@types/node-fetch": "^2.5.7",
     "@types/parcel-bundler": "^1.12.1",
     "@types/pem": "^1.9.5",
     "@types/proxy-from-env": "^1.0.1",
@@ -54,6 +54,7 @@
     "eslint-config-prettier": "^6.0.0",
     "eslint-plugin-import": "^2.18.2",
     "eslint-plugin-prettier": "^3.1.0",
+    "istanbul-badges-readme": "^1.2.0",
     "leaked-handles": "^5.2.0",
     "parcel-bundler": "^1.12.4",
     "prettier": "^2.0.5",
@@ -107,5 +108,34 @@
   ],
   "engines": {
     "node": ">= 12"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.ts$": "<rootDir>/test/node_modules/ts-jest"
+    },
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "<rootDir>/lib/vscode",
+      "<rootDir>/out"
+    ],
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "<rootDir>/src/**/*.ts"
+    ],
+    "coverageDirectory": "<rootDir>/coverage",
+    "coverageReporters": [
+      "json",
+      "json-summary",
+      "text"
+    ],
+    "coveragePathIgnorePatterns": [
+      "out"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "lines": 40
+      }
+    }
   }
 }

test/jest.config.js

@@ -1,22 +1,13 @@
 {
-  "name": "test",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "jest"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "#": "We must put jest in a sub-directory otherwise VS Code somehow picks up",
+  "#": "the types and generates conflicts with mocha.",
   "devDependencies": {
     "@types/jest": "^26.0.20",
     "@types/node-fetch": "^2.5.8",
     "@types/supertest": "^2.0.10",
     "jest": "^26.6.3",
     "node-fetch": "^2.6.1",
     "supertest": "^6.1.1",
-    "ts-jest": "^26.4.4",
-    "typescript": "^4.1.3"
+    "ts-jest": "^26.4.4"
   }
 }

test/package.json

@@ -1,10 +1,4 @@
 {
   "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "typeRoots": ["node_modules/@types", "../typings"],
-    "composite": true
-  },
-  "include": ["./**/*.ts"],
-  "exclude": ["node_modules/**"],
-  "types": ["jest"]
+  "include": ["./**/*.ts"]
 }

test/tsconfig.json

@@ -3523,11 +3523,6 @@ typedarray-to-buffer@^3.1.5:
   dependencies:
     is-typedarray "^1.0.0"
 
-typescript@^4.1.3:
-  version "4.1.3"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.3.tgz#519d582bd94cba0cf8934c7d8e8467e473f53bb7"
-  integrity sha512-B3ZIOf1IKeH2ixgHhj6la6xdwR9QrLC5d1VKeCSY4tvkqhF2eqd9O7txNlS0PO3GrBAFIdr3L1ndNwteUbZLYg==
-
 union-value@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/union-value/-/union-value-1.0.1.tgz#0b6fe7b835aecda61c6ea4d4f02c14221e109847"