Merge pull request #79 from Code-Inspect/12-add-tests-for-all-existin…

…g-actions

 Add tests for all existing actions

.vscode-test.mjs

@@ -1,5 +1,12 @@
 import { defineConfig } from '@vscode/test-cli';
 
 export default defineConfig({
+	version: '1.60.0',
 	files: 'out/test/**/*.test.js',
+	workspaceFolder: './test-workspace',
+	extensionDevelopmentPath: './',
+	mocha: {
+		timeout: 300000,
+		slow: 1100
+	}
 });

package.json

@@ -75,6 +75,12 @@
         "icon": "$(graph)",
         "category": "flowR"
       },
+      {
+        "command": "vscode-flowr.session.internal",
+        "title": "Start Local flowR Shell",
+        "icon": "$(terminal)",
+        "category": "flowR"
+      },
       {
         "command": "vscode-flowr.session.connect",
         "title": "Connect to flowR Server",

src/diagram.ts

@@ -7,7 +7,7 @@ export function registerDiagramCommands(context: vscode.ExtensionContext) {
 		if(activeEditor) {
 			const mermaid = await (await getFlowrSession()).retrieveDataflowMermaid(activeEditor.document)
 			if(mermaid) {
-				createWebview('flowr-dataflow', 'Dataflow Graph', mermaid)
+				return { mermaid, webview: createWebview('flowr-dataflow', 'Dataflow Graph', mermaid) }
 			}
 		}
 	}))

src/extension.ts

