@zohodesk/testinglibrary 2.9.1 → 3.0.2

package/.gitlab-ci.yml

@@ -1,29 +1,35 @@
-image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
 
-#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

@@ -26,15 +26,46 @@
 ### Bug fix
   - Updated the custom-reported to include the errors in tests during the executions. It will help us avoid the stage passed without the actual test execution. 
 
-### v0.2.9 - 24-10-2024
+
+## Version History
+
+### v0.2.9 - 25-10-2024
 
 #### Feature
   - Added support for scenario level tag support
   - Added a new cli optin like uat-validate to validate the feature files using playwright-bdd
   - Mode based configuration implementations
   - @only option enabled in dev pipeline
+  - Latest setup related configuration changed for init option
+
+### v0.3.0 - 25-10-2024
+
+#### Features
+  - Added support for scenario level tag support
+  - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
+  - Below package versions are updated in this release. 
+    - playwright - 1.48.0, 
+    - playwright-bdd - 7.5.0,
+    - @playwright/test - 1.48.0,
+    - @cucumber/cucumber - 11.0.1
+  - From this version, We adopt the playwright-bdd as library instead of modified source
+  - Published on 11-11-2024
+  
+#### Deprecations
+  - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
+  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
+
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.
 
 ### v0.2.9.1 - 14-11-2024
 
 #### 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/fixtures.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _test = require("@playwright/test");
+var _playwrightBdd = require("playwright-bdd");
+var _readConfigFile = require("./readConfigFile");
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
+const {
+  bddMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+let base = bddMode ? _playwrightBdd.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
+const buildInFixturesTest = base.extend({
+  ...buildInFixtures
+});
+const userFixtures = (0, _getUserFixtures.default)();
+const userFixturesTest = base.extend({
+  ...userFixtures
+});
+const test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
+module.exports = {
+  test
+};

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

@@ -1,37 +1,24 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "createBdd", {
+exports.createBdd = void 0;
+Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
-    return _bddFramework.createBdd;
+    return _test.expect;
   }
 });
