Fix var capturing regex (#955)

* simplify regex to capture '_var_' inside jinja brackets

* update regex to check for valid vars inside jinja inline brackets

* add lightspeed e2e tests for asserting correct syntax of variables returned in suggestion

* add test fixture

Author: priyamsahoo

src/features/utils/lightspeed.ts

@@ -39,7 +39,7 @@ export function convertToSnippetString(suggestion: string): string {
   // this regex matches the content inside {{  }} with decided vars, i.e., {{ _var_ }}
   // TODO: once a prefix is decided for using it in from of variable names, the regex
   // can be changed to match it
-  const regex = /(?:^|)[^@#\s_]*(_([^_]+)_)/gm;
+  const regex = /{{ (_[a-zA-Z_]\w*_) }}/gm;
 
   let counter = 0;
   const convertedSuggestion = suggestion.replace(regex, (item) => {

test/helper.ts

@@ -242,6 +242,7 @@ export async function testInlineSuggestion(
 
   // this is the position where we have placeholder for the task name in the test fixture
   // i.e., <insert task name for ansible lightspeed suggestion here>
+  // playbook used: lightspeed/playbook_1.yml
   const writePosition = new vscode.Position(4, 4);
 
   // replace the placeholder with valid task name for suggestions
@@ -422,3 +423,67 @@ export async function testInlineSuggestionCursorPositions(
     "getInlineSuggestionItems should not be called"
   );
 }
+
+export async function testValidJinjaBrackets(
+  prompt: string,
+  expectedValidJinjaInlineVar: string
+): Promise<void> {
+  let editor = vscode.window.activeTextEditor;
+
+  if (!editor) {
+    throw new Error("No active editor found");
+  }
+
+  // this is the position where we have placeholder for the task name in the test fixture
+  // i.e., <insert task name for ansible lightspeed suggestion here>
+  // playbook used: lightspeed/playbook_with_vars.yml
+  const writePosition = new vscode.Position(17, 4);
+
+  // replace the placeholder with valid task name for suggestions
+  await editor.edit(async (edit) => {
+    const replaceRange = new vscode.Range(
+      writePosition,
+      new vscode.Position(integer.MAX_VALUE, integer.MAX_VALUE)
+    );
+    edit.replace(replaceRange, `- name: ${prompt}\n`);
+  });
+
+  await vscode.commands.executeCommand("cursorMove", {
+    to: "nextBlankLine",
+  });
+
+  editor = vscode.window.activeTextEditor;
+  if (editor) {
+    const currentPosition = editor.selection.active;
+    const newLine = currentPosition.line + 1;
+    const newColumn = currentPosition.character + 4;
+
+    const newPosition = new vscode.Position(newLine, newColumn);
+
+    await editor.edit((editBuilder) => {
+      editBuilder.insert(newPosition, "    ");
+    });
+
+    editor.selection = new vscode.Selection(newPosition, newPosition);
+    editor.revealRange(new vscode.Range(newPosition, newPosition));
+  }
+  await vscode.commands.executeCommand(
+    LightSpeedCommands.LIGHTSPEED_SUGGESTION_TRIGGER
+  );
+  await sleep(LIGHTSPEED_INLINE_SUGGESTION_WAIT_TIME);
+  await vscode.commands.executeCommand(
+    LightSpeedCommands.LIGHTSPEED_SUGGESTION_COMMIT
+  );
+  await sleep(LIGHTSPEED_INLINE_SUGGESTION_AFTER_COMMIT_WAIT_TIME);
+
+  // get the committed suggestion
+  const suggestionRange = new vscode.Range(
+    new vscode.Position(writePosition.line + 1, writePosition.character),
+    new vscode.Position(integer.MAX_VALUE, integer.MAX_VALUE)
+  );
+
+  const docContentAfterSuggestion = doc.getText(suggestionRange).trim();
+
+  // assert
+  assert.include(docContentAfterSuggestion, expectedValidJinjaInlineVar);
+}

test/testFixtures/lightspeed/playbook_with_vars.yml

@@ -0,0 +1,18 @@
+- name: Deploy podman application
+  hosts: app_servers
+  become: true
+  vars:
+    foo_app:
+      env:
+        FOO_TEAM_SETTINGS_SITE_NAME: FOO NAME
+      name: foo-preview
+      image: docker.io/foo/foo-preview
+      state: started
+      generate_systemd:
+        path: /etc/systemd/system/
+        container_prefix: app
+        restart_policy: always
+      ports:
+        - 8065:8065
+  tasks:
+    - <insert task name for project ansible lightspeed suggestion here>

test/testScripts/lightspeed/testLightspeed.test.ts

@@ -8,6 +8,7 @@ import {
   canRunLightspeedTests,
   testInlineSuggestionNotTriggered,
   testInlineSuggestionCursorPositions,
+  testValidJinjaBrackets,
 } from "../../helper";
 
 function testSuggestionPrompts() {
@@ -51,6 +52,17 @@ function testInvalidCursorPosition() {
   return tests;
 }
 
+function testSuggestionWithValidJinjaBrackets() {
+  const tests = [
+    {
+      taskName: "Run container with podman using foo_app var",
+      expectedValidJinjaInlineVar: "{{ foo_app.image }}",
+    },
+  ];
+
+  return tests;
+}
+
 export function testLightspeed(): void {
   describe("TEST ANSIBLE LIGHTSPEED", function () {
     before(async function () {
@@ -108,9 +120,30 @@ export function testLightspeed(): void {
           );
         });
       });
-      after(async function () {
-        disableLightspeedSettings();
+    });
+
+    describe("Test Ansible Lightspeed inline completion suggestions", function () {
+      const docUri1 = getDocUri("lightspeed/playbook_with_vars.yml");
+
+      before(async function () {
+        await vscode.commands.executeCommand(
+          "workbench.action.closeAllEditors"
+        );
+        await activate(docUri1);
       });
+
+      const tests = testSuggestionWithValidJinjaBrackets();
+
+      tests.forEach(({ taskName, expectedValidJinjaInlineVar }) => {
+        it(`Should provide suggestion with valid jinja brackets for task prompt '${taskName}'`, async function () {
+          // await testInlineSuggestion(taskName, expectedValidJinjaInlineVar);
+          await testValidJinjaBrackets(taskName, expectedValidJinjaInlineVar);
+        });
+      });
+    });
+
+    after(async function () {
+      disableLightspeedSettings();
     });
   });
 }