@zohodesk/testinglibrary 2.9.1 → 2.9.2

package/.gitlab-ci.yml

@@ -1,29 +1,35 @@
 image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
 
-#workflow:
-#  rules:
-#    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: always
+    - if: $CI_PIPELINE_SOURCE == "web"
+      when: always
 
 stages:
   - build
   - unit
   - uat
 
+default:
+  cache:
+    key: build-cache
+    paths:
+      - node_modules
+      - build
+
 # Install dependencies stage
 build:
   stage: build
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
+    - npm install --ignore-scripts
+    - npm run build
     - npm install
-  artifacts:
-    paths:
-      - node_modules/
-
 
 # Unit tests stage
 unit:
   stage: unit
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
     - npm run test
   artifacts:
@@ -34,10 +40,7 @@ unit:
 # UAT tests stage
 uat-auth:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
-    - npm install 
-    - npm run build
     - cd examples
     - npm install $(npm pack ../../testing-framework | tail -1)
     - output=$(npm run uatauth)
@@ -53,10 +56,7 @@ uat-auth:
 
 uat-noauth:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
-    - npm install 
-    - npm run build
     - cd examples
     - npm install $(npm pack ../../testing-framework | tail -1)
     - output=$(npm run uatnoauth)
@@ -72,10 +72,7 @@ uat-noauth:
     
 uat-profile:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
-    - npm install 
-    - npm run build
     - cd examples
     - npm install $(npm pack ../../testing-framework | tail -1)
     - output=$(npm run uatprofile)
@@ -91,10 +88,7 @@ uat-profile:
 
 uat-nobdd:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
-    - npm install 
-    - npm run build
     - cd nobdd
     - npm install $(npm pack ../../testing-framework | tail -1)
     - output=$(npm run uatnobdd)
@@ -108,4 +102,3 @@ uat-nobdd:
     when: always
     paths:
       - nobdd/uat/playwright-report
-

package/README.md

@@ -38,3 +38,8 @@
 
 #### Enhancement
    - Beta feature Actors and edition configurations are unified 
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+    - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.

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

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.LOGIN_MUTEX_TIMEOUT = void 0;
+const LOGIN_MUTEX_TIMEOUT = exports.LOGIN_MUTEX_TIMEOUT = {
+  "wait": 5000,
+  "retries": 5,
+  "stale": 300000
+};

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

@@ -10,6 +10,7 @@ exports.verifyIfCookieFileExists = verifyIfCookieFileExists;
 var _path = _interopRequireDefault(require("path"));
 var _fs = require("fs");
 var _readConfigFile = require("../../readConfigFile");
+var _checkAuthDirectory = require("../checkAuthDirectory");
 var _logger = require("../../../../utils/logger");
 /* eslint-disable no-console */
 
