breaking - changes to testRunner.setup

Signed-off-by: shmck <[email protected]>
coderoad · ShMcK · Aug 6, 2020 · Aug 2, 2020 · Aug 3, 2020 · Aug 3, 2020
commit 7da0e08f2bfbb2e6f9b17e46bdbc1374b1050607
diff --git a/src/schema/skeleton.ts b/src/schema/skeleton.ts
@@ -52,14 +52,14 @@ export default {
               description: "An optional folder for the test runner",
               examples: ["coderoad"],
             },
-            setup: {
-              $ref: "#/definitions/setup_action_without_commits",
-              description:
-                "Setup actions or commands used for setting up the test runner on tutorial launch",
-            },
           },
           required: ["command", "args"],
         },
+        setup: {
+          $ref: "#/definitions/setup_action_without_commits",
+          description:
+            "Setup actions or commands used for setting up the test runner on tutorial launch",
+        },
         repo: {
           type: "object",
           description: "The repo holding the git commits for the tutorial",

diff --git a/src/schema/tutorial.ts b/src/schema/tutorial.ts
@@ -71,14 +71,14 @@ export default {
               description: "An optional folder for the test runner",
               examples: ["coderoad"],
             },
-            setup: {
-              $ref: "#/definitions/setup_action",
-              description:
-                "Setup commits or commands used for setting up the test runner on tutorial launch",
-            },
           },
           required: ["command", "args"],
         },
+        setup: {
+          $ref: "#/definitions/setup_action",
+          description:
+            "Setup commits or commands used for setting up the test runner on tutorial launch",
+        },
         repo: {
           type: "object",
           description: "The repo holding the git commits for the tutorial",

diff --git a/src/utils/parse.ts b/src/utils/parse.ts
@@ -153,8 +153,8 @@ export function parse(params: ParseParams): any {
   // add init commits
   if (params.commits.INIT && params.commits.INIT.length) {
     // @ts-ignore
-    parsed.config.testRunner.setup = {
-      ...(parsed.config?.testRunner?.setup || {}),
+    parsed.config.setup = {
+      ...(parsed.config?.setup || {}),
       commits: params.commits.INIT,
     };
   }

diff --git a/src/validate.ts b/src/validate.ts
@@ -74,14 +74,10 @@ async function validate(args: string[]) {
       await cherryPick(commits.INIT);
 
       // run commands
-      if (skeleton.config?.testRunner?.setup?.commands) {
+      if (skeleton.config?.setup?.commands) {
         console.info("-- Running commands...");
 
-        await runCommands(
-          skeleton.config?.testRunner?.setup?.commands,
-          // add optional setup directory
-          skeleton.config?.testRunner?.directory
-        );
+        await runCommands(skeleton.config?.setup?.commands);
       }
     }
 

diff --git a/tests/parse.test.ts b/tests/parse.test.ts
@@ -987,9 +987,9 @@ Description.
               tap: "--reporter=mocha-tap-reporter",
             },
             directory: "coderoad",
-            setup: {
-              commands: [],
-            },
+          },
+          setup: {
+            commands: [],
           },
           appVersions: {
             vscode: ">=0.7.0",
@@ -1026,9 +1026,9 @@ Description.
               tap: "--reporter=mocha-tap-reporter",
             },
             directory: "coderoad",
-            setup: {
-              commands: [],
-            },
+          },
+          setup: {
+            commands: [],
           },
           repo: {
             uri: "https://path.to/repo",
@@ -1101,9 +1101,9 @@ Description.
               tap: "--reporter=mocha-tap-reporter",
             },
             directory: "coderoad",
-            setup: {
-              commits: ["abcdef1", "123456789"],
-            },
+          },
+          setup: {
+            commits: ["abcdef1", "123456789"],
           },
           repo: {
             uri: "https://path.to/repo",

diff --git a/tests/skeleton.test.ts b/tests/skeleton.test.ts
@@ -8,15 +8,16 @@ const validJson = {
   config: {
     testRunner: {
       directory: "coderoad",
-      setup: {
-        commands: [],
-      },
+
       args: {
         filter: "--grep",
         tap: "--reporter=mocha-tap-reporter",
       },
       command: "./node_modules/.bin/mocha",
     },
+    setup: {
+      commands: [],
+    },
     repo: {
       uri: "http://github.com/somePath/toRepo.git",
       branch: "codeBranch",

diff --git a/tests/tutorial.test.ts b/tests/tutorial.test.ts
@@ -13,10 +13,10 @@ const validJson: Partial<T.Tutorial> = {
         tap: "tap",
       },
       directory: "coderoad",
-      setup: {
-        commits: ["abcdef1"],
-        commands: ["npm install"],
-      },
+    },
+    setup: {
+      commits: ["abcdef1"],
+      commands: ["npm install"],
     },
     repo: {
       uri: "https://github.com/some-repo.git",

diff --git a/typings/tutorial.d.ts b/typings/tutorial.d.ts
@@ -10,6 +10,7 @@ export type TutorialConfig = {
   repo: TutorialRepo;
   dependencies?: TutorialDependency[];
   reset?: ConfigReset;
+  setup?: StepActions;
 };
 
 /** Logical groupings of tasks */
@@ -69,7 +70,6 @@ export interface TestRunnerConfig {
   command: string;
   args: TestRunnerArgs;
   directory?: string;
-  setup?: StepActions;
 }
 
 export interface TutorialRepo {