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

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

@@ -16,6 +16,7 @@ var _mergeObjects = require("./helpers/mergeObjects");
 
 function getDefaultConfig() {
   return {
+    uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],
     trace: false,
@@ -65,6 +66,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
 /**
  * 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,

package/build/lib/post-install.js

@@ -5,7 +5,7 @@ var _path = _interopRequireDefault(require("path"));
 var _child_process = require("child_process");
 var _logger = require("../utils/logger");
 var _rootPath = require("../utils/rootPath");
-// We are adding NODE_ENV to production in react-cli
+// 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;

package/changelog.md

@@ -7,6 +7,7 @@
 - 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-exp.6",
+  "version": "0.1.8-exp.7",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.8-exp.6",
+  "version": "0.1.8-exp.7",
   "description": "",
   "main": "./build/index.js",
   "scripts": {