Update dependencies (#226)

* Release v0.21.0
* Npm update to increase our dependencies
* Update package versions 2022/07/12
* Update major version of dependencies to keep modern

* Improve testing

Author: kddejong

.eslintrc.js

@@ -13,7 +13,7 @@ module.exports = {
     },
     "ignorePatterns": ["server/node_modules/", "client/node_modules/"],
     "rules": {
-        "@typescript-eslint/class-name-casing": "warn",
+        "@typescript-eslint/naming-convention": "warn",
         "@typescript-eslint/member-delimiter-style": [
             "warn",
             {

.vscode/launch.json

@@ -9,6 +9,9 @@
 			"args": [
 				"--extensionDevelopmentPath=${workspaceRoot}"
 			],
+			"env": {
+				"PATH": "${env:PATH}"
+		  	},
 			"stopOnEntry": false,
 			"sourceMaps": true,
 			"outFiles": [

client/package-lock.json

@@ -18,17 +18,17 @@
     "scripts": {},
     "devDependencies": {
         "@types/glob": "^7.1.3",
-        "@types/vscode": "1.52.0",
-        "mocha": "^6.2.3",
-        "vscode-test": "^1.5.1"
+        "@types/vscode": "1.69.0",
+        "mocha": "^10.0.0",
+        "@vscode/test-electron": "^2.1.5"
     },
     "dependencies": {
         "@types/lodash": "^4.14.168",
         "@types/semver": "^5.5.0",
         "lodash": "^4.17.21",
         "node-yaml-parser": "~0.0.9",
-        "semver": "^5.5.1",
-        "vscode-languageclient": "~5.2.1",
-        "vscode-uri": "^1.0.1"
+        "semver": "^7.3.7",
+        "vscode-languageclient": "~8.0.1",
+        "vscode-uri": "^3.0.3"
     }
 }

client/package.json

@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License").
 You may not use this file except in compliance with the License.
 A copy of the License is located at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 or in the "license" file accompanying this file. This file is distributed
 on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
@@ -17,12 +17,13 @@ permissions and limitations under the License.
 import * as path from 'path';
 import * as fs from 'fs';
 import { workspace, ExtensionContext, ConfigurationTarget, window, WebviewPanel, Uri, commands, ViewColumn, window as VsCodeWindow } from 'vscode';
-import { LanguageClient, LanguageClientOptions, ServerOptions, TransportKind } from 'vscode-languageclient';
+import { LanguageClient, LanguageClientOptions, ServerOptions, TransportKind } from 'vscode-languageclient/node';
 import { registerYamlSchemaSupport } from './yaml-support/yaml-schema';
 
 let previews: { [index: string]: WebviewPanel } = {};
+let languageClient: LanguageClient;
 
-export function activate(context: ExtensionContext) {
+export async function activate(context: ExtensionContext) {
 
 	// The server is implemented in node
 	let serverModule = context.asAbsolutePath(path.join('server', 'out', 'server.js'));
@@ -93,45 +94,40 @@ export function activate(context: ExtensionContext) {
 	}
 
 	// Create the language client and start the client.
-	let languageClient = new LanguageClient('cfnLint', 'CloudFormation linter Language Server', serverOptions, clientOptions);
-	let clientDisposable = languageClient.start();
+	languageClient = new LanguageClient('cfnLint', 'CloudFormation linter Language Server', serverOptions, clientOptions);
+	await languageClient.start();
 
-	languageClient.onReady().then(() => {
-		languageClient.onNotification('cfn/busy', () => {
-			window.showInformationMessage("Linter is already running. Please try again.");
-		});
-		languageClient.onNotification('cfn/previewIsAvailable', (uri) => {
-			reloadSidePreview(uri, languageClient);
-		});
-		languageClient.onNotification('cfn/isPreviewable', (value) => {
-			commands.executeCommand('setContext', 'isPreviewable', value);
-		});
-		languageClient.onNotification('cfn/fileclosed', (uri) => {
-			// if the user closed the template itself, we close the preview
-			if (previews[uri]) {
-				previews[uri].dispose();
-			}
-		});
-
-		let previewDisposable = commands.registerCommand('extension.sidePreview', () => {
+	languageClient.onNotification('cfn/busy', () => {
+		window.showInformationMessage("Linter is already running. Please try again.");
+	});
+	languageClient.onNotification('cfn/previewIsAvailable', (uri) => {
+		reloadSidePreview(uri, languageClient);
+	});
+	languageClient.onNotification('cfn/isPreviewable', (value) => {
+		commands.executeCommand('setContext', 'isPreviewable', value);
+	});
+	languageClient.onNotification('cfn/fileclosed', (uri) => {
+		// if the user closed the template itself, we close the preview
+		if (previews[uri]) {
+			previews[uri].dispose();
+		}
+	});
 
-			if (window.activeTextEditor.document) {
-				let uri = Uri.file(window.activeTextEditor.document.fileName).toString();
+	let previewDisposable = commands.registerCommand('extension.sidePreview', () => {
 
-				languageClient.sendNotification('cfn/requestPreview', uri);
-			}
+		if (window.activeTextEditor.document) {
+			let uri = Uri.file(window.activeTextEditor.document.fileName).toString();
 
-		});
+			languageClient.sendNotification('cfn/requestPreview', uri);
+		}
 
-		context.subscriptions.push(previewDisposable);
 	});
 
-	// Push the disposable to the context's subscriptions so that the
-	// client can be deactivated on extension deactivation
-	context.subscriptions.push(clientDisposable);
+	context.subscriptions.push(previewDisposable);
+
 }
 
-function reloadSidePreview(file:string, languageClient:LanguageClient) {
+function reloadSidePreview(file: string, languageClient: LanguageClient) {
 	let uri = Uri.parse(file);
 	let stringifiedUri = uri.toString();
 	let dotFile = uri.fsPath + ".dot";
@@ -145,7 +141,7 @@ function reloadSidePreview(file:string, languageClient:LanguageClient) {
 	if (!previews[stringifiedUri]) {
 		previews[stringifiedUri] = VsCodeWindow.createWebviewPanel(
 			'cfnLintPreview', // Identifies the type of the webview. Used internally
-			'Template: ' + dotFile.slice(0,-4), // Title of the panel displayed to the user
+			'Template: ' + dotFile.slice(0, -4), // Title of the panel displayed to the user
 			ViewColumn.Two, // Editor column to show the new webview panel in.
 			{
 				enableScripts: true,
@@ -163,7 +159,7 @@ function reloadSidePreview(file:string, languageClient:LanguageClient) {
 	panel.webview.html = getPreviewContent(content);
 }
 
-function getPreviewContent(content: String) : string {
+function getPreviewContent(content: String): string {
 
 	let multilineString = "`" + content + "`";
 	// FIXME is there a better way of converting from dot to svg that is not using cdn urls?
@@ -207,4 +203,11 @@ export async function yamlLangaugeServerValidation(): Promise<void> {
 			workspace.getConfiguration().update('yaml.validate', false, ConfigurationTarget.Global);
 		}
 	}
+}
+
+export function deactivate(): Thenable<void> | undefined {
+	if (!languageClient) {
+		return undefined;
+	}
+	return languageClient.stop();
 }

client/src/extension.ts

@@ -1,5 +1,10 @@
 import * as path from 'path';
-import { runTests } from 'vscode-test';
+import * as cp from 'child_process';
+import * as os from "os";
+import { downloadAndUnzipVSCode,
+	resolveCliArgsFromVSCodeExecutablePath,
+	runTests,
+ } from '@vscode/test-electron';
 
 async function main() {
 	try {
@@ -11,13 +16,11 @@ async function main() {
 		// Passed to --extensionTestsPath
 		const extensionTestsPath = path.resolve(__dirname, './suite/index');
 
-		const cp = require('child_process');
-		const { downloadAndUnzipVSCode, resolveCliPathFromVSCodeExecutablePath } = require('vscode-test');
-		const vscodeExecutablePath = await downloadAndUnzipVSCode('1.61.0');
-		const cliPath = resolveCliPathFromVSCodeExecutablePath(vscodeExecutablePath);
+		const vscodeExecutablePath = await downloadAndUnzipVSCode('1.69.1');
+		const [cli, ...args] = resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath);
 
 		// Use cp.spawn / cp.exec for custom setup
-		cp.spawnSync(cliPath, ['--install-extension', 'redhat.vscode-yaml'], {
+		cp.spawnSync(cli, [...args, '--install-extension', 'redhat.vscode-yaml'], {
 			encoding: 'utf-8',
 			stdio: 'inherit'
 		});
@@ -27,9 +30,10 @@ async function main() {
 			vscodeExecutablePath,
 			extensionDevelopmentPath,
 			extensionTestsPath,
+			launchArgs: ['--user-data-dir', `${os.tmpdir()}`],
 		});
 	} catch (err) {
-		console.error('Failed to run tests');
+		console.error(`Failed to run tests: ${err}`);
 		process.exit(1);
 	}
 }

client/src/test/runTest.ts

@@ -2,23 +2,16 @@
 import * as vscode from 'vscode';
 import * as assert from 'assert';
 import * as fs from 'fs';
-import { getDocUri, activate, activateAndPreview, getDocPath } from './helper';
+import { getDocUri, activate, activateAndPreview, getDocPath, sleep, testDiagnostics } from './helper';
 
-suite('A test to create some better spacing for activation', () => {
-	const docUri = getDocUri('good.yaml');
-
-	test('A more elaborate sleep', async () => {
-		await activate(docUri);
-
-		const actualDiagnostics = vscode.languages.getDiagnostics(docUri);
-		console.log(actualDiagnostics);
-	});
-});
 
 suite('Should have failures with a bad template', () => {
 	const docUri = getDocUri('bad.yaml');
 
 	test('Diagnose bad template', async () => {
+		await activate(docUri);
+        await sleep(2000); // Wait for the diagnostics to compute on this file
+
 		await testDiagnostics(docUri, [
 			{
 				severity: vscode.DiagnosticSeverity.Error,
@@ -43,6 +36,8 @@ suite('Should not have failures on a good template', () => {
 	const docUri = getDocUri('good.yaml');
 
 	test('Diagnose good template', async () => {
+		await activate(docUri);
+        await sleep(2000); // Wait for the diagnostics to compute on this file
 		await testDiagnostics(docUri, []);
 	});
 });
@@ -51,6 +46,8 @@ suite('Should not have failures a non CloudFormation Template', () => {
 	const docUri = getDocUri('not_template.yaml');
 
 	test('Diagnose good template', async () => {
+		await activate(docUri);
+        await sleep(2000); // Wait for the diagnostics to compute on this file
 		await testDiagnostics(docUri, []);
 	});
 });
@@ -59,6 +56,8 @@ suite('Should have failures even though AWSTemplateFormatVersion isn\'t in the f
 	const docUri = getDocUri('still_a_template.yaml');
 
 	test('Diagnoses a bad template without AWSTemplateFormatVersion', async () => {
+		await activate(docUri);
+        await sleep(2000); // Wait for the diagnostics to compute on this file
 		await testDiagnostics(docUri, [
 			{
 				severity: vscode.DiagnosticSeverity.Error,
@@ -73,6 +72,8 @@ suite('Should have failures even though AWSTemplateFormatVersion isn\'t in the f
 	const docUri = getDocUri('still_a_template_2.yaml');
 
 	test('Diagnoses a bad template without AWSTemplateFormatVersion', async () => {
+		await activate(docUri);
+        await sleep(2000); // Wait for the diagnostics to compute on this file
 		await testDiagnostics(docUri, [
 			{
 				severity: vscode.DiagnosticSeverity.Error,
@@ -87,6 +88,8 @@ suite('Should have failures even with a space in the filename', () => {
 	const docUri = getDocUri('a template.yaml');
 
 	test('Diagnoses a bad template with spaces in the name', async () => {
+		await activate(docUri);
+        await sleep(2000); // Wait for the diagnostics to compute on this file
 		await testDiagnostics(docUri, [
 			{
 				severity: vscode.DiagnosticSeverity.Error,
@@ -123,17 +126,3 @@ function toRange(sLine: number, sChar: number, eLine: number, eChar: number) {
 	return new vscode.Range(start, end);
 }
 
-async function testDiagnostics(docUri: vscode.Uri, expectedDiagnostics: vscode.Diagnostic[]) {
-	await activate(docUri);
-
-	const actualDiagnostics = vscode.languages.getDiagnostics(docUri);
-	assert.equal(actualDiagnostics.length, expectedDiagnostics.length);
-
-	expectedDiagnostics.forEach((expectedDiagnostic, i) => {
-		const actualDiagnostic = actualDiagnostics[i];
-		assert.equal(actualDiagnostic.message, expectedDiagnostic.message);
-		assert.deepEqual(actualDiagnostic.range, expectedDiagnostic.range);
-		assert.equal(actualDiagnostic.severity, expectedDiagnostic.severity);
-	});
-}
-

client/src/test/suite/cfnlint.test.ts

@@ -4,6 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 
 import * as vscode from 'vscode';
+import * as assert from 'assert';
 import * as path from 'path';
 
 export let doc: vscode.TextDocument;
@@ -14,20 +15,29 @@ export let platformEol: string;
 /**
  * Activates the kddejong.vscode-cfn-lint extension
  */
-export async function activate(docUri: vscode.Uri) {
-	const ext = vscode.extensions.getExtension('kddejong.vscode-cfn-lint')!;
-	await ext.activate();
-	await vscode.workspace.getConfiguration().update('yaml.validate', false, vscode.ConfigurationTarget.Global);
+export async function activate(docUri: vscode.Uri): Promise<any> {
+	const extension = vscode.extensions.getExtension("kddejong.vscode-cfn-lint");
+	const activation = await extension?.activate();
+
 	try {
 		doc = await vscode.workspace.openTextDocument(docUri);
-		editor = await vscode.window.showTextDocument(doc);
-		await sleep(4000); // Wait for server activation
+		editor = await vscode.window.showTextDocument(doc, {
+			preview: true,
+			preserveFocus: false,
+		});
+
+		await reinitializeExtension();
+		return activation;
 	} catch (e) {
-		console.error(e);
-		throw(e);
+		console.error("Error from activation -> ", e);
 	}
 }
 
+async function reinitializeExtension(): Promise<void> {
+	await vscode.languages.setTextDocumentLanguage(doc, 'yaml');
+	await sleep(20000); // Wait for server activation
+}
+
 export async function activateAndPreview(docUri: vscode.Uri) {
 	await activate(docUri);
 
@@ -36,13 +46,14 @@ export async function activateAndPreview(docUri: vscode.Uri) {
 	await sleep(4000); // Wait for preview to become available
 }
 
-async function sleep(ms: number) {
+export async function sleep(ms: number) {
 	return new Promise(resolve => setTimeout(resolve, ms));
 }
 
 export const getDocPath = (p: string) => {
 	return path.resolve(__dirname, '../../../src/test/suite/fixtures', p);
 };
+
 export const getDocUri = (p: string) => {
 	return vscode.Uri.file(getDocPath(p));
 };
@@ -53,4 +64,20 @@ export async function setTestContent(content: string): Promise<boolean> {
 		doc.positionAt(doc.getText().length)
 	);
 	return editor.edit(eb => eb.replace(all, content));
-}
+}
+
+export async function testDiagnostics(docUri: vscode.Uri, expectedDiagnostics: vscode.Diagnostic[]) {
+	await activate(docUri);
+
+	const actualDiagnostics = vscode.languages.getDiagnostics(docUri);
+
+	assert.equal(actualDiagnostics.length, expectedDiagnostics.length);
+
+	expectedDiagnostics.forEach((expectedDiagnostic, i) => {
+		const actualDiagnostic = actualDiagnostics[i];
+		assert.equal(actualDiagnostic.message, expectedDiagnostic.message);
+		assert.deepEqual(actualDiagnostic.range, expectedDiagnostic.range);
+		assert.equal(actualDiagnostic.severity, expectedDiagnostic.severity);
+	});
+}
+