@zohodesk/testinglibrary 0.1.8-exp.5 → 0.1.8-exp.7

package/.babelrc

@@ -6,6 +6,8 @@
         "targets": {
           "node": "14"
         },
+        // We are adding plugin @babel/plugin-transform-destructuring to ensure babel does not transform the destructing 
+        // as playwright does not allow parameters without destrucring
         "exclude": ["@babel/plugin-transform-destructuring"]
       }
     ]
@@ -13,6 +15,7 @@
   "plugins": [
       ["@babel/plugin-transform-runtime"]
   ],
+  // Ignored as these are setup files needed during init script. Files inside that folder are copied not transformed
   "ignore": [
     "./src/setup-folder-structure/samples"
   ]

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

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/* eslint-disable no-undef */
+/* eslint-disable no-param-reassign */
+
+// Note: We are duplicating below method from @zohodesk/i18n. We are not importing it as react package not yet availble in test environment.
+function replaceI18NValuesWithRegex(i18nStr, values) {
+  if (typeof values !== 'undefined') {
+    if (Array.isArray(values)) {
+      for (let i = 0; i < values.length; i++) {
+        i18nStr = i18nStr.replace(new RegExp(`\\{${i}\\}`, 'g'), values[i]);
+      }
+    } else {
+      i18nStr = i18nStr.replace(new RegExp('\\{0\\}', 'g'), values);
+    }
+  }
+  return i18nStr;
+}
+var _default = exports.default = {
+  i18N: async ({
+    page
+  }, use) => {
+    await use(async (key, values) => {
+      const i18nValue = await page.evaluate(i18nKey => window.i18n[i18nKey], key);
+      const i18nStr = replaceI18NValuesWithRegex(i18nValue, values);
+      return i18nStr;
+    });
+  }
+};

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

@@ -9,11 +9,15 @@ var _page = _interopRequireDefault(require("./page"));
 var _context = _interopRequireDefault(require("./context"));
 var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
 var _addTags = _interopRequireDefault(require("./addTags"));