@@ -19,18 +19,19 @@ export async function activate(context: vscode.ExtensionContext) {
 	registerDiagramCommands(context)
 	registerSliceCommands(context)
 
-	context.subscriptions.push(
-		vscode.commands.registerCommand('vscode-flowr.session.connect', async() => {
-			await establishServerSession()
-		})
-	)
-	context.subscriptions.push(
-		vscode.commands.registerCommand('vscode-flowr.session.disconnect', () => {
-			if(flowrSession instanceof FlowrServerSession) {
-				destroySession()
-			}
-		})
-	)
+	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.session.internal', async() => {
+		await establishInternalSession()
+		return flowrSession
+	}))
+	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.session.connect', async() => {
+		await establishServerSession()
+		return flowrSession
+	}))
+	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.session.disconnect', () => {
+		if(flowrSession instanceof FlowrServerSession) {
+			destroySession()
+		}
+	}))
 
 	context.subscriptions.push(
 		vscode.commands.registerCommand('vscode-flowr.report', () => {

src/flowr/internal-session.ts

@@ -46,7 +46,7 @@ export class FlowrInternalSession implements FlowrSession {
 		// wait at most 1 second for the version, since the R shell doesn't let us know if the path
 		// we provided doesn't actually lead anywhere, or doesn't contain an R executable, etc.
 		let handle: NodeJS.Timeout
-		const timeout = new Promise<null>(resolve => handle = setTimeout(() => resolve(null), 1000))
+		const timeout = new Promise<null>(resolve => handle = setTimeout(() => resolve(null), 5000))
 		await Promise.race([this.shell.usedRVersion(), timeout]).then(version => {
 			clearTimeout(handle)
 			if(!version){

src/selection-slicer.ts

@@ -69,8 +69,8 @@ class SelectionSlicer {
 	}
 
 	// Slice once at the current cursor position
-	async sliceSelectionOnce(): Promise<void> {
-		await this.update()
+	async sliceSelectionOnce(): Promise<string> {
+		return await this.update()
 	}
 
 	// Stop following the cursor and clear the selection slice output
@@ -111,10 +111,10 @@ class SelectionSlicer {
 		this.decos = undefined
 	}
 
-	protected async update(): Promise<void> {
+	protected async update(): Promise<string> {
 		const ret = await getSelectionSlice()
 		if(ret === undefined){
-			return
+			return ''
 		}
 		const provider = getReconstructionContentProvider()
 		const uri = this.makeUri()
@@ -132,6 +132,7 @@ class SelectionSlicer {
 		this.decos ||= makeSliceDecorationTypes()
 		await displaySlice(ret.editor, ret.sliceElements, this.decos)
 		this.decoratedEditors.push(ret.editor)
+		return ret.code
 	}
 }
 

src/slice.ts

@@ -9,7 +9,7 @@ import { disposeActivePositionSlicer, getActivePositionSlicer, addCurrentPositio
 
 export function registerSliceCommands(context: vscode.ExtensionContext) {
 	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.slice.cursor', async() => {
-		await getSelectionSlicer().sliceSelectionOnce()
+		return await getSelectionSlicer().sliceSelectionOnce()
 	}))
 	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.slice.clear', () => {
 		clearSliceOutput()
@@ -19,7 +19,7 @@ export function registerSliceCommands(context: vscode.ExtensionContext) {
 	}))
 
 	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.slice.show.in.editor', async() => {
-		await showReconstructionInEditor()
+		return await showReconstructionInEditor()
 	}))
 
 	context.subscriptions.push(vscode.commands.registerCommand('vscode-flowr.slice.position', async() => {

src/test/diagram.test.ts

@@ -0,0 +1,20 @@
+import * as vscode from 'vscode'
+import * as assert from 'assert'
+
+import { activateExtension, openTestFile } from './test-util'
+
+suite('diagram', () => {
+	suiteSetup(async() => {
+		await activateExtension()
+	})
+
+	test('dataflow', async() => {
+		await openTestFile('simple-example.R')
+		const result: {webview: vscode.WebviewPanel, mermaid: string} | undefined =
+			await vscode.commands.executeCommand('vscode-flowr.dataflow')
+		assert.ok(result)
+		assert.equal(result.webview.title, 'Dataflow Graph')
+		assert.ok(result.mermaid.startsWith('flowchart TD'))
+	})
+})
+

src/test/slice.test.ts

@@ -0,0 +1,33 @@
+import * as vscode from 'vscode'
+import * as assert from 'assert'
+import { activateExtension, openTestFile } from './test-util'
+
+suite('slice', () => {
+	suiteSetup(async() => {
+		await activateExtension()
+	})
+
+	test('slice cursor', async() => {
+		await openTestFile('example.R', new vscode.Selection(7, 6, 7, 6))
+		const slice: string | undefined = await vscode.commands.executeCommand('vscode-flowr.slice.cursor')
+		assert.ok(slice)
+		assert.equal(slice, `
+product <- 1
+n <- 10
+for(i in 1:(n - 1)) product <- product * i
+			`.trim())
+	})
+
+	test('reconstruct cursor', async() => {
+		await openTestFile('example.R', new vscode.Selection(7, 6, 7, 6))
+		const newEditor: vscode.TextEditor | undefined = await vscode.commands.executeCommand('vscode-flowr.slice.show.in.editor')
+		assert.ok(newEditor)
+		assert.equal(vscode.window.activeTextEditor, newEditor)
+		assert.ok(newEditor.document.fileName.endsWith('Selection Slice'))
+		assert.equal(newEditor.document.getText(), `
+product <- 1
+n <- 10
+for(i in 1:(n - 1)) product <- product * i
+			`.trim())
+	})
+})

src/test/test-util.ts

@@ -0,0 +1,30 @@
+// also see https://github.com/microsoft/vscode-extension-samples/blob/main/lsp-sample/client/src/test/helper.ts for various test helper samples
+
+import * as vscode from 'vscode'
+import * as assert from 'assert'
+import * as path from 'path'
+import type { FlowrInternalSession } from '../flowr/internal-session'
+
+export async function activateExtension(): Promise<void> {
+	const ext = vscode.extensions.getExtension('code-Inspect.vscode-flowr')
+
+	assert.notEqual(ext, undefined, 'extension not found')
+
+	await assert.doesNotReject(async() => {
+		await ext?.activate()
+	}, 'extension activation failed')
+
+	// force start a local shell and wait, since there seem to be some async issues with commands
+	const session: FlowrInternalSession = await vscode.commands.executeCommand('vscode-flowr.session.internal')
+	assert.equal(session.state, 'active')
+}
+
+export async function openTestFile(name: string, selection?: vscode.Selection): Promise<vscode.TextEditor> {
+	const file = path.resolve(__dirname, '..', '..', 'test-workspace', name)
+	const doc = await vscode.workspace.openTextDocument(file)
+	const editor = await vscode.window.showTextDocument(doc)
+	if(selection) {
+		editor.selection = selection
+	}
+	return editor
+}

test-workspace/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "vscode-flowr.verboseLog": true
+}

test-workspace/example.R

@@ -0,0 +1,12 @@
+sum <- 0
+product <- 1
+w <- 7
+n <- 10
+
+for (i in 1:(n - 1)) {
+  sum <- sum + i + w
+  product <- product * i
+}
+
+cat("Sum:", sum, "\n")
+cat("Product:", product, "\n")

test-workspace/simple-example.R

@@ -0,0 +1,2 @@
+X <- 2
+Y <- X + 1