Add functional and acceptance test harnesses and spl2 tests and bugfixes

.github/workflows/build-test.yaml

@@ -0,0 +1,52 @@
+name: Build and test
+on:
+  push:
+    branches:
+      - main
+      - master
+      - develop
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  unit-test:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+      # Without this a failure in one OS will cancel jobs running for others
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16
+    - run: npm install
+    - run: xvfb-run -a npm test
+      if: runner.os == 'Linux'
+    - run: npm test
+      if: runner.os != 'Linux'
+  functional-test:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+      # Without this a failure in one OS will cancel jobs running for others
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16
+    - run: npm install
+    - run: npm run compile-tests
+    - run: echo "Run acceptance tests" && node ./out/test/runFunctionalTests.js
+      if: runner.os == 'macOS'
+    - run: echo "Run acceptance tests" && xvfb-run -a node ./out/test/runFunctionalTests.js
+      if: runner.os == 'Linux'
+    - run: echo "Run acceptance tests" && node .\out\test\runFunctionalTests.js
+      if: runner.os == 'Windows'

.github/workflows/package-acceptance-test.yaml

@@ -0,0 +1,65 @@
+name: Package .vsix and run acceptance tests
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16
+    - run: npm --version
+    - run: node --version
+    - run: npm install
+    - run: npm list
+    - run: npm run compile
+    - run: npm install -g @vscode/vsce
+    - run: vsce package
+    - uses: actions/upload-artifact@v3
+      with:
+        name: vsix-package
+        path: splunk-*.vsix
+        if-no-files-found: error
+
+  acceptance-test:
+    needs: package
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+      # Without this a failure in one OS will cancel jobs running for others
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Download package
+      uses: actions/download-artifact@v3
+      with:
+        name: vsix-package
+    - run: pwd
+    - run: ls -l *.vsix
+      if: runner.os != 'Windows'
+    - run: dir *.vsix
+      if: runner.os == 'Windows'
+    - name: Install Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16
+    - run: npm --version
+    - run: node --version
+    - run: npm install
+    - run: npm list
+    - run: npm run compile-tests
+    - run: echo "Run acceptance tests" && node ./out/test/runAcceptanceTests.js
+      if: runner.os == 'macOS'
+    - run: echo "Run acceptance tests" && xvfb-run -a node ./out/test/runAcceptanceTests.js
+      if: runner.os == 'Linux'
+    - run: echo "Run acceptance tests" && node .\out\test\runAcceptanceTests.js
+      if: runner.os == 'Windows'

.gitignore

@@ -14,4 +14,7 @@ tsconfig.lsif.json
 *.pyc
 conf_diff.py
 *.vsix
-dist/
+dist/
+out/test
+out/package.json
+.vscode-test

.vscode/launch.json

@@ -45,6 +45,38 @@
                 "<node_internals>/**"
             ],
             "type": "node"
-        }
+        },
+		{
+			"name": "Extension Functional Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+			  "--disable-extensions",
+			  "--extensionDevelopmentPath=${workspaceFolder}",
+			  "--extensionTestsPath=${workspaceFolder}/out/test/functional/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js",
+				"${workspaceFolder}/out/**/*.json"
+			],
+			"preLaunchTask": "npm: compile-tests"
+		  },
+		  {
+			"name": "Extension Acceptance Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+			  "--disable-extensions",
+			  "--extensionDevelopmentPath=${workspaceFolder}",
+			  "--extensionTestsPath=${workspaceFolder}/out/test/acceptance/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js",
+				"${workspaceFolder}/out/**/*.json"
+			],
+			"preLaunchTask": "npm: compile-tests"
+		  }
     ]
 }

.vscode/tasks.json

@@ -19,6 +19,15 @@
 				"kind": "build",
 				"isDefault": true
 			}
-		}	
+		},
+		{
+			"type": "npm",
+			"script": "compile-tests",
+			"problemMatcher": ["$tsc"],
+			"isBackground": false,
+			"group": {
+				"kind": "build"
+			}
+		}
 	]
 }

