@zohodesk/testinglibrary 0.0.9-exp.3 → 0.0.9-n20-experimental

package/.babelrc

@@ -6,14 +6,19 @@
         "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"]
       }
     ]
   ],
   "plugins": [
-      ["@babel/plugin-transform-runtime"]
+      ["@babel/plugin-transform-runtime"],
+      ["@babel/plugin-transform-modules-commonjs"]
   ],
+  // Ignored as these are setup files needed during init script. Files inside that folder are copied not transformed
   "ignore": [
-    "./src/setup-folder-structure/samples"
+    "./src/setup-folder-structure/samples",
+    "./src/common/**"
   ]
 }

package/.eslintrc.js

@@ -22,6 +22,10 @@ module.exports = {
     "sourceType": "module"
   },
   "rules": {
-    "indent": ["error", 2]
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "no-empty-pattern": "off",
+    "comma-dangle": ["error", "never"],
+    "curly": ["error"],
+    "brace-style": "error"
   }
 }

package/.gitlab-ci.yml

@@ -0,0 +1,191 @@
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
+
+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
+      - npm-shrinkwrap.json
+
+# Install dependencies stage
+build:
+  stage: build
+  script:
+    - npm -v
+    - node -v
+    - npm install --ignore-scripts
+    - npm run build
+    - npm install
+    - npm shrinkwrap
+    - npm run build
+
+# Unit tests stage
+unit:
+  stage: unit
+  script:
+    - npm run test
+  artifacts:
+    when: always
+    paths:
+      - unit_reports
+
+# UAT tests stage
+uat-auth:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatauth)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uat-noauth:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnoauth)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+    
+uat-profile:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatprofile)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report 
+
+
+uat-unauth:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatunauth)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report 
+
+uat-nobdd:
+  stage: uat
+  script:
+    - cd nobdd
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnobdd -- --headless)
+    - echo "$output"
+    - node ../ValidateUATReport.js nobdd
+
+
+  artifacts:
+    when: always
+    paths:
+      - nobdd/uat/playwright-report
+
+
+uatmodule:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatmodule)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uatconfigmodule:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatconfigmodule)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uat-smoketest:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uat-smoketest)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uat-multiactor:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uat-multiactor)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+      
+uat-data_generator:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uat-data_generator)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+

package/README.md

@@ -12,7 +12,157 @@
   ### Run TestCase
 
     - npm run test
+
   ### Generate Report
 
      - npm run report
-    
+
+## Version History
+
+### v3.2.8 - 18-09-2025
+
+### Bug fix
+
+  - Default profile switching handled in Multi actor – Improved handling of default profile switching to ensure smoother execution flow.
+
+  - QC Report tags issue fixed – Resolved an issue where QC Report tags were not displaying correctly in reports.
+
+### v3.2.7 - 10-09-2025
+
+### Bug fix
+  - Fixed a bug where the default profile page was not being handled properly in `this`.
+
+### v3.2.6 - 05-09-2025
+
+#### Feature
+
+  - Multi-actor execution support – now possible to switch between multiple profile agents within scenarios using the predefined step: - `access the {string} profile page`
+
+### Bug fix
+  - Fixed the issue where localapp and hcapp UAT were not running properly.
+
+### v3.2.5 - 28-08-2025
+
+#### Enhancement
+
+  - Removed the searchFake dependency from the project level and adopted it inside the framework, reducing project-side maintenance. use this predefined step: - `Given (a search entity)`
+
+### v3.2.4 - 29-07-2025
+
+#### Feature
+  - Data Generator steps are now supported directly via the framework.
+
+### Bug fix
+  - Feature File Root Directory not found issue fixed
+
+### v3.2.3 - 29-07-2025
+
+#### Feature
+  - Added support for running Smoke Tests in the UAT stage.
+
+### v3.2.0 - 22-06-2025
+
+#### Feature
+  - Default required spec files are now auto-imported from the library into the project.
+
+### v3.1.13 - 02-07-2025
+
+#### Enhancement
+  - Below package versions are updated in this release.
+    - @cucumber/Cucumber - 11.3.0
+    - Playwright/test - 1.53.2
+    - Playwright - 1.53.2
+    - Playwright-bdd - 8.3.1
+  - QC custom reporter changes have been adopted into the framework.
+
+### v3.1.5 - 22-05-2025
+
+#### Feature
+  - Added support for Module Based Execution UAT stage.
+
+### v3.1.4 - 12-05-2025
+
+#### Enhancement
+  - Playwright version 1.52.0 adopted in testing framework
+
+### v3.1.3 - 25-04-2025
+
+#### Enhancement
+  - Playwright version 1.51.0 adopted in testing framework
+
+### v0.2.8 - 26-09-2024
+
+#### Feature
+  - Added support for writing unitcases for framework implementations
+
+### 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. 
+
+
+### v3.0.8 - 25-12-2024
+
+#### Enhancement
+  - Added support to disable headless mode using command line arguments
+  - Proper validation added for node 14 build process
+  - Removed unwanted uat.config.js files in test projects (examples / nobdd)
+
+### 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.
+  
+### 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 - 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.3.3 - 27-11-2024
+
+#### Feature
+- Custom report integration support (ReportPortal)
+
+### 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/common/data-generator/steps/DataGenerator.spec.js

