Migrate to 'vscode-test' (#981)

Signed-off-by: Rome Li <rome.li@microsoft.com>

Author: akaroml

.vscode/launch.json

@@ -49,8 +49,8 @@
 			"args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ],
 			"stopOnEntry": false,
 			"sourceMaps": true,
-			"outFiles": ["${workspaceRoot}/out/test/**"],
+			"outFiles": ["${workspaceRoot}/out/**/*.js"],
 			"preLaunchTask": "npm: compile"
 		}
 	]
-}
+}

package-lock.json

@@ -11,7 +11,7 @@
   "preview": true,
   "enableProposedApi": false,
   "engines": {
-    "vscode": "^1.33.0"
+    "vscode": "^1.36.0"
   },
   "repository": {
     "type": "git",
@@ -500,18 +500,18 @@
   },
   "scripts": {
     "vscode:prepublish": "webpack --mode production",
-    "compile": "tsc -p ./",
+    "compile": "tsc -p ./&webpack --mode development",
     "watch": "webpack --mode development --watch --info-verbosity verbose",
-    "postinstall": "node ./node_modules/vscode/bin/install",
-    "test": "node ./node_modules/vscode/bin/test",
+    "pretest": "npm run compile",
+    "test": "node ./out/test/runtest.js",
     "build-server": "./node_modules/.bin/gulp build_server",
-    "watch-server": "./node_modules/.bin/gulp watch_server",
-    "webpack": "webpack --mode development"
+    "watch-server": "./node_modules/.bin/gulp watch_server"
   },
   "devDependencies": {
     "@types/glob": "5.0.30",
     "@types/mocha": "^5.2.5",
     "@types/node": "^6.0.40",
+    "@types/vscode": "^1.36.0",
     "gulp": "^4.0.0",
     "gulp-decompress": "2.0.1",
     "gulp-download": "0.0.1",
@@ -520,7 +520,7 @@
     "tslint": "^5.11.0",
     "typescript": "^3.4.1",
     "typescript-tslint-plugin": "^0.3.1",
-    "vscode": "^1.1.35",
+    "vscode-test": "^1.0.0",
     "webpack": "^4.27.1",
     "webpack-cli": "^3.1.2"
   },

package.json

@@ -6,7 +6,7 @@ import { Commands } from './commands';
 
 let existingExtensions: Array<string>;
 
-export function collectJavaExtensions(extensions: vscode.Extension<any>[]): string[] {
+export function collectJavaExtensions(extensions: readonly vscode.Extension<any>[]): string[] {
 	const result = [];
 	if (extensions && extensions.length) {
 		for (const extension of extensions) {
@@ -26,7 +26,7 @@ export function collectJavaExtensions(extensions: vscode.Extension<any>[]): stri
 	return result;
 }
 
-export function onExtensionChange(extensions: vscode.Extension<any>[]) {
+export function onExtensionChange(extensions: readonly vscode.Extension<any>[]) {
 	if (!existingExtensions) {
 		return;
 	}

src/plugin.ts

@@ -20,7 +20,7 @@ suite('Java Language Extension', () => {
 		});
 	});
 
-	test('should register all java commands', function () {
+	test('should register all java commands', () => {
 		return vscode.commands.getCommands(true).then((commands) =>
 		{
 			const JAVA_COMMANDS = [
@@ -53,14 +53,14 @@ suite('Java Language Extension', () => {
 				Commands.APPLY_REFACTORING_COMMAND,
 				Commands.RENAME_COMMAND
 			];
-			const foundJavaCommands = commands.filter(function(value) {
+			const foundJavaCommands = commands.filter((value) => {
 				return JAVA_COMMANDS.indexOf(value)>=0 || value.startsWith('java.');
 			});
 			assert.equal(foundJavaCommands.length , JAVA_COMMANDS.length, 'Some Java commands are not registered properly or a new command is not added to the test');
 		});
 	});
 
-	test('should parse VM arguments', function () {
+	test('should parse VM arguments', () => {
 		const userArgs = '-Xmx512m -noverify   -Dfoo=\"something with blank\"  ';
 		const vmArgs = ['-noverify', 'foo'];
 
@@ -73,7 +73,7 @@ suite('Java Language Extension', () => {
 		assert.equal('-Dfoo=something with blank', vmArgs[3]);
 	});
 
-	test('should parse VM arguments with spaces', function () {
+	test('should parse VM arguments with spaces', () => {
 		const userArgs = '-javaagent:"C:\\Program Files\\Java\\lombok.jar" -Xbootclasspath/a:"C:\\Program Files\\Java\\lombok.jar" -Dfoo="Some \\"crazy\\" stuff"';
 		const vmArgs = [];
 
@@ -85,15 +85,16 @@ suite('Java Language Extension', () => {
 		assert.equal(vmArgs[2], '-Dfoo=Some "crazy" stuff');
 	});
 
-	test('should collect java extensions', function () {
+	test('should collect java extensions', () => {
 		const packageJSON = JSON.parse(fs.readFileSync(path.join(__dirname, '../../test/resources/packageExample.json'), 'utf8'));
 		const fakedExtension = {
 			id: 'test',
 			extensionPath: '',
 			isActive: true,
 			packageJSON,
 			exports: '',
-			activate: null
+			activate: null,
+			extensionKind: vscode.ExtensionKind.Workspace
 		};
 
 		const extensions = [fakedExtension];
@@ -102,7 +103,7 @@ suite('Java Language Extension', () => {
 		assert(result[0].endsWith(path.normalize('./bin/java.extend.jar')));
 	});
 
-	test('should parse Java version', function () {
+	test('should parse Java version', () => {
 		// Test boundaries
 		assert.equal(requirements.parseMajorVersion(null), 0);
 		assert.equal(requirements.parseMajorVersion(''), 0);

test/extension.test.ts

@@ -1,23 +1,48 @@
-// 
-// PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING  
+//
+// 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.
 
-// tslint:disable-next-line:no-require-imports
-let testRunner = require('vscode/lib/testrunner');
+import * as path from 'path';
+import * as Mocha from 'mocha';
+import * as glob from 'glob';
+
+export function run(): Promise<void> {
+	const mocha = new Mocha({
+		ui: 'tdd',
+		useColors: true
+	});
+
+	const testsRoot = path.resolve(__dirname, '..');
+
+	return new Promise((c, e) => {
+		glob('**/**.test.js', { cwd: testsRoot }, (err, files) => {
+			if (err) {
+				return e(err);
+			}
 
-// 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
-});
+			// Add files to the test suite
+			files.forEach(f => mocha.addFile(path.resolve(testsRoot, f)));
 
-module.exports = testRunner;
+			try {
+				// Run the mocha test
+				mocha.run(failures => {
+					if (failures > 0) {
+						e(new Error(`${failures} tests failed.`));
+					} else {
+						c();
+					}
+				});
+			} catch (err) {
+				e(err);
+			}
+		});
+	});
+}

test/index.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, './');
+
+		// 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();