FYP-44: updated the way we build and run tests

Author: DiogoTheCoder

.vscode/launch.json

@@ -40,7 +40,7 @@
 				"--extensionDevelopmentPath=${workspaceFolder}"
 			],
 			"outFiles": [
-				"${workspaceFolder}/out/**/*.js"
+				"${workspaceFolder}/out/src/**/*.js"
 			],
 			"preLaunchTask": "${defaultBuildTask}"
 		},
@@ -50,10 +50,10 @@
 			"request": "launch",
 			"args": [
 				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+				"--extensionTestsPath=${workspaceFolder}/out/src/test/suite/index"
 			],
 			"outFiles": [
-				"${workspaceFolder}/out/test/**/*.js"
+				"${workspaceFolder}/out/src/test/**/*.js"
 			],
 			"preLaunchTask": "${defaultBuildTask}"
 		}

azure-pipelines.yml

@@ -41,14 +41,10 @@ steps:
   - script: yarn --frozen-lockfile
     displayName: Install Dependencies
 
-  - script: yarn compile
-    displayName: Build Extension
-
   - script: yarn serve
     displayName: Build Language Server
 
-  - script: yarn run pretest
-    displayName: Pre-test
-
-  - bash: node ./out/test/runTest.js
-    displayName: Run Tests
+  - script: yarn run test
+    displayName: Build & Test
+    env:
+      DISPLAY: ':99.0'

package.json

@@ -14,22 +14,21 @@
   "activationEvents": [
     "onLanguage:java"
   ],
-  "main": "./out/extension.js",
+  "main": "./out/src/extension.js",
   "scripts": {
     "vscode:prepublish": "yarn run build && yarn run test",
     "compile": "tsc -p ./",
-    "serve": "mvn clean install",
-    "build": "yarn run lint && yarn run compile && mvn clean install",
+    "build": "mvn clean install",
     "lint": "eslint --fix \"**/*.{js,ts,tsx}\"",
-    "pretest": "rm -rf out/test/suite/test && cp -R src/test/suite/test out/test/suite/test",
-    "test": "yarn run build && yarn run pretest && node ./out/test/runTest.js",
-    "watch": "tsc -watch -p ./"
+    "test": "sh test.sh",
+    "watch": "tsc -watch -p ./ "
   },
   "devDependencies": {
     "@types/flat": "^5.0.1",
     "@types/glob": "^7.1.3",
     "@types/mocha": "^8.2.0",
     "@types/node": "^12.11.7",
+    "@types/prettier": "^2.2.1",
     "@types/vscode": "^1.50.0",
     "@typescript-eslint/eslint-plugin": "^4.1.1",
     "@typescript-eslint/parser": "^4.1.1",
@@ -40,7 +39,7 @@
     "mocha": "^8.1.3",
     "string-hex": "^1.0.0",
     "typescript": "^4.0.2",
-    "vscode-test": "^1.4.0"
+    "vscode-test": "^1.5.1"
   },
   "dependencies": {
     "deepdash": "^5.3.2",
@@ -80,14 +79,14 @@
           ".java",
           ".class"
         ],
