@zohodesk/testinglibrary 0.1.8-exp.4 → 0.1.8-stb-bdd-v1

package/build/setup-folder-structure/helper.js

@@ -29,7 +29,6 @@ function helpercmd() {
   _commander.program.option('--debug', 'This command is used to initiate a debugging session');
   _commander.program.option('--tags', 'Run specific test case with mentioned tags (Usage: -- --tags="@live")');
   _commander.program.option('--workers', 'Specify number of workers to run the test case parallely (Usage: -- --workers=2)');
-  _commander.program.option('--browsers', 'Specify the browsers on which the test case should run (Usage: -- --browsers="chrome,firefox,safari")');
   _commander.program.parse(process.argv);
 }
 var _default = exports.default = helpercmd;

package/build/setup-folder-structure/reportEnhancement/addonScript.html

@@ -1,25 +1,25 @@
-<script>
-    function sortEdition(event) {
-      var currentURL = window.location.href;
-      const endPointCount = window.location.href.indexOf('#');
-      if (!(endPointCount == -1)) {
-        window.history.pushState({}, '', currentURL.slice(0, endPointCount));
-        currentURL = currentURL.slice(0, endPointCount);
-      }
-      console.log(currentURL);
-      window.open(`${currentURL}#?q=@edition_${event.target.value}`, '_self');
-    }
-  </script>
-  <div class="mainContainer" style="margin-left: 20px; display: flex;">
-    <div class="selectEditionContainer" style="padding: 20px;">
-      <select class="selectEdition" style="padding: 5px; width: 100px; border-radius: 6px; border: 1px solid var(--color-border-default);"  onchange="sortEdition(event)">
-        <option value="EnterPrise">EnterPrise</option>
-        <option value="Professional">Professional</option>
-        <option value="Express">Express</option>
-        <option value="Standard">Standard</option>
-        <option value="Free">Free</option>
-      </select>
-    </div>
-  </div>
-
+<script>
+    function sortEdition(event) {
+      var currentURL = window.location.href;
+      const endPointCount = window.location.href.indexOf('#');
+      if (!(endPointCount == -1)) {
+        window.history.pushState({}, '', currentURL.slice(0, endPointCount));
+        currentURL = currentURL.slice(0, endPointCount);
+      }
+      console.log(currentURL);
+      window.open(`${currentURL}#?q=@edition_${event.target.value}`, '_self');
+    }
+  </script>
+  <div class="mainContainer" style="margin-left: 20px; display: flex;">
+    <div class="selectEditionContainer" style="padding: 20px;">
+      <select class="selectEdition" style="padding: 5px; width: 100px; border-radius: 6px; border: 1px solid var(--color-border-default);"  onchange="sortEdition(event)">
+        <option value="EnterPrise">EnterPrise</option>
+        <option value="Professional">Professional</option>
+        <option value="Express">Express</option>
+        <option value="Standard">Standard</option>
+        <option value="Free">Free</option>
+      </select>
+    </div>
+  </div>
+
   

package/build/setup-folder-structure/samples/auth-setup-sample.js

