@zohodesk/testinglibrary 3.1.0 → 3.1.2

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

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _page = require("./page");
+var _default = exports.default = {
+  executionContext: async ({
+    $tags
+  }, use) => {
+    let testPortalActorDetails = {
+      actorInfo: (0, _page.getCustomAccountDetails)($tags)
+    };
+    await use(testPortalActorDetails);
+  }
+};

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

@@ -11,6 +11,7 @@ var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
 var _addTags = _interopRequireDefault(require("./addTags"));
 var _i18N = _interopRequireDefault(require("./i18N"));
 var _unauthenticatedPage = _interopRequireDefault(require("./unauthenticatedPage"));
+var _executionContext = _interopRequireDefault(require("./executionContext"));
 function extractTagsFromTitle(text) {
   return text.match(/@\w+/g) || [];
 }
@@ -20,7 +21,8 @@ function getBuiltInFixtures(bddMode) {
     ..._context.default,
     ..._cacheLayer.default,
     ..._i18N.default,
-    ..._unauthenticatedPage.default
+    ..._unauthenticatedPage.default,
+    ..._executionContext.default
   };
   if (bddMode) {
     builtInFixtures = {

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+exports.getCustomAccountDetails = getCustomAccountDetails;
 var _auth = require("../helpers/auth");
 var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
@@ -57,9 +58,10 @@ var _default = exports.default = {
   page: async ({
     context,
     $tags,
-    page
+    page,
+    executionContext
   }, use, testInfo) => {
-    let testPortalDetails = getCustomAccountDetails($tags);
+    let testPortalDetails = executionContext.actorInfo;
     let testDetails = {
       page,
       $tags,

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

@@ -24,11 +24,7 @@ function getAuthFileDirectory() {
   return _path.default.resolve(_path.default.join(uatDirectory, 'playwright', '.auth'));
 }
 function verifyIfCookieFileExists(authFile) {
-  (0, _checkAuthDirectory.createAuthDirectoryIfNotExist)();
-  if (!(0, _fs.existsSync)(authFile)) {
-    console.log('creating auth file..');
-    (0, _fs.writeFileSync)(authFile, JSON.stringify(authContent, null, 2));
-  }
+  return (0, _fs.existsSync)(authFile);
 }
 function convertCookiesToParse(cookies, authFilePath) {
   try {
@@ -39,8 +35,11 @@ function convertCookiesToParse(cookies, authFilePath) {
   }
 }
 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);
+  if (verifyIfCookieFileExists(authFile)) {
+    const fileContent = (0, _fs.readFileSync)(authFile);
+    const stroageState = convertCookiesToParse(fileContent, authFile);
+    if (stroageState.cookies) {
+      await page.context().addCookies(stroageState.cookies);
+    }
+  }
 }

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

@@ -10,6 +10,7 @@ var _fileMutex = _interopRequireDefault(require("../fileMutex"));
 var _fileMutexConfig = require("../../constants/fileMutexConfig");
 var _checkAuthCookies = require("./checkAuthCookies");
 var _checkAuthDirectory = require("../checkAuthDirectory");
+var _fs = require("fs");
 /* eslint-disable no-console */
 
 async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
@@ -21,9 +22,15 @@ async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
   authFilePrefix = authFilePrefix || email;
   const authFile = _path.default.resolve(_path.default.join((0, _checkAuthCookies.getAuthFileDirectory)(), `${authFilePrefix}-cookies.json`));
   const lockFileName = email.replace(/[@.]/g, '_');
-  const fileMutex = new _fileMutex.default((0, _checkAuthDirectory.getLockDirectoryPath)(), lockFileName, email, authFile, _fileMutexConfig.fileDeletionTimeoutConfig);
+  const fileMutex = new _fileMutex.default((0, _checkAuthDirectory.getLockDirectoryPath)(), lockFileName, _fileMutexConfig.fileDeletionTimeoutConfig);
+  let loginUsingCookie = false;
   try {
-    await fileMutex.acquire();
+    if ((0, _checkAuthCookies.verifyIfCookieFileExists)(authFile)) {
+      console.log(`${email} Cookie file exists. Loading cookies, worker index - ${process.env.TEST_WORKER_INDEX}`);
+      loginUsingCookie = true;
+    } else {
+      await fileMutex.acquire();
+    }
     await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
     const isAlreadyLoggedIn = await isLoggedIn(testInfo);
     if (!isAlreadyLoggedIn) {
@@ -36,7 +43,9 @@ async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
   } catch (error) {
     console.error(`Error during login for ${email}:`, error);
   } finally {
-    await fileMutex.release();
+    if (!loginUsingCookie) {
+      await fileMutex.release();
+    }
   }
 }
 var _default = exports.default = performLoginSteps;

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

@@ -7,30 +7,24 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
 var _fs = require("fs");
-function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
-function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
-var _getLockFilePath = /*#__PURE__*/new WeakSet();
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+var _FileMutex_brand = /*#__PURE__*/new WeakSet();
 class FileMutex {
-  constructor(directory, lockFileName, email, authFile, fileDeletionTimeoutConfig) {
-    _classPrivateMethodInitSpec(this, _getLockFilePath);
+  constructor(directory, lockFileName, fileDeletionTimeoutConfig) {
+    _classPrivateMethodInitSpec(this, _FileMutex_brand);
     this.directory = directory;
     this.lockFileName = lockFileName + ".lock";
-    this.email = email;
-    this.authFile = authFile;
     this.fileDeletionTimeout = fileDeletionTimeoutConfig.timeout;
-    this.createDirectoryIfNotExist();
-    this.lockFilePath = _classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this);
+    this.lockFilePath = _assertClassBrand(_FileMutex_brand, this, _getLockFilePath).call(this);
+    _assertClassBrand(_FileMutex_brand, this, _createDirectoryIfNotExist).call(this);
   }
   async acquire() {
-    if ((0, _fs.existsSync)(this.authFile)) {
-      console.log(`${this.email} Cookie file exists. Loading cookies...`);
-      return;
-    }
     return new Promise((resolve, reject) => {
       if (!(0, _fs.existsSync)(this.lockFilePath)) {
         (0, _fs.writeFileSync)(this.lockFilePath, 'locked');
-        console.log(`Lock file created: ${this.lockFilePath}`);
+        console.log(`Lock file created: ${this.lockFilePath}, worker index - ${process.env.TEST_WORKER_INDEX}`);
         return resolve();
       }
       const timeout = setTimeout(() => {
@@ -41,7 +35,7 @@ class FileMutex {
         try {
           if (eventType === 'rename' && filename === this.lockFileName) {
             clearTimeout(timeout);
-            console.log(`Lock file deleted! Proceeding...`);
+            console.log(`Lock file deleted! Proceeding, worker index - ${process.env.TEST_WORKER_INDEX}`);
             watcher.close();
             resolve();
           }
@@ -56,21 +50,22 @@ class FileMutex {
     try {
       if ((0, _fs.existsSync)(this.lockFilePath)) {
         (0, _fs.unlinkSync)(this.lockFilePath);
-        console.log(`Lock file deleted: ${this.lockFilePath}`);
+        console.log(`Lock file deleted: ${this.lockFilePath}, worker index - ${process.env.TEST_WORKER_INDEX}`);
       }
     } catch (err) {
-      console.error(`Error deleting lock file: ${err.message}`);
-    }
-  }
-  async createDirectoryIfNotExist() {
-    if (!(0, _fs.existsSync)(this.directory)) {
-      (0, _fs.mkdirSync)(this.directory, {
-        recursive: true
-      });
+      console.error(`Error deleting lock file: ${err.message}, worker index - ${process.env.TEST_WORKER_INDEX}`);
+      throw err;
     }
   }
 }
-function _getLockFilePath2() {
+function _getLockFilePath() {
   return _path.default.resolve(_path.default.join(this.directory, this.lockFileName));
 }
+async function _createDirectoryIfNotExist() {
+  if (!(0, _fs.existsSync)(this.directory)) {
+    (0, _fs.mkdirSync)(this.directory, {
+      recursive: true
+    });
+  }
+}
 var _default = exports.default = FileMutex;

package/build/core/playwright/tagProcessor.js

@@ -1,23 +1,13 @@
 "use strict";
 
 var _logger = require("../../utils/logger");
-function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
-function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
-var _buildTagsString = /*#__PURE__*/new WeakSet();
-var _parseEdition = /*#__PURE__*/new WeakSet();
-var _processSingleEdition = /*#__PURE__*/new WeakSet();
-var _processMultipleEditions = /*#__PURE__*/new WeakSet();
-var _getEditionArgs = /*#__PURE__*/new WeakSet();
-var _buildEditionTags = /*#__PURE__*/new WeakSet();
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+var _TagProcessor_brand = /*#__PURE__*/new WeakSet();
 class TagProcessor {
   constructor(editionOrder) {
-    _classPrivateMethodInitSpec(this, _buildEditionTags);
-    _classPrivateMethodInitSpec(this, _getEditionArgs);
-    _classPrivateMethodInitSpec(this, _processMultipleEditions);
-    _classPrivateMethodInitSpec(this, _processSingleEdition);
-    _classPrivateMethodInitSpec(this, _parseEdition);
-    _classPrivateMethodInitSpec(this, _buildTagsString);
+    _classPrivateMethodInitSpec(this, _TagProcessor_brand);
     this.editionOrder = editionOrder;
   }
   processTags(userArgs) {
@@ -25,36 +15,36 @@ class TagProcessor {
     const edition = userArgs['edition'] || null;
     if (!edition) return tagArgs;
     const editionsArray = edition.split(',');
-    const editionTags = editionsArray.length === 1 ? _classPrivateMethodGet(this, _processSingleEdition, _processSingleEdition2).call(this, editionsArray[0], tagArgs) : _classPrivateMethodGet(this, _processMultipleEditions, _processMultipleEditions2).call(this, editionsArray, tagArgs);
+    const editionTags = editionsArray.length === 1 ? _assertClassBrand(_TagProcessor_brand, this, _processSingleEdition).call(this, editionsArray[0], tagArgs) : _assertClassBrand(_TagProcessor_brand, this, _processMultipleEditions).call(this, editionsArray, tagArgs);
     return editionTags;
   }
 }
-function _buildTagsString2(tags, editionTags) {
+function _buildTagsString(tags, editionTags) {
   return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
 }
-function _parseEdition2(edition) {
+function _parseEdition(edition) {
   if (edition.startsWith('<=')) return ['<=', edition.slice(2)];
   if (edition.startsWith('>=')) return ['>=', edition.slice(2)];
   if (edition.startsWith('<')) return ['<', edition.slice(1)];
   if (edition.startsWith('>')) return ['>', edition.slice(1)];
   return [null, edition];
 }
-function _processSingleEdition2(selectedEdition, tagArgs) {
-  const editionArgs = _classPrivateMethodGet(this, _getEditionArgs, _getEditionArgs2).call(this, selectedEdition);
+function _processSingleEdition(selectedEdition, tagArgs) {
+  const editionArgs = _assertClassBrand(_TagProcessor_brand, this, _getEditionArgs).call(this, selectedEdition);
   if (editionArgs && editionArgs.length > 0) {
-    const editionTags = _classPrivateMethodGet(this, _buildEditionTags, _buildEditionTags2).call(this, editionArgs, 'or');
-    return _classPrivateMethodGet(this, _buildTagsString, _buildTagsString2).call(this, tagArgs, editionTags);
+    const editionTags = _assertClassBrand(_TagProcessor_brand, this, _buildEditionTags).call(this, editionArgs, 'or');
+    return _assertClassBrand(_TagProcessor_brand, this, _buildTagsString).call(this, tagArgs, editionTags);
   }
   _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions for ${selectedEdition} found. Running with default edition`);
   return tagArgs;
 }
-function _processMultipleEditions2(editionsArray, tagArgs) {
+function _processMultipleEditions(editionsArray, tagArgs) {
   const filteredEditions = this.editionOrder.filter(edition => !editionsArray.includes(edition));
-  const editionTags = _classPrivateMethodGet(this, _buildEditionTags, _buildEditionTags2).call(this, filteredEditions, 'or');
-  return _classPrivateMethodGet(this, _buildTagsString, _buildTagsString2).call(this, tagArgs, editionTags);
+  const editionTags = _assertClassBrand(_TagProcessor_brand, this, _buildEditionTags).call(this, filteredEditions, 'or');
+  return _assertClassBrand(_TagProcessor_brand, this, _buildTagsString).call(this, tagArgs, editionTags);
 }
-function _getEditionArgs2(selectedEdition) {
-  const [operator, editionValue] = _classPrivateMethodGet(this, _parseEdition, _parseEdition2).call(this, selectedEdition.toLowerCase());
+function _getEditionArgs(selectedEdition) {
+  const [operator, editionValue] = _assertClassBrand(_TagProcessor_brand, this, _parseEdition).call(this, selectedEdition.toLowerCase());
   const index = this.editionOrder.findIndex(edition => edition.toLowerCase() === editionValue);
   if (index === -1) {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions for ${selectedEdition} found. Running with default edition`);
@@ -73,7 +63,7 @@ function _getEditionArgs2(selectedEdition) {
       return this.editionOrder.filter((_, i) => i !== index);
   }
 }
-function _buildEditionTags2(editionArgs, operator = 'or') {
+function _buildEditionTags(editionArgs, operator = 'or') {
   return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
 }
 module.exports = TagProcessor;

package/build/test/core/playwright/buildInFixtures/__tests__/executionContext.test.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _page = require("../../../../../core/playwright/builtInFixtures/page");
+var _executionContext = _interopRequireDefault(require("../../../../../core/playwright/builtInFixtures/executionContext"));
+jest.mock('../../../../../core/playwright/builtInFixtures/page');
+describe('executionContext', () => {
+  test('should pass actorInfo with details from getCustomAccountDetails to use', async () => {
+    const mockTags = ['tag1', 'tag2'];
+    const mockActorInfo = {
+      id: '1',
+      edition: 'enterprise',
+      orgName: 'orgName',
+      profile: 'admin',
+      email: 'xxx.x+uat@zohotest.com'
+    };
+    _page.getCustomAccountDetails.mockReturnValue(mockActorInfo);
+    const use = jest.fn();
+    await _executionContext.default.executionContext({
+      $tags: mockTags
+    }, use);
+    expect(_page.getCustomAccountDetails).toHaveBeenCalledWith(mockTags);
+    expect(use).toHaveBeenCalledWith({
+      actorInfo: mockActorInfo
+    });
+  });
+});

package/build/test/core/playwright/helpers/__tests__/fileMutex.test.js

@@ -8,8 +8,6 @@ jest.mock('fs');
 describe('FileMutex', () => {
   const directory = '/tmp/locks';
   const lockFileName = 'test-lock';
-  const email = 'test@example.com';
-  const authFile = '/tmp/authFile';
   const fileDeletionTimeoutConfig = {
     timeout: 1000
   };
@@ -17,27 +15,14 @@ describe('FileMutex', () => {
   let fileMutex;
   beforeEach(() => {
     jest.clearAllMocks();
-    fileMutex = new _fileMutex.default(directory, lockFileName, email, authFile, fileDeletionTimeoutConfig);
+    fileMutex = new _fileMutex.default(directory, lockFileName, fileDeletionTimeoutConfig);
   });
   describe('acquire', () => {
-    it('should create directory if it does not exist', async () => {
-      _fs.existsSync.mockReturnValue(false);
-      await fileMutex.createDirectoryIfNotExist();
-      expect(_fs.mkdirSync).toHaveBeenCalledWith(directory, {
-        recursive: true
-      });
-    });
     it('should create the lock file if it does not exist', async () => {
-      _fs.existsSync.mockImplementation(filePath => filePath === authFile ? false : false);
       _fs.writeFileSync.mockImplementation(() => {});
       await fileMutex.acquire();
       expect(_fs.writeFileSync).toHaveBeenCalledWith(fileMutex.lockFilePath, 'locked');
     });
-    it('should resolve immediately if auth file exists', async () => {
-      _fs.existsSync.mockImplementation(filePath => filePath === authFile);
-      await fileMutex.acquire();
-      expect(_fs.existsSync).toHaveBeenCalledWith(authFile);
-    });
     it('should wait for lock file deletion if it exists', async () => {
       _fs.existsSync.mockImplementation(filePath => filePath === fileMutex.lockFilePath);
       _fs.watch.mockImplementation((dir, callback) => {
@@ -88,9 +73,7 @@ describe('FileMutex', () => {
       _fs.unlinkSync.mockImplementation(() => {
         throw new Error(errorMessage);
       });
-      console.error = jest.fn();
-      await fileMutex.release();
-      expect(console.error).toHaveBeenCalledWith(`Error deleting lock file: ${errorMessage}`);
+      await expect(fileMutex.release()).rejects.toThrow(errorMessage);
     });
   });
 });