@zohodesk/testinglibrary 0.4.82-n18-experimental → 0.4.84-n18-experimental

package/.gitlab-ci.yml

@@ -160,19 +160,4 @@ 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,12 +12,68 @@
   ### 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
@@ -27,8 +83,6 @@
   - 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,20 +1,13 @@
 "use strict";
 
-// import { createBdd , test } from '@zohodesk/testinglibrary';
-// import DataGenerator from '@zohodesk/testinglibrary/DataGenerator';
-// import { generateAndCacheTestData } from './DataGeneratorStepsHelper';  
-
-// const { Given } = createBdd();
-
-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
-} = createBdd();
+} = (0, _testinglibrary.createBdd)();
+const dataGenerator = new _DataGenerator.default();
 Given('generate a {string} entity {string} with generator {string}', async ({
   page,
   context,
@@ -22,7 +15,7 @@ Given('generate a {string} entity {string} with generator {string}', async ({
   cacheLayer,
   executionContext
 }, module, entityName, generatorName, dataTable) => {
-  await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName);
+  await (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "template", generatorName, dataTable, cacheLayer, entityName);
 });
 Given('generate a {string} entity {string} with API {string}', async ({
   page,
@@ -31,7 +24,7 @@ Given('generate a {string} entity {string} with API {string}', async ({
   cacheLayer,
   executionContext
 }, module, entityName, operationId, dataTable) => {
-  await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName);
+  await (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "API", operationId, dataTable, cacheLayer, entityName);
 });
 Given('generate a {string} entity {string} with generator {string} using {string} profile', async ({
   page,
@@ -40,7 +33,7 @@ Given('generate a {string} entity {string} with generator {string} using {string
   cacheLayer,
   executionContext
 }, module, entityName, generatorName, profile, dataTable) => {
-  await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile);
+  await (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile);
 });
 Given('generate a {string} entity {string} with API {string} using {string} profile', async ({
   page,
@@ -49,5 +42,5 @@ Given('generate a {string} entity {string} with API {string} using {string} prof
   cacheLayer,
   executionContext
 }, module, entityName, operationId, profile, dataTable) => {
-  await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile);
+  await (0, _DataGeneratorStepsHelper.generateAndCacheTestData)(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile);
 });

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

@@ -1,13 +1,13 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.generateAndCacheTestData = generateAndCacheTestData;
 var _testinglibrary = require("@zohodesk/testinglibrary");
-// import DataGenerator from '@zohodesk/testinglibrary/DataGenerator';
-const DataGenerator = require("@zohodesk/testinglibrary/DataGenerator").default;
-const dataGenerator = new DataGenerator();
+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();

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

@@ -0,0 +1,36 @@
+"use strict";
+
+var _testinglibrary = require("@zohodesk/testinglibrary");
+const {
+  BeforeScenario,
+  Given
+} = (0, _testinglibrary.createBdd)();
+BeforeScenario(async function ({
+  actorCtx,
+  page,
+  context,
+  browser,
+  executionContext
+}) {
+  // This will run before each scenario and set all the fixtures into this context
+  this.page = page;
+  this.context = context;
+  this.browser = browser;
+  this.executionContext = executionContext;
+  this.setActor = async role => {
+    const userPage = actorCtx.userPages.find(up => up.role === role);
+    if (userPage) {
+      this.page = userPage.page;
+      this.context = userPage.context;
+      this.browser = userPage.browser;
+      this.executionContext = userPage.actorInfo;
+    } else {
+      throw new Error(`Actor ${role} not found`);
+    }
+  };
+});
+Given("switch to {string} profile user page", async function ({
+  page
+}, userRole) {
+  await this.setActor(userRole);
+});

package/build/core/dataGenerator/DataGenerator.js

@@ -71,9 +71,7 @@ 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/dataGenerator/DataGeneratorHelper.js

@@ -29,31 +29,19 @@ async function processGenerator(generators, dataTable) {
     return generator;
   });
 }
-async function makeRequest(url, payload, timeoutMs = 30000) {
-  const controller = new AbortController();
-  const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
-  try {
-    const response = await fetch(url, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(payload),
-      signal: controller.signal
-    });
-    clearTimeout(timeoutId);
-    if (!response.ok) {
-      const errorBody = await response.text();
-      throw new Error(`HTTP error! status: ${response.status}, body: ${errorBody}`);
-    }
-    return response.json();
-  } catch (error) {
-    clearTimeout(timeoutId);
-    if (error.name === 'AbortError') {
-      throw new Error(`Request timeout after ${timeoutMs}ms`);
-    }
-    throw error;
+async function makeRequest(url, payload) {
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(payload)
+  });
+  if (!response.ok) {
+    const errorBody = await response.text();
+    throw new Error(`HTTP error! status: ${response.status}, body: ${errorBody}`);
   }
+  return response.json();
 }
 async function getGeneratorFilePath(featureFile) {
   let generatorPath = featureFile.replace(".features-gen/", "");

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

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _logger = require("../../../utils/logger");
+var _customFixturesHelper = require("../helpers/customFixturesHelper");
+class actorContext {
+  constructor() {
+    this.page = null;
+    this.browser = null;
+    this.context = null;
+    this.actorInfo = null;
+    this.userPages = [];
+    this.actorsList = {};
+  }
+  async setupAdditionalActors(browser, $tags, testInfo, defaultPage, defaultContext) {
+    const actorInfoMap = (0, _customFixturesHelper.getCustomAccountDetails)($tags);
+    const currentActor = actorInfoMap.additional;
+    await Promise.all(Object.entries(currentActor).map(async ([role, actorInfo], index) => {
+      let context, page;
+      if (index === 0) {
+        context = defaultContext;
+        page = defaultPage;
+      } else {
+        context = await browser.newContext();
+        page = await context.newPage();
+      }
+      let ctxTestDetails = {
+        page,
+        $tags,
+        context,
+        ...actorInfo
+      };
+      await (0, _customFixturesHelper.executeDefaultLoginSteps)(context, testInfo, ctxTestDetails, actorInfo);
+      this.actorsList[role] = {
+        role,
+        browser,
+        context,
+        page,
+        actorInfo,
+        isPrimary: index === 0
+      };
+      await this.addUserPage(role, browser, page, context, actorInfo);
+    }));
+    for (const actorObj of Object.values(this.actorsList)) {
+      await (0, _customFixturesHelper.performDefaultPageSteps)({
+        context: actorObj.context,
+        page: actorObj.page,
+        $tags,
+        ...actorObj.actorInfo
+      });
+    }
+  }
+  async addUserPage(role, browser, page, context, actorInfo) {
+    this.userPages.push({
+      role,
+      browser,
+      page,
+      context,
+      actorInfo
+    });
+  }
+  async cleanup() {
+    for (const actor of Object.values(this.actorsList)) {
+      if (!actor.isPrimary && actor.context) {
+        try {
+          await actor.context.close();
+        } catch (error) {
+          _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Failed to close context for actor ${actor.role}:`, error);
+        }
+      }
+    }
+  }
+}
+var _default = exports.default = {
+  actorCtx: async ({
+    $tags,
+    browser,
+    context,
+    page
+  }, use, testInfo) => {
+    const ctxObject = new actorContext();
+    await ctxObject.setupAdditionalActors(browser, $tags, testInfo, page, context);
+    await use(ctxObject);
+    await ctxObject.cleanup();
+  }
+};

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

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

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

@@ -12,12 +12,14 @@ 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,58 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-exports.getCustomAccountDetails = getCustomAccountDetails;
-var _auth = require("../helpers/auth");
-var _readConfigFile = require("../readConfigFile");
+var _customFixturesHelper = require("../helpers/customFixturesHelper");
 /* 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,
@@ -63,7 +13,7 @@ var _default = exports.default = {
     page,
     executionContext
   }, use, testInfo) => {
-    let testPortalDetails = executionContext.actorInfo;
+    let testPortalDetails = executionContext;
     let testDetails = {
       page,
       $tags,
@@ -76,24 +26,11 @@ var _default = exports.default = {
         await context.clearCookies();
         return;
       }
-      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);
-      }
+      await (0, _customFixturesHelper.executeDefaultLoginSteps)(context, testInfo, testDetails, testPortalDetails);
     } catch (e) {
       console.error('Error during page', e);
     } finally {
-      await performDefaultPageSteps(testDetails);
+      await (0, _customFixturesHelper.performDefaultPageSteps)(testDetails);
       await use(page);
       await context.close();
     }

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

@@ -0,0 +1,96 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.executeDefaultLoginSteps = executeDefaultLoginSteps;
+exports.getCustomAccountDetails = getCustomAccountDetails;
+exports.loginSteps = loginSteps;
+exports.performDefaultPageSteps = performDefaultPageSteps;
+exports.verifyPageIsLoaded = verifyPageIsLoaded;
+var _auth = require("../helpers/auth");
+var _additionalProfiles = require("../helpers/additionalProfiles");
+var _readConfigFile = require("../readConfigFile");
+var _logger = require("../../../utils/logger");
+/* eslint-disable global-require */
+
+let {
+  testSetup,
+  isAuthMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+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) {
+  try {
+    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 mainActor = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
+      const additionalProfileActors = (0, _additionalProfiles.additionProfiles)(tags, editionInfo, betaFeature, portalInfo);
+      const additionalProfileTags = tags.filter(tag => tag.startsWith('@additional_profile_'));
+      const additionalActors = {};
+      additionalProfileTags.forEach((tag, index) => {
+        const profileName = tag.replace('@additional_profile_', '');
+        additionalActors[profileName] = additionalProfileActors[index];
+      });
+      return {
+        main: mainActor,
+        additional: additionalActors
+      };
+    }
+    return {
+      main: (0, _auth.getDefaultActor)(),
+      additional: {}
+    };
+  } catch (err) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while getting custom account details:', err);
+  }
+}
+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;
+}
+async function executeDefaultLoginSteps(context, testInfo, testDetails, testPortalDetails) {
+  if (!isAuthMode) {
+    return;
+  }
+  try {
+    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 (error) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while executing the default login steps:', error);
+  }
+}

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

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