outline test runner config changes

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

Author: ShMcK

CHANGELOG.md

@@ -125,3 +125,28 @@ CODEROAD_TUTORIAL_URL='path/to/tutorial_config_file.json' // will load directly
 ## [0.6.1]
 
 - Replace checkboxes with icons
+
+## [0.7.0]
+
+- Change for the test runner config. Changes are backwards compatible.
+
+1. `testRunner.path`=> `testRunner.directory`
+2. `testRunner.actions` => `testRunner.setup`
+3. Change command to capture `args` for "TAP" support, and test "filter"ing support. These changes will help lead to specific test suite presets in the future.
+
+```json
+{
+  "testRunner": {
+    "command": "mocha",
+    "args": {
+      "filter": "--grep",
+      "tap": "--reporter=mocha-tap-reporter"
+    },
+    "directory": ".coderoad",
+    "setup": {
+      "commits": ["410bd4f"],
+      "commands": ["npm install"]
+    }
+  }
+}
+```

src/actions/setupActions.ts

@@ -10,10 +10,10 @@ import logger from '../services/logger'
 interface SetupActions {
   actions: TT.StepActions
   send: (action: T.Action) => void // send messages to client
-  path?: string
+  dir?: string
 }
 
-export const setupActions = async ({ actions, send, path }: SetupActions): Promise<void> => {
+export const setupActions = async ({ actions, send, dir }: SetupActions): Promise<void> => {
   if (!actions) {
     return
   }
@@ -45,7 +45,7 @@ export const setupActions = async ({ actions, send, path }: SetupActions): Promi
 
   // 4. run command
   if (!alreadyLoaded) {
-    await runCommands({ commands: commands || [], send, path }).catch(onError)
+    await runCommands({ commands: commands || [], send, dir }).catch(onError)
   }
 }
 

src/actions/utils/runCommands.ts

@@ -4,10 +4,10 @@ import { exec } from '../../services/node'
 interface RunCommands {
   commands: string[]
   send: (action: T.Action) => void
-  path?: string
+  dir?: string
 }
 
-const runCommands = async ({ commands, send, path }: RunCommands) => {
+const runCommands = async ({ commands, send, dir }: RunCommands) => {
   if (!commands.length) {
     return
   }
@@ -19,7 +19,7 @@ const runCommands = async ({ commands, send, path }: RunCommands) => {
     send({ type: 'COMMAND_START', payload: { process: { ...process, status: 'RUNNING' } } })
     let result: { stdout: string; stderr: string }
     try {
-      result = await exec({ command, path })
+      result = await exec({ command, dir })
       console.log(result)
     } catch (error) {
       console.log(`Test failed: ${error.message}`)

src/editor/commands.ts

@@ -50,11 +50,12 @@ export const createCommands = ({ extensionPath, workspaceState }: CreateCommandP
       // setup 1x1 horizontal layout
       webview.createOrShow()
     },
-    [COMMANDS.CONFIG_TEST_RUNNER]: async (config: TT.TutorialTestRunnerConfig) => {
-      if (config.actions) {
+    [COMMANDS.CONFIG_TEST_RUNNER]: async (config: TT.TestRunnerConfig) => {
+      const setup = config.setup || config.actions // TODO: depreacte and remove config.actions
+      if (setup) {
         // setup tutorial test runner commits
         // assumes git already exists
-        await setupActions({ actions: config.actions, send: webview.send, path: config.path })
+        await setupActions({ actions: setup, send: webview.send, dir: config.directory || config.path }) // TODO: deprecate and remove config.path
       }
       testRunner = createTestRunner(config, {
         onSuccess: (position: T.Position) => {

src/services/node/index.ts

@@ -8,11 +8,11 @@ const asyncExec = promisify(cpExec)
 
 interface ExecParams {
   command: string
-  path?: string
+  dir?: string
 }
 
 export const exec = (params: ExecParams): Promise<{ stdout: string; stderr: string }> | never => {
-  const cwd = join(WORKSPACE_ROOT, params.path || '')
+  const cwd = join(WORKSPACE_ROOT, params.dir || '')
   return asyncExec(params.command, { cwd })
 }
 

src/services/testRunner/index.ts

@@ -18,7 +18,7 @@ interface Callbacks {
 const failChannelName = 'CodeRoad (Tests)'
 const logChannelName = 'CodeRoad (Logs)'
 
-const createTestRunner = (config: TT.TutorialTestRunnerConfig, callbacks: Callbacks) => {
+const createTestRunner = (config: TT.TestRunnerConfig, callbacks: Callbacks) => {
   return async (position: T.Position, onSuccess?: () => void): Promise<void> => {
     logger('createTestRunner', position)
     const startTime = throttle()
@@ -34,7 +34,8 @@ const createTestRunner = (config: TT.TutorialTestRunnerConfig, callbacks: Callba
 
     let result: { stdout: string | undefined; stderr: string | undefined }
     try {
-      result = await exec({ command: config.command, path: config.path })
+      const command = config.args ? `${config.command} ${config?.args.tap}` : config.command // TODO: enforce TAP
+      result = await exec({ command, dir: config.directory || config.path }) // TODO: remove config.path later
     } catch (err) {
       result = { stdout: err.stdout, stderr: err.stack }
     }

typings/tutorial.d.ts

@@ -2,7 +2,7 @@ export type Maybe<T> = T | null
 
 export type TutorialConfig = {
   appVersions: TutorialAppVersions
-  testRunner: TutorialTestRunnerConfig
+  testRunner: TestRunnerConfig
   repo: TutorialRepo
   dependencies?: TutorialDependency[]
 }
@@ -52,10 +52,18 @@ export type StepActions = {
   subtasks?: string[]
 }
 
-export interface TutorialTestRunnerConfig {
+export interface TestRunnerArgs {
+  filter?: string
+  tap: string
+}
+
+export interface TestRunnerConfig {
   command: string
-  path?: string
-  actions?: StepActions
+  args?: TestRunnerArgs
+  path?: string // deprecated
+  directory?: string
+  actions?: StepActions // deprecated
+  setup?: StepActions
 }
 
 export interface TutorialRepo {