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

package/bin/client/code_gen/playwright_codeget.js

@@ -4,6 +4,9 @@ import { StepsDefinitions } from "../cucumber/steps_definitions.js";
 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
@@ -12,6 +15,13 @@ const findElementIdentifier = (node, step, userData, elements) => {
 
   let elementIdentifier = null;
   const keys = Object.keys(elements);
+
+  for (let i = 0; i < keys.length; i++) {
+    const element_key = keys[i];
+    const element = elements[element_key];
+    element["element_key"] = element_key;
+  }
+
   let name = node.name;
   if (!name && step.dataKey) {
     name = step.dataKey;
@@ -92,11 +102,16 @@ const splitToLocatorsGroups = (locators) => {
 const _generateCodeFromCommand = (step, elements, userData) => {
   let elementsChanged = false;
 
-  let elementIdentifier = null;
+  let elementIdentifier = step.locators?.element_key;
   let locatorObject = step.locators;
   // 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;
@@ -130,18 +145,20 @@ const _generateCodeFromCommand = (step, elements, userData) => {
     let locatorObjectClone = JSON.parse(JSON.stringify(locatorObject));
     element_name = locatorObjectClone.element_name;
     delete locatorObjectClone.element_name;
-    keys.forEach((key) => {
-      let elementClone = JSON.parse(JSON.stringify(elements[key]));
-      delete elementClone.element_name;
-      if (JSON.stringify(elementClone) === JSON.stringify(locatorObjectClone)) {
-        elementIdentifier = key;
-      }
-    });
+    if (!elementIdentifier) {
+      keys.forEach((key) => {
+        let elementClone = JSON.parse(JSON.stringify(elements[key]));
+        delete elementClone.element_name;
+        if (JSON.stringify(elementClone) === JSON.stringify(locatorObjectClone)) {
+          elementIdentifier = key;
+        }
+      });
+    }
     if (!elementIdentifier) {
       elementIdentifier = findElementIdentifier(node, step, userData, elements);
     }
     const withoutAllStrategyLocators = excludeKey(locatorObject, "allStrategyLocators");
-    elements[elementIdentifier] = withoutAllStrategyLocators;
+    elements[elementIdentifier] = { ...withoutAllStrategyLocators, element_key: elementIdentifier };
     elementsChanged = true;
   }
   let optionElement = null;
@@ -157,8 +174,6 @@ const _generateCodeFromCommand = (step, elements, userData) => {
     }
   }
 
-  const codeLines = [];
-
   let line = null;
   let comment = null;
   let input = null;
@@ -353,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]}`;
@@ -362,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]))}`;
@@ -716,6 +748,7 @@ const generateCode = (recording, codePage, userData, projectDir, methodName) =>
   }
   let elements = {};
   if (!codePage) {
+    socketLogger.info("CodePage is null");
     console.log("codePage is null");
   } else {
     elements = codePage.getVariableDeclarationAsObject("elements");

package/bin/client/cucumber/feature.js

@@ -8,6 +8,7 @@ import { parseStepTextParameters, toCucumberExpression, unEscapeNonPrintables }
 import stream from "stream";
 import { testStringForRegex } from "../recorderv3/update_feature.js";
 import { generateTestData } from "./feature_data.js";
+import socketLogger from "../utils/socket_logger.js";
 class DataTable {
   constructor(dataTableDocument) {
     if (!dataTableDocument) {
@@ -544,6 +545,9 @@ const scenarioResolution = async (featureFilePath) => {
         fs.rmSync(tmpDir, { recursive: true });
       }
     } catch (e) {
+      socketLogger.error(
+        `An error has occurred while removing the temp folder at ${tmpDir}. Please remove it manually. Error: ${e}`
+      );
       console.error(
         `An error has occurred while removing the temp folder at ${tmpDir}. Please remove it manually. Error: ${e}`
       );

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();
@@ -15,7 +21,7 @@ export const projectDocument = (folder, featureName = null, scenarioName = null,
   // read all the feature files in the project folder under features folder
   let featureFiles = [];
   const featuresDir = path.join(folder, "features");
-  featureFiles = fs.readdirSync(featuresDir).filter((file) => {
+  featureFiles = fs.readdirSync(featuresDir, { recursive: true }).filter((file) => {
     return file.endsWith(".feature");
   });
   const documents = [];
@@ -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

@@ -45,7 +45,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 +59,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 +67,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

@@ -6,6 +6,7 @@ import crypto from "crypto";
 import { findFilesWithExtension } from "./cucumber/steps_definitions.js";
 import fs from "fs";
 //import { spawn } from "child_process";
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
 
 if (process.argv.length < 3) {
   console.log("Usage: node cucumber_selector.js <projectsDir> --all");
@@ -100,8 +101,8 @@ if (process.argv.includes("--scenario-name")) {
 }
 const projectName = selectedScenario.featureFile.split(path.sep)[0];
 let deleteMjsFiles = readlineSync.keyInYN("Delete mjs file?");
+let stepsPath = path.join(selectedScenario.projectsDir, projectName, "features", "step_definitions");
 if (deleteMjsFiles) {
-  let stepsPath = path.join(selectedScenario.projectsDir, projectName, "features", "step_definitions");
   if (fs.existsSync(stepsPath)) {
     // delete all the *.mjs files
     let files = fs.readdirSync(stepsPath);
@@ -112,6 +113,21 @@ if (deleteMjsFiles) {
     }
   }
 }
+// copy utils file to the steps directory
+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");
+const hooksContent = fs.readFileSync(hooksTemplateFilePath, "utf8");
+const hooksFilePath = path.join(stepsPath, "_hooks.mjs");
+fs.writeFileSync(hooksFilePath, hooksContent, "utf8");
+
 process.env.PROJECT_PATH = path.join(selectedScenario.projectsDir, projectName);
 //chanks[currentChank][index];
 console.log("Running scenario:");

package/bin/client/local_agent.js

@@ -267,7 +267,7 @@ class LocalAgent {
         null,
         true,
         null,
-        450,
+        -1,
         null,
         initScript
       );
@@ -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"
+}