Simplify tests and fix teardown

- Use the vscode-test command line instead of a separate script in order to run the tests.
- Add proper teardown to some test suites that didn't have it

Switching over to the vscode-test cli changed the order in which the tests are executed.
Since some tests didn't have proper teardown, the following tests in the suite started failing.
By adding the proper teardown (and in one case changing the expected result) I got them passing again.

Signed-off-by: David Thompson <davthomp@redhat.com>

Reduce expected number of calls to get tests passing

It used to be 2 because a document from a previous test was left open,
which triggered the update twice (once during the direct invocation,
and once during the faked document changed notification).

Signed-off-by: David Thompson <davthomp@redhat.com>

Author: datho7561

.vscode-test.mjs

@@ -1,6 +1,10 @@
 import { defineConfig } from '@vscode/test-cli';
 
 export default defineConfig({
-  files: 'out/smoke-test/**/*.test.js',
-  workspaceFolder: './smoke-test/',
+  files: 'out/test/**/*.test.js',
+  workspaceFolder: '.',
+  mocha: {
+    ui: 'bdd',
+    timeout: 10_000,
+  },
 });

.vscode-test.smoketest.mjs

@@ -0,0 +1,9 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+  files: 'out/smoke-test/**/*.test.js',
+  workspaceFolder: './smoke-test/',
+  mocha: {
+    ui: 'bdd'
+  }
+});

.vscode/launch.json

@@ -16,23 +16,6 @@
         "VSCODE_REDHAT_TELEMETRY_DEBUG":"true"
       }
     },
-    {
-      "name": "Extension Tests",
-      "type": "extensionHost",
-      "request": "launch",
-      "runtimeExecutable": "${execPath}",
-      "preLaunchTask": "compile test",
-      "args": [
-        "--disable-extension=ms-kubernetes-tools.vscode-kubernetes-tools",
-        "--extensionDevelopmentPath=${workspaceFolder}",
-        "--extensionTestsPath=${workspaceFolder}/out/test",
-        "${workspaceRoot}/test/testFixture"
-      ],
-      "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
-      "env": {
-        "DEBUG_VSCODE_YAML":"true"
-      }
-    },
     {
       "name": "Launch Web Extension",
       "type": "extensionHost",

package.json

@@ -278,13 +278,13 @@
     "compile": "webpack --mode none",
     "format": "prettier --write .",
     "lint": "eslint -c .eslintrc.js --ext .ts src test",
-    "test": "npm run test-compile && sh scripts/e2e.sh",
+    "test": "npm run test-compile && npx vscode-test",
     "ui-test": "npm run test-compile && extest setup-and-run out/test/ui-test/allTestsSuite.js -c 1.76.2",
     "vscode:prepublish": "webpack --mode production && npm run copy-l10n",
     "copy-l10n": "cp -r node_modules/yaml-language-server/l10n dist/l10n",
     "watch": "webpack --mode development --watch --info-verbosity verbose",
     "test-compile": "npm run clean && tsc -p ./ && webpack --mode development && npm run copy-l10n",
-    "smoke-test": "npm run test-compile && vscode-test smoke-test/*",
+    "smoke-test": "npm run test-compile && vscode-test --config .vscode-test.smoketest.mjs",
     "compile-smoke-test-web": "webpack --config smoke-test/webpack.config",
     "smoke-test-web": "npm run compile-smoke-test-web && vscode-test-web --extensionDevelopmentPath=. --extensionTestsPath=./out/smoke-test/smoke-test-runner.js ./smoke-test",
     "run-in-chromium": "npm run compile && vscode-test-web --browserType=chromium --extensionDevelopmentPath=. ."

scripts/e2e.sh

@@ -1,29 +1,28 @@
 require('mocha/mocha');
 
 export function run(): Promise<void> {
+  return new Promise((c, e) => {
+    mocha.setup({
+      ui: 'bdd',
+      reporter: undefined,
+    });
 
-	return new Promise((c, e) => {
-		mocha.setup({
-			ui: 'tdd',
-			reporter: undefined
-		});
+    // bundles all files in the current directory matching `*.test`
+    const importAll = (r: __WebpackModuleApi.RequireContext) => r.keys().forEach(r);
+    importAll(require.context('.', true, /\.test$/));
 
-		// bundles all files in the current directory matching `*.test`
-		const importAll = (r: __WebpackModuleApi.RequireContext) => r.keys().forEach(r);
-		importAll(require.context('.', true, /\.test$/));
-
-		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);
-		}
-	});
-}
+    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);
+    }
+  });
+}

smoke-test/smoke-test-runner.ts

@@ -2,7 +2,7 @@ import { assert } from 'chai';
 import * as vscode from 'vscode';
 import { URI } from 'vscode-uri';
 
-suite('Smoke test suite', function () {
+describe('Smoke test suite', function () {
   this.timeout(10_000);
 
   // diagnostics take some time to appear; the language server must be started and respond to file open event
@@ -12,12 +12,14 @@ suite('Smoke test suite', function () {
 
   let schemaInstanceUri: URI;
 
-  this.beforeAll(async function () {
+  before(async function () {
     const workspaceUri = vscode.workspace.workspaceFolders[0].uri;
-    schemaInstanceUri = workspaceUri.with({ path: workspaceUri.path + (workspaceUri.path.endsWith('/') ? '' : '/') + SCHEMA_INSTANCE_NAME });
+    schemaInstanceUri = workspaceUri.with({
+      path: workspaceUri.path + (workspaceUri.path.endsWith('/') ? '' : '/') + SCHEMA_INSTANCE_NAME,
+    });
   });
 
-  test('instance has right diagnostics', async function () {
+  it('has right diagnostics when schema is referenced through a comment', async function () {
     const textDocument = await vscode.workspace.openTextDocument(schemaInstanceUri);
     await vscode.window.showTextDocument(textDocument);
     await new Promise((resolve) => setTimeout(resolve, DIAGNOSTICS_DELAY));

smoke-test/smoke.test.ts

@@ -6,7 +6,7 @@
  *--------------------------------------------------------------------------------------------*/
 'use strict';
 
-import { workspace, ExtensionContext, extensions, window, commands, Uri, l10n } from 'vscode';
+import { workspace, ExtensionContext, extensions, window, commands, Uri } from 'vscode';
 import {
   CommonLanguageClient,
   LanguageClientOptions,

src/extension.ts

@@ -16,6 +16,10 @@ describe('Completion should work in multiple different scenarios', () => {
     await resetSettings('schemaStore.enable', true);
   });
 
+  after(async () => {
+    vscode.window.tabGroups.close(vscode.window.tabGroups.activeTabGroup);
+  });
+
   it('completion works with local schema', async () => {
     await activate(docUri);
     const schemaPath = path.join(__dirname, '..', '..', 'test', 'testFixture', 'schemas', 'basic_completion_schema.json');