+var _i18N = _interopRequireDefault(require("./i18N"));
+var _unauthenticatedPage = _interopRequireDefault(require("./unauthenticatedPage"));
 function getBuiltInFixtures(bddMode) {
   let builtInFixtures = {
     ..._page.default,
     ..._context.default,
-    ..._cacheLayer.default
+    ..._cacheLayer.default,
+    ..._i18N.default,
+    ..._unauthenticatedPage.default
   };
   if (bddMode) {
     builtInFixtures = {

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

@@ -1,51 +1,54 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-// function test(descrition, callback) {
-//   return test(descrition, ({ page }) => {
-//     const { locator, ...custompage } = page
-//     callback({ page: custompage })
-//   })
-// }
-// class FilteredPage {
-//   constructor(page) {
-//     this.page = page;
-//     this.allowedMethods = ['getByText', 'getByTitle'];
-//     this.context = page.context;
-//   }
-//   goto(...args) {
-//     return this.page['goto'](...args);
-//   }
-//   getByRole(...args) {
-//     return this.page['getByRole'](...args);
-//   }
-// }
-// function FilteredPage(page) {
-//   return {
-//     getByRole: () => {
-//       throw new Error('You cannnot use getByRole property')
-//     }
-//   }
-// }
+var _getUsers = require("../helpers/auth/getUsers");
+var _loginSteps = _interopRequireDefault(require("../helpers/auth/loginSteps"));
+/* eslint-disable global-require */
+
+function getTagInputFromSelectedTags(tags, inputString) {
+  const selectedTag = tags.find(tag => tag.startsWith(inputString));
+  let tagInput = null;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  return tagInput;
+}
+function getCustomAccountDetails(tags) {
+  const filteredTags = tags.filter(tag => tag.startsWith('@profile') || tag.startsWith('@edition') || tag.startsWith('@profile') || tag.startsWith('@darkLaunch'));
+  if (filteredTags && filteredTags.length > 0) {
+    const selectedProfile = getTagInputFromSelectedTags(filteredTags, '@profile');
+    const selectedEdition = getTagInputFromSelectedTags(filteredTags, '@edition');
+    const darkLaunchFeature = getTagInputFromSelectedTags(filteredTags, '@darkLaunch');
+    const user = (0, _getUsers.getUserForSelectedEditionAndProfile)(selectedEdition, selectedProfile, darkLaunchFeature);
+    return user;
+  }
+  return null;
+}
 var _default = exports.default = {
   page: async ({
+    context,
+    $tags,
     page
   }, use) => {
-    page.getBaseUrl = function () {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}`;
-    };
-    page.getCustomPageUrl = function (url) {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}/${url}`;
-    };
-    await use(page);
+    const customAccountDetails = getCustomAccountDetails($tags);
+    if (customAccountDetails === null) {
+      await page.goto(process.env.domain);
+      await use(page);
+    } else {
+      await context.clearCookies();
+      await (0, _loginSteps.default)({
+        page,
+        role: `${customAccountDetails.role}-${customAccountDetails.edition}`,
+        useremail: customAccountDetails.email,
+        password: customAccountDetails.password
+      }, async () => page.url().includes(process.env.domain));
+      await page.goto(process.env.domain);
+      await use(page);
+      await context.close();
+    }
   }
 };

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

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  unauthenticatedPage: async ({
+    browser
+  }, use) => {
+    const context = await browser.newContext({
+      storageState: null
+    });
+    const unauthenticatedPage = await context.newPage();
+    await use(unauthenticatedPage);
+    await context.close();
+  }
+};

package/build/core/playwright/clear-caches.js

@@ -9,21 +9,32 @@ var _path = _interopRequireDefault(require("path"));
 var _fileUtils = require("../../utils/fileUtils");
 var _logger = require("../../utils/logger");
 var _readConfigFile = require("./readConfigFile");
+function deleteAuthFiles(authFilePath) {
+  authFilePath.split('/').pop();
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting auth files present in ${authFilePath}`);
+  (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), authFilePath));
+}
+function deletePlaywrightReport(reportPath) {
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting Playwright report ${reportPath}`);
+  (0, _fileUtils.deleteFolder)(reportPath);
+}
+function deleteGeneratedFeatures() {
+  const featuresGenPath = _path.default.resolve(process.cwd(), 'uat', '.features-gen');
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting generated features at ${featuresGenPath}`);
+  (0, _fileUtils.deleteFolder)(featuresGenPath);
+}
 function clearCaches() {
   try {
     const {
       authFilePath,
       reportPath
     } = (0, _readConfigFile.generateConfigFromFile)();
-    authFilePath.split('/').pop();
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting auth files present in ${authFilePath}`);
-    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), authFilePath));
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting Playwright report ${reportPath}`);
-    (0, _fileUtils.deleteFolder)(reportPath);
-    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), 'uat', '.features-gen'));
-    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared');
+    deleteAuthFiles(authFilePath);
+    deletePlaywrightReport(reportPath);
+    deleteGeneratedFeatures();
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared. Now you can try running npm run uat');
   } catch (err) {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error While clearing cookies');
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error While clearing cookies. Try manually delete folder uat/playwright and uat/playwright-report');
   }
 }
 var _default = exports.default = clearCaches;

package/build/core/playwright/codegen.js

@@ -9,11 +9,11 @@ var _child_process = require("child_process");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _rootPath = require("../../utils/rootPath");
-const userArgs = process.argv.slice(3);
-const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-const command = playwrightPath;
-const args = ['codegen'].concat(userArgs);
 function generateCodegen() {
+  const domainUrl = process.argv.slice(3);
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const args = ['codegen'].concat(domainUrl);
   const childProcess = (0, _child_process.spawn)(command, args, {
     stdio: 'inherit'
   });

package/build/core/playwright/constants/browserTypes.js

@@ -3,11 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SAFARI = exports.FIREFOX = exports.EDGE = exports.CHROME = exports.BROWSER_PROJECT_MAPPING = void 0;
-const CHROME = exports.CHROME = 'chromium';
-const EDGE = exports.EDGE = 'Microsoft Edge';
-const FIREFOX = exports.FIREFOX = 'firefox';
-const SAFARI = exports.SAFARI = 'webkit';
+exports.BROWSER_PROJECT_MAPPING = void 0;
 const BROWSER_PROJECT_MAPPING = exports.BROWSER_PROJECT_MAPPING = {
   CHROME: 'chromium',
   EDGE: 'Microsoft Edge',

package/build/core/playwright/env-initializer.js

@@ -7,15 +7,19 @@ Object.defineProperty(exports, "__esModule", {
 exports.initializeEnvConfig = initializeEnvConfig;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
+var _configFileNameProvider = require("./helpers/configFileNameProvider");
+function setEnvironmentVariables(mode, configJSON) {
+  process.env.mode = mode;
+  for (const key in configJSON[mode]) {
+    process.env[key] = configJSON[mode][key];
+  }
+}
 function initializeEnvConfig(mode = 'dev') {
   try {
-    const configFile = (0, _fs.readFileSync)(_path.default.resolve(process.cwd(), './uat/env-config.json'));
+    const configFile = (0, _fs.readFileSync)(_path.default.resolve(process.cwd(), `./${(0, _configFileNameProvider.getEnvConfigFilePath)()}`));
     const configJSON = JSON.parse(configFile);
-    process.env.mode = mode;
-    for (const key in configJSON[mode]) {
-      process.env[key] = configJSON[mode][key];
-    }
+    setEnvironmentVariables(mode, configJSON);
   } catch (err) {
-    throw new Error('Config File Not Exists. Please provide a config file to intiailize the environment variables');
+    throw new Error(`Config File Not Exists. Please provide a config file ${(0, _configFileNameProvider.getEnvConfigFilePath)()} to intiailize the environment variables`);
   }
 }

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

@@ -0,0 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _getUrlOrigin = _interopRequireDefault(require("./getUrlOrigin"));
+async function accountLogin(page, useremail, password) {
+  await page.locator('#login_id').fill(useremail);
+  await page.locator('#nextbtn').click();
+  await page.locator('#password').fill(password);
+  await page.locator('#nextbtn').click();
+  const domainUrlOrigin = (0, _getUrlOrigin.default)(process.env.domain);
+  await page.waitForNavigation();
+  await Promise.race([page.waitForURL(`${domainUrlOrigin}/**`), page.waitForURL('**/announcement/**')]);
+}
+var _default = exports.default = accountLogin;

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

@@ -0,0 +1,47 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.authDirectory = void 0;
+exports.loadCookiesIfPresent = loadCookiesIfPresent;
+exports.verifyIfCookieFileExists = verifyIfCookieFileExists;
+var _path = _interopRequireDefault(require("path"));
+var _fs = require("fs");
+var _readConfigFile = require("../../readConfigFile");
+/* eslint-disable no-console */
+
+const {
+  uatDirectory
+} = (0, _readConfigFile.generateConfigFromFile)();
+const authDirectory = exports.authDirectory = _path.default.resolve(_path.default.join(uatDirectory, 'playwright', '.auth'));
+const authContent = {
+  cookies: []
+};
+function verifyIfCookieFileExists(authFile) {
+  if (!(0, _fs.existsSync)(authDirectory)) {
+    console.log('Creating auth directory for the first time setup...');
+    (0, _fs.mkdirSync)(authDirectory, {
+      recursive: true
+    });
+  }
+  if (!(0, _fs.existsSync)(authFile)) {
+    console.log('creating auth file..');
+    (0, _fs.writeFileSync)(authFile, JSON.stringify(authContent, null, 2));
+  }
+}
+function convertCookiesToParse(cookies, authFilePath) {
+  try {
+    return JSON.parse(cookies);
+  } catch (err) {
+    throw new Error(` Error while parsing cookies ${err} \n${_path.default.resolve(process.cwd(), authFilePath)} File is Empty`);
+    // process.exit()
+  }
+}
+async function loadCookiesIfPresent(page, authFile) {
+  verifyIfCookieFileExists(authFile);
+  const cookies = (0, _fs.readFileSync)(authFile);
+  const parsedCookies = convertCookiesToParse(cookies, authFile);
+  await page.context().addCookies(parsedCookies.cookies === undefined ? [] : parsedCookies.cookies);
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+function getUrlOrigin(url) {
+  const {
+    origin
+  } = new URL(url);
+  return origin;
+}
+var _default = exports.default = getUrlOrigin;

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

@@ -0,0 +1,72 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getListOfUsers = getListOfUsers;
+exports.getPrimaryUser = getPrimaryUser;
+exports.getUserForSelectedEditionAndProfile = getUserForSelectedEditionAndProfile;
+exports.isCI = isCI;
+var _path = _interopRequireDefault(require("path"));
+var _readConfigFile = require("../../readConfigFile");
+/* eslint-disable global-require */
+function isCI() {
+  return process.env.mode === 'CI' || process.env.mode === 'ci';
+}
+function getListOfUsers() {
+  let users;
+  const {
+    uatDirectory
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  if (isCI()) {
+    users = require(_path.default.join(uatDirectory, 'conf/ci/actors/index'));
+  } else {
+    users = require(_path.default.join(uatDirectory, '.conf/dev/actors/index'));
+  }
+  return users;
+}
+function getPrimaryUser() {
+  let primaryUser;
+  const {
+    uatDirectory
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  if (isCI()) {
+    primaryUser = require(_path.default.join(uatDirectory, 'conf/ci/settings.json'));
+  } else {
+    primaryUser = require(_path.default.join(uatDirectory, 'conf/dev/settings.json'));
+  }
+  return primaryUser;
+}
+function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, darkLaunchFeature) {
+  const {
+    editions: userdata,
+    darkLaunch
+  } = getListOfUsers();
+  const primaryUser = getPrimaryUser();
+  const edition = preferedEdition || primaryUser.edition;
+  const profile = preferredProfile || primaryUser.role;
+  let selectedProfile = {};
+  if (darkLaunchFeature && darkLaunchFeature !== null) {
+    const {
+      profiles: darkLaunchProfiles,
+      ...darkLaunchEditionData
+    } = darkLaunch[darkLaunchFeature] ? darkLaunch[darkLaunchFeature][0] : {};
+    selectedProfile = darkLaunchProfiles.find(user => user.role === profile);
+    return {
+      ...darkLaunchEditionData,
+      ...selectedProfile
+    };
+  }
+  // TODO: We are returning the first data from array. We need to check the possiblity of having multiple users for same role and possibly round robin
+  // For this we need to get the data from ci environment.
+  const {
+    profiles,
+    ...editionData
+  } = userdata[edition] ? userdata[edition][0] : {};
+  selectedProfile = profiles.find(user => user.role === profile);
+  return {
+    ...editionData,
+    ...selectedProfile
+  };
+}

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

@@ -0,0 +1,36 @@
+"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 _accountLogin = _interopRequireDefault(require("./accountLogin"));
+var _checkAuthCookies = require("./checkAuthCookies");
+/* eslint-disable no-console */
+
+async function performLoginSteps({
+  page,
+  role,
+  useremail,
+  password
+}, isLoggedIn) {
+  const authFile = _path.default.resolve(_path.default.join(_checkAuthCookies.authDirectory, `${role}-cookies.json`));
+  await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
+  await page.goto(process.env.domain);
+  await page.waitForNavigation();
+  const loginStatus = await isLoggedIn(page);
+  if (!loginStatus) {
+    await (0, _accountLogin.default)(page, useremail, password);
+    await page.goto(process.env.domain);
+
+    // await page.waitForLoadState();
+
+    await isLoggedIn(page);
+    await page.context().storageState({
+      path: authFile
+    });
+  }
+}
+var _default = exports.default = performLoginSteps;

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getEnvConfigFilePath = getEnvConfigFilePath;
+exports.getUATFileName = getUATFileName;
+function getUATFileName() {
+  return 'uat.config.js';
+}
+function getEnvConfigFilePath() {
+  return `uat/env-config.json`;
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergeObjects = mergeObjects;
+// Utility function to merge objects using spread operator
+function mergeObjects(obj1, obj2) {
+  return {
+    ...obj1,
+    ...obj2
+  };
+}

package/build/core/playwright/readConfigFile.js

@@ -4,16 +4,19 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.fileName = void 0;
 exports.generateConfigFromFile = generateConfigFromFile;
 exports.getAuthFilePath = getAuthFilePath;
 exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
-const fileName = exports.fileName = 'uat.config.js';
+var _configFileNameProvider = require("./helpers/configFileNameProvider");
+var _mergeObjects = require("./helpers/mergeObjects");
+// const fileName = 'uat.config.js';
+
 function getDefaultConfig() {
   return {
+    uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],
     trace: false,
@@ -51,21 +54,19 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `key - ${configKey} is not yet supported in uat configuration. This will not be used while creating playwright configuration`);
     }
   });
