setup Test Runner

src/actions/runTest/channel.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
+}

src/actions/runTest/index.ts

@@ -1,153 +0,0 @@
-import * as vscode from 'vscode'
-import node from '../../services/node'
-
-// TODO: use tap parser to make it easier to support other test runners
-
-// ensure only latest run_test action is taken
-let currentId = 0
-
-// quick solution to prevent processing multiple results
-// NOTE: may be possible to kill child process early
-const shouldExitEarly = (processId: number): boolean => {
-	return currentId !== processId
-}
-
-let channel: vscode.OutputChannel
-
-const getOutputChannel = (name: string): vscode.OutputChannel => {
-	if (!channel) {
-		channel = vscode.window.createOutputChannel(name)
-	}
-	return channel
-}
-
-interface Callbacks {
-	onSuccess(): void
-	onFail(): void
-	onRun(): void
-	onError(): void
-}
-
-interface TestRunnerConfig {
-	command: string
-	parser(output: string): boolean
-}
-
-export const createTestRunner = (config: TestRunnerConfig, callbacks: Callbacks) => {
-
-	const outputChannelName = 'TEST_OUTPUT'
-
-	return {
-		run() {
-			console.log('------------------- run test ------------------')
-			const processId = ++currentId
-			callbacks.onRun()
-
-			try {
-				const {stdout} = await node.exec(config.command)
-			}
-		}
-	}
-}
-
-async function runTest({onSuccess, onFail, onRun, onError}: Callbacks): Promise<void> {
-
-
-
-
-	// TODO: verify test runner for args
-	// jest CLI docs https://jestjs.io/docs/en/cli
-	// const testArgs = [
-	// 	'--json',
-	// 	'--onlyChanged',
-	// 	'--env=node',
-	// 	'--maxConcurrency=4',
-	// 	'--maxWorkers=4'
-	// ]
-
-	const commandLine = `npm test -- ${testArgs.join(' ')}`
-
-	try {
-		// capture position early on test start
-		// in case position changes
-		const {stdout} = await node.exec(commandLine)
-		if (shouldExitEarly(processId)) {
-			// exit early
-			return
-		}
-
-		if (stdout) {
-			const lines = stdout.split(/\r{0,1}\n/)
-			for (const line of lines) {
-				if (line.length > 0) {
-					const regExp = /^{\"numFailedTestSuites/
-					const matches = regExp.exec(line)
-					if (matches && matches.length) {
-						const result = JSON.parse(line)
-
-						if (result.success) {
-							if (shouldExitEarly(processId)) {
-								// exit early
-								return
-							}
-							console.log('success!')
-							onSuccess()
-						} else {
-							console.log('NOT SUCCESS?')
-						}
-					}
-				}
-			}
-		}
-	} catch (err) {
-		if (shouldExitEarly(processId)) {
-			// exit early
-			return
-		}
-		// error contains output & error message
-		// output can be parsed as json
-		const {stdout, stderr} = err
-		console.log('TEST FAILED', stdout)
-
-		if (!stdout) {
-			console.error('SOMETHING WENT WRONG WITH A PASSING TEST')
-			onError()
-			return
-		}
-		// test runner failed
-		channel = getOutputChannel(outputChannelName)
-
-		if (stdout) {
-			const lines = stdout.split(/\r{0,1}\n/)
-
-			for (const line of lines) {
-				if (line.length > 0) {
-					const dataRegExp = /^{\"numFailedTestSuites"/
-					const matches = dataRegExp.exec(line)
-
-					if (matches && matches.length) {
-						const result = JSON.parse(line)
-						const firstError = result.testResults.find((t: any) => t.status === 'failed')
-
-						if (firstError) {
-							if (shouldExitEarly(processId)) {
-								// exit early
-								return
-							}
-							onFail()
-						} else {
-							console.error('NOTE: PARSER DID NOT WORK FOR ', line)
-						}
-					}
-				}
-			}
-		}
-
-		if (stderr) {
-			channel.show(false)
-			channel.appendLine(stderr)
-		}
-	}
-}
-
-export default runTest

src/actions/runTest/testRunner.ts

@@ -0,0 +1,69 @@
+import node from '../../services/node'
+import {getOutputChannel} from './channel'
+import {setLatestProcess, isLatestProcess} from './throttle'
+
+// TODO: use tap parser to make it easier to support other test runners
+// TODO: how to load test runner parser
+// TODO: where to instantiate test runner
+
+
+interface Callbacks {
+	onSuccess(): void
+	onFail(): void
+	onRun(): void
+	onError(): void
+}
+
+interface TestRunnerConfig {
+	command: string
+	parser(output: string): Error | null
+}
+
+export const createTestRunner = (config: TestRunnerConfig, callbacks: Callbacks) => {
+
+	const outputChannelName = 'TEST_OUTPUT'
+
+	return async () => {
+		console.log('------------------- run test ------------------')
+
+		// track processId to prevent multiple 
+		const processId = setLatestProcess()
+		if (!isLatestProcess(processId)) {return }
+
+		// flag as running
+		callbacks.onRun()
+
+		let result: {stdout: string | undefined, stderr: string | undefined}
+		try {
+			result = await node.exec(config.command)
+		} catch (err) {
+			result = err
+		}
+		const {stdout, stderr} = result
+
+		// simple way to throttle requests
+		if (!stdout || !isLatestProcess(processId)) {return }
+
+		if (stderr) {
+			callbacks.onError()
+
+			// open terminal with error string
+			const channel = getOutputChannel(outputChannelName)
+			channel.show(false)
+			channel.appendLine(stderr)
+			return
+		}
+
+		// pass or fail?
+		const testsFailed = config.parser(stdout)
+		if (testsFailed === null) {
+			callbacks.onSuccess()
+		} else {
+			// open terminal with failed test string
+			const channel = getOutputChannel(outputChannelName)
+			channel.show(false)
+			channel.appendLine(testsFailed.message)
+			callbacks.onFail()
+		}
+	}
+}

src/actions/runTest/throttle.ts

@@ -0,0 +1,8 @@
+// ensure only latest run_test action is taken
+let currentId = 0
+
+export const setLatestProcess = () => currentId++
+
+// quick solution to prevent processing multiple results
+// NOTE: may be possible to kill child process early
+export const isLatestProcess = (processId: number): boolean => currentId === processId