out/extension.js

@@ -254,7 +254,7 @@ async function activate(context) {
 
     // Notebook
     context.subscriptions.push(vscode.workspace.registerNotebookSerializer('splunk-notebook', new SplunkNotebookSerializer(), {transientCellMetadata: {inputCollapsed: true, outputCollapsed: true}, transientOutputs: false}));
-	  context.subscriptions.push(vscode.workspace.registerNotebookSerializer('spl2-notebook', new Spl2NotebookSerializer(), {transientCellMetadata: {inputCollapsed: true, outputCollapsed: true}, transientOutputs: false}));
+	context.subscriptions.push(vscode.workspace.registerNotebookSerializer('spl2-notebook', new Spl2NotebookSerializer(), {transientCellMetadata: {inputCollapsed: true, outputCollapsed: true}, transientOutputs: false}));
     const controller = new SplunkController();
     context.subscriptions.push(controller);
     const spl2Controller = new Spl2Controller();
@@ -340,9 +340,10 @@ async function handleSpl2Document(context, progressBar) {
         return;
     }
     try {
-        const installedLatestLsp = await installMissingSpl2Requirements(context, progressBar);
+        const globalStoragePath = context.globalStorageUri.fsPath;
+        const installedLatestLsp = await installMissingSpl2Requirements(globalStoragePath, progressBar);
         if (!installedLatestLsp) {
-            await getLatestSpl2Release(context, progressBar);
+            await getLatestSpl2Release(globalStoragePath, progressBar);
         }
         const onSpl2Restart = async (nextPort) => {
             await spl2Client.deactivate();

out/notebooks/spl2/initializer.ts

@@ -2,7 +2,6 @@ import * as child_process from 'child_process';
 import { AddressInfo, Socket } from 'net';
 import * as path from 'path';
 import {
-    ExtensionContext,
     StatusBarItem,
     window,
     workspace,
@@ -49,7 +48,7 @@ interface LSPLog {
 	message: string,
 }
 
-export async function startSpl2ClientAndServer(context: ExtensionContext, progressBar: StatusBarItem, portToAttempt: number, onClose: (nextPort: number) => void): Promise<Spl2ClientServer> {
+export async function startSpl2ClientAndServer(globalStoragePath: string, progressBar: StatusBarItem, portToAttempt: number, onClose: (nextPort: number) => void): Promise<Spl2ClientServer> {
     return new Promise(async (resolve, reject) => {
         try {
             // If the user has already opted-out for good then stop here
@@ -77,9 +76,9 @@ export async function startSpl2ClientAndServer(context: ExtensionContext, progre
                 );
                 return;
             }
-            const lspPath = path.join(getLocalLspDir(context), getLspFilename(lspVersion));
+            const lspPath = path.join(getLocalLspDir(globalStoragePath), getLspFilename(lspVersion));
 
-            const server = new Spl2ClientServer(context, progressBar, javaPath, lspPath, portToAttempt, onClose);
+            const server = new Spl2ClientServer(progressBar, javaPath, lspPath, portToAttempt, onClose);
             await server.initialize();
             resolve(server);
         } catch (err) {
@@ -89,7 +88,6 @@ export async function startSpl2ClientAndServer(context: ExtensionContext, progre
 }
 
 export class Spl2ClientServer {
-    context: ExtensionContext;
     progressBar: StatusBarItem;
     javaPath: string;
     lspPath: string;
@@ -103,8 +101,7 @@ export class Spl2ClientServer {
     serverProcess: child_process.ChildProcess;
     socket: Socket;
 
-    constructor(context: ExtensionContext, progressBar: StatusBarItem, javaPath: string, lspPath: string, portToAttempt: number, onClose: (nextPort: number) => void) {
-        this.context = context;
+    constructor(progressBar: StatusBarItem, javaPath: string, lspPath: string, portToAttempt: number, onClose: (nextPort: number) => void) {
         this.progressBar = progressBar;
         this.javaPath = javaPath;
         this.lspPath = lspPath;