Upgrade to newest vscode testing framework, enable unit tests on CI (#25)

* testing ci

* set display

* migrate to vscode-test

* testing

* ok, we need the deps

* set display in same command

* continue testing

* use default xvfb

* create xvfb.init

* libnss3

* more libs

* fix

Author: Arnold Trakhtenberg

.circleci/config.yml

@@ -17,18 +17,20 @@ jobs:
           paths:
             - node_modules
       - run:
-          name: Install vscode dependencies
-          command: 'sudo apt install libgtk-3-0 libxss1 libgconf-2-4 libnss3 libasound2'
+          name: Setup build environment
+          command: |
+            sudo apt-get update
+            sudo apt-get install -y libxkbfile-dev pkg-config libsecret-1-dev libxss1 dbus xvfb libgtk-3-0 libnss3 libasound2
+            sudo cp test/xvfb.init /etc/init.d/xvfb
+            sudo chmod +x /etc/init.d/xvfb
+            sudo update-rc.d xvfb defaults
+            sudo service xvfb start
       - run:
           name: Build
           command: 'yarn run vscode:prepublish'
-      # Temporarily disabled until we set vscode testing with circleci
-      # - run:
-      #     name: Download vscode executable
-      #     command: 'mkdir -p .vscode-test/stable && wget -qO- https://vscode-update.azurewebsites.net/1.27.2/linux-x64/stable | tar zxv -C .vscode-test/stable/ && chmod 0755 .vscode-test/stable/VSCode-linux-x64/code && tail -c +4 .vscode-test/stable/VSCode-linux-x64/code > .vscode-test/stable/VSCode-linux-x64/code'
-      # - run:
-      #     name: Test
-      #     command: 'yarn test'
+      - run:
+          name: Test
+          command: 'DISPLAY=:1 yarn test'
       - run:
           name: Lint
           command: 'yarn run prettier:check'

package.json

@@ -94,20 +94,21 @@
 		"compile": "webpack --mode none",
 		"watch": "webpack --mode none --watch",
 		"test-compile": "tsc -p ./ && cp ./package.json ./out/package.json",
-		"postinstall": "node ./node_modules/vscode/bin/install",
-		"test": "yarn run prettier:check && yarn run test-compile && node ./node_modules/vscode/bin/test",
+		"test": "yarn run test-compile && node ./out/test/runTest.js",
 		"prettier:write": "prettier --single-quote true --print-width 120 --use-tabs true --trailing-comma all --write \"{src,tests}/**/*.ts\"",
 		"prettier:check": "prettier --single-quote true --print-width 120 --use-tabs true --trailing-comma all --list-different \"{src,tests}/**/*.ts\""
 	},
 	"devDependencies": {
 		"@types/mocha": "^2.2.32",
 		"@types/node": "^6.0.40",
+		"@types/vscode": "1.34.0",
+		"glob": "7.1.6",
 		"mocha": "5.2.0",
 		"prettier": "^1.5.3",
 		"pretty-error": "^2.1.1",
 		"ts-loader": "6.0.4",
 		"typescript": "^2.4.2",
-		"vscode": "^1.1.34",
+		"vscode-test": "1.3.0",
 		"webpack": "4.35.0",
 		"webpack-cli": "3.3.5"
 	},
@@ -124,4 +125,4 @@
 		"node.extend": "^1.1.7",
 		"lodash": "^4.17.12"
 	}
-}
+}

test/index.ts

@@ -1,22 +1,38 @@
-//
-// PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING
-//
-// This file is providing the test runner to use when running extension tests.
-// By default the test runner in use is Mocha based.
-//
-// You can provide your own test runner if you want to override it by exporting
-// a function run(testRoot: string, clb: (error:Error) => void) that the extension
-// host can call to run the tests. The test runner is expected to use console.log
-// to report the results back to the caller. When the tests are finished, return
-// a possible error to the callback or null if none.
+import * as path from 'path';
+import * as Mocha from 'mocha';
+import * as glob from 'glob';
 
-var testRunner = require('vscode/lib/testrunner');
+export function run(): Promise<void> {
+	// Create the mocha test
+	const mocha = new Mocha({
+		ui: 'tdd',
+	});
+	mocha.useColors(true);
 
-// You can directly control Mocha options by uncommenting the following lines
-// See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
-testRunner.configure({
-	ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.)
-	useColors: true, // colored output from test results
-});
+	const testsRoot = path.resolve(__dirname, '..');
 
-module.exports = testRunner;
+	return new Promise((c, e) => {
+		glob('**/**.test.js', { cwd: testsRoot }, (err, files) => {
+			if (err) {
+				return e(err);
+			}
+
+			// Add files to the test suite
+			files.forEach(f => mocha.addFile(path.resolve(testsRoot, f)));
+
+			try {
+				// Run the mocha test
+				mocha.run(failures => {
+					if (failures > 0) {
+						e(new Error(`${failures} tests failed.`));
+					} else {
+						c();
+					}
+				});
+			} catch (err) {
+				console.error(err);
+				e(err);
+			}
+		});
+	});
+}

test/runTest.ts

@@ -0,0 +1,23 @@
+import * as path from 'path';
+
+import { runTests } from 'vscode-test';
+
+async function main() {
+	try {
+		// The folder containing the Extension Manifest package.json
+		// Passed to `--extensionDevelopmentPath`
+		const extensionDevelopmentPath = path.resolve(__dirname, '../');
+
+		// The path to the extension test script
+		// Passed to --extensionTestsPath
+		const extensionTestsPath = path.resolve(__dirname, './index');
+
+		// Download VS Code, unzip it and run the integration test
+		await runTests({ extensionDevelopmentPath, extensionTestsPath });
+	} catch (err) {
+		console.error('Failed to run tests');
+		process.exit(1);
+	}
+}
+
+main();

test/xvfb.init

@@ -0,0 +1,26 @@
+# https://gist.github.com/jterrace/2911875
+
+XVFB=/usr/bin/Xvfb
+XVFBARGS=":1 -screen 0 1024x768x24 -ac +extension GLX +render -noreset"
+PIDFILE=/var/run/xvfb.pid
+case "$1" in
+  start)
+    echo -n "Starting virtual X frame buffer: Xvfb"
+    start-stop-daemon --start --quiet --pidfile $PIDFILE --make-pidfile --background --exec $XVFB -- $XVFBARGS
+    echo "."
+    ;;
+  stop)
+    echo -n "Stopping virtual X frame buffer: Xvfb"
+    start-stop-daemon --stop --quiet --pidfile $PIDFILE
+    echo "."
+    ;;
+  restart)
+    $0 stop
+    $0 start
+    ;;
+  *)
+        echo "Usage: /etc/init.d/xvfb {start|stop|restart}"
+        exit 1
+esac
+
+exit 0