Merge pull request #34 from phpactor/test

Add test runner

Author: dantleech

.github/workflows/ci.yml

@@ -1,31 +1,20 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
+name: Test Extension
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
   pull_request:
     branches: [ master ]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [17.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
     steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Node.js
+      uses: actions/setup-node@v2
       with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+        node-version: 14
+    - run: npm install
+    - run: xvfb-run -a npm test

.gitignore

@@ -1,3 +1,4 @@
 lib
 .vscode
 node_modules
+.vscode-test

README.md

@@ -1,5 +1,5 @@
 Phpactor VSCode Extension
-======================
+=========================
 
 ![phpactor2sm](https://user-images.githubusercontent.com/530801/27995098-82e72c4c-64c0-11e7-96d2-f549c711ca8b.png)
 
@@ -9,8 +9,6 @@ with [VSCode](https://github.com/neoclide/coc.nvim).
 Installation
 ------------
 
-First, install [Phpactor](https://phpactor.readthedocs.io/en/develop/usage/standalone.html).
-
 The package isn't published yet on the "marketplace" so:
 
 1. Install [yarn](https://classic.yarnpkg.com/en/docs/install) and [npm](https://www.npmjs.com/get-npm).
@@ -26,6 +24,7 @@ Phpactor should then be enabled the next time you start VS code.
 Commands
 --------
 
+- `phpactor.update`: Update Phpactor to the latest version
 - `phpactor.status`: Show Phpactor's status
 - `phpactor.reindex`: Reindex the project.
 - `phpactor.services.list`: List Phpactor's currently running services.

package-lock.json

@@ -15,13 +15,21 @@
     "scripts": {
         "clean": "rimraf lib",
         "build": "tsc -p tsconfig.json",
-        "prepare": "yarn clean && yarn build"
+        "prepare": "yarn clean && yarn build",
+        "watch": "tsc -watch -p ./",
+        "pretest": "npm run compile",
+        "compile": "tsc -p ./",
+        "test": "node ./lib/test/runTests.js"
     },
     "activationEvents": [
         "onLanguage:php"
     ],
     "contributes": {
         "commands": [
+            {
+                "command": "phpactor.update",
+                "title": "Update Phpactor to the latest version"
+            },
             {
                 "command": "phpactor.reindex",
                 "title": "Phpactor: Reindex the project."
@@ -43,8 +51,8 @@
             "title": "phpactor config",
             "properties": {
                 "phpactor.path": {
-                    "type": "string",
-                    "default": "phpactor",
+                    "type": "string|null",
+                    "default": null,
                     "description": "phpactor bin path"
                 },
                 "phpactor.enable": {
@@ -66,15 +74,24 @@
     "devDependencies": {
         "@chemzqm/tsconfig": "^0.0.3",
         "@chemzqm/tslint-config": "^1.0.18",
+        "@types/glob": "^7.1.1",
+        "@types/mocha": "^9.1.0",
         "@types/node": "^11.13.10",
         "@types/vscode": "1.43.0",
+        "@typescript-eslint/eslint-plugin": "^5.19.0",
+        "@typescript-eslint/parser": "^5.19.0",
+        "@vscode/test-electron": "^2.1.3",
+        "eslint": "^8.13.0",
+        "glob": "^7.1.4",
+        "mocha": "^9.2.2",
         "rimraf": "~3.0.2",
+        "source-map-support": "^0.5.12",
         "ts-loader": "~8.0.2",
         "tslib": "^2.1.0",
         "tslint": "^5.16.0",
-        "typescript": "~3.9.7",
-        "webpack": "^4.34.0",
+        "typescript": "^4.6.3",
         "vscode-test": "~1.4.0",
+        "webpack": "^4.34.0",
         "webpack-cli": "^3.3.4"
     },
     "dependencies": {

package.json

@@ -5,6 +5,9 @@ import {
 } from "vscode-languageclient";
 
 import * as vscode from "vscode";
+import { spawn } from "child_process";
+import { existsSync, mkdir, mkdirSync } from "fs";
+import { basename, dirname } from "path";
 
 const LanguageID = 'php';
 
@@ -15,10 +18,13 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
     const config = workspaceConfig.get("phpactor") as any;
     const enable = config.enable;
 
+    if (!config.path) {
+        config.path = await installPhpactor(context.globalStoragePath)
+    }
+
     if (enable === false) return;
 
     languageClient = createClient(config);
-
     languageClient.start();
 }
 
@@ -60,26 +66,27 @@ function createClient(config: any): LanguageClient {
         clientOptions
     );
 
-
     vscode.commands.registerCommand('phpactor.reindex', reindex);
     vscode.commands.registerCommand('phpactor.config.dump', dumpConfig);
     vscode.commands.registerCommand('phpactor.services.list', servicesList);
     vscode.commands.registerCommand('phpactor.status', status);
+    const updateConfig = {cwd: dirname(dirname(config.path))}
+    vscode.commands.registerCommand('phpactor.update', updatePhpactor, updateConfig);
 
     return languageClient;
 }
 
 function reindex(): void {
-	if(!languageClient) {
-		return;
+    if(!languageClient) {
+        return;
     }
 
     languageClient.sendRequest('indexer/reindex');
 }
 
 async function dumpConfig(): Promise<void> {
-	if(!languageClient) {
-		return;
+    if(!languageClient) {
+        return;
     }
 
     const channel = vscode.window.createOutputChannel('Phpactor Config')
@@ -89,20 +96,74 @@ async function dumpConfig(): Promise<void> {
 }
 
 function servicesList(): void {
-	if(!languageClient) {
-		return;
+    if(!languageClient) {
+        return;
     }
 
     languageClient.sendRequest('service/running');
 }
 
 async function status(): Promise<any> {
-	if(!languageClient) {
-		return;
+    if(!languageClient) {
+        return;
     }
 
     const channel = vscode.window.createOutputChannel('Phpactor Status')
     const result = await languageClient.sendRequest<string>('phpactor/status');
     channel.append(result)
     channel.show()
 }
+
+async function installPhpactor(storagePath: string): Promise<string> {
+    const channel = vscode.window.createOutputChannel("Phpactor Installation")
+    vscode.window.showInformationMessage("Installing Phpactor")
+    if (!existsSync(storagePath)) {
+        mkdirSync(storagePath)
+    }
+
+    const path = `${storagePath}/phpactor`
+
+    if (!existsSync(path)) {
+        await exec(channel, 'git', ['clone', 'https://github.com/phpactor/phpactor', '--depth=1'], storagePath)
+        await exec(channel, 'composer', ['install', '--no-dev'], path)
+        vscode.window.showInformationMessage(`Phpactor installed at ${path}`)
+    }
+
+    return `${storagePath}/phpactor/bin/phpactor`
+}
+
+export async function updatePhpactor(): Promise<void> {
+    const channel = vscode.window.createOutputChannel('Phpactor Update')
+    channel.appendLine(this.cwd)
+    await exec(channel, 'git', ['pull'], this.cwd)
+    await exec(channel, 'composer', ['install', '--no-dev'], this.cwd)
+    channel.appendLine("Phpactor updated")
+    vscode.window.showInformationMessage("Phpactor updated")
+}
+
+
+function exec(channel: vscode.OutputChannel, command: string, args: string[], cwd: string): Promise<void> {
+    return new Promise(function (resolve, reject) {
+
+        const child = spawn(command, args, {
+            cwd: cwd,
+            timeout: 30000,
+        })
+        child.stdout.on('data', function (data) {
+            channel.append(data.toString('utf8'))
+        })
+        child.stderr.on('data', function (data) {
+            channel.append(data.toString('utf8'))
+        })
+        child.on('close', function (code) {
+            if (code !== 0) {
+                reject(`Expected git to exit with code 0 got "${code}"`)
+            }
+            resolve()
+        });
+
+        child.on('error', function (err) {
+            reject(err)
+        });
+    })
+}

src/extension.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/runTests.ts

@@ -0,0 +1,15 @@
+import * as assert from 'assert';
+
+// You can import and use all API from the 'vscode' module
+// as well as import your extension to test it
+import * as vscode from 'vscode';
+import * as myExtension from '../../extension';
+
+suite('Extension Test Suite', () => {
+	test('Extension is present', async () => {
+        assert.ok(vscode.extensions.getExtension("dantleech.vscode-phpactor"));
+	});
+	test('Extension activates', async () => {
+        await vscode.extensions.getExtension("dantleech.vscode-phpactor")?.activate();
+	});
+});

src/test/suite/extension.test.ts

@@ -0,0 +1,38 @@
+;import * as path from 'path';
+import Mocha from 'mocha';
+import glob from 'glob';
+
+export function run(): Promise<void> {
+	// Create the mocha test
+	const mocha = new Mocha({
+		ui: 'tdd',
+        timeout: 30000
+	});
+
+	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);
+			}
+		});
+	});
+}