allow for separate coderoad directory

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

Author: ShMcK

src/actions/utils/runCommands.ts

@@ -13,7 +13,7 @@ const runCommands = async (commands: string[], send: (action: T.Action) => void)
     send({ type: 'COMMAND_START', payload: { process: { ...process, status: 'RUNNING' } } })
     let result: { stdout: string; stderr: string }
     try {
-      result = await exec(command)
+      result = await exec({ command })
     } catch (error) {
       console.log(`Test failed: ${error.message}`)
       send({ type: 'COMMAND_FAIL', payload: { process: { ...process, status: 'FAIL' } } })

src/editor/commands.ts

@@ -1,6 +1,7 @@
 import * as TT from 'typings/tutorial'
 import * as vscode from 'vscode'
 import createTestRunner, { Payload } from '../services/testRunner'
+import setupActions from 'actions/setupActions'
 import createWebView from '../webview'
 
 export const COMMANDS = {
@@ -47,7 +48,12 @@ export const createCommands = ({ extensionPath, workspaceState }: CreateCommandP
       // setup 1x1 horizontal layout
       webview.createOrShow()
     },
-    [COMMANDS.CONFIG_TEST_RUNNER]: (config: TT.TutorialTestRunner) => {
+    [COMMANDS.CONFIG_TEST_RUNNER]: (config: TT.TutorialTestRunnerConfig) => {
+      if (config.actions) {
+        // setup tutorial test runner commits
+        // assumes git already exists
+        setupActions(config.actions, webview.send)
+      }
       testRunner = createTestRunner(config, {
         onSuccess: (payload: Payload) => {
           // send test pass message back to client

src/services/dependencies/index.ts

@@ -5,7 +5,7 @@ const semverRegex = /(?<=^v?|\sv?)(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)
 
 export const version = async (name: string): Promise<string | null> => {
   try {
-    const { stdout, stderr } = await exec(`${name} --version`)
+    const { stdout, stderr } = await exec({ command: `${name} --version` })
     if (!stderr) {
       const match = stdout.match(semverRegex)
       if (match) {

src/services/git/index.ts

@@ -6,7 +6,7 @@ const gitOrigin = 'coderoad'
 
 const stashAllFiles = async (): Promise<never | void> => {
   // stash files including untracked (eg. newly created file)
-  const { stdout, stderr } = await exec(`git stash --include-untracked`)
+  const { stdout, stderr } = await exec({ command: `git stash --include-untracked` })
   if (stderr) {
     console.error(stderr)
     throw new Error('Error stashing files')
@@ -21,7 +21,7 @@ const cherryPickCommit = async (commit: string, count = 0): Promise<never | void
   try {
     // cherry-pick pulls commits from another branch
     // -X theirs merges and accepts incoming changes over existing changes
-    const { stdout } = await exec(`git cherry-pick -X theirs ${commit}`)
+    const { stdout } = await exec({ command: `git cherry-pick -X theirs ${commit}` })
     if (!stdout) {
       throw new Error('No cherry-pick output')
     }
@@ -47,7 +47,7 @@ export function loadCommit(commit: string): Promise<never | void> {
 */
 
 export async function saveCommit(message: string): Promise<never | void> {
-  const { stdout, stderr } = await exec(`git commit -am '${message}'`)
+  const { stdout, stderr } = await exec({ command: `git commit -am '${message}'` })
   if (stderr) {
     console.error(stderr)
     throw new Error('Error saving progress to Git')
@@ -58,7 +58,7 @@ export async function saveCommit(message: string): Promise<never | void> {
 export async function clear(): Promise<Error | void> {
   try {
     // commit progress to git
-    const { stderr } = await exec('git reset HEAD --hard && git clean -fd')
+    const { stderr } = await exec({ command: 'git reset HEAD --hard && git clean -fd' })
     if (!stderr) {
       return
     }
@@ -70,7 +70,7 @@ export async function clear(): Promise<Error | void> {
 }
 
 async function init(): Promise<Error | void> {
-  const { stderr } = await exec('git init')
+  const { stderr } = await exec({ command: 'git init' })
   if (stderr) {
     throw new Error('Error initializing Git')
   }
@@ -85,13 +85,13 @@ export async function initIfNotExists(): Promise<never | void> {
 
 export async function checkRemoteConnects(repo: TT.TutorialRepo): Promise<never | void> {
   // check for git repo
-  const externalRepoExists = await exec(`git ls-remote --exit-code --heads ${repo.uri}`)
+  const externalRepoExists = await exec({ command: `git ls-remote --exit-code --heads ${repo.uri}` })
   if (externalRepoExists.stderr) {
     // no repo found or no internet connection
     throw new Error(externalRepoExists.stderr)
   }
   // check for git repo branch
-  const { stderr, stdout } = await exec(`git ls-remote --exit-code --heads ${repo.uri} ${repo.branch}`)
+  const { stderr, stdout } = await exec({ command: `git ls-remote --exit-code --heads ${repo.uri} ${repo.branch}` })
   if (stderr) {
     throw new Error(stderr)
   }
@@ -101,7 +101,7 @@ export async function checkRemoteConnects(repo: TT.TutorialRepo): Promise<never
 }
 
 export async function addRemote(repo: string): Promise<never | void> {
-  const { stderr } = await exec(`git remote add ${gitOrigin} ${repo} && git fetch ${gitOrigin}`)
+  const { stderr } = await exec({ command: `git remote add ${gitOrigin} ${repo} && git fetch ${gitOrigin}` })
   if (stderr) {
     const alreadyExists = stderr.match(`${gitOrigin} already exists.`)
     const successfulNewBranch = stderr.match('new branch')
@@ -116,7 +116,7 @@ export async function addRemote(repo: string): Promise<never | void> {
 
 export async function checkRemoteExists(): Promise<boolean> {
   try {
-    const { stdout, stderr } = await exec('git remote -v')
+    const { stdout, stderr } = await exec({ command: 'git remote -v' })
     if (stderr) {
       return false
     }

src/services/node/index.ts

@@ -6,9 +6,14 @@ import { WORKSPACE_ROOT } from '../../environment'
 
 const asyncExec = promisify(cpExec)
 
-export const exec = (cmd: string): Promise<{ stdout: string; stderr: string }> | never => {
-  return asyncExec(cmd, {
-    cwd: WORKSPACE_ROOT,
+interface ExecParams {
+  command: string
+  path?: string
+}
+
+export const exec = (params: ExecParams): Promise<{ stdout: string; stderr: string }> | never => {
+  return asyncExec(params.command, {
+    cwd: join(WORKSPACE_ROOT, params.path || ''),
   })
 }
 

src/services/testRunner/index.ts

@@ -1,3 +1,4 @@
+import { TutorialTestRunnerConfig } from 'typings/tutorial'
 import { exec } from '../node'
 import logger from '../logger'
 import parser from './parser'
@@ -17,14 +18,10 @@ interface Callbacks {
   onError(payload: Payload): void
 }
 
-interface TestRunnerConfig {
-  command: string
-}
-
 const failChannelName = 'CodeRoad (Tests)'
 const logChannelName = 'CodeRoad (Logs)'
 
-const createTestRunner = (config: TestRunnerConfig, callbacks: Callbacks) => {
+const createTestRunner = (config: TutorialTestRunnerConfig, callbacks: Callbacks) => {
   return async (payload: Payload, onSuccess?: () => void): Promise<void> => {
     const startTime = throttle()
     // throttle time early
@@ -39,7 +36,7 @@ const createTestRunner = (config: TestRunnerConfig, callbacks: Callbacks) => {
 
     let result: { stdout: string | undefined; stderr: string | undefined }
     try {
-      result = await exec(config.command)
+      result = await exec({ command: config.command, path: config.path })
     } 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: TutorialTestRunner
+  testRunner: TutorialTestRunnerConfig
   repo: TutorialRepo
   dependencies?: TutorialDependency[]
 }
@@ -51,8 +51,10 @@ export type StepActions = {
   watchers: string[]
 }
 
-export interface TutorialTestRunner {
+export interface TutorialTestRunnerConfig {
   command: string
+  path?: string
+  actions?: StepActions
 }
 
 export interface TutorialRepo {