Create a basic integration test

Author: Tony Spataro

.vscode/launch.json

@@ -5,6 +5,7 @@
 {
 	"version": "0.2.0",
 	"configurations": [
+
 		{
 			"name": "Run Extension",
 			"type": "extensionHost",
@@ -17,5 +18,17 @@
 			],
 			"preLaunchTask": "${defaultBuildTask}"
 		},
+		{
+			"name": "Run Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+			],
+			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
 	]
 }

package.json

@@ -4,6 +4,7 @@
   "description": "VSCode support for the syntax_tree gem",
   "icon": "doc/logo.png",
   "version": "0.2.1",
+  "packageManager": "yarn@1.22.19",
   "publisher": "ruby-syntax-tree",
   "repository": {
     "type": "git",
@@ -96,8 +97,13 @@
     "vscode-languageclient": "^8.0.1"
   },
   "devDependencies": {
+    "@types/glob": "^7.1.1",
+    "@types/mocha": "^9.1.1",
     "@types/node": "^18.0.0",
     "@types/vscode": "^1.68.0",
+    "@vscode/test-electron": "^1.6.1",
+    "glob": "^7.1.4",
+    "mocha": "^9.1.1",
     "typescript": "^4.7.4",
     "vsce": "^2.9.2"
   }

src/test/runTest.ts

@@ -0,0 +1,23 @@
+import * as path from 'path';
+
+import { runTests } from '@vscode/test-electron';
+
+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, './suite/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();

src/test/suite/automation.ts

@@ -0,0 +1,29 @@
+import * as assert from 'assert';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import { TextEncoder } from 'util';
+
+import { Uri, commands, window, workspace } from 'vscode';
+
+// Can't actually open this as a workspace (it kills the debug connection),
+// but we need somewhere to put temp files.
+const WORKSPACE_FOLDER = fs.mkdtempSync(`${os.tmpdir()}${path.sep}vscode-syntax-tree-`);
+
+export async function closeAll() {
+  while (window.activeTextEditor) {
+    await commands.executeCommand('workbench.action.closeActiveEditor');
+  }
+}
+
+export async function createEditor(content: string, filename = 'test.rb') {
+  const uri = Uri.file(`${WORKSPACE_FOLDER}${path.sep}${filename}`);
+  await workspace.fs.writeFile(uri, new TextEncoder().encode(content));
+  await window.showTextDocument(uri);
+  assert.ok(window.activeTextEditor);
+  return window.activeTextEditor;
+}
+
+export async function formatDocument() {
+  await commands.executeCommand('editor.action.formatDocument', 'ruby-syntax-tree.vscode-syntax-tree');
+}

src/test/suite/index.test.ts

@@ -0,0 +1,24 @@
+import * as assert from 'assert';
+
+import * as auto from './automation';
+
+// can directly import extension if needed
+// import * as myExtension from '../../extension';
+
+const UNFORMATTED = `class Foo; def bar; puts 'baz'; end; end`;
+
+const FORMATTED = `class Foo
+  def bar
+    puts "baz"
+  end
+end
+`;
+
+suite('Syntax Tree', () => {
+  test('Format Document', async () => {
+    await auto.closeAll();
+    const editor = await auto.createEditor(UNFORMATTED);
+    await auto.formatDocument();
+    assert.equal(editor.document.getText(), FORMATTED);
+  });
+});

src/test/suite/index.ts

@@ -0,0 +1,40 @@
+import * as path from 'path';
+import * as Mocha from 'mocha';
+import * as glob from 'glob';
+
+export function run(): Promise<void> {
+  // Create the mocha test
+  const mocha = new Mocha({
+    asyncOnly: true,
+    color: true,
+    timeout: 300000, // five minutes (since we can't say "no timeout")
+    ui: 'tdd'
+  });
+
+  const testsRoot = path.resolve(__dirname, '..');
+
+  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);
+      }
+    });
+  });
+}