-        "configuration": "./language-configuration.json"
+        "configuration": "./out/src/syntaxes/language-configuration.json"
       }
     ],
     "grammars": [
       {
         "language": "java",
         "scopeName": "source.java",
-        "path": "./syntaxes/java.tmLanguage.json"
+        "path": "./out/src/syntaxes/java.tmLanguage.json"
       }
     ],
     "configuration": {

src/commands/displaySyntaxTree.ts

@@ -10,9 +10,6 @@ require('deepdash')(_);
 export function displaySyntaxTree() {
   const editor = getEditor();
   const code = editor.document.getText();
-  if (typeof code !== 'string') {
-    throw Error('Was unable to read code!');
-  }
 
   // Get the last part of the filename (after the last slash), e.g. Refactor.java
   const filename = editor.document.fileName.substring(
@@ -38,7 +35,7 @@ export function displaySyntaxTree() {
     throw Error(error.message);
   }
 
-  ast = _.filterDeep(ast, (value, key, parent) => {
+  ast = _.filterDeep(ast, (value: any, key: any, parent: any) => {
     if (value !== null) {
       if (Array.isArray(value) && value.length === 0) {
         return false;

src/extension.ts

@@ -23,7 +23,7 @@ export function activate(context: vscode.ExtensionContext) {
 
   let classPath = path.join(
     __dirname,
-    '..',
+    '../../',
     'launcher',
     'target',
     'launcher.jar',

syntaxes/java.tmLanguage.json renamed to src/syntaxes/java.tmLanguage.json

@@ -6,15 +6,20 @@ async function main() {
   try {
     // The folder containing the Extension Manifest package.json
     // Passed to `--extensionDevelopmentPath`
-    const extensionDevelopmentPath = path.resolve(__dirname, '../../');
+    const extensionDevelopmentPath = path.resolve(__dirname, '../../../');
 
-    // The path to the extension test script
+    // The path to the extension test runner 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 });
+    await runTests({
+      extensionDevelopmentPath,
+      extensionTestsPath,
+      launchArgs: ['--disable-extensions'],
+    });
   } catch (err) {
+    console.error(err);
     console.error('Failed to run tests');
     process.exit(1);
   }

language-configuration.json renamed to src/syntaxes/language-configuration.json

@@ -16,12 +16,10 @@ suite('Extension Test Suite', () => {
       'DiogoTheCoder.make-java-great-again',
     )!;
 
-    textDocument = await activate(FILE_PATH);
+    textDocument = await activate(ext, FILE_PATH);
     assert.strictEqual(textDocument.lineCount > 0, true);
     assert.strictEqual(ext.isActive, true);
 
-    const text = textDocument.getText();
-
     await sleep(5000);
 
     const diagnostics = vscode.languages.getDiagnostics(textDocument.uri);

src/test/runTest.ts

@@ -1,16 +1,15 @@
 import * as vscode from 'vscode';
-import { TextDocument } from 'vscode';
+import { Extension, TextDocument } from 'vscode';
 import path from 'path';
 
 export let doc: vscode.TextDocument;
 export let editor: vscode.TextEditor;
 
-export async function activate(filePath: string): Promise<TextDocument> {
-  const ext = vscode.extensions.getExtension(
-    'DiogoTheCoder.make-java-great-again',
-  )!;
-
-  await ext.activate();
+export async function activate(
+  extension: Extension<any>,
+  filePath: string,
+): Promise<TextDocument> {
+  await extension.activate();
   try {
     doc = await vscode.workspace.openTextDocument(filePath);
     editor = await vscode.window.showTextDocument(doc);
@@ -25,7 +24,7 @@ export async function activate(filePath: string): Promise<TextDocument> {
 export function getDocPath(relativePath: string) {
   // Resolve Windows nonsense
   relativePath = relativePath.replace('%3A', '');
-  return path.join(__dirname, `test/src/${relativePath}`);
+  return path.join(__dirname, `java/src/${relativePath}`);
 }
 
 export async function sleep(ms: number) {

src/test/suite/extension.test.ts

@@ -6,6 +6,7 @@ export function run(): Promise<void> {
   // Create the mocha test
   const mocha = new Mocha({
     ui: 'tdd',
+    color: true,
     timeout: 60 * 60 * 1000,
   });
 

src/test/suite/helper.ts

@@ -0,0 +1 @@
+declare module 'mulang';

src/test/suite/index.ts

@@ -26,7 +26,7 @@ export function writeCode(code: string): void {
 
   const formattedCode = prettier.format(code, {
     parser: 'java',
-    tabWidth: editor.options.tabSize,
+    tabWidth: Number.parseInt(editor.options.tabSize?.toString() ?? '4', 10),
   });
 
   const updateCode = new vscode.TextEdit(wholeDocument, formattedCode);

src/test/suite/test/README.md renamed to src/test/suite/java/README.md

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Clear out the old compiled TS files
+rm -rf out/
+
+# Run tsc -p ./
+yarn run compile
+
+# Copy over the syntaxes folder (JSON files) to the out
+cp -a src/syntaxes out/src/syntaxes
+
+# Copy over the App.java used for testing
+mkdir -p "out/src/test/suite/java"
+cp -r src/test/suite/java/. out/src/test/suite/java
+
+# And run the tests!
+node ./out/src/test/runTest.js

src/test/suite/test/src/App.java renamed to src/test/suite/java/src/App.java

@@ -4,27 +4,16 @@
 		"module": "commonjs",
 		"target": "es2019",
 		"outDir": "out",
-		"lib": [
-			"ES2019"
-		],
+		"lib": ["ES2019"],
 		"sourceMap": true,
-		"rootDir": "src",
 		"strict": true,
 		"composite": true,
 		"esModuleInterop": true,
 		"suppressImplicitAnyIndexErrors": true,
-		"noImplicitAny": false,
 		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"allowJs" : true,
 	},
-	"include": [
-		"src"
-	],
-	"exclude": [
-		"node_modules",
-		"./node_modules",
-		"./node_modules/*",
-		"./node_modules/@types/node/index.d.ts",
-		"**/out/**",
-		".vscode-test"
-	]
+	"include": ["./src/**/*"],
+	"exclude": ["node_modules", ".vscode-test", "out"]
 }