@zohodesk/testinglibrary 0.4.86-n18-experimental → 0.4.87-n18-experimental

package/.babelrc

@@ -18,6 +18,7 @@
   ],
   // 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/.gitlab-ci.yml

@@ -160,4 +160,19 @@ uat-smoketest:
     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,68 +12,12 @@
   ### Run TestCase
 
     - npm run test
-
   ### Generate Report
 
      - npm run report
 
 ## Version History
 
-### v3.2.6 - 02-09-2025
-
-#### Feature
-
-  - Multi-actor execution support – now possible to switch between multiple profile agents within scenarios using the new `actorCtx` custom fixture.
-
-### 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.
-
-### 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
@@ -83,6 +27,8 @@
   - 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. 
 
 
+## Version History
+
 ### v3.0.8 - 25-12-2024
 
 #### Enhancement

package/build/common/data-generator/steps/DataGenerator.spec.js

@@ -1,46 +1,22 @@
-"use strict";
+// const { createBdd } = require("@zohodesk/testinglibrary");
+// const { generateAndCacheTestData } = require("./DataGeneratorStepsHelper");
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _testinglibrary = require("@zohodesk/testinglibrary");
-var _DataGenerator = _interopRequireDefault(require("@zohodesk/testinglibrary/DataGenerator"));
-var _DataGeneratorStepsHelper = require("./DataGeneratorStepsHelper");
-const {
-  Given
-} = (0, _testinglibrary.createBdd)();
-const dataGenerator = new _DataGenerator.default();
-Given('generate a {string} entity {string} with generator {string}', async ({
-  page,
-  context,
-  i18N,
-  cacheLayer,
-  executionContext
-}, module, entityName, generatorName, dataTable) => {
-  await (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "template", generatorName, dataTable, cacheLayer, entityName);
+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 (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "API", operationId, 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 (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile);
+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);
 });
-Given('generate a {string} entity {string} with API {string} using {string} profile', async ({
-  page,
-  context,
-  i18N,
-  cacheLayer,
-  executionContext
-}, module, entityName, operationId, profile, dataTable) => {
-  await (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile);
-});

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

@@ -1,22 +1,23 @@
-"use strict";
+// import { test } from '@zohodesk/testinglibrary';
+// const DataGenerator = require("@zohodesk/testinglibrary/DataGenerator").default;
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.generateAndCacheTestData = generateAndCacheTestData;
-var _testinglibrary = require("@zohodesk/testinglibrary");
-var _DataGenerator = _interopRequireDefault(require("@zohodesk/testinglibrary/DataGenerator"));
-const dataGenerator = new _DataGenerator.default();
-async function generateAndCacheTestData(executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null) {
-  let actorInfo;
-  const testInfo = _testinglibrary.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);
+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/searchFake/helpers/rpcRequestHelper.js

@@ -1,37 +1,41 @@
-"use strict";
+import { expect } from '@zohodesk/testinglibrary';
 
-var _testinglibrary = require("@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 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;
     }
-    const responseData = await response.json();
-    (0, _testinglibrary.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;
+    
+    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
-};
+
+module.exports = { executeRpcRequest, entityIdReConstructor };

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

@@ -1,30 +1,26 @@
-"use strict";
+import {createBdd } from '@zohodesk/testinglibrary';
+import { executeRpcRequest , entityIdReConstructor } from '../helpers/rpcRequestHelper';
 
-var _testinglibrary = require("@zohodesk/testinglibrary");
-var _rpcRequestHelper = require("../helpers/rpcRequestHelper");
-const {
-  Given
-} = (0, _testinglibrary.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 (0, _rpcRequestHelper.entityIdReConstructor)(payload);
-    await (0, _rpcRequestHelper.executeRpcRequest)(page, payload);
-  }
-});
+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