@@ -0,0 +1,19 @@
+import { createBdd , test } from '@zohodesk/testinglibrary';
+import { generateAndCacheTestData } from './DataGeneratorStepsHelper';  
+
+const { Given } = createBdd();
+
+Given('generate a {string} entity {string} with generator {string}', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, generatorName, dataTable) => {
+    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName);
+});
+
+Given('generate a {string} entity {string} with API {string}', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, dataTable) => {
+    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName);
+});
+Given('generate a {string} entity {string} with generator {string} using {string} profile', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, generatorName, profile, dataTable) => {
+    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile);
+});
+
+Given('generate a {string} entity {string} with API {string} using {string} profile', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, profile, dataTable) => {
+    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile);
+});

package/build/common/data-generator/steps/DataGeneratorStepsHelper.js

@@ -0,0 +1,19 @@
+import { test } from '@zohodesk/testinglibrary';
+import DataGenerator from '@zohodesk/testinglibrary/DataGenerator';
+
+const dataGenerator = new DataGenerator();
+
+export async function generateAndCacheTestData(executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null) {
+    let actorInfo;
+    const testInfo = test.info();
+    const scenarioName = testInfo.title.split('/').pop() || 'Unknown Scenario';
+
+    if (profile) {
+        actorInfo = await dataGenerator.getDataGenUserExecutionContext(executionContext.actorInfo.edition, profile);
+    } else {
+        actorInfo = executionContext.actorInfo;
+    }
+    
+    const generatedData = await dataGenerator.generate(testInfo, actorInfo, type, identifier, scenarioName, dataTable ? dataTable.hashes() : []);
+    await cacheLayer.set(entityName, generatedData.data);
+}

package/build/common/multi-actor/steps/multiActorHandling.spec.js

@@ -0,0 +1,26 @@
+import { createBdd } from '@zohodesk/testinglibrary';
+const { BeforeScenario, Given } = createBdd();
+
+BeforeScenario(async function({ page, context, browser, cacheLayer, executionContext, actorContext }) {
+    // This will run before each scenario and set all the fixtures into this context
+    this.page = page;
+    this.context = context;
+    this.browser = browser;
+    this.cacheLayer = cacheLayer;
+    this.executionContext = executionContext;
+    this.setActor = async (role) => {
+        const userPage = actorContext.actorsObj[role];
+        if (userPage) {
+            this.page = userPage.page;
+            this.context = userPage.context;
+            this.browser = userPage.browser;
+            this.executionContext = userPage.executionContext;
+        } else {
+            throw new Error(`Actor "${role}" not found in user pages.`);
+        }
+    }
+});
+
+Given("access the {string} profile page", async function({ page }, userRole) {
+    await this.setActor(userRole);
+});

package/build/common/searchFake/helpers/rpcRequestHelper.js