@@ -1,72 +1,72 @@
-/* eslint-disable no-console */
-import { test as setup, expect } from '@zohodesk/testinglibrary';
-import path from 'path';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-
-const userdata = require('./authUsers.json');
-
-const authDirectory = path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
-
-const authContent = { "cookies": [] };
-
-const LOGIN_ERR_MESSAGE = 'Need go be logged in';
-// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
-
-
-function convertCookiesToParse(cookies, authFilePath) {
-  try {
-    return JSON.parse(cookies)
-  } catch (err) {
-    throw new Error(` Error while parsing cookies ${err} \n${path.resolve(process.cwd(), authFilePath)} File is Empty`)
-    // process.exit()
-  }
-}
-
-if (!existsSync(authDirectory)) {
-  console.log('Creating auth directory for the first time setup...');
-  mkdirSync(authDirectory, { recursive: true });
-}
-
-userdata.forEach((data) => {
-  const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
-  if (!existsSync(authFile)) {
-    console.log('creating auth file..');
-    writeFileSync(authFile, JSON.stringify(authContent, null, 2))
-  }
-  setup(data.description, async ({ page }) => {
-
-    try {
-      const cookies = readFileSync(authFile);
-      const parsedCookies = convertCookiesToParse(cookies, authFile);
-      await page.context().addCookies(parsedCookies.cookies === undefined ? [] : parsedCookies.cookies)
-      await page.goto(page.getBaseUrl());
-      await page.waitForLoadState();
-      if (await page.url().includes(process.env.domain)) {
-        await page.waitForSelector(data.locator);
-      } else {
-        throw new Error(LOGIN_ERR_MESSAGE);
-      }
-
-
-    } catch (err) {
-      if (err.message === LOGIN_ERR_MESSAGE) {
-
-        await expect(page.locator('.load-bg')).toBeHidden();
-        await page.locator('#login_id').type(data.useremail);
-        await page.locator('#nextbtn').click();
-        await page.locator('#password').type(data.password);
-        await page.locator('#nextbtn').click();
-
-        await page.waitForLoadState("networkidle");
-
-        await page.waitForSelector(data.locator)
-
-        await page.context().storageState({ path: authFile });
-      }
-
-    }
-
-  });
-
-
-})
+/* eslint-disable no-console */
+import { test as setup, expect } from '@zohodesk/testinglibrary';
+import path from 'path';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+
+const userdata = require('./authUsers.json');
+
+const authDirectory = path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
+
+const authContent = { "cookies": [] };
+
+const LOGIN_ERR_MESSAGE = 'Need go be logged in';
+// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
+
+
+function convertCookiesToParse(cookies, authFilePath) {
+  try {
+    return JSON.parse(cookies)
+  } catch (err) {
+    throw new Error(` Error while parsing cookies ${err} \n${path.resolve(process.cwd(), authFilePath)} File is Empty`)
+    // process.exit()
+  }
+}
+
+if (!existsSync(authDirectory)) {
+  console.log('Creating auth directory for the first time setup...');
+  mkdirSync(authDirectory, { recursive: true });
+}
+
+userdata.forEach((data) => {
+  const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
+  if (!existsSync(authFile)) {
+    console.log('creating auth file..');
+    writeFileSync(authFile, JSON.stringify(authContent, null, 2))
+  }
+  setup(data.description, async ({ page }) => {
+
+    try {
+      const cookies = readFileSync(authFile);
+      const parsedCookies = convertCookiesToParse(cookies, authFile);
+      await page.context().addCookies(parsedCookies.cookies === undefined ? [] : parsedCookies.cookies)
+      await page.goto(page.getBaseUrl());
+      await page.waitForLoadState();
+      if (await page.url().includes(process.env.domain)) {
+        await page.waitForSelector(data.locator);
+      } else {
+        throw new Error(LOGIN_ERR_MESSAGE);
+      }
+
+
+    } catch (err) {
+      if (err.message === LOGIN_ERR_MESSAGE) {
+
+        await expect(page.locator('.load-bg')).toBeHidden();
+        await page.locator('#login_id').type(data.useremail);
+        await page.locator('#nextbtn').click();
+        await page.locator('#password').type(data.password);
+        await page.locator('#nextbtn').click();
+
+        await page.waitForLoadState("networkidle");
+
+        await page.waitForSelector(data.locator)
+
+        await page.context().storageState({ path: authFile });
+      }
+
+    }
+
+  });
+
+
+})

package/build/setup-folder-structure/samples/authUsers-sample.json

