Converted test recorder for bulk recordings (#169)

* Converted test recorded for bulk recordings

* File name in camel case

* Added spoken form to test suit

* Added test recordings for actions

* Innumerate test cases with same name

* Remove breakpoint test

* Added exception

Author: AndreasArvidsson

src/TestCaseRecorder.ts

@@ -6,8 +6,6 @@ import { walkDirsSync } from "./test/suite/walkSync";
 
 export class TestCaseRecorder {
   active: boolean = false;
-  outPath: string | null = null;
-  spokenForm: string | null = null;
   workspacePath: string | null;
   workSpaceFolder: string | null;
   fixtureRoot: string | null;
@@ -28,23 +26,19 @@ export class TestCaseRecorder {
       : null;
   }
 
-  start(): Promise<void> {
-    this.active = true;
-    return this.promptSpokenForm();
+  async start(): Promise<boolean> {
+    this.active = await this.promptSubdirectory();
+    return this.active;
   }
 
-  async finish(testCase: TestCase): Promise<string | null> {
+  stop() {
     this.active = false;
-    const outPath = await this.promptSubdirectory();
-    const fixture = testCase.toYaml();
-
-    if (outPath) {
-      this.writeToFile(outPath, fixture);
-    } else {
-      this.showFixture(fixture);
-    }
+  }
 
-    return outPath;
+  async finish(testCase: TestCase): Promise<void> {
+    const outPath = this.calculateFilePath(testCase);
+    const fixture = testCase.toYaml();
+    await this.writeToFile(outPath, fixture);
   }
 
   private async writeToFile(outPath: string, fixture: string) {
@@ -59,39 +53,13 @@ export class TestCaseRecorder {
       });
   }
 
-  private async showFixture(fixture: string) {
-    const document = await vscode.workspace.openTextDocument({
-      language: "yaml",
-      content: fixture,
-    });
-    await vscode.window.showTextDocument(document, {
-      viewColumn: vscode.ViewColumn.Beside,
-    });
-  }
-
-  private async promptSpokenForm(): Promise<void> {
-    const result = await vscode.window.showInputBox({
-      prompt: "Talon Command",
-      ignoreFocusOut: true,
-      validateInput: (input) => (input.trim().length > 0 ? null : "Required"),
-    });
-
-    // Inputs return undefined when a user cancels by hitting 'escape'
-    if (result === undefined) {
-      this.active = false;
-      return;
-    }
-
-    this.spokenForm = result;
-  }
-
-  private async promptSubdirectory(): Promise<string | null> {
+  private async promptSubdirectory(): Promise<boolean> {
     if (
       this.workspacePath == null ||
       this.fixtureRoot == null ||
       this.workSpaceFolder !== "cursorless-vscode"
     ) {
-      return null;
+      throw new Error("Can't prompt for subdirectory");
     }
 
     const subdirectories = walkDirsSync(this.fixtureRoot).concat("/");
@@ -103,16 +71,16 @@ export class TestCaseRecorder {
     ]);
 
     if (subdirectorySelection === undefined) {
-      return null;
+      return false;
     } else if (subdirectorySelection === createNewSubdirectory) {
       return this.promptNewSubdirectory();
     } else {
       this.fixtureSubdirectory = subdirectorySelection;
-      return this.promptFileName();
+      return true;
     }
   }
 
-  private async promptNewSubdirectory(): Promise<string | null> {
+  private async promptNewSubdirectory(): Promise<boolean> {
     if (this.fixtureRoot == null) {
       throw new Error("Missing fixture root. Not in cursorless workspace?");
     }
@@ -128,32 +96,43 @@ export class TestCaseRecorder {
     }
 
     this.fixtureSubdirectory = subdirectory;
-    return this.promptFileName();
+    return true;
   }
 
-  private async promptFileName(): Promise<string | null> {
+  private calculateFilePath(testCase: TestCase): string {
     if (this.fixtureRoot == null) {
       throw new Error("Missing fixture root. Not in cursorless workspace?");
     }
 
-    const filename = await vscode.window.showInputBox({
-      prompt: "Fixture Filename",
-    });
-
-    if (filename === undefined || this.fixtureSubdirectory == null) {
-      return this.promptSubdirectory(); // go back a prompt
-    }
-
     const targetDirectory = path.join(
       this.fixtureRoot,
-      this.fixtureSubdirectory
+      this.fixtureSubdirectory!
     );
 
     if (!fs.existsSync(targetDirectory)) {
       fs.mkdirSync(targetDirectory);
     }
 
-    this.outPath = path.join(targetDirectory, `${filename}.yml`);
-    return this.outPath;
+    let filename = camelize(testCase.spokenForm);
+    let filePath = path.join(targetDirectory, `${filename}.yml`);
+
+    let i = 2;
+    while (fs.existsSync(filePath)) {
+      filename += i++;
+      filePath = path.join(targetDirectory, `${filename}.yml`);
+    }
+
+    return filePath;
   }
 }
+
+function camelize(str: string) {
+  return str
+    .split(" ")
+    .map((str, index) => (index === 0 ? str : capitalize(str)))
+    .join("");
+}
+
+function capitalize(str: string) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}

src/extension.ts

@@ -79,21 +79,33 @@ export async function activate(context: vscode.ExtensionContext) {
   const graph = makeGraph(graphConstructors);
   const thatMark = new ThatMark();
   const testCaseRecorder = new TestCaseRecorder(context);
+
   const cursorlessRecordTestCaseDisposable = vscode.commands.registerCommand(
     "cursorless.recordTestCase",
     async () => {
-      console.log("Recording test case for next command");
-      testCaseRecorder.start();
+      if (testCaseRecorder.active) {
+        vscode.window.showInformationMessage("Stopped recording test cases");
+        testCaseRecorder.stop();
+      } else {
+        if (await testCaseRecorder.start()) {
+          vscode.window.showInformationMessage(
+            "Recording test cases for following commands"
+          );
+        }
+      }
     }
   );
+
   const cursorlessCommandDisposable = vscode.commands.registerCommand(
     "cursorless.command",
     async (
+      spokenForm: string,
       actionName: ActionType,
       partialTargets: PartialTarget[],
       ...extraArgs: any[]
     ) => {
       try {
+        console.debug(`spokenForm: ${spokenForm}`);
         console.debug(`action: ${actionName}`);
         console.debug(`partialTargets:`);
         console.debug(JSON.stringify(partialTargets, null, 3));
@@ -109,14 +121,9 @@ export async function activate(context: vscode.ExtensionContext) {
 
         const isPaste = actionName === "paste";
 
-        var clipboardContents: string | undefined;
-
-        if (isPaste) {
-          clipboardContents = await Clipboard.readText();
-          // clipboardContents = "hello";
-          // clipboardContents = "hello\n";
-          // clipboardContents = "\nhello\n";
-        }
+        const clipboardContents = isPaste
+          ? await Clipboard.readText()
+          : undefined;
 
         const inferenceContext = {
           selectionContents,
@@ -151,7 +158,7 @@ export async function activate(context: vscode.ExtensionContext) {
             targets,
             thatMark: thatMark,
             navigationMap: graph.navigationMap!,
-            spokenForm: testCaseRecorder.spokenForm ?? "",
+            spokenForm,
           };
           testCase = new TestCase(command, context);
           await testCase.recordInitialState();

src/test/suite/fixtures/recorded/actions/bringMade.yml

@@ -0,0 +1,33 @@
+spokenForm: bring made
+languageId: typescript
+command:
+  actionName: bring
+  partialTargets:
+    - type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: m}
+    - type: primitive
+      mark: {type: cursor}
+      selectionType: token
+      position: contents
+      modifier: {type: identity}
+      insideOutsideType: inside
+  extraArgs: []
+marks:
+  default.m:
+    start: {line: 0, character: 6}
+    end: {line: 0, character: 21}
+initialState:
+  documentContents: "const myVariableValue = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+finalState:
+  documentContents: "const myVariableValue = \"hello\";\r\nmyVariableValue"
+  selections:
+    - anchor: {line: 1, character: 15}
+      active: {line: 1, character: 15}
+  thatMark:
+    - anchor: {line: 1, character: 15}
+      active: {line: 1, character: 0}
+returnValue: null
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: null}, {type: primitive, mark: {type: cursor}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: inside}]

src/test/suite/fixtures/recorded/actions/bringMadeToCap.yml

@@ -0,0 +1,32 @@
+spokenForm: bring made to cap
+languageId: typescript
+command:
+  actionName: bring
+  partialTargets:
+    - type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: m}
+    - type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: c}
+  extraArgs: []
+marks:
+  default.m:
+    start: {line: 0, character: 6}
+    end: {line: 0, character: 21}
+  default.c:
+    start: {line: 0, character: 0}
+    end: {line: 0, character: 5}
+initialState:
+  documentContents: "const myVariableValue = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+finalState:
+  documentContents: "myVariableValue myVariableValue = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  thatMark:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 15}
+returnValue: null
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: null}, {type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: c}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: null}]

src/test/suite/fixtures/recorded/actions/carveMade.yml

@@ -0,0 +1,27 @@
+spokenForm: carve made
+languageId: typescript
+command:
+  actionName: cut
+  partialTargets:
+    - type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: m}
+  extraArgs: []
+marks:
+  default.m:
+    start: {line: 0, character: 6}
+    end: {line: 0, character: 21}
+initialState:
+  documentContents: "const myVariableValue = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+finalState:
+  documentContents: "const = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  thatMark:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+returnValue: null
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: null}]

src/test/suite/fixtures/recorded/actions/chuckMade.yml

@@ -0,0 +1,27 @@
+spokenForm: chuck made
+languageId: typescript
+command:
+  actionName: delete
+  partialTargets:
+    - type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: m}
+  extraArgs: []
+marks:
+  default.m:
+    start: {line: 0, character: 6}
+    end: {line: 0, character: 21}
+initialState:
+  documentContents: "const myVariableValue = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+finalState:
+  documentContents: "const = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  thatMark:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+returnValue: null
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: outside}]

src/test/suite/fixtures/recorded/actions/clearMade.yml

@@ -0,0 +1,27 @@
+spokenForm: clear made
+languageId: typescript
+command:
+  actionName: clear
+  partialTargets:
+    - type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: m}
+  extraArgs: []
+marks:
+  default.m:
+    start: {line: 0, character: 6}
+    end: {line: 0, character: 21}
+initialState:
+  documentContents: "const myVariableValue = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+finalState:
+  documentContents: "const  = \"hello\";\r\n"
+  selections:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+  thatMark:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+returnValue: null
+fullTargets: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: m}, selectionType: token, position: contents, modifier: {type: identity}, insideOutsideType: inside}]