@dev-blinq/cucumber_client 1.0.1421-dev → 1.0.1421-stage

package/bin/client/code_gen/playwright_codeget.js

@@ -5,6 +5,8 @@ import path from "path";
 import { CodePage } from "./page_reflection.js";
 import { convertToIdentifier, escapeNonPrintables } from "./utils.js";
 import socketLogger from "../utils/socket_logger.js";
+import fs from "fs";
+
 const findElementIdentifier = (node, step, userData, elements) => {
   if (node.key) {
     // incase of rerunning implemented steps
@@ -105,6 +107,11 @@ const _generateCodeFromCommand = (step, elements, userData) => {
   // handle element
   let element_name = null;
   let allStrategyLocators = null;
+  const codeLines = [];
+
+  if (_isCodeGenerationStep(step) === false)
+    return { codeLines, elements: elementsChanged ? elements : null, elementIdentifier, allStrategyLocators };
+
   if (_isCodeGenerationStep(step) && step.type !== Types.VERIFY_PAGE_SNAPSHOT) {
     allStrategyLocators = step.allStrategyLocators ?? splitToLocatorsGroups(step.locators);
     let node = null;
@@ -167,8 +174,6 @@ const _generateCodeFromCommand = (step, elements, userData) => {
     }
   }
 
-  const codeLines = [];
-
   let line = null;
   let comment = null;
   let input = null;
@@ -363,7 +368,7 @@ const _generateCodeFromCommand = (step, elements, userData) => {
       codeLines.push(line);
       break;
     }
-    case Types.VERIFY_PAGE_SNAPSHOT:
+    case Types.VERIFY_PAGE_SNAPSHOT: {
       comment = step.nestFrmLoc
         ? `// Verify page snapshot ${step.parameters[0]} in the frame ${step.selectors.iframe_src}`
         : `// Verify page snapshot ${step.parameters[0]}`;
@@ -372,7 +377,24 @@ const _generateCodeFromCommand = (step, elements, userData) => {
       codeLines.push(line);
       line = `await context.web.snapshotValidation(frameLocator, _param_0 , _params, ${JSON.stringify(options)}, this);`;
       codeLines.push(line);
+
+      const data = step.data;
+      if (data) {
+        try {
+          const { snapshot, fileName, filePath } = data;
+          const folderPath = process.env.BVT_TEMP_SNAPSHOTS_FOLDER ?? filePath;
+          const filePathWithName = path.join(folderPath, fileName);
+          if (!fs.existsSync(folderPath)) {
+            fs.mkdirSync(folderPath, { recursive: true });
+          }
+          fs.writeFileSync(filePathWithName, snapshot, "utf-8");
+        } catch (e) {
+          console.log(`Error saving snapshot file: ${e}`);
+          throw e;
+        }
+      }
       break;
+    }
     case Types.VERIFY_PAGE_CONTAINS_TEXT:
       line = "await context.web.verifyTextExistInPage( ";
       input = `${escapeNonPrintables(JSON.stringify(step.parameters[0]))}`;

package/bin/client/cucumber/feature_data.js

@@ -41,10 +41,10 @@ const generateTestData = (featureFile) => {
       try {
         const fake = faker.helpers.fake(match[0]);
 
-        if(fake === match[0]){ 
+        if (fake === match[0]) {
           continue;
         }
-        
+
         otherFakeData.push({
           var: match[0],
           fake,

package/bin/client/cucumber/project_to_document.js

@@ -4,7 +4,13 @@ import { AstBuilder, GherkinClassicTokenMatcher, Parser } from "@cucumber/gherki
 import { Feature } from "./feature.js";
 import { StepsDefinitions } from "./steps_definitions.js";
 
-export const projectDocument = (folder, featureName = null, scenarioName = null, supressErrors = false, errors = []) => {
+export const projectDocument = (
+  folder,
+  featureName = null,
+  scenarioName = null,
+  supressErrors = false,
+  errors = []
+) => {
   const uuidFn = () => (23212).toString(16);
   const builder = new AstBuilder(uuidFn);
   const matcher = new GherkinClassicTokenMatcher();
@@ -59,4 +65,4 @@ export const projectDocument = (folder, featureName = null, scenarioName = null,
 // const documents = projectDocument(projectDir, featureName, scenarioName, true, errors);
 // const args = process.argv.slice(2);
 
-// console.log(JSON.stringify(documents));
+// console.log(JSON.stringify(documents));

package/bin/client/cucumber/steps_definitions.js

@@ -36,6 +36,19 @@ class StepsDefinitions {
     //   }
     // });
     const { expressions, methods } = codePage;
+
+    if (codePage.fileContent.includes('from "./utils.mjs"')) {
+      const filePath = path.join(
+        this.baseFolder,
+        this.isTemp ? (process.env.tempFeaturesFolderPath ?? "__temp_features") : "features",
+        "step_definitions",
+        "utils.mjs"
+      );
+      const utilsCodePage = new CodePage(filePath);
+      utilsCodePage.generateModel();
+      methods.push(...utilsCodePage.methods);
+    }
+
     for (let i = 0; i < expressions.length; i++) {
       const expression = expressions[i];
       const pattern = expression.pattern;
@@ -45,7 +58,10 @@ class StepsDefinitions {
       if (method && expression.keyword && pattern && expression.methodName) {
         this.steps[pattern] = {
           // file: path.join(this.isTemp ? "__temp_features" : "features", mjsFile),
-          file: path.join(this.isTemp ? process.env.tempFeaturesFolderPath ?? "__temp_features" : "features", mjsFile),
+          file: path.join(
+            this.isTemp ? (process.env.tempFeaturesFolderPath ?? "__temp_features") : "features",
+            mjsFile
+          ),
           functionName: expression.methodName,
           name: pattern,
           source: this.findKey(method.codePart, "source"),
@@ -56,7 +72,7 @@ class StepsDefinitions {
   }
   load(print = true, supressErrors = false, errors = []) {
     const mjsFiles = findFilesWithExtension(
-      path.join(this.baseFolder, this.isTemp ? process.env.tempFeaturesFolderPath ?? "__temp_features" : "features"),
+      path.join(this.baseFolder, this.isTemp ? (process.env.tempFeaturesFolderPath ?? "__temp_features") : "features"),
       "mjs"
     );
     // console.log({ mjsFiles });
@@ -64,7 +80,7 @@ class StepsDefinitions {
       const mjsFile = mjsFiles[i];
       const filePath = path.join(
         this.baseFolder,
-        this.isTemp ? process.env.tempFeaturesFolderPath ?? "__temp_features" : "features",
+        this.isTemp ? (process.env.tempFeaturesFolderPath ?? "__temp_features") : "features",
         mjsFile
       );
       const codePage = new CodePage(filePath);

package/bin/client/cucumber_selector.js

@@ -117,6 +117,10 @@ if (deleteMjsFiles) {
 const utilsPath = path.join(__dirname, "../assets/templates/utils_template.txt");
 const utilsContent = fs.readFileSync(utilsPath, "utf8");
 const utilsFileName = stepsPath + "/utils.mjs";
+// if stepsPath directory doesn't exist create it
+if (!fs.existsSync(stepsPath)) {
+  fs.mkdirSync(stepsPath, { recursive: true });
+}
 fs.writeFileSync(utilsFileName, utilsContent, "utf8");
 // copy hooks file to the steps directory
 const hooksTemplateFilePath = path.join(__dirname, "../assets/templates/_hooks_template.txt");

package/bin/client/local_agent.js

@@ -696,6 +696,7 @@ class LocalAgent {
               stepDiff: stepResult,
             });
             page.removeUnusedElements();
+            page.mergeSimilarElements();
             agent.scenarioReport.updateLastStep({
               code: {
                 cleanFileNames: page.cleanFileNames,
@@ -809,12 +810,12 @@ class LocalAgent {
           } catch (err) {
             logger.error("Error reading memory file: " + err.message);
           }
-          const screenshot = await agent.getScreenshot(agent.context);
+          //const screenshot = await agent.getScreenshot(agent.context);
           // check if the popup is open
           const popupResult = await agent.context.web.closeUnexpectedPopups(null, null);
           if (nodes) {
             nodes.memory = memory;
-            nodes.screenshot = screenshot;
+            //nodes.screenshot = screenshot;
             if (popupResult.rerun === true) {
               nodes.rerun = true;
             }

package/bin/client/parse_feature_file.js

@@ -1,37 +1,34 @@
-import {
-  AstBuilder,
-  GherkinClassicTokenMatcher,
-  Parser,
-} from '@cucumber/gherkin'
-import { readFileSync, writeFileSync } from 'fs'
-import { loadArgs, showUsage, validateCLIArg } from './cli_helpers.js'
-let id =0;
-const uuidFn = () => (++id).toString(16) 
-const builder = new AstBuilder(uuidFn)
-const matcher = new GherkinClassicTokenMatcher()
+import { AstBuilder, GherkinClassicTokenMatcher, Parser } from "@cucumber/gherkin";
+import { readFileSync, writeFileSync } from "fs";
+import { loadArgs, showUsage, validateCLIArg } from "./cli_helpers.js";
+let id = 0;
+const uuidFn = () => (++id).toString(16);
+const builder = new AstBuilder(uuidFn);
+const matcher = new GherkinClassicTokenMatcher();
 
-const parser = new Parser(builder, matcher)
+const parser = new Parser(builder, matcher);
 
 const parseFeatureFile = (featureFilePath) => {
-  const source = readFileSync(featureFilePath, 'utf8')
-  const gherkinDocument = parser.parse(source)
-  return gherkinDocument
-}
+  const source = readFileSync(featureFilePath, "utf8");
+  const gherkinDocument = parser.parse(source);
+  return gherkinDocument;
+};
 
-const args = loadArgs()
-const featureFilePath = args[0]
-const outputFilePath = args[1]
-const usage = 'Usage: node parse_feature_file.js <featureFilePath> [<outputFilePath>] \n\nExample: node parseFeatureFile.js ./features/my.feature ./features/my.feature.json\n\n'
+const args = loadArgs();
+const featureFilePath = args[0];
+const outputFilePath = args[1];
+const usage =
+  "Usage: node parse_feature_file.js <featureFilePath> [<outputFilePath>] \n\nExample: node parseFeatureFile.js ./features/my.feature ./features/my.feature.json\n\n";
 try {
-  validateCLIArg(featureFilePath, 'featureFilePath')
+  validateCLIArg(featureFilePath, "featureFilePath");
 } catch (error) {
-  showUsage(error, usage)
+  showUsage(error, usage);
 }
-const gherkinDocument = parseFeatureFile(featureFilePath)
+const gherkinDocument = parseFeatureFile(featureFilePath);
 if (outputFilePath) {
-  writeFileSync(outputFilePath, JSON.stringify(gherkinDocument, null, 2))
+  writeFileSync(outputFilePath, JSON.stringify(gherkinDocument, null, 2));
 } else {
-  console.log(JSON.stringify(gherkinDocument, null, 2))
+  console.log(JSON.stringify(gherkinDocument, null, 2));
 }
 
-export { parseFeatureFile }
+export { parseFeatureFile };

package/bin/client/playground/projects/env.json

@@ -1,3 +1,3 @@
 {
-    "baseUrl": "https://google.com"
-}
+  "baseUrl": "https://google.com"
+}

package/bin/client/project.js

@@ -1,220 +1,204 @@
+// project.ts
 import { writeFileSync, readFileSync, readdirSync, existsSync, mkdirSync } from "fs";
-import { CodePage } from "./code_gen/page_reflection.js";
-
-import logger from "../logger.js";
 import path from "path";
 import { fileURLToPath } from "url";
+// Keep the .js extensions because the compiled runtime modules are ESM .js files.
+import { CodePage } from "./code_gen/page_reflection.js";
+import logger from "../logger.js";
 import { findFilesWithExtension } from "./cucumber/steps_definitions.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-
-class Project {
-  environment = null;
-  pages = [];
-  constructor(rootFolder) {
-    this.rootFolder = rootFolder;
-    this.stepsFolder = path.join(rootFolder, "features", "step_definitions");
-  }
-
-  async load() {
-    this.pages = [];
-    // load env.json from the project root folder
-    let envFile = "";
-    const envArgVal = checkForEnvArg();
-    if (envArgVal) {
-      envFile = envArgVal;
-    } else if (process.env["BLINQ_ENV"]) {
-      envFile = process.env["BLINQ_ENV"];
-    } else if (existsSync(path.join(this.rootFolder, "env.json"))) {
-      envFile = path.join(this.rootFolder, "env.json");
-    } else {
-      //list all the files in the environments directory use the first json file
-      let files = readdirSync(path.join(this.rootFolder, "environments"));
-      for (let i = 0; i < files.length; i++) {
-        let file = files[i];
-        if (file.endsWith(".json")) {
-          envFile = path.join(this.rootFolder, "environments", file);
-          break;
-        }
-      }
-    }
-    // const envFile = path.join(this.rootFolder, "env.json");
-    if (!existsSync(envFile) || envFile === "") {
-      throw new Error(
-        `
-  ======================================================
-  env.json file not found in the project root folder
-  or in the environments folder
-  ======================================================
-  `
-      );
-    }
-    let envFileContent = readFileSync(envFile, "utf8");
-    try {
-      this.environment = JSON.parse(envFileContent);
-    } catch (e) {
-      throw new Error(
-        `
-        ======================================================
-        unable to parse environment file
-        ${e}
-        ======================================================
-        `
-      );
+function checkForEnvArg() {
+    for (const arg of process.argv.slice(2)) {
+        if (arg.startsWith("--")) {
+            const [key, value] = arg.split("=");
+            if (key.slice(2) === "env") {
+                return value ?? null;
+            }
+        }
     }
-    if (!this.environment.baseUrl) {
-      throw new Error(
-        `
-  ======================================================
-  baseUrl not found in env.json file
-  or in the environments folder
-  ======================================================
-  `
-      );
+    return null;
+}
+function generatePrompt(promptFile, parameters, chat = true) {
+    let promptFileContent = readFileSync(promptFile, "utf8");
+    for (const key in parameters) {
+        const value = parameters[key];
+        promptFileContent = promptFileContent.replaceAll(`{${key}}`, value);
     }
-    // list all the files in the project /features/step_definitions folder with mjs extension
-    if (!existsSync(this.stepsFolder)) {
-      return;
+    if (!chat)
+        return { promptFileContent };
+    const messages = [];
+    const parts = promptFileContent.split("####");
+    for (let i = 0; i < parts.length; i++) {
+        if (!parts[i].trim())
+            continue;
+        const role = parts[i];
+        const prompt = parts[i + 1];
+        messages.push({ role, content: (prompt ?? "").trim() });
+        i++;
     }
-    try {
-      // load the utils_template and save it to the project step_definitions folder
-      const utilsPath = path.join(__dirname, "../assets/templates/utils_template.txt");
-      const utilsContent = readFileSync(utilsPath, "utf8");
-      const utilsFileName = this.stepsFolder + "/utils.mjs";
-      writeFileSync(utilsFileName, utilsContent, "utf8");
-      const hooksTemplateFilePath = path.join(__dirname, "../assets", "templates", "_hooks_template.txt");
-      if (existsSync(hooksTemplateFilePath)) {
-        const hooksFilePath = path.join(this.stepsFolder, "_hooks.mjs");
-        const hooksContent = readFileSync(hooksTemplateFilePath, "utf8");
-        writeFileSync(hooksFilePath, hooksContent, "utf8");
-      }
-    } catch (e) {
-      logger.error("Error loading utils_template");
+    return { messages, promptFileContent };
+}
+class Project {
+    rootFolder;
+    stepsFolder;
+    environment = null;
+    pages = [];
+    constructor(rootFolder) {
+        this.rootFolder = rootFolder;
+        this.stepsFolder = path.join(rootFolder, "features", "step_definitions");
     }
-
-    const files = findFilesWithExtension(this.stepsFolder, "mjs");
-
-    //let files = readdirSync(this.stepsFolder);
-
-    for (let i = 0; i < files.length; i++) {
-      let file = files[i];
-      if (file.startsWith("_")) {
-        continue;
-      }
-      if (file.endsWith(".mjs")) {
-        let fullFileName = this.rootFolder + "/features/step_definitions/" + file;
-
-        // create a new CodePage object for each file
-        let page = new CodePage(fullFileName);
-        page.generateModel();
-        this.pages.push(page);
-      }
+    async load() {
+        this.pages = [];
+        // Resolve env file path
+        let envFile = "";
+        const envArgVal = checkForEnvArg();
+        if (envArgVal) {
+            envFile = envArgVal;
+        }
+        else if (process.env["BLINQ_ENV"]) {
+            envFile = process.env["BLINQ_ENV"];
+        }
+        else if (existsSync(path.join(this.rootFolder, "env.json"))) {
+            envFile = path.join(this.rootFolder, "env.json");
+        }
+        else {
+            // pick the first .json from environments/
+            const envDir = path.join(this.rootFolder, "environments");
+            const files = existsSync(envDir) ? readdirSync(envDir) : [];
+            for (let i = 0; i < files.length; i++) {
+                const file = files[i];
+                if (file.endsWith(".json")) {
+                    envFile = path.join(envDir, file);
+                    break;
+                }
+            }
+        }
+        if (!existsSync(envFile) || envFile === "") {
+            throw new Error(`
+======================================================
+env.json file not found in the project root folder
+or in the environments folder
+======================================================
+`);
+        }
+        const envFileContent = readFileSync(envFile, "utf8");
+        try {
+            this.environment = JSON.parse(envFileContent);
+        }
+        catch (e) {
+            throw new Error(`
+======================================================
+unable to parse environment file
+${e}
+======================================================
+`);
+        }
+        if (!this.environment.baseUrl) {
+            throw new Error(`
+======================================================
+baseUrl not found in env.json file
+or in the environments folder
+======================================================
+`);
+        }
+        // Prepare step_definitions utilities
+        if (!existsSync(this.stepsFolder)) {
+            return this.environment.name;
+        }
+        try {
+            const utilsPath = path.join(__dirname, "../assets/templates/utils_template.txt");
+            const utilsContent = readFileSync(utilsPath, "utf8");
+            const utilsFileName = path.join(this.stepsFolder, "utils.mjs");
+            writeFileSync(utilsFileName, utilsContent, "utf8");
+            const hooksTemplateFilePath = path.join(__dirname, "../assets", "templates", "_hooks_template.txt");
+            if (existsSync(hooksTemplateFilePath)) {
+                const hooksFilePath = path.join(this.stepsFolder, "_hooks.mjs");
+                const hooksContent = readFileSync(hooksTemplateFilePath, "utf8");
+                writeFileSync(hooksFilePath, hooksContent, "utf8");
+            }
+        }
+        catch {
+            logger.error("Error loading utils_template");
+        }
+        const files = findFilesWithExtension(this.stepsFolder, "mjs");
+        for (let i = 0; i < files.length; i++) {
+            const file = files[i];
+            if (file.startsWith("_"))
+                continue;
+            if (file.endsWith(".mjs")) {
+                const fullFileName = path.join(this.rootFolder, "features", "step_definitions", file);
+                const page = new CodePage(fullFileName);
+                page.generateModel();
+                this.pages.push(page);
+            }
+        }
+        return this.environment.name;
     }
-    return this.environment.name;
-  }
-  getPagesNames() {
-    let result = [];
-    this.pages.forEach((page) => {
-      result.push(page.getName());
-    });
-    return result;
-  }
-  findMethodInPages(methodName) {
-    for (const page of this.pages) {
-      for (const method of page.methods) {
-        if (method.name === methodName) {
-          return { page, method };
-        }
-      }
+    getPagesNames() {
+        const result = [];
+        this.pages.forEach((page) => result.push(page.getName()));
+        return result;
     }
-    return { page: null, method: null };
-  }
-
-  getProjectSignature() {
-    let result = [];
-    this.pages.forEach((page) => {
-      page.getMethodsNames().forEach((methodName) => {
-        result.push(page.getMethodInCommandFormat(methodName));
-      });
-    });
-    return result;
-  }
-  getPage(pageName, createEmpty = false) {
-    for (let i = 0; i < this.pages.length; i++) {
-      if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
-        return this.pages[i];
-      }
+    findMethodInPages(methodName) {
+        for (const page of this.pages) {
+            for (const method of page.methods) {
+                if (method.name === methodName) {
+                    return { page, method };
+                }
+            }
+        }
+        return { page: null, method: null };
     }
-    if (createEmpty) {
-      let distFileName = this.stepsFolder + "/" + pageName + "_page.mjs";
-      let page = new CodePage(distFileName);
-      page.generateModel();
-      this.setPage(pageName, page);
-      return page;
+    getProjectSignature() {
+        const result = [];
+        this.pages.forEach((page) => {
+            page.getMethodsNames().forEach((methodName) => {
+                result.push(page.getMethodInCommandFormat(methodName));
+            });
+        });
+        return result;
     }
-    return null;
-  }
-  setPage(pageName, page) {
-    for (let i = 0; i < this.pages.length; i++) {
-      if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
-        this.pages[i] = page;
-      }
+    getPage(pageName, createEmpty = false) {
+        for (let i = 0; i < this.pages.length; i++) {
+            if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
+                return this.pages[i];
+            }
+        }
+        if (createEmpty) {
+            const distFileName = path.join(this.stepsFolder, `${pageName}_page.mjs`);
+            const page = new CodePage(distFileName);
+            page.generateModel();
+            this.setPage(pageName, page);
+            return page;
+        }
+        return null;
     }
-  }
-  createNewPage(name, _path) {
-    let distFileName = this.stepsFolder + "/" + name + "_page.mjs";
-    if (existsSync(distFileName)) {
-      logger.error("Page already exists: " + distFileName);
-      throw new Error("Page already exists: " + name + " - " + name + "_page.mjs");
+    setPage(pageName, page) {
+        for (let i = 0; i < this.pages.length; i++) {
+            if (this.pages[i].getName().toLowerCase() === pageName.toLowerCase()) {
+                this.pages[i] = page;
+            }
+        }
     }
-    if (!existsSync(this.stepsFolder)) {
-      mkdirSync(this.stepsFolder, { recursive: true });
+    createNewPage(name, _path) {
+        const distFileName = path.join(this.stepsFolder, `${name}_page.mjs`);
+        if (existsSync(distFileName)) {
+            logger.error("Page already exists: " + distFileName);
+            throw new Error(`Page already exists: ${name} - ${name}_page.mjs`);
+        }
+        if (!existsSync(this.stepsFolder)) {
+            mkdirSync(this.stepsFolder, { recursive: true });
+        }
+        const map = {
+            name,
+            path: _path ? `"${_path}"` : "null",
+            name_upper: name.charAt(0).toUpperCase() + name.slice(1),
+        };
+        const { promptFileContent } = generatePrompt(path.join(__dirname, "../assets/templates/page_template.txt"), map, false);
+        writeFileSync(distFileName, promptFileContent, "utf8");
+        // refresh pages list
+        void this.load();
     }
-    let map = {
-      name,
-      path: _path ? `"${_path}"` : "null",
-      name_upper: name.charAt(0).toUpperCase() + name.slice(1),
-    };
-
-    let content = generatePrompt(
-      path.join(__dirname, "../assets/templates/page_template.txt"),
-      map,
-      false
-    ).promptFileContent;
-    writeFileSync(distFileName, content, "utf8");
-    this.load();
-  }
 }
-const generatePrompt = (promptFile, parameters, chat = true) => {
-  let promptFileContent = readFileSync(promptFile, "utf8");
-  for (const key in parameters) {
-    const value = parameters[key];
-    promptFileContent = promptFileContent.replaceAll(`{${key}}`, value);
-  }
-  if (!chat) return { promptFileContent };
-  const messages = [];
-  const parts = promptFileContent.split("####");
-  for (let i = 0; i < parts.length; i++) {
-    if (!parts[i].trim()) continue;
-    const role = parts[i];
-    const prompt = parts[i + 1];
-    messages.push({ role, content: prompt.trim() });
-    //    console.error("####prompt####", `role ${role}ֿֿ`);
-    //    console.error(prompt.trim());
-    i++;
-  }
-  return { messages, promptFileContent };
-};
-
-const checkForEnvArg = () => {
-  for (let arg of process.argv.slice(2)) {
-    if (arg.startsWith("--")) {
-      const [key, value] = arg.split("=");
-      if (key.slice(2) === "env") {
-        return value;
-      }
-    }
-  }
-  return null;
-};
-export { Project };
+export { Project, generatePrompt, checkForEnvArg };