@zohodesk/testinglibrary 0.1.8-exp.1 → 0.1.8-exp.10

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/context.js

@@ -4,12 +4,23 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _readConfigFile = require("../readConfigFile");
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function performDefaultContextSteps(context) {
+  if (testSetup.context) {
+    await testSetup.context(context);
+  }
+}
 var _default = exports.default = {
   context: async ({
     context
   }, use) => {
+    await context.addInitScript(() =>
     // eslint-disable-next-line no-undef
-    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
+    window.localStorage.setItem('isDnBannerHide', true));
+    await performDefaultContextSteps(context);
     await use(context);
   }
 };

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,65 @@
 "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"));
+var _readConfigFile = require("../readConfigFile");
+/* 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;
+}
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function performDefaultPageSteps(page) {
+  if (testSetup.page) {
+    await testSetup.page(page);
+  } else {
+    await page.goto(process.env.domain);
+  }
+}
 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 performDefaultPageSteps(page);
+      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 performDefaultPageSteps(page);
+      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

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

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/index.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "accountLogin", {
+  enumerable: true,
+  get: function () {
+    return _accountLogin.default;
+  }
+});
+Object.defineProperty(exports, "getListOfUsers", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getListOfUsers;
+  }
+});
+Object.defineProperty(exports, "getPrimaryUser", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getPrimaryUser;
+  }
+});
+Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getUserForSelectedEditionAndProfile;
+  }
+});
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.isCI;
+  }
+});
+Object.defineProperty(exports, "loadCookiesIfPresent", {
+  enumerable: true,
+  get: function () {
+    return _checkAuthCookies.loadCookiesIfPresent;
+  }
+});
+Object.defineProperty(exports, "performLoginSteps", {
+  enumerable: true,
+  get: function () {
+    return _loginSteps.default;
+  }
+});
+Object.defineProperty(exports, "verifyIfCookieFileExists", {
+  enumerable: true,
+  get: function () {
+    return _checkAuthCookies.verifyIfCookieFileExists;
+  }
+});
+var _accountLogin = _interopRequireDefault(require("./accountLogin"));
+var _checkAuthCookies = require("./checkAuthCookies");
+var _getUsers = require("./getUsers");
+var _loginSteps = _interopRequireDefault(require("./loginSteps"));

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/getUserFixtures.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _logger = require("../../../utils/logger");
+var _readConfigFile = require("../readConfigFile");
+function getUserFixtures() {
+  const {
+    additionalPages
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  if (additionalPages.page || additionalPages.context) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Not allowed to override the page and context fixture. Use Test Setup in uat configuration');
+  }
+  return additionalPages;
+}
+var _default = exports.default = getUserFixtures;

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
+  };
+}