@zohodesk/testinglibrary 3.1.9 → 3.1.10-experimental

package/.gitlab-ci.yml

@@ -146,18 +146,4 @@ uatconfigmodule:
     paths:
       - examples/uat/playwright-report
 
-uat-smoketest:
-  stage: uat
-  script:
-    - cd examples
-    - npm install $(npm pack ../../testing-framework | tail -1)
-    - output=$(npm run uat-smoketest)
-    - echo "$output"
-    - node ../ValidateUATReport.js examples
-
-  artifacts:
-    when: always
-    paths:
-      - examples/uat/playwright-report
-
       

package/build/common/data-generator/DataGenerator.js

@@ -0,0 +1,65 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _fs = _interopRequireDefault(require("fs"));
+var _DataGeneratorHelper = require("./DataGeneratorHelper");
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+var _DataGenerator_brand = /*#__PURE__*/new WeakSet();
+class DataGenerator {
+  constructor() {
+    _classPrivateMethodInitSpec(this, _DataGenerator_brand);
+  }
+  async generate(testInfo, actorInfo, page, templateName, scenarioName, dataTable) {
+    try {
+      const templates = await _assertClassBrand(_DataGenerator_brand, this, _getGenerator).call(this, testInfo, templateName);
+      if (!templates) throw new Error(templateName + ' Template not found');
+      const {
+        crmcsrToken,
+        cookieString
+      } = await (0, _DataGeneratorHelper.getCookies)(page);
+      const processedTemplates = await (0, _DataGeneratorHelper.processTemplate)(templates, dataTable);
+      const user = actorInfo;
+      let host = process.env.domain.replace("/agent/", "");
+      const apiPayload = {
+        scenario_name: scenarioName,
+        data_generation_templates: processedTemplates,
+        account: {
+          email: user.email,
+          password: user.password,
+          storeVariables: {
+            orgId: user.orgId
+          },
+          cookieAuthHeaders: {
+            Cookie: cookieString,
+            'X-ZCSRF-TOKEN': crmcsrToken
+          },
+          authentications: ["cookie-auth"]
+        },
+        environmentDetails: {
+          "host": host
+        }
+      };
+      return await (0, _DataGeneratorHelper.makeRequest)(process.env.dataGeneratorDomain + process.env.dataGeneratorAPI, apiPayload);
+    } catch (error) {
+      console.error('Error creating data:', error);
+      throw error;
+    }
+  }
+}
+async function _getGenerator(testInfo, templateName) {
+  let templateFilePath = await (0, _DataGeneratorHelper.getGeneratorFilePath)(testInfo.file);
+  templateFilePath = _path.default.join(templateFilePath, "../../data-generators/template.json");
+  if (!templateFilePath) return null;
+  const data = _fs.default.readFileSync(templateFilePath, 'utf8');
+  const template = JSON.parse(data);
+  if (!templateName || !template.generators) return null;
+  return template.generators[templateName] || null;
+}
+var _default = exports.default = DataGenerator;

package/build/common/data-generator/DataGeneratorHelper.js

@@ -0,0 +1,62 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getCookies = getCookies;
+exports.getGeneratorFilePath = getGeneratorFilePath;
+exports.makeRequest = makeRequest;
+exports.processTemplate = processTemplate;
+async function getCookies(page) {
+  const context = page.context();
+  const pageUrl = new URL(page.url());
+  const currentDomain = pageUrl.hostname;
+  const cookies = await context.cookies([page.url()]);
+  const crmcsrCookie = cookies.filter(cookie => cookie.domain.includes(currentDomain) && cookie.name === 'crmcsr');
+  return {
+    crmcsrToken: crmcsrCookie.map(c => `${'crmcsrfparam'}=${c.value}`).join('; '),
+    cookieString: cookies.map(c => `${c.name}=${c.value}`).join('; ')
+  };
+}
+
+//Create payload for the template
+async function processTemplate(template, dataTable) {
+  if (!template || !dataTable) {
+    return template;
+  }
+  const data = dataTable.hashes();
+  return template.map(tmpl => {
+    if (!tmpl.params) {
+      return tmpl;
+    }
+    data.forEach(row => {
+      const generatorName = row.DG_APIName;
+      if (generatorName === tmpl.name) {
+        delete row.DG_APIName;
+        Object.entries(row).forEach(([key, value]) => {
+          tmpl.params[key] = value;
+        });
+      }
+    });
+    return tmpl;
+  });
+}
+async function makeRequest(url, payload) {
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(payload)
+  });
+  if (!response.ok) {
+    const errorBody = await response.text();
+    throw new Error(`HTTP error! status: ${response.status}, body: ${errorBody}`);
+  }
+  return response.json();
+}
+async function getGeneratorFilePath(featureFile) {
+  let generatorPath = featureFile.split('/').slice(0, 9).join("/").concat("/", featureFile.split('/').slice(10, featureFile.length - 1).join("/"));
+  generatorPath = generatorPath.replace(".features-gen/", "");
+  return generatorPath;
+}

