pass filter arg to test

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

Author: ShMcK

src/actions/tutorialConfig.ts

@@ -6,12 +6,12 @@ import * as git from '../services/git'
 import { DISABLE_RUN_ON_SAVE } from '../environment'
 
 interface TutorialConfigParams {
-  config: TT.TutorialConfig
+  data: TT.Tutorial
   alreadyConfigured?: boolean
   onComplete?(): void
 }
 
-const tutorialConfig = async ({ config, alreadyConfigured }: TutorialConfigParams): Promise<E.ErrorMessage | void> => {
+const tutorialConfig = async ({ data, alreadyConfigured }: TutorialConfigParams): Promise<E.ErrorMessage | void> => {
   if (!alreadyConfigured) {
     // setup git, add remote
     const initError: E.ErrorMessage | void = await git.initIfNotExists().catch(
@@ -27,7 +27,7 @@ const tutorialConfig = async ({ config, alreadyConfigured }: TutorialConfigParam
     }
 
     // verify that internet is connected, remote exists and branch exists
-    const remoteConnectError: E.ErrorMessage | void = await git.checkRemoteConnects(config.repo).catch(
+    const remoteConnectError: E.ErrorMessage | void = await git.checkRemoteConnects(data.config.repo).catch(
       (error: Error): E.ErrorMessage => ({
         type: 'FailedToConnectToGitRepo',
         message: error.message,
@@ -40,7 +40,7 @@ const tutorialConfig = async ({ config, alreadyConfigured }: TutorialConfigParam
     }
 
     // TODO if remote not already set
-    const coderoadRemoteError: E.ErrorMessage | void = await git.setupCodeRoadRemote(config.repo.uri).catch(
+    const coderoadRemoteError: E.ErrorMessage | void = await git.setupCodeRoadRemote(data.config.repo.uri).catch(
       (error: Error): E.ErrorMessage => ({
         type: 'GitRemoteAlreadyExists',
         message: error.message,
@@ -52,7 +52,7 @@ const tutorialConfig = async ({ config, alreadyConfigured }: TutorialConfigParam
     }
   }
 
-  await vscode.commands.executeCommand(COMMANDS.CONFIG_TEST_RUNNER, config.testRunner)
+  await vscode.commands.executeCommand(COMMANDS.CONFIG_TEST_RUNNER, data)
 
   if (!DISABLE_RUN_ON_SAVE) {
     // verify if file test should run based on document saved

src/channel/index.ts

@@ -204,7 +204,7 @@ class Channel implements Channel {
             }
           }
 
-          const error: E.ErrorMessage | void = await tutorialConfig({ config: data.config }).catch((error: Error) => ({
+          const error: E.ErrorMessage | void = await tutorialConfig({ data }).catch((error: Error) => ({
             type: 'UnknownError',
             message: `Location: tutorial config.\n\n${error.message}`,
           }))
@@ -231,9 +231,8 @@ class Channel implements Channel {
           if (!tutorialContinue) {
             throw new Error('Invalid tutorial to continue')
           }
-          const continueConfig: TT.TutorialConfig = tutorialContinue.config
           await tutorialConfig({
-            config: continueConfig,
+            data: tutorialContinue,
             alreadyConfigured: true,
           })
           // update the current stepId on startup

src/editor/commands.ts

@@ -50,14 +50,19 @@ export const createCommands = ({ extensionPath, workspaceState }: CreateCommandP
       // setup 1x1 horizontal layout
       webview.createOrShow()
     },
-    [COMMANDS.CONFIG_TEST_RUNNER]: async (config: TT.TestRunnerConfig) => {
-      const setup = config.setup || config.actions // TODO: deprecate and remove config.actions
+    [COMMANDS.CONFIG_TEST_RUNNER]: async (data: TT.Tutorial) => {
+      const testRunnerConfig = data.config.testRunner
+      const setup = testRunnerConfig.setup || testRunnerConfig.actions // TODO: deprecate and remove config.actions
       if (setup) {
         // setup tutorial test runner commits
         // assumes git already exists
-        await setupActions({ actions: setup, send: webview.send, dir: config.directory || config.path }) // TODO: deprecate and remove config.path
+        await setupActions({
+          actions: setup,
+          send: webview.send,
+          dir: testRunnerConfig.directory || testRunnerConfig.path,
+        }) // TODO: deprecate and remove config.path
       }
-      testRunner = createTestRunner(config, {
+      testRunner = createTestRunner(data, {
         onSuccess: (position: T.Position) => {
           logger('test pass position', position)
           // send test pass message back to client
@@ -89,7 +94,8 @@ export const createCommands = ({ extensionPath, workspaceState }: CreateCommandP
       //   ...current,
       //   stepId: current && current.position.stepId?.length ? current.position.stepId : currentPosition.stepId,
       // }
-      testRunner(currentPosition, callback?.onSuccess)
+      logger('currentPosition', currentPosition)
+      testRunner({ position: currentPosition, onSuccess: callback?.onSuccess })
     },
   }
 }

src/services/testRunner/index.ts

@@ -20,14 +20,13 @@ const logChannelName = 'CodeRoad (Logs)'
 
 interface TestRunnerParams {
   position: T.Position
-  filter?: string
   onSuccess?: () => void
 }
 
-const createTestRunner = (config: TT.TestRunnerConfig, callbacks: Callbacks) => {
-  const testRunnerFilterArg = config.args?.filter
-  return async ({ position, filter: testFilter, onSuccess }: TestRunnerParams): Promise<void> => {
-    logger('createTestRunner', position)
+const createTestRunner = (data: TT.Tutorial, callbacks: Callbacks) => {
+  const testRunnerConfig = data.config.testRunner
+  const testRunnerFilterArg = testRunnerConfig.args?.filter
+  return async ({ position, onSuccess }: TestRunnerParams): Promise<void> => {
     const startTime = throttle()
     // throttle time early
     if (!startTime) {
@@ -41,17 +40,29 @@ const createTestRunner = (config: TT.TestRunnerConfig, callbacks: Callbacks) =>
 
     let result: { stdout: string | undefined; stderr: string | undefined }
     try {
-      let command = config.args ? `${config.command} ${config?.args.tap}` : config.command // TODO: enforce TAP
+      let command = testRunnerConfig.args
+        ? `${testRunnerConfig.command} ${testRunnerConfig?.args.tap}`
+        : testRunnerConfig.command // TODO: enforce TAP
 
       // filter tests if requested
       if (testRunnerFilterArg) {
+        // get tutorial step from position
+        // check the step actions for specific command
+        // NOTE: cannot just pass in step actions as the test can be called by:
+        // - onEditorSave, onWatcher, onSolution, onRunTest, onSubTask
+        const levels = data.levels
+        const level = levels.find((l) => l.id === position.levelId)
+        const step = level?.steps.find((s) => s.id === position.stepId)
+        const testFilter = step?.setup?.filter
         if (testFilter) {
-          command += ` ${testRunnerFilterArg} ${testFilter}`
+          // append filter commands
+          command = [command, testRunnerFilterArg, testFilter].join(' ')
         } else {
           throw new Error('Test Runner filter not configured')
         }
       }
-      result = await exec({ command, dir: config.directory || config.path }) // TODO: remove config.path later
+      logger('COMMAND', command)
+      result = await exec({ command, dir: testRunnerConfig.directory || testRunnerConfig.path }) // TODO: remove config.path later
     } catch (err) {
       result = { stdout: err.stdout, stderr: err.stack }
     }