@@ -0,0 +1,41 @@
+import { expect } from '@zohodesk/testinglibrary';
+
+async function executeRpcRequest(page, payload) {
+
+    const url = new URL(page.url());
+    const baseUrl = `${url.protocol}//${url.host}`;
+    const invokeURL = `${baseUrl}/api/testing/acceptanceTest/rpc/invoke`;
+    
+    try {
+        const response = await page.request.post(invokeURL, {
+            headers: {'Content-Type': 'application/json'},
+            data: payload
+        });
+
+        if (!response.ok()) {
+            throw new Error(`HTTP ${response.status()}: ${response.statusText()}`);
+        }
+
+        const responseData = await response.json();
+        expect(responseData.data).toHaveProperty('status', 'success');
+
+    } catch (error) {
+        throw error;
+    }
+}
+
+
+async function entityIdReConstructor(payload) {
+    
+    if (typeof payload !== 'object' || payload === null) {
+        throw new Error('Invalid payload. It must be a non-null object.');
+    }
+    if (!payload.arguments || typeof payload.arguments.entityId !== 'string') {
+        throw new Error('Invalid payload.arguments.entityId. It must be a non-empty string.');
+    }
+
+    payload.arguments.entityId = payload.arguments.entityId.split(',').map(id => id.trim());
+    return payload;
+}
+
+module.exports = { executeRpcRequest, entityIdReConstructor };

package/build/common/searchFake/steps/searchFake.spec.js

@@ -0,0 +1,26 @@
+import {createBdd } from '@zohodesk/testinglibrary';
+import { executeRpcRequest , entityIdReConstructor } from '../helpers/rpcRequestHelper';
+
+const { Given } = createBdd();
+
+Given('a search entity', async ({page}, dataTable)=>{
+    const data = dataTable.hashes();
+    
+    for (const row of data) {
+        
+        const { moduleName, entityId, searchString } = row;
+        const payload = {
+            className: 'applicationDriver.rpc.desk.integrations.search.SearchFakeDataPopulator',
+            methodName: 'populateSearchData',
+            arguments: {
+                module: moduleName,
+                searchString: searchString, 
+                entityId: entityId
+            }
+        };
+        await entityIdReConstructor(payload);
+
+        await executeRpcRequest(page, payload);
+    }
+    
+});

package/build/core/dataGenerator/DataGenerator.js

