Merge pull request #53 from ShMcK/feature/refactor-test-runner

Feature/refactor test runner

Author: ShMcK

src/actions/runTest.ts

@@ -4,34 +4,34 @@ import * as vscode from 'vscode'
 import * as git from '../services/git'
 import node from '../services/node'
 
-interface ErrorMessageFilter {
-	[lang: string]: {
-		[key: string]: string
-	}
-}
+// interface ErrorMessageFilter {
+// 	[lang: string]: {
+// 		[key: string]: string
+// 	}
+// }
 
 // TODO: should be loaded on startup based on language
-const commandErrorMessageFilter: ErrorMessageFilter = {
-	JAVASCRIPT: {
-		'node-gyp': 'Error running npm setup command'
-	}
-}
+// const commandErrorMessageFilter: ErrorMessageFilter = {
+// 	JAVASCRIPT: {
+// 		'node-gyp': 'Error running npm setup command'
+// 	}
+// }
 
 
 // TODO: pass command and command name down for filtering. Eg. JAVASCRIPT, 'npm install'
-const runCommands = async (commands: string[], language: string = 'JAVASCRIPT') => {
+const runCommands = async (commands: string[]) => {
 	for (const command of commands) {
 		const {stdout, stderr} = await node.exec(command)
 		if (stderr) {
 			console.error(stderr)
 			// language specific error messages from running commands
-			const filteredMessages = Object.keys(commandErrorMessageFilter[language])
-			for (const message of filteredMessages) {
-				if (stderr.match(message)) {
-					// ignored error
-					throw new Error('Error running setup command')
-				}
-			}
+			// const filteredMessages = Object.keys(commandErrorMessageFilter[language])
+			// for (const message of filteredMessages) {
+			// 	if (stderr.match(message)) {
+			// 		// ignored error
+			// 		throw new Error('Error running setup command')
+			// 	}
+			// }
 		}
 		console.log(`run command: ${command}`, stdout)
 	}
@@ -45,7 +45,8 @@ const disposeWatcher = (listener: string) => {
 	delete watchers[listener]
 }
 
-const setupActions = async (workspaceRoot: vscode.WorkspaceFolder, {commands, commits, files, listeners}: G.StepActions): Promise<void> => {
+const setupActions = async (workspaceRoot: vscode.WorkspaceFolder, actions: G.StepActions): Promise<void> => {
+	const {commands, commits, files, listeners} = actions
 	// run commits
 	if (commits) {
 		for (const commit of commits) {
@@ -55,16 +56,36 @@ const setupActions = async (workspaceRoot: vscode.WorkspaceFolder, {commands, co
 
 	// run file watchers (listeners)
 	if (listeners) {
+		console.log('listeners')
 		for (const listener of listeners) {
 			if (!watchers[listener]) {
 				const pattern = new vscode.RelativePattern(
 					vscode.workspace.getWorkspaceFolder(workspaceRoot.uri)!,
 					listener
 				)
-				watchers[listener] = vscode.workspace.createFileSystemWatcher(
+				console.log(pattern)
+				const listen = vscode.workspace.createFileSystemWatcher(
 					pattern
 				)
+				watchers[listener] = listen
 				watchers[listener].onDidChange(() => {
+					console.log('onDidChange')
+					// trigger save
+					vscode.commands.executeCommand('coderoad.run_test', null, () => {
+						// cleanup watcher on success
+						disposeWatcher(listener)
+					})
+				})
+				watchers[listener].onDidCreate(() => {
+					console.log('onDidCreate')
+					// trigger save
+					vscode.commands.executeCommand('coderoad.run_test', null, () => {
+						// cleanup watcher on success
+						disposeWatcher(listener)
+					})
+				})
+				watchers[listener].onDidDelete(() => {
+					console.log('onDidDelete')
 					// trigger save
 					vscode.commands.executeCommand('coderoad.run_test', null, () => {
 						// cleanup watcher on success

src/actions/setupActions.ts

@@ -1,7 +1,8 @@
 import * as G from 'typings/graphql'
 import * as vscode from 'vscode'
 import * as git from '../services/git'
-import langaugeMap from '../editor/languageMap'
+import languageMap from '../editor/languageMap'
+import {COMMANDS} from '../editor/commands'
 
 interface TutorialConfigParams {
 	config: G.TutorialConfig,
@@ -19,10 +20,29 @@ const tutorialConfig = async ({config, alreadyConfigured, }: TutorialConfigParam
 		await git.setupRemote(config.repo.uri)
 	}
 
+	vscode.commands.executeCommand(COMMANDS.CONFIG_TEST_RUNNER, config.testRunner)
+
+	const fileFormats = config.testRunner.fileFormats
+
+	// verify if file test should run based on document saved
+	const shouldRunTest = (document: vscode.TextDocument): boolean => {
+		// must be a file
+		if (document.uri.scheme !== 'file') {
+			return false
+		}
+		// must configure with file formatss
+		if (fileFormats && fileFormats.length) {
+			const fileFormat: G.FileFormat = languageMap[document.languageId]
+			if (!fileFormats.includes(fileFormat)) {
+				return false
+			}
+		}
+		return true
+	}
+
 	// setup onSave hook
 	vscode.workspace.onDidSaveTextDocument((document: vscode.TextDocument) => {
-		const fileFormat: G.FileFormat = langaugeMap[document.languageId]
-		if (document.uri.scheme === 'file' && config.fileFormats.includes(fileFormat)) {
+		if (shouldRunTest(document)) {
 			vscode.commands.executeCommand('coderoad.run_test')
 		}
 	})

src/actions/tutorialConfig.ts

@@ -161,7 +161,6 @@ class ReactWebView {
 			}
 		}
 
-
 		// set CSP (content security policy) to grant permission to local files
 		const cspMeta: HTMLMetaElement = document.createElement('meta')
 		cspMeta.httpEquiv = 'Content-Security-Policy'

src/editor/ReactWebView.ts

@@ -1,10 +1,12 @@
+import * as G from 'typings/graphql'
 import * as vscode from 'vscode'
 import ReactWebView from './ReactWebView'
-import runTest from '../actions/runTest'
+import createTestRunner, {Payload} from '../services/testRunner'
 
-const COMMANDS = {
+export const COMMANDS = {
 	START: 'coderoad.start',
 	OPEN_WEBVIEW: 'coderoad.open_webview',
+	CONFIG_TEST_RUNNER: 'coderoad.config_test_runner',
 	RUN_TEST: 'coderoad.run_test',
 	SET_CURRENT_STEP: 'coderoad.set_current_step',
 }
@@ -19,6 +21,7 @@ export const createCommands = ({extensionPath, workspaceState, workspaceRoot}: C
 	// React panel webview
 	let webview: any
 	let currentStepId = ''
+	let testRunner: any
 
 	return {
 		// initialize
@@ -49,37 +52,37 @@ export const createCommands = ({extensionPath, workspaceState, workspaceRoot}: C
 			// setup 1x1 horizontal layout
 			webview.createOrShow()
 		},
-		[COMMANDS.SET_CURRENT_STEP]: ({stepId}: {stepId: string}) => {
-			// NOTE: as async, may sometimes be inaccurate
-			// set from last setup stepAction
-			currentStepId = stepId
-		},
-		[COMMANDS.RUN_TEST]: (current: {stepId: string} | undefined, onSuccess: () => void) => {
-			console.log('-------- command.run_test ------ ')
-			// use stepId from client, or last set stepId
-			const payload = {stepId: current ? current.stepId : currentStepId}
-			runTest({
-				onSuccess: () => {
+		[COMMANDS.CONFIG_TEST_RUNNER]: (config: G.TutorialTestRunner) => {
+			testRunner = createTestRunner(config, {
+				onSuccess: (payload: Payload) => {
 					// send test pass message back to client
-					webview.send({type: 'TEST_PASS', payload})
-					onSuccess()
 					vscode.window.showInformationMessage('PASS')
+					webview.send({type: 'TEST_PASS', payload})
 				},
-				onFail: () => {
+				onFail: (payload: Payload) => {
 					// send test fail message back to client
-					webview.send({type: 'TEST_FAIL', payload})
 					vscode.window.showWarningMessage('FAIL')
+					webview.send({type: 'TEST_FAIL', payload})
 				},
-				onError: () => {
-					console.log('COMMAND TEST_ERROR')
+				onError: (payload: Payload) => {
 					// send test error message back to client
 					webview.send({type: 'TEST_ERROR', payload})
 				},
-				onRun: () => {
+				onRun: (payload: Payload) => {
 					// send test run message back to client
 					webview.send({type: 'TEST_RUNNING', payload})
 				}
 			})
 		},
+		[COMMANDS.SET_CURRENT_STEP]: ({stepId}: Payload) => {
+			// NOTE: as async, may sometimes be inaccurate
+			// set from last setup stepAction
+			currentStepId = stepId
+		},
+		[COMMANDS.RUN_TEST]: (current: Payload | undefined, onSuccess: () => void) => {
+			// use stepId from client, or last set stepId
+			const payload: Payload = {stepId: current ? current.stepId : currentStepId}
+			testRunner(payload, onSuccess)
+		},
 	}
 }

src/editor/commands.ts

@@ -29,7 +29,6 @@ class Editor {
 	}
 
 	private activateCommands = (): void => {
-
 		// set workspace root for node executions
 		const workspaceRoots: vscode.WorkspaceFolder[] | undefined = vscode.workspace.workspaceFolders
 		if (!workspaceRoots || !workspaceRoots.length) {

src/editor/index.ts

@@ -0,0 +1,10 @@
+import * as vscode from 'vscode'
+
+let channel: vscode.OutputChannel
+
+export const getOutputChannel = (name: string): vscode.OutputChannel => {
+	if (!channel) {
+		channel = vscode.window.createOutputChannel(name)
+	}
+	return channel
+}