@@ -71,7 +71,9 @@ async function _generateAPIGenerator(operationId) {
   }];
 }
 async function _constructApiPayload(scenarioName, processedGenerators, actorInfo) {
+  const orgOauth = actorInfo['org_oauth'] || {};
   const dataGeneratorConfig = actorInfo['data-generator'] || {};
+  dataGeneratorConfig.account.org_oauth = orgOauth;
   const apiPayload = {
     scenario_name: scenarioName,
     data_generation_templates: processedGenerators,

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

@@ -4,13 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _customFixturesHelper = require("../helpers/customFixturesHelper");
+var _page = require("./page");
 var _default = exports.default = {
   executionContext: async ({
     $tags
   }, use) => {
-    const allActorsObj = (0, _customFixturesHelper.getCustomAccountDetails)($tags);
-    const currentActor = allActorsObj.main;
-    await use(currentActor);
+    let testPortalActorDetails = {
+      actorInfo: (0, _page.getCustomAccountDetails)($tags)
+    };
+    await use(testPortalActorDetails);
   }
 };

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

@@ -12,14 +12,12 @@ var _addTags = _interopRequireDefault(require("./addTags"));
 var _i18N = _interopRequireDefault(require("./i18N"));
 var _unauthenticatedPage = _interopRequireDefault(require("./unauthenticatedPage"));
 var _executionContext = _interopRequireDefault(require("./executionContext"));
-var _actorCtx = _interopRequireDefault(require("./actorCtx"));
 function extractTagsFromTitle(text) {
   return text.match(/@\w+/g) || [];
 }
 function getBuiltInFixtures(bddMode) {
   let builtInFixtures = {
     ..._page.default,
-    ..._actorCtx.default,
     ..._context.default,
     ..._cacheLayer.default,
     ..._i18N.default,

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

@@ -4,8 +4,58 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _loginDefaultStepsHelper = require("../helpers/auth/loginDefaultStepsHelper");
+exports.getCustomAccountDetails = getCustomAccountDetails;
+var _auth = require("../helpers/auth");
+var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
+
+//import { additionProfiles } from '../helpers/additionalProfiles';
+
+function getTagInputFromSelectedTags(tags, inputString) {
+  const selectedTag = [...tags].reverse().find(tag => tag.startsWith(inputString));
+  let tagInput = null;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  return tagInput;
+}
+function getCustomAccountDetails(tags) {
+  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal', '@additional_profile'];
+  const filteredTags = tags.filter(tag => tagsTobeFiltered.some(prefix => tag.startsWith(prefix)));
+  if (filteredTags && filteredTags.length > 0) {
+    const portalInfo = getTagInputFromSelectedTags(filteredTags, '@portal');
+    const betaFeature = getTagInputFromSelectedTags(filteredTags, '@beta');
+    const profileInfo = getTagInputFromSelectedTags(filteredTags, '@profile');
+    const editionInfo = getTagInputFromSelectedTags(filteredTags, '@edition');
+    const user = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
+    return user;
+  }
+  return (0, _auth.getDefaultActor)();
+}
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function loginSteps(pageDetail) {
+  const {
+    page
+  } = pageDetail;
+  if (testSetup.loginSteps && typeof testSetup.loginSteps === 'function') {
+    return await testSetup.loginSteps(pageDetail);
+  } else {
+    await page.goto(process.env.domain);
+  }
+}
+async function performDefaultPageSteps(testInfo) {
+  if (testSetup.page && typeof testSetup.page === 'function') {
+    await testSetup.page(testInfo);
+  }
+}
+async function verifyPageIsLoaded(testInfo) {
+  if (testSetup.validateLogin && typeof testSetup.validateLogin === 'function') {
+    return await testSetup.validateLogin(testInfo);
+  }
+  return true;
+}
 var _default = exports.default = {
   page: async ({
     context,
@@ -13,7 +63,7 @@ var _default = exports.default = {
     page,
     executionContext
   }, use, testInfo) => {
-    let testPortalDetails = executionContext;
+    let testPortalDetails = executionContext.actorInfo;
     let testDetails = {
       page,
       $tags,
@@ -26,11 +76,24 @@ var _default = exports.default = {
         await context.clearCookies();
         return;
       }
-      await (0, _loginDefaultStepsHelper.executeDefaultLoginSteps)(context, testInfo, testDetails, testPortalDetails);
+      const {
+        isAuthMode
+      } = (0, _readConfigFile.generateConfigFromFile)();
+      if (!isAuthMode) {
+        return;
+      }
+      const projectName = testInfo.project.name;
+      if (testPortalDetails && projectName !== 'setup' && projectName !== 'cleanup') {
+        await context.clearCookies();
+        await (0, _auth.performLoginSteps)(testDetails, async testInfo => {
+          return await verifyPageIsLoaded(testInfo);
+        }, loginSteps);
+        process.env.actorInfo = JSON.stringify(testPortalDetails);
+      }
     } catch (e) {
       console.error('Error during page', e);
     } finally {
-      await (0, _loginDefaultStepsHelper.performDefaultPageSteps)(testDetails);
+      await performDefaultPageSteps(testDetails);
       await use(page);
       await context.close();
     }

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

@@ -7,12 +7,11 @@ exports.additionProfiles = additionProfiles;
 var _getUsers = require("./auth/getUsers");
 function additionProfiles(tags, editionInfo, betaFeature, portalInfo) {
   const additionalProfileTags = tags.filter(tag => tag.startsWith('@additional_profile_'));
-  let additionalProfileActors = {};
+  let additionalProfileActors = [];
   if (additionalProfileTags.length > 0 && editionInfo) {
-    additionalProfileTags.forEach(tag => {
+    additionalProfileActors = additionalProfileTags.map(tag => {
       const additionalProfile = tag.replace('@additional_profile_', '');
-      const actorDetails = (0, _getUsers.getUserForSelectedEditionAndProfile)(editionInfo, additionalProfile, betaFeature, portalInfo);
-      additionalProfileActors[additionalProfile] = actorDetails;
+      return (0, _getUsers.getUserForSelectedEditionAndProfile)(editionInfo, additionalProfile, betaFeature, portalInfo);
     });
   }
   return additionalProfileActors;

package/build/test/Test.js

@@ -0,0 +1,13 @@
+"use strict";
+
+delete require.cache[require.resolve('../core/playwright/runner/Runner')];
+function test() {
+  const inputString = "@hc";
+  const selectedTag = ["@hc_1234"].reverse().find(tag => tag.startsWith(inputString));
+  let tagInput = null;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  console.log(tagInput);
+}
+test();

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

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