@@ -0,0 +1,108 @@
+"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 _fs = _interopRequireDefault(require("fs"));
+var _logger = require("../../utils/logger");
+var _DataGeneratorHelper = require("./DataGeneratorHelper");
+var _helpers = require("@zohodesk/testinglibrary/helpers");
+var _DataGeneratorError = require("./DataGeneratorError");
+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 _DataGenerator_brand = /*#__PURE__*/new WeakSet();
+class DataGenerator {
+  constructor() {
+    _classPrivateMethodInitSpec(this, _DataGenerator_brand);
+  }
+  async generate(testInfo, actorInfo, generatorType, generatorName, scenarioName, dataTable) {
+    try {
+      let generators;
+      if (generatorType === 'API') {
+        generators = await _assertClassBrand(_DataGenerator_brand, this, _generateAPIGenerator).call(this, generatorName);
+      } else {
+        generators = await _assertClassBrand(_DataGenerator_brand, this, _getGenerator).call(this, testInfo, generatorName);
+      }
+      const processedGenerators = await (0, _DataGeneratorHelper.processGenerator)(generators, dataTable);
+      const apiPayload = await _assertClassBrand(_DataGenerator_brand, this, _constructApiPayload).call(this, scenarioName, processedGenerators, actorInfo);
+      const response = await (0, _DataGeneratorHelper.makeRequest)(process.env.DG_SERVICE_DOMAIN + process.env.DG_SERVICE_API_PATH, apiPayload);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, `Generated response for the generator: ${generatorName} for scenario: ${scenarioName}, Response: ${JSON.stringify(response)}`);
+      return response;
+    } catch (error) {
+      if (error instanceof _DataGeneratorError.DataGeneratorError) {
+        console.error(error.getMessage());
+        console.error("Stack trace:", error.stack);
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error.getMessage());
+      } else {
+        console.error("Error Type:", error.constructor.name);
+        console.error("Error Message:", error.message);
+        console.error("Stack trace:", error.stack);
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `${error.constructor.name} - Message: ${error.message}`);
+      }
+      console.error('Data Generation failed for the generator: ', generatorName, "\n\nError response :", error);
+      throw error;
+    }
+  }
+  async getDataGenUserExecutionContext(edition, profile) {
+    try {
+      const dataGenUserDetails = await (0, _helpers.getUserForSelectedEditionAndProfile)(edition, profile);
+      return dataGenUserDetails;
+    } catch (error) {
+      console.error('Error occurred while fetching data generation user details: ', error);
+      throw error;
+    }
+  }
+}
+async function _getGenerator(testInfo, generatorName) {
+  let generator = null;
+  let generatorFilePath = await (0, _DataGeneratorHelper.getGeneratorFilePath)(testInfo.file);
+  generatorFilePath = _path.default.join(generatorFilePath, "../../data-generators/generators.json");
+  if (_fs.default.existsSync(generatorFilePath)) {
+    const data = _fs.default.readFileSync(generatorFilePath, 'utf8');
+    const generatorObj = JSON.parse(data);
+    if (generatorName || generatorObj.generators) {
+      generator = generatorObj.generators[generatorName] || null;
+    }
+  }
+  if (!generator) {
+    throw new _DataGeneratorError.GeneratorError(`Generator "${generatorName}" could not be found in the path located at "${generatorFilePath}"`);
+  }
+  return generator;
+}
+async function _generateAPIGenerator(operationId) {
+  return [{
+    type: "dynamic",
+    generatorOperationId: operationId,
+    dataPath: "$.response.body:$",
+    name: operationId
+  }];
+}
+async function _constructApiPayload(scenarioName, processedGenerators, actorInfo) {
+  const dataGeneratorObj = actorInfo['data-generator'];
+  if (!dataGeneratorObj) {
+    throw new _DataGeneratorError.DataGeneratorConfigurationError(`Data Generator configuration is missing for the profile: ${actorInfo['profile']}`);
+  }
+  const apiPayload = {
+    scenario_name: scenarioName,
+    data_generation_templates: processedGenerators,
+    ...dataGeneratorObj
+  };
+  const account = apiPayload.account;
+  if (account) {
+    account.email = actorInfo.email;
+    account.password = actorInfo.password;
+  }
+  const environmentDetails = apiPayload.environmentDetails || {};
+  if (environmentDetails) {
+    environmentDetails.iam_url = process.env.DG_IAM_DOMAIN;
+    const domainUrl = new URL(process.env.domain);
+    environmentDetails.host = domainUrl.origin;
+  }
+  apiPayload.environmentDetails = environmentDetails;
+  return apiPayload;
+}
+var _default = exports.default = DataGenerator;

package/build/core/dataGenerator/DataGeneratorError.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GeneratorError = exports.DataGeneratorError = exports.DataGeneratorConfigurationError = void 0;
+class DataGeneratorError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'DataGeneratorError';
+
+    // Maintains proper stack trace for where our error was thrown (only available on V8)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, DataGeneratorError);
+    }
+  }
+
+  /**
+   * Get formatted error message with error type and message
+   * @returns {string} Formatted error message
+   */
+  getMessage() {
+    return `\n\n ${this.name} :::  \n\n Error Message: ${this.message} \n\n `;
+  }
+}
+
+// Specific error for Data Generator configuration issues
+exports.DataGeneratorError = DataGeneratorError;
+class DataGeneratorConfigurationError extends DataGeneratorError {
+  constructor(message) {
+    super(message);
+    this.name = 'DataGeneratorConfigurationError';
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, DataGeneratorConfigurationError);
+    }
+  }
+}
+
+// Specific error for Generator related issues
+exports.DataGeneratorConfigurationError = DataGeneratorConfigurationError;
+class GeneratorError extends DataGeneratorError {
+  constructor(message) {
+    super(message);
+    this.name = 'GeneratorError';
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, GeneratorError);
+    }
+  }
+}
+exports.GeneratorError = GeneratorError;