@@ -23,13 +24,7 @@ function getAuthFileDirectory() {
   return _path.default.resolve(_path.default.join(uatDirectory, 'playwright', '.auth'));
 }
 function verifyIfCookieFileExists(authFile) {
-  const authDirectory = getAuthFileDirectory();
-  if (!(0, _fs.existsSync)(authDirectory)) {
-    console.log('Creating auth directory for the first time setup...');
-    (0, _fs.mkdirSync)(authDirectory, {
-      recursive: true
-    });
-  }
+  (0, _checkAuthDirectory.createAuthDirectoryIfNotExist)();
   if (!(0, _fs.existsSync)(authFile)) {
     console.log('creating auth file..');
     (0, _fs.writeFileSync)(authFile, JSON.stringify(authContent, null, 2));
@@ -41,7 +36,6 @@ function convertCookiesToParse(cookies, authFilePath) {
   } catch (err) {
     _logger.Logger.error(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) {

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

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
+var _fileMutex = _interopRequireDefault(require("../fileMutex"));
+var _fileMutexConfig = require("../../constants/fileMutexConfig");
 var _accountLogin = _interopRequireDefault(require("./accountLogin"));
 var _checkAuthCookies = require("./checkAuthCookies");
 /* eslint-disable no-console */
@@ -17,25 +19,30 @@ async function performLoginSteps({
   password
 }, isLoggedIn) {
   const authFile = _path.default.resolve(_path.default.join((0, _checkAuthCookies.getAuthFileDirectory)(), `${authFilePrefix}-cookies.json`));
-  await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
-  await page.goto(process.env.domain);
-
-  // await page.waitForNavigation();
-
-  // await page.waitForLoadState('networkidle')
-
-  await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
-  const loginStatus = await isLoggedIn(page);
-  if (!loginStatus) {
-    await (0, _accountLogin.default)(page, useremail, password);
+  const lockFileName = useremail.replace(/[@.]/g, '_');
+  const fileMutex = new _fileMutex.default((0, _checkAuthCookies.getAuthFileDirectory)(), lockFileName, _fileMutexConfig.LOGIN_MUTEX_TIMEOUT);
+  try {
+    await fileMutex.acquire();
+    await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
     await page.goto(process.env.domain);
-
-    // await page.waitForLoadState();
-
-    await isLoggedIn(page);
-    await page.context().storageState({
-      path: authFile
-    });
+    await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
+    const isAlreadyLoggedIn = await isLoggedIn(page);
+    if (!isAlreadyLoggedIn) {
+      await (0, _accountLogin.default)(page, useremail, password);
+      await page.goto(process.env.domain);
+      await isLoggedIn(page);
+      await page.context().storageState({
+        path: authFile
+      });
+    }
+  } catch (error) {
+    console.error(`Error during login for ${useremail}:`, error);
+  } finally {
+    try {
+      await fileMutex.release();
+    } catch (releaseError) {
+      console.error(`Error releasing lock for ${useremail}:`, releaseError);
+    }
   }
 }
 var _default = exports.default = performLoginSteps;

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

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createAuthDirectoryIfNotExist = createAuthDirectoryIfNotExist;
+var _fs = require("fs");
+var _checkAuthCookies = require("./auth/checkAuthCookies");
+function createAuthDirectoryIfNotExist() {
+  const authDirectory = (0, _checkAuthCookies.getAuthFileDirectory)();
+  if (!(0, _fs.existsSync)(authDirectory)) {
+    console.log('Creating auth directory for the first time setup...');
+    (0, _fs.mkdirSync)(authDirectory, {
+      recursive: true
+    });
+  }
+}

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

@@ -0,0 +1,58 @@
+"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 _lockfile = _interopRequireDefault(require("lockfile"));
+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();
+var _createDirectoryIfNotExist = /*#__PURE__*/new WeakSet();
+class FileMutex {
+  constructor(directory, lockFileName, timeout) {
+    _classPrivateMethodInitSpec(this, _createDirectoryIfNotExist);
+    _classPrivateMethodInitSpec(this, _getLockFilePath);
+    this.directory = directory;
+    this.lockFileName = lockFileName;
+    this.timeout = timeout;
+  }
+  async acquire() {
+    _classPrivateMethodGet(this, _createDirectoryIfNotExist, _createDirectoryIfNotExist2).call(this);
+    return new Promise((resolve, reject) => {
+      _lockfile.default.lock(_classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this), this.timeout, err => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
+  async release() {
+    return new Promise((resolve, reject) => {
+      _lockfile.default.unlock(_classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this), err => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
+}
+function _getLockFilePath2() {
+  return _path.default.resolve(_path.default.join(this.directory, `/${this.lockFileName}.lock`));
+}
+function _createDirectoryIfNotExist2() {
+  if (!(0, _fs.existsSync)(this.directory)) {
+    (0, _fs.mkdirSync)(this.directory, {
+      recursive: true
+    });
+  }
+}
+var _default = exports.default = FileMutex;

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

@@ -0,0 +1,94 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _fileMutex = _interopRequireDefault(require("../../../../../core/playwright/helpers/fileMutex"));
+var _lockfile = _interopRequireDefault(require("lockfile"));
+var _path = _interopRequireDefault(require("path"));
+var _fs = _interopRequireDefault(require("fs"));
+jest.mock('lockfile');
+jest.mock('fs');
+describe('FileMutex', () => {
+  const mockDirectory = '/tmp';
+  const mockFileName = 'test_user';
+  const mockTimeout = {
+    wait: 5000,
+    retries: 5,
+    stale: 60000
+  };
+  let fileMutex;
+  beforeEach(() => {
+    fileMutex = new _fileMutex.default(mockDirectory, mockFileName, mockTimeout);
+  });
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+  describe('acquire', () => {
+    it('should resolve when lockfile.lock succeeds and call getLockFilePath correctly', async () => {
+      const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
+      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
+        expect(lockPath).toBe(expectedPath);
+        expect(options).toEqual(mockTimeout);
+        callback(null);
+      });
+      await expect(fileMutex.acquire()).resolves.toBeUndefined();
+      expect(_lockfile.default.lock).toHaveBeenCalledWith(expectedPath, mockTimeout, expect.any(Function));
+    });
+    it('should reject when lockfile.lock fails', async () => {
+      const mockError = new Error('Lock failed');
+      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
+        expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
+        expect(options).toEqual(mockTimeout);
+        callback(mockError);
+      });
+      await expect(fileMutex.acquire()).rejects.toThrow('Lock failed');
+      expect(_lockfile.default.lock).toHaveBeenCalled();
+    });
+    it('should create the directory if it does not exist and acquire the lock', async () => {
+      _fs.default.existsSync.mockReturnValue(false);
+      _fs.default.mkdirSync.mockImplementation((dir, options) => {
+        expect(dir).toBe(mockDirectory);
+        expect(options).toEqual({
+          recursive: true
+        });
+      });
+      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
+        expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
+        expect(options).toEqual(mockTimeout);
+        callback(null);
+      });
+      await expect(fileMutex.acquire()).resolves.toBeUndefined();
+      expect(_fs.default.existsSync).toHaveBeenCalledWith(mockDirectory);
+      expect(_fs.default.mkdirSync).toHaveBeenCalledWith(mockDirectory, {
+        recursive: true
+      });
+      expect(_lockfile.default.lock).toHaveBeenCalled();
+    });
+    it('should not create the directory if it already exists', async () => {
+      _fs.default.existsSync.mockReturnValue(true);
+      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
+        callback(null);
+      });
+      await expect(fileMutex.acquire()).resolves.toBeUndefined();
+      expect(_fs.default.mkdirSync).not.toHaveBeenCalled();
+      expect(_lockfile.default.lock).toHaveBeenCalled();
+    });
+  });
+  describe('release', () => {
+    it('should resolve when lockfile.unlock succeeds and call getLockFilePath correctly', async () => {
+      const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
+      _lockfile.default.unlock.mockImplementation((path, callback) => {
+        callback(null);
+      });
+      await expect(fileMutex.release()).resolves.toBeUndefined();
+      expect(_lockfile.default.unlock).toHaveBeenCalledWith(expectedPath, expect.any(Function));
+    });
+    it('should reject when lockfile.unlock fails', async () => {
+      const mockError = new Error('Unlock failed');
+      _lockfile.default.unlock.mockImplementation((path, callback) => {
+        callback(mockError);
+      });
+      await expect(fileMutex.release()).rejects.toThrow('Unlock failed');
+      expect(_lockfile.default.unlock).toHaveBeenCalled();
+    });
+  });
+});

package/nobdd/uat/conf/default/actors/index.js

@@ -1,5 +1,2 @@
 const editions = require('./editions/index');
-const beta = require('./beta/index');
-
-
-module.exports = { editions, beta }
+module.exports = { editions }

package/nobdd/uat/conf/default/settings.json

@@ -2,5 +2,5 @@
   "environment": "ci",
   "edition": "enterprise",
   "profile": "admin",
-  "domain": "https://zdesk-devops08.csez.zohocorpin.com:31007/agent"
+  "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent"
 }

package/nobdd/uat/conf/nobdd/uat.config.js

@@ -12,16 +12,24 @@ function getPrimaryCookiePath() {
  * @typedef {import('@zohodesk/testinglibrary').UserConfig} UserConfig
  */
 module.exports = {
-  headless: true,
+  headless: false,
+  retries:1,
   openReportOn: 'never',
   browsers: ['Chrome'],
-  isAuthMode: false,
+  isAuthMode: true,
   authFilePath: getPrimaryCookiePath(),
-  trace: true,
-  video: true,
+  trace: 'retain-on-failure',
+  video: 'retain-on-failure',
+  retries:1,
   bddMode: false,
+  expectTimeout: 10 * 1000,
+  testTimeout: 60 * 1000,
+  globalTimeout: 2 * 60 * 60 * 1000,
+  featureFilesFolder: 'feature-files',
+  stepDefinitionsFolder: 'steps',
   viewport: { width: 1280, height: 720 },
   testIdAttribute: 'data-id',
+  editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
   additionalPages: {
     ...customFixtures
   }

package/nobdd/uat/env-config.json

@@ -1,18 +1,18 @@
 {
   "dev": {
-    "domain": "https://desk.localzoho.com/agent",
+    "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
     "orgName": "org-name",
     "deptName": "dept-name",
     "moduleName": "module-name"
   },
   "prod": {
-    "domain": "https://desk.localzoho.com/agent/",
+    "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
     "orgName": "sangeetha.t@zohocorp.com",
     "deptName": "sangeethat",
     "moduleName": "sangeethat"
   },
   "ci": {
-    "domain": "https://zdesk-devops08.csez.zohocorpin.com:31007/agent/",
+    "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
     "orgName": "clientcicdk8",
     "deptName": "clientcicdk8",
     "moduleName": "tickets"

package/nobdd/uat/fixtures/setup.teardown.js

@@ -21,7 +21,8 @@ if (!isDevelopmentSetup()) {
       const authFilePath = path.join(authDirectory, file);
       await loadCookiesIfPresent(page, authFilePath);
       const domainOrigin = getUrlOrigin(process.env.domain);
-      await page.goto(`${domainOrigin}/support/logout.sas `);
+      const logoutURL = `${domainOrigin}/support/logout.sas`;
+      await page.goto(logoutURL);
       await page.waitForNavigation();
       await expect(page.locator('[id="signin_flow"]')).toBeVisible();
       await fs.rmSync(authFilePath);

package/nobdd/uat/modules/nobdd/steps/VerifyNoBDD.feature.spec.js

@@ -4,11 +4,11 @@ test.describe("Verify no authentication required @nobdd", () => {
 
   test("Verify the page is not logged in", async ({ page }) => {
 
-    await page.goto('https://desk.localzoho.com/');
+    await page.goto(process.env.domain);
 
-    await page.waitForSelector('.zgh-accounts');
+    await page.waitForSelector('#login');
 
-    const isLoggedIn = await page.isVisible('.zgh-accounts');
+    const isLoggedIn = await page.isVisible('#login');
     expect(isLoggedIn).toBe(true);
 
   });

package/nobdd/uat.config.js

@@ -13,17 +13,23 @@ function getPrimaryCookiePath() {
  */
 module.exports = {
   headless: false,
+  retries:1,
   openReportOn: 'never',
   browsers: ['Chrome'],
   isAuthMode: true,
   authFilePath: getPrimaryCookiePath(),
-  trace: true,
-  video: true,
-  bddMode: true,
+  trace: 'retain-on-failure',
+  video: 'retain-on-failure',
+  retries:1,
+  bddMode: false,
+  expectTimeout: 10 * 1000,
+  testTimeout: 60 * 1000,
+  globalTimeout: 2 * 60 * 60 * 1000,
   featureFilesFolder: 'feature-files',
   stepDefinitionsFolder: 'steps',
   viewport: { width: 1280, height: 720 },
   testIdAttribute: 'data-id',
+  editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
   additionalPages: {
     ...customFixtures
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "2.9.1",
+  "version": "2.9.2",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -32,6 +32,7 @@
     "fast-glob": "3.3.1",
     "jest": "29.6.2",
     "jest-environment-jsdom": "29.6.2",
+    "lockfile": "^1.0.4",
     "msw": "1.2.3",
     "playwright": "1.42.1",
     "supports-color": "8.1.1"

package/nobdd/uat/conf/default/actors/beta/custom-module.json

@@ -1,24 +0,0 @@
-[
-  {
-    "id": "1",
-    "edition": "enterprise",
-    "orgName": "custommoduleportal",
-    "profiles": [
-      {
-        "profile": "admin",
-        "email": "indragith.m+agent@zohotest.com",
-        "password": "Paara!2019"
-      },
-      {
-        "profile": "agent",
-        "email": "indragith.m+agent@zohotest.com",
-        "password": "Paara!2019"
-      },
-      {
-        "profile": "lightagent",
-        "email": "indragith.m+abc1@zohotest.com",
-        "password": "Paara!2019"
-      }
-    ]
-  }
-]

package/nobdd/uat/conf/default/actors/beta/index.js

@@ -1,6 +0,0 @@
-const parentchild = require('./parent-child.json');
-const custommodule = require('./custom-module.json');
-
-const beta = { parentchild, custommodule };
-
-module.exports = beta;

package/nobdd/uat/conf/default/actors/beta/parent-child.json

@@ -1,24 +0,0 @@
-[
-  {
-    "id": "1",
-    "edition": "enterprise",
-    "orgName": "parentchildportal",
-    "profiles": [
-      {
-        "profile": "admin",
-        "email": "indragith.m@zohocorp.com",
-        "password": "Paara!2019"
-      },
-      {
-        "profile": "agent",
-        "email": "indragith.m+agent@zohotest.com",
-        "password": "Paara!2019"
-      },
-      {
-        "profile": "lightagent",
-        "email": "indragith.m+abc1@zohotest.com",
-        "password": "Paara!2019"
-      }
-    ]
-  }
-]