@@ -1,9 +1,9 @@
-[
-    {
-        "useremail": "/ user name /",
-        "password": "/ password /",
-        "description": "/ description/",
-        "filename": "user.json",
-        "locator": "/ selector to identify page has been loaded completely /"
-    }
+[
+    {
+        "useremail": "/ user name /",
+        "password": "/ password /",
+        "description": "/ description/",
+        "filename": "user.json",
+        "locator": "/ selector to identify page has been loaded completely /"
+    }
 ]

package/build/setup-folder-structure/samples/env-config-sample.json

@@ -1,21 +1,21 @@
-{
-  "dev": {
-    "domain": "https://desk.localzoho.com/agent",
-    "orgName": "org-name",
-    "deptName": "dept-name",
-    "moduleName": "module-name",
-    "devURL": "Provide your devURL here"
-  },
-  "prod": {
-    "domain": "https://desk.localzoho.com/agent",
-    "orgName": "org-name",
-    "deptName": "dept-name",
-    "moduleName": "module-name"
-  },
-  "k8test": {
-    "domain": "https://desk.localzoho.com/agent",
-    "orgName": "org-name",
-    "deptName": "dept-name",
-    "moduleName": "module-name"
-  }
+{
+  "dev": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name",
+    "devURL": "Provide your devURL here"
+  },
+  "prod": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  },
+  "k8test": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  }
 }

package/build/setup-folder-structure/samples/git-ignore.sample.js

@@ -1,37 +1,37 @@
-import { existsSync, readFileSync, writeFileSync } from 'fs';
-import path from 'path';
-import { Logger } from '../utils/logger';
-import { generateConfigFromFile } from '../core/playwright/readConfigFile';
-const gitIgnoreAbsolutePath = path.resolve(process.cwd(), '../', '../')
-
-const { reportPath = path.resolve(process.cwd(), 'uat', 'playwright-reports') } = generateConfigFromFile();
-const testResultsPath = path.resolve(process.cwd(), 'uat', 'test-results');
-
-const testResultsRelativepath = path.relative(gitIgnoreAbsolutePath, testResultsPath)
-const reportRelativepath = path.relative(gitIgnoreAbsolutePath, reportPath)
-
-
-const absolutePathfeaturegen = path.resolve(process.cwd(), 'uat', '.features-gen');
-const featuregenRelativePath = path.relative(gitIgnoreAbsolutePath,absolutePathfeaturegen)
-
-const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}\n${featuregenRelativePath}`
-
-function updateGitIgnore() {
-  if (existsSync(path.resolve(process.cwd(), '../', '../', '.gitignore'))) {
-    let gitIgnoreData = readFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore'), 'utf-8', (err) => {
-      if (err) {
-        Logger.log(Logger.FAILURE_TYPE, 'cannot able to read git ignore ')
-        // process.exit()
-      }
-    })
-    if (gitIgnoreData.includes(dirpathtoIgnore)) {
-      return
-    } else {
-      writeFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore', dirpathtoIgnore, null, 2))
-    }
-  } else {
-    Logger.log(Logger.INFO_TYPE, 'GitIgnore file is No Found ....')
-  }
-}
-
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import path from 'path';
+import { Logger } from '../utils/logger';
+import { generateConfigFromFile } from '../core/playwright/readConfigFile';
+const gitIgnoreAbsolutePath = path.resolve(process.cwd(), '../', '../')
+
+const { reportPath = path.resolve(process.cwd(), 'uat', 'playwright-reports') } = generateConfigFromFile();
+const testResultsPath = path.resolve(process.cwd(), 'uat', 'test-results');
+
+const testResultsRelativepath = path.relative(gitIgnoreAbsolutePath, testResultsPath)
+const reportRelativepath = path.relative(gitIgnoreAbsolutePath, reportPath)
+
+
+const absolutePathfeaturegen = path.resolve(process.cwd(), 'uat', '.features-gen');
+const featuregenRelativePath = path.relative(gitIgnoreAbsolutePath,absolutePathfeaturegen)
+
+const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}\n${featuregenRelativePath}`
+
+function updateGitIgnore() {
+  if (existsSync(path.resolve(process.cwd(), '../', '../', '.gitignore'))) {
+    let gitIgnoreData = readFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore'), 'utf-8', (err) => {
+      if (err) {
+        Logger.log(Logger.FAILURE_TYPE, 'cannot able to read git ignore ')
+        // process.exit()
+      }
+    })
+    if (gitIgnoreData.includes(dirpathtoIgnore)) {
+      return
+    } else {
+      writeFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore', dirpathtoIgnore, null, 2))
+    }
+  } else {
+    Logger.log(Logger.INFO_TYPE, 'GitIgnore file is No Found ....')
+  }
+}
+
 export default updateGitIgnore;

package/build/setup-folder-structure/samples/uat-config-sample.js

@@ -1,44 +1,44 @@
-/**
- * @typedef {Object|null} viewportConfig
- * @property {number} width - width of the viewport
- * @property {number} height - height of the viewport 
- */
-/**
- * Represents the user configuration object.
- * @typedef {Object} UserConfig
- * @property {string} headless - Headless Browsers mode.
- * @property {number} trace - trace for test cases.
- * @property {boolean} video - video for test cases,
- * @property {boolean} debug - debug mode
- * @property {string} mode: mode in which the test cases needs to run
- * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
- * @property {string} authFilePath - File Path where the cookies stored
- * @property {any} browsers: List of browsers
- * @property {string} openReportOn: default Option value (never, on-failure and always) 
- * @property {any} reportPath : directory where report is generate
- * @property {boolean} bddMode: Feature files needs to be processed
- * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
- * @property {number} testTimeout: time in milliseconds which the test should fail
- * @property {Object} additionalPages: custom pages configuration
- * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
- * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
- * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
- * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
- */
-
-/**
-* @type {UserConfig}
-*/
-module.exports = {
-  headless: false,
-  browsers: ['Chrome', 'Firefox', 'Safari', 'Edge'],
-  mode: 'dev',
-  isAuthMode: true,
-  authFilePath: 'uat/playwright/.auth/user.json',
-  trace: true,
-  video: true,
-  bddMode: true,
-  featureFilesFolder: 'feature-files',
-  stepDefinitionsFolder: 'steps',
-  viewport: { width: 1280, height: 720 }
-}
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport 
+ */
+/**
+ * Represents the user configuration object.
+ * @typedef {Object} UserConfig
+ * @property {string} headless - Headless Browsers mode.
+ * @property {number} trace - trace for test cases.
+ * @property {boolean} video - video for test cases,
+ * @property {boolean} debug - debug mode
+ * @property {string} mode: mode in which the test cases needs to run
+ * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
+ * @property {string} authFilePath - File Path where the cookies stored
+ * @property {any} browsers: List of browsers
+ * @property {string} openReportOn: default Option value (never, on-failure and always) 
+ * @property {any} reportPath : directory where report is generate
+ * @property {boolean} bddMode: Feature files needs to be processed
+ * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {Object} additionalPages: custom pages configuration
+ * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
+ * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
+ * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
+ * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
+ */
+
+/**
+* @type {UserConfig}
+*/
+module.exports = {
+  headless: false,
+  browsers: ['Chrome', 'Firefox', 'Safari', 'Edge'],
+  mode: 'dev',
+  isAuthMode: true,
+  authFilePath: 'uat/playwright/.auth/user.json',
+  trace: true,
+  video: true,
+  bddMode: true,
+  featureFilesFolder: 'feature-files',
+  stepDefinitionsFolder: 'steps',
+  viewport: { width: 1280, height: 720 }
+}

package/build/utils/cliArgsToObject.js

@@ -5,19 +5,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.cliArgsToObject = cliArgsToObject;
 exports.objectToCliArgs = objectToCliArgs;
-/**
- * Converts an array of command-line arguments into an object.
- *
- * @param {string[]} cliArgs - An array of command-line arguments.
- * @param {boolean} [isKeyNeedToBeAdded=true] - Indicates whether the keys should be added to the resulting object.
- * @returns {Object} An object representing the command-line arguments, where keys are argument names (without '--') and values are argument values.
- * If `isKeyNeedToBeAdded` is set to `false`, only values are included in the object with numeric indexes as keys.
- *
- * @example
- * // Example usage:
- * const args = ['--port=8080', '--verbose', 'input.txt'];
- * const result = cliArgsToObject(args);
- * // result will be: { port: '8080', verbose: true }
+/**
+ * Converts an array of command-line arguments into an object.
+ *
+ * @param {string[]} cliArgs - An array of command-line arguments.
+ * @param {boolean} [isKeyNeedToBeAdded=true] - Indicates whether the keys should be added to the resulting object.
+ * @returns {Object} An object representing the command-line arguments, where keys are argument names (without '--') and values are argument values.
+ * If `isKeyNeedToBeAdded` is set to `false`, only values are included in the object with numeric indexes as keys.
+ *
+ * @example
+ * // Example usage:
+ * const args = ['--port=8080', '--verbose', 'input.txt'];
+ * const result = cliArgsToObject(args);
+ * // result will be: { port: '8080', verbose: true }
  */
 // eslint-disable-next-line no-unused-vars
 function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
@@ -37,18 +37,18 @@ function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
   return processEnv;
 }
 
-/**
- * Converts an object to an array of command-line arguments.
- *
- * @param {Object} objectToBeConverted - The object to be converted to command-line arguments.
- * @param {(string|function(string): boolean)} [isKeyNeedToBeAdded=true] - A string representing a key, or a function that determines whether a key should be added to the resulting array.
- * @returns {string[]} An array of command-line arguments generated from the object's key-value pairs. Keys are transformed into argument names (with '--') and values are added as argument values.
- *
- * @example
- * // Example usage:
- * const options = { port: 8080, verbose: true, input: 'input.txt' };
- * const args = objectToCliArgs(options);
- * // args will be: ['--port=8080', '--verbose', '--input=input.txt']
+/**
+ * Converts an object to an array of command-line arguments.
+ *
+ * @param {Object} objectToBeConverted - The object to be converted to command-line arguments.
+ * @param {(string|function(string): boolean)} [isKeyNeedToBeAdded=true] - A string representing a key, or a function that determines whether a key should be added to the resulting array.
+ * @returns {string[]} An array of command-line arguments generated from the object's key-value pairs. Keys are transformed into argument names (with '--') and values are added as argument values.
+ *
+ * @example
+ * // Example usage:
+ * const options = { port: 8080, verbose: true, input: 'input.txt' };
+ * const args = objectToCliArgs(options);
+ * // args will be: ['--port=8080', '--verbose', '--input=input.txt']
  */
 function objectToCliArgs(objectToBeConverted, isKeyNeedToBeAdded) {
   const argsArray = [];

package/build/utils/fileUtils.js

@@ -5,12 +5,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.checkIfFileExists = checkIfFileExists;
+exports.createFolderSync = createFolderSync;
 exports.deleteFile = deleteFile;
 exports.deleteFolder = deleteFolder;
 exports.readFileContents = readFileContents;
 exports.writeFileContents = writeFileContents;
-var _fs = _interopRequireDefault(require("fs"));
+var _fs = _interopRequireWildcard(require("fs"));
 var _path = _interopRequireDefault(require("path"));
+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 && Object.prototype.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 checkIfFileExists(file) {
   try {
     _fs.default.accessSync(file, _fs.default.constants.F_OK);
@@ -61,4 +64,19 @@ function deleteFolder(folderPath) {
       throw new Error(`Error while deleting the test data file: ${folderPath}`);
     }
   }
+}
+function resolveFilePath(...filePath) {
+  var resolvedPath;
+  for (let i = 0; i < filePath.length; i++) {
+    resolvedPath = _path.default.resolve(resolvedPath, filePath[i]);
+  }
+  return resolvedPath;
+}
+function createFolderSync(folderPath, options = {}) {
+  if ((0, _fs.existsSync)(folderPath)) {
+    return null;
+  }
+  return (0, _fs.mkdirSync)(folderPath, {
+    recursive: true
+  });
 }

package/build/utils/getFilePath.js

@@ -4,8 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = getFilePathWithExtension;
+exports.isWindows = void 0;
 var _os = require("os");
-const isWindows = (0, _os.platform)().toLowerCase() === 'win32';
+const isWindows = exports.isWindows = (0, _os.platform)().toLowerCase() === 'win32';
 function getFilePathWithExtension(binName) {
   return isWindows ? `${binName}.cmd` : binName;
 }