-Object.defineProperty(exports, "expect", {
+Object.defineProperty(exports, "test", {
   enumerable: true,
   get: function () {
-    return _test.expect;
+    return _playwrightBdd.test;
   }
 });
-exports.test = void 0;
-var _bddFramework = require("../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _test = require("@playwright/test");
-var _readConfigFile = require("./readConfigFile");
-var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
-var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
-const {
-  bddMode
-} = (0, _readConfigFile.generateConfigFromFile)();
-let base = bddMode ? _bddFramework.test : _test.test;
-const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
-const buildInFixturesTest = base.extend({
-  ...buildInFixtures
-});
-const userFixtures = (0, _getUserFixtures.default)();
-const userFixturesTest = base.extend({
-  ...userFixtures
-});
-const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
+let createBdd = function () {
+  return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
+};
+exports.createBdd = createBdd;

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

@@ -39,12 +39,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-const testOptions = (0, _configUtils.getTestUseOptions)({
+const use = {
   trace,
   video,
   viewport,
   testIdAttribute
-});
+};
 
 /**
  * Playwright configuration object
@@ -65,7 +65,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use: testOptions,
+    use,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

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

@@ -7,14 +7,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
-exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _bddFramework = require("../../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
-var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _fileUtils = require("../../../utils/fileUtils");
 /**
  ** Playwright project configuration
@@ -148,30 +146,15 @@ function getPathsForFeatureFiles(cwd) {
 function getTestDir(bddMode, cwd, {
   stepDefinitionsFolder
 }) {
-  return bddMode ? (0, _bddFramework.defineBddConfig)({
-    paths: getPathsForFeatureFiles(cwd),
-    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
+  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
+    features: getPathsForFeatureFiles(cwd),
+    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
+    importTestFrom: require.resolve('../fixtures.js'),
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
+    disableWarnings: {
+      importTestFrom: true
+    },
     publish: true
   }) : _path.default.join(cwd, 'uat');
-}
-function getTestUseOptions({
-  viewport,
-  trace,
-  video,
-  testIdAttribute
-}) {
-  let defaultTestuseOptions = {
-    viewport,
-    testIdAttribute,
-    trace: trace ? 'on' : 'off',
-    video: video ? {
-      mode: 'on',
-      size: {
-        ...viewport
-      }
-    } : 'off'
-  };
-  return defaultTestuseOptions;
 }

package/build/core/playwright/test-runner.js

@@ -43,7 +43,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
 }
 function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
+  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');

package/build/decorators.d.ts

@@ -1 +1 @@
-export * from './bdd-framework/decorators';
+export * from 'playwright-bdd/decorators';

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("./bdd-framework/decorators");
+var _decorators = require("playwright-bdd/decorators");
 Object.keys(_decorators).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _decorators[key]) return;

package/build/setup-folder-structure/samples/actors-index.js

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

package/build/setup-folder-structure/samples/auth-setup-sample.js

@@ -1,73 +1,21 @@
 /* eslint-disable no-console */
 import { test as setup, expect } from '@zohodesk/testinglibrary';
-import path from 'path';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-import { getAuthFileDirectory } from '../../core/playwright';
-import { Logger } from '../../utils/logger';
+import {
+  performLoginSteps,
+  getDefaultActor
+} from '@zohodesk/testinglibrary/helpers';
 
-const userdata = require('./authUsers.json');
+const user = getDefaultActor();
 
-const authContent = { cookies: [] };
-
-const LOGIN_ERR_MESSAGE = 'Need go be logged in';
-// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
-
-function convertCookiesToParse(cookies, authFilePath) {
-  try {
-    return JSON.parse(cookies);
-  } catch (err) {
-    Logger.error(err);
-    throw new Error(
-      ` Error while parsing cookies ${err} \n${path.resolve(
-        process.cwd(),
-        authFilePath
-      )} File is Empty`
-    );
-    // process.exit()
-  }
-}
-const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
-if (!existsSync(authDirectory)) {
-  console.log('Creating auth directory for the first time setup...');
-  mkdirSync(authDirectory, { recursive: true });
+async function verifyPageIsLoaded(page) {
+  //Implement your validation steps here
+  //Refer desk_client_app auth.setup.js
+  return true;
 }
 
-userdata.forEach(data => {
-  const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
-  if (!existsSync(authFile)) {
-    console.log('creating auth file..');
-    writeFileSync(authFile, JSON.stringify(authContent, null, 2));
-  }
-  setup(data.description, async ({ page }) => {
-    try {
-      const cookies = readFileSync(authFile);
-      const parsedCookies = convertCookiesToParse(cookies, authFile);
-      await page
-        .context()
-        .addCookies(
-          parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
-        );
-      await page.goto(page.getBaseUrl());
-      await page.waitForLoadState();
-      if (await page.url().includes(process.env.domain)) {
-        await page.waitForSelector(data.locator);
-      } else {
-        throw new Error(LOGIN_ERR_MESSAGE);
-      }
-    } catch (err) {
-      if (err.message === LOGIN_ERR_MESSAGE) {
-        await expect(page.locator('.load-bg')).toBeHidden();
-        await page.locator('#login_id').type(data.useremail);
-        await page.locator('#nextbtn').click();
-        await page.locator('#password').type(data.password);
-        await page.locator('#nextbtn').click();
-
-        await page.waitForLoadState('networkidle');
-
-        await page.waitForSelector(data.locator);
+setup(`${user.edition} - Authentication`, async ({ page }) => {
 
-        await page.context().storageState({ path: authFile });
-      }
-    }
-  });
-});
+  //Implement performLoginSteps here
+  const { email, password } = user;
+  await performLoginSteps({ },verifyPageIsLoaded );
+});

package/build/setup-folder-structure/samples/editions-index.js

@@ -0,0 +1,3 @@
+const free = require('./free.json');
+const editions = { free};
+module.exports = editions;

package/build/setup-folder-structure/samples/free-sample.json

@@ -0,0 +1,25 @@
+[
+    {
+      "id": "1",
+      "edition": "free",
+      "orgName": "orgFree",
+      "profiles": [
+        {
+          "profile": "admin",
+          "email": "admin+free@zohotest.com",
+          "password": "password@0987"
+        },
+        {
+          "profile": "agent",
+          "email": "agent@zohotest.com",
+          "password": "password@12345"
+        },
+        {
+          "profile": "lightagent",
+          "email": "lightagent@zohotest.com",
+          "password": "password@12345"
+        }
+      ]
+    }
+  ]
+  

package/build/setup-folder-structure/samples/settings.json

@@ -0,0 +1,7 @@
+{
+  "environment": "dev",
+  "edition": "enterprise",
+  "profile": "admin",
+  "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
+  "devUrl" : "" 
+}