-  return {
-    ...defaultConfig,
-    ...configurationObj
-  };
+  return (0, _mergeObjects.mergeObjects)(defaultConfig, configurationObj);
 }
 
 /**
  * @typedef {Object|null} viewportConfig
  * @property {number} width - width of the viewport
- * @property {number} height - height of the viewport 
+ * @property {number} height - height of the viewport
  */
 
 /**
  * Represents the user configuration object.
  * @typedef {Object} UserConfig
+ * @property {string} uatDirectory - Directory in which uat configuration is places.
  * @property {string} headless - Headless Browsers mode.
  * @property {number} trace - trace for test cases.
  * @property {boolean} video - video for test cases,
@@ -74,7 +75,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @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 {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
@@ -91,9 +92,9 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * Generates a configuration object from a file, if it exists.
  *
  * @returns {UserConfig}
-*/
+ */
 function generateConfigFromFile() {
-  const filePath = _path.default.resolve(process.cwd(), fileName);
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     /** @type {UserConfig} */
     const config = require(filePath);
@@ -103,7 +104,7 @@ function generateConfigFromFile() {
   return {};
 }
 function isUserConfigFileAvailable() {
-  const filePath = _path.default.resolve(process.cwd(), fileName);
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }

package/build/core/playwright/report-generator.js

@@ -10,15 +10,15 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _rootPath = require("../../utils/rootPath");
 var _readConfigFile = require("./readConfigFile");
-const userArgs = process.argv.slice(3);
-const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-const command = playwrightPath;
-const {
-  reportPath: htmlPath
-} = (0, _readConfigFile.generateConfigFromFile)();
-const args = ['show-report', htmlPath].concat(userArgs);
 async function generateReport() {
   // await preProcessReport()
+  const userArgs = process.argv.slice(3);
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const {
+    reportPath: htmlPath
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  const args = ['show-report', htmlPath].concat(userArgs);
   const childProcess = (0, _child_process.spawn)(command, args, {
     stdio: 'inherit'
   });

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

@@ -9,7 +9,7 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
-const defaultBrowsers = ['Chrome', 'Firefox', 'Edge', 'Safari'];
+const defaultCIBrowsers = ['Chrome', 'Firefox', 'Edge', 'Safari'];
 const {
   browsers,
   trace,
@@ -26,7 +26,7 @@ const {
   stepDefinitionsFolder,
   testIdAttribute
 } = (0, _readConfigFile.generateConfigFromFile)();
-const browserList = process.env.mode === 'ci' ? defaultBrowsers : browsers;
+const browserList = process.env.mode === 'ci' ? defaultCIBrowsers : browsers;
 const projects = (0, _configUtils.getProjects)({
   browsers: browserList,
   isAuthMode,

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

@@ -116,7 +116,7 @@ function getBrowsersList(browserFromArgs) {
   if (browserFromArgs) {
     if (typeof browserFromArgs === 'string') {
       let listOfbrowsers = browserFromArgs.split(',').map(browser => browser.trim().toLowerCase());
-      _logger.Logger.log(_logger.Logger.INFO_TYPE, '');
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Using browsers from command line args');
       return listOfbrowsers;
     }
   }

package/build/index.js

@@ -23,17 +23,6 @@ Object.defineProperty(exports, "test", {
   }
 });
 var _index = require("./core/playwright/index");
-// const { expect, test, createBdd } = require('./core/playwright/index');
-// const { fireEvent, render } = require('@testing-library/react');
-
-// module.exports = {
-//   expect,
-//   test,
-//   fireEvent,
-//   render,
-//   createBdd
-// }
-
 // import { fireEvent, render } from '@testing-library/react';
 
 const {

package/build/lib/cli.js

@@ -12,9 +12,6 @@ var _helper = _interopRequireDefault(require("../setup-folder-structure/helper")
 // import createJestRunner from '../core/jest/runner/jest-runner';
 
 const [,, option, ...otherOptions] = process.argv;
-// const args = process.argv.slice(3);
-// const appPath = process.cwd();
-
 switch (option) {
   case 'test':
     {

package/build/lib/post-install.js

@@ -5,13 +5,18 @@ var _path = _interopRequireDefault(require("path"));
 var _child_process = require("child_process");
 var _logger = require("../utils/logger");
 var _rootPath = require("../utils/rootPath");
-const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-const command = playwrightPath;
-const args = ['install'];
-_logger.Logger.log(_logger.Logger.INFO_TYPE, 'Downloading browsers for running tests');
-const childProcess = (0, _child_process.spawn)(command, args, {
-  stdio: 'inherit'
-});
-childProcess.on('error', error => {
-  _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
-});
+// We are skipping the download of browsers when NODE_ENV is set to production or flag SKIP_BROWSER_DOWNLOAD is set to true
+if (process.env.NODE_ENV !== 'production' || process.env.SKIP_BROWSER_DOWNLOAD === true) {
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const args = ['install'];
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Downloading browsers for running tests');
+  const childProcess = (0, _child_process.spawn)(command, args, {
+    stdio: 'inherit'
+  });
+  childProcess.on('error', error => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+  });
+} else {
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Skipping browsers download in production mode');
+}

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

@@ -29,6 +29,7 @@ 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('--edition', 'Specify edition to run the test cases (Usage: -- --edition="standard". This will run the test cases with either no edition mentioned or edition standard)');
   _commander.program.option('--browsers', 'Specify the browsers on which the test case should run (Usage: -- --browsers="chrome,firefox,safari")');
   _commander.program.parse(process.argv);
 }

package/build/utils/cliArgsToObject.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.cliArgsToObject = cliArgsToObject;
 exports.objectToCliArgs = objectToCliArgs;
+function isMatchForOption(option) {
+  return /^--./.test(option);
+}
+
 /**
  * Converts an array of command-line arguments into an object.
  *
@@ -23,7 +27,7 @@ exports.objectToCliArgs = objectToCliArgs;
 function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
   const processEnv = {};
   cliArgs.forEach(option => {
-    if (/^--./.test(option)) {
+    if (isMatchForOption(option)) {
       const equIndex = option.indexOf('=');
       let key = option.slice(2, equIndex);
       let value = option.slice(equIndex + 1);

package/build/utils/fileUtils.js

@@ -11,6 +11,7 @@ exports.readFileContents = readFileContents;
 exports.writeFileContents = writeFileContents;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
+var _logger = require("./logger");
 function checkIfFileExists(file) {
   try {
     _fs.default.accessSync(file, _fs.default.constants.F_OK);
@@ -49,6 +50,8 @@ function deleteFile(filePath) {
     } catch (err) {
       throw new Error(`Error while deleting the test data file: ${filePath}`);
     }
+  } else {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `File Does not Exist in the path ${filePath}`);
   }
 }
 function deleteFolder(folderPath) {

package/build/utils/rootPath.js

@@ -12,24 +12,31 @@ var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
 var _logger = require("./logger");
 var _getFilePath = _interopRequireDefault(require("./getFilePath"));
-function findBinaryPath(directory, command) {
-  const binaryPath = _path.default.join(directory, '.bin', (0, _getFilePath.default)(command));
-  if (_fs.default.existsSync(binaryPath)) {
-    return binaryPath;
+// TODO: Publish and check this change of finding package.json working fine.
+function findPath(directory, pathToFind) {
+  const filePath = _path.default.join(directory, pathToFind);
+  if (_fs.default.existsSync(filePath)) {
+    return filePath;
   }
-
-  // Recursively search parent directories. Might be time-consuming ?? Can we look for npm module like which?
   const parentDir = _path.default.dirname(directory);
   if (parentDir === directory) {
     return null;
   }
-  return findBinaryPath(parentDir, command);
+  return findPath(parentDir, pathToFind);
+}
+function findPackageJSON(startDir) {
+  return findPath(startDir, 'package.json');
+}
+function findBinaryPath(directory, command) {
+  const binaryPath = _path.default.join('.bin', (0, _getFilePath.default)(command));
+  return findPath(directory, binaryPath);
 }
 function getRootPath() {
-  return _path.default.resolve(__dirname, '../', '../');
+  return findPackageJSON(_path.default.resolve(__dirname));
 }
 function getRootNodeModulesPath() {
-  return _path.default.resolve(getRootPath(), 'node_modules');
+  const rootPath = getRootPath();
+  return _path.default.resolve(_path.default.dirname(rootPath), 'node_modules');
 }
 function getBinPath(command) {
   const packageNodeModulesPath = getRootNodeModulesPath();

package/changelog.md

@@ -6,6 +6,8 @@
 **Enhancements**
 - Added option to specify browsers in command line.
   - npm run uat -- --browsers='chrome,firefox'
+- Playwright version updated to 1.41.1
+- Added option to Skip Browser download
 
 # 0.1.8
 **Issue Fixes**

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.8",
+  "version": "0.1.8-exp.7",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2074,11 +2074,11 @@
       "integrity": "sha512-Aq58f5HiWdyDlFffbbSjAlv596h/cOnt2DO1w3DOC7OJ5EHs0hd/nycJfiu9RJbT6Yk6F1knnRRXNSpxoIVZ9Q=="
     },
     "@playwright/test": {
-      "version": "1.40.1",
-      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.40.1.tgz",
-      "integrity": "sha512-EaaawMTOeEItCRvfmkI9v6rBkF1svM8wjl/YPRrg2N2Wmp+4qJYkWtJsbew1szfKKDm6fPLy4YAanBhIlf9dWw==",
+      "version": "1.41.2",
+      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.41.2.tgz",
+      "integrity": "sha512-qQB9h7KbibJzrDpkXkYvsmiDJK14FULCCZgEcoe2AvFAS64oCirWTwzTlAYEbKaRxWs5TFesE1Na6izMv3HfGg==",
       "requires": {
-        "playwright": "1.40.1"
+        "playwright": "1.41.2"
       }
     },
     "@sinclair/typebox": {
@@ -5387,18 +5387,18 @@
       }
     },
     "playwright": {
-      "version": "1.40.1",
-      "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.40.1.tgz",
-      "integrity": "sha512-2eHI7IioIpQ0bS1Ovg/HszsN/XKNwEG1kbzSDDmADpclKc7CyqkHw7Mg2JCz/bbCxg25QUPcjksoMW7JcIFQmw==",
+      "version": "1.41.2",
+      "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.41.2.tgz",
+      "integrity": "sha512-v0bOa6H2GJChDL8pAeLa/LZC4feoAMbSQm1/jF/ySsWWoaNItvrMP7GEkvEEFyCTUYKMxjQKaTSg5up7nR6/8A==",
       "requires": {
         "fsevents": "2.3.2",
-        "playwright-core": "1.40.1"
+        "playwright-core": "1.41.2"
       }
     },
     "playwright-core": {
-      "version": "1.40.1",
-      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.40.1.tgz",
-      "integrity": "sha512-+hkOycxPiV534c4HhpfX6yrlawqVUzITRKwHAmYfmsVreltEl6fAZJ3DPfLMOODw0H3s1Itd6MDCWmP1fl/QvQ=="
+      "version": "1.41.2",
+      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.41.2.tgz",
+      "integrity": "sha512-VaTvwCA4Y8kxEe+kfm2+uUUw5Lubf38RxF7FpBxLPmGe5sdNkSg5e3ChEigaGrX7qdqT3pt2m/98LiyvU2x6CA=="
     },
     "pretty-format": {
       "version": "29.7.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.8-exp.5",
+  "version": "0.1.8-exp.7",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   "dependencies": {
     "@babel/preset-react": "7.22.5",
     "@cucumber/cucumber": "9.2.0",
-    "@playwright/test": "1.40.1",
+    "@playwright/test": "1.41.2",
     "@testing-library/jest-dom": "5.11.9",
     "@testing-library/react": "11.2.7",
     "@testing-library/react-hooks": "7.0.2",
@@ -32,7 +32,7 @@
     "jest": "29.6.2",
     "jest-environment-jsdom": "29.6.2",
     "msw": "1.2.3",
-    "playwright": "1.40.1"
+    "playwright": "1.41.2"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"