package/build/common/data-generator/uat/steps/DataGenerator.spec.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _testinglibrary = require("@zohodesk/testinglibrary");
+var _DataGenerator = _interopRequireDefault(require("../../DataGenerator"));
+const {
+  Given,
+  When,
+  Then
+} = (0, _testinglibrary.createBdd)();
+const dataGenerator = new _DataGenerator.default();
+Given('generate a {string} entity {string} with {string}', async ({
+  page,
+  context,
+  i18N,
+  cacheLayer,
+  executionContext
+}, module, entityName, generatorName, dataTable) => {
+  const testInfo = _testinglibrary.test.info();
+  const scenarioName = testInfo.title.split('/').pop() || 'Unknown Scenario';
+  const generatedData = await dataGenerator.generate(testInfo, executionContext.actorInfo, page, generatorName, scenarioName, dataTable);
+  await cacheLayer.set(entityName, generatedData.value);
+});
+Given('goto generated entity {string} using web URL', async ({
+  page,
+  cacheLayer
+}, entityName) => {
+  const entityData = await cacheLayer.get(entityName);
+  const url = entityData.webUrl;
+  await page.goto(url);
+});

package/build/core/playwright/builtInFixtures/page.js

@@ -9,8 +9,6 @@ var _auth = require("../helpers/auth");
 var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
 
-//import { additionProfiles } from '../helpers/additionalProfiles';
-
 function getTagInputFromSelectedTags(tags, inputString) {
   const selectedTag = [...tags].reverse().find(tag => tag.startsWith(inputString));
   let tagInput = null;
@@ -20,7 +18,7 @@ function getTagInputFromSelectedTags(tags, inputString) {
   return tagInput;
 }
 function getCustomAccountDetails(tags) {
-  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal', '@additional_profile'];
+  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal'];
   const filteredTags = tags.filter(tag => tagsTobeFiltered.some(prefix => tag.startsWith(prefix)));
   if (filteredTags && filteredTags.length > 0) {
     const portalInfo = getTagInputFromSelectedTags(filteredTags, '@portal');

package/build/core/playwright/helpers/auth/index.js

@@ -4,6 +4,12 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "DataGenerator", {
+  enumerable: true,
+  get: function () {
+    return _DataGenerator.default;
+  }
+});
 Object.defineProperty(exports, "accountLogin", {
   enumerable: true,
   get: function () {
@@ -73,4 +79,5 @@ Object.defineProperty(exports, "verifyIfCookieFileExists", {
 var _accountLogin = _interopRequireDefault(require("./accountLogin"));
 var _checkAuthCookies = require("./checkAuthCookies");
 var _getUsers = require("./getUsers");
-var _loginSteps = _interopRequireDefault(require("./loginSteps"));
+var _loginSteps = _interopRequireDefault(require("./loginSteps"));
+var _DataGenerator = _interopRequireDefault(require("../../../../common/data-generator/DataGenerator"));

package/build/core/playwright/helpers/auth/loginSteps.js

@@ -10,6 +10,7 @@ var _fileMutex = _interopRequireDefault(require("../fileMutex"));
 var _fileMutexConfig = require("../../constants/fileMutexConfig");
 var _checkAuthCookies = require("./checkAuthCookies");
 var _checkAuthDirectory = require("../checkAuthDirectory");
+var _fs = require("fs");
 /* eslint-disable no-console */
 
 async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {

package/build/core/playwright/setup/config-creator.js

@@ -12,7 +12,6 @@ var _configUtils = require("./config-utils");
 const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
 const {
   browsers,
-  isSmokeTest,
   trace,
   video,
   isAuthMode,
@@ -32,7 +31,6 @@ const {
 const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
-  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -63,21 +61,7 @@ if (customReporter) {
  *
  * @returns {import('@playwright/test').PlaywrightTestConfig}
  */
-
 function getPlaywrightConfig() {
-  const commonConfig = {
-    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
-  };
-  const dependencies = isAuthMode ? ['setup'] : [];
-  const smokeTestProject = isSmokeTest ? {
-    name: 'smokeTest',
-    testMatch: /.*\.smokeTest\.js/,
-    testDir: _path.default.join(process.cwd(), 'uat'),
-    use: {
-      ...commonConfig
-    },
-    dependencies: dependencies
-  } : {};
   const playwrightConfig = {
     testDir,
     globalTimeout: globalTimeout || 3600000,
@@ -94,11 +78,11 @@ function getPlaywrightConfig() {
       testMatch: /.*\.setup\.js/,
       testDir: _path.default.join(process.cwd(), 'uat'),
       teardown: 'cleanup'
-    }, smokeTestProject, {
+    }, {
       name: 'cleanup',
       testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects, smokeTestProject],
+    }, ...projects] : [...projects],
     ...uatConfig
   };
   return playwrightConfig;

package/build/core/playwright/setup/config-utils.js

@@ -19,11 +19,9 @@ var _fileUtils = require("../../../utils/fileUtils");
  ** Playwright project configuration
  * @returns {import('@playwright/test').Project}
  */
-
 function getBrowserConfig({
   browserName,
   isAuthMode,
-  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -34,8 +32,7 @@ function getBrowserConfig({
     viewport,
     storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
   };
-  // Determine dependencies based on the mode and smoke test status
-  const dependencies = isSmokeTest ? isAuthMode ? ['setup', 'smokeTest'] : ['smokeTest'] : isAuthMode ? ['setup'] : [];
+  const dependencies = isAuthMode ? ['setup'] : [];
   if (browser === 'chrome') {
     return {
       name: _browserTypes.BROWSER_PROJECT_MAPPING.CHROME,
@@ -102,7 +99,6 @@ function getBrowserConfig({
 function getProjects({
   browsers,
   isAuthMode,
-  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -111,7 +107,6 @@ function getProjects({
   return browsers.map(browserName => getBrowserConfig({
     browserName,
     isAuthMode,
-    isSmokeTest,
     authFilePath,
     expectTimeout,
     testTimeout,
@@ -172,7 +167,7 @@ function getTestDir(bddMode, cwd, {
 }) {
   return bddMode ? (0, _playwrightBdd.defineBddConfig)({
     features: getPathsForFeatureFiles(cwd),
-    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
+    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), _path.default.join(cwd, '/node_modules/@zohodesk/testinglibrary/build/common/', '**', 'uat', '**', '*.spec.js'), require.resolve('../fixtures.js')],
     importTestFrom: require.resolve('../fixtures.js'),
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),

package/build/core/playwright/setup/qc-custom-reporter.js

@@ -32,12 +32,23 @@ class CustomJsonReporter {
       attachments: result.attachments,
       startTime: result.startTime,
       retry: result.retry,
-      stderr: result.stderr.map(err => stdioEntry(err)),
-      stdout: result.stdout.map(out => stdioEntry(out)),
+      stderr: result.stderr.map(err => ({
+        text: err
+      })),
+      stdout: result.stdout.map(out => ({
+        text: out
+      })),
       workerIndex: result.workerIndex,
       duration: result.duration,
-      error: result.error,
-      errors: (_result$errors = result.errors) === null || _result$errors === void 0 ? void 0 : _result$errors.map(processError),
+      errors: ((_result$errors = result.errors) === null || _result$errors === void 0 ? void 0 : _result$errors.map(({
+        message,
+        stack,
+        snippet
+      }) => ({
+        message,
+        stack,
+        snippet
+      }))) ?? [],
       steps: ((_result$steps = result.steps) === null || _result$steps === void 0 ? void 0 : _result$steps.map(step => extractMergedSteps(this.report.config.rootDir, step))) ?? []
     };
     const existingResults = this.testResultsById.get(key) ?? [];
@@ -152,125 +163,4 @@ const parseLocation = (rootDir, {
   file: isRelative ? _path.default.relative(rootDir, file) : file,
   line,
   column
-} : {};
-const stdioEntry = s => typeof s === 'string' ? {
-  text: s
-} : {
-  buffer: s.toString('base64')
-};
-const processError = error => {
-  const message = error.message || error.value || '';
-  const stack = error.stack;
-  if (!stack && !error.location) return {
-    message
-  };
-  const tokens = [];
-  const parsedStack = stack ? constructErrorStack(stack) : undefined;
-  tokens.push((parsedStack === null || parsedStack === void 0 ? void 0 : parsedStack.message) || message);
-  if (error.snippet) {
-    tokens.push('');
-    tokens.push(error.snippet);
-  }
-  if (parsedStack && parsedStack.stackLines.length) {
-    const dimmedStackLines = parsedStack.stackLines.split('\n').map(line => dimify(line));
-    tokens.push(dimmedStackLines.join('\n'));
-  }
-  let location = error.location;
-  if (parsedStack && !location) location = parsedStack.location;
-  if (error.cause) tokens.push(dimify('[cause]: ') + processError(error.cause).message);
-  return {
-    location,
-    message: tokens.join('\n')
-  };
-};
-const constructErrorStack = stack => parseErrorStack(stack, _path.default.sep, false);
-const dimify = text => `\x1b[2m${text}\x1b[22m`;
-const parseErrorStack = (stack, pathSeparator, showInternalStackFrames = false) => {
-  const lines = stack.split("\n");
-  let firstStackLineIndex = lines.findIndex(line => line.startsWith("    at "));
-  if (firstStackLineIndex === -1) firstStackLineIndex = lines.length;
-  const message = lines.slice(0, firstStackLineIndex).join("\n");
-  const stackStartIndex = indexLocator(stack, '\n', firstStackLineIndex) + 1 || 0;
-  const stackLinesString = stackStartIndex ? stack.slice(stackStartIndex) : '';
-  let location;
-  const stackLinesArr = stackLinesString.split('\n');
-  for (const line of stackLinesArr) {
-    const frame = parseStackFrame(line, pathSeparator, showInternalStackFrames);
-    if (!frame || !frame.file) continue;
-    if (isInNodeModules(frame.file, pathSeparator)) continue;
-    location = {
-      file: frame.file,
-      column: frame.column || 0,
-      line: frame.line || 0
-    };
-    break;
-  }
-  return {
-    message,
-    stackLines: stackLinesString,
-    location
-  };
-};
-const indexLocator = (str, pat, n) => {
-  let L = str.length,
-    i = -1;
-  while (n-- && i++ < L) {
-    i = str.indexOf(pat, i);
-    if (i < 0) break;
-  }
-  return i;
-};
-const isInNodeModules = (file, pathSeparator) => file.includes(`${pathSeparator}node_modules${pathSeparator}`);
-const parseStackFrame = (text, pathSeparator, showInternalStackFrames) => {
-  const re = new RegExp("^(?:\\s*at )?(?:(new) )?(?:(.*?) \\()?(?:eval at ([^ ]+) \\((.+?):(\\d+):(\\d+)\\), )?(?:(.+?):(\\d+):(\\d+)|(native))(\\)?)$");
-  const methodRe = /^(.*?) \[as (.*?)\]$/;
-  const match = text && text.match(re);
-  if (!match) return null;
-  let fname = match[2];
-  let file = match[7];
-  if (!file) return null;
-  if (!showInternalStackFrames && (file.startsWith("internal") || file.startsWith("node:"))) return null;
-  const line = match[8];
-  const column = match[9];
-  const closeParen = match[11] === ")";
-  const frame = {
-    file: "",
-    line: 0,
-    column: 0
-  };
-  if (line) frame.line = Number(line);
-  if (column) frame.column = Number(column);
-  if (closeParen && file) {
-    let closes = 0;
-    for (let i = file.length - 1; i > 0; i--) {
-      if (file.charAt(i) === ")") {
-        closes++;
-      } else if (file.charAt(i) === "(" && file.charAt(i - 1) === " ") {
-        closes--;
-        if (closes === -1 && file.charAt(i - 1) === " ") {
-          const before = file.slice(0, i - 1);
-          const after = file.slice(i + 1);
-          file = after;
-          fname += ` (${before}`;
-          break;
-        }
-      }
-    }
-  }
-  if (fname) {
-    const methodMatch = fname.match(methodRe);
-    if (methodMatch) fname = methodMatch[1];
-  }
-  if (file) {
-    if (file.startsWith("file://")) file = fileURLToPath(file, pathSeparator);
-    frame.file = file;
-  }
-  if (fname) frame.function = fname;
-  return frame;
-};
-const fileURLToPath = (fileUrl, pathSeparator) => {
-  if (!fileUrl.startsWith("file://")) return fileUrl;
-  let path = decodeURIComponent(fileUrl.slice(7));
-  if (path.startsWith("/") && /^[a-zA-Z]:/.test(path.slice(1))) path = path.slice(1);
-  return path.replace(/\//g, pathSeparator);
-};
+} : {};

package/build/test/Test.js

@@ -0,0 +1,13 @@
+"use strict";
+
+delete require.cache[require.resolve('../core/playwright/runner/Runner')];
+function test() {
+  const inputString = "@hc";
+  const selectedTag = ["@hc_1234"].reverse().find(tag => tag.startsWith(inputString));
+  let tagInput = null;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  console.log(tagInput);
+}
+test();

package/build/utils/fileUtils.js

@@ -14,8 +14,7 @@ var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("./logger");
 var glob = _interopRequireWildcard(require("glob"));
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function checkIfFileExists(file) {
   try {
     _fs.default.accessSync(file, _fs.default.constants.F_OK);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "3.1.9",
+  "version": "3.1.10-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -15,7 +15,8 @@
   "exports": {
     ".": "./build/index.js",
     "./decorators": "./build/decorators.js",
-    "./helpers": "./build/core/playwright/helpers/auth/index.js"
+    "./helpers": "./build/core/playwright/helpers/auth/index.js",
+    "./common_steps": "./build/common/uat/steps/common.spec.js"
   },
   "keywords": [],
   "author": "",
@@ -36,8 +37,8 @@
     "jest-environment-jsdom": "29.6.2",
     "msw": "1.2.3",
     "playwright": "1.52.0",
-    "supports-color": "8.1.1",
-    "playwright-bdd": "8.2.1"
+    "playwright-bdd": "8.2.1",
+    "supports-color": "8.1.1"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"

package/test-results/.last-run.json

@@ -0,0 +1,4 @@
+{
+  "status": "failed",
+  "failedTests": []
+}

package/build/core/playwright/helpers/additionalProfiles.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.additionProfiles = additionProfiles;
-var _getUsers = require("./auth/getUsers");
-function additionProfiles(tags, editionInfo, betaFeature, portalInfo) {
-  const additionalProfileTags = tags.filter(tag => tag.startsWith('@additional_profile_'));
-  let additionalProfileActors = [];
-  if (additionalProfileTags.length > 0 && editionInfo) {
-    additionalProfileActors = additionalProfileTags.map(tag => {
-      const additionalProfile = tag.replace('@additional_profile_', '');
-      return (0, _getUsers.getUserForSelectedEditionAndProfile)(editionInfo, additionalProfile, betaFeature, portalInfo);
-    });
-  }
-  return additionalProfileActors;
-}