@zohodesk/testinglibrary 3.2.7 → 3.2.9

package/.gitlab-ci.yml

@@ -160,4 +160,32 @@ uat-smoketest:
     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

@@ -19,6 +19,14 @@
 
 ## 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

package/build/common/multi-actor/steps/{additionalContext.spec.js → multiActorHandling.spec.js}

@@ -1,11 +1,12 @@
 import { createBdd } from '@zohodesk/testinglibrary';
 const { BeforeScenario, Given } = createBdd();
 
-BeforeScenario(async function({ page, context, browser, executionContext, actorContext }) {
+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];
@@ -13,7 +14,7 @@ BeforeScenario(async function({ page, context, browser, executionContext, actorC
             this.page = userPage.page;
             this.context = userPage.context;
             this.browser = userPage.browser;
-            this.executionContext = userPage.actorInfo;
+            this.executionContext = userPage.executionContext;
         } else {
             throw new Error(`Actor "${role}" not found in user pages.`);
         }

package/build/core/dataGenerator/DataGenerator.js

@@ -10,6 +10,7 @@ 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"); }
@@ -32,6 +33,16 @@ class DataGenerator {
       _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;
     }
@@ -58,7 +69,7 @@ async function _getGenerator(testInfo, generatorName) {
     }
   }
   if (!generator) {
-    throw new Error(`Generator "${generatorName}" could not be found in the path located at "${generatorFilePath}"`);
+    throw new _DataGeneratorError.GeneratorError(`Generator "${generatorName}" could not be found in the path located at "${generatorFilePath}"`);
   }
   return generator;
 }
@@ -71,11 +82,14 @@ async function _generateAPIGenerator(operationId) {
   }];
 }
 async function _constructApiPayload(scenarioName, processedGenerators, actorInfo) {
-  const dataGeneratorConfig = actorInfo['data-generator'] || {};
+  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,
-    ...dataGeneratorConfig
+    ...dataGeneratorObj
   };
   const account = apiPayload.account;
   if (account) {

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;

package/build/core/dataGenerator/DataGeneratorHelper.js

@@ -15,7 +15,7 @@ async function processGenerator(generators, dataTable) {
     dataTable.forEach(row => {
       const generatorName = row.DG_API_NAME;
       if (generatorName === generator.name) {
-        generator.params = generator.params ? generator.params : [];
+        generator.params = generator.params ? generator.params : {};
 
         // The API name row is only used for matching the template
         // Filter out DG_API_NAME and collect other values

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

@@ -5,16 +5,25 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _logger = require("../../../utils/logger");
-var _customFixturesHelper = require("../helpers/customFixturesHelper");
+var _additionalProfiles = require("../helpers/additionalProfiles");
 var _loginDefaultStepsHelper = require("../helpers/auth/loginDefaultStepsHelper");
-class additionalActorContext {
+class ActorContext {
   constructor() {
     this.actorsObj = {};
   }
-  async setupAdditionalActors(browser, $tags, testInfo) {
+  async setup(browser, $tags, testInfo, context, page, executionContext) {
     try {
-      const actorInfoMap = (0, _customFixturesHelper.getCustomAccountDetails)($tags);
-      const additionalActors = actorInfoMap.additional;
+      const {
+        profile
+      } = executionContext.actorInfo;
+      this.actorsObj[profile] = {
+        role: profile,
+        browser,
+        context,
+        page,
+        executionContext
+      };
+      const additionalActors = (0, _additionalProfiles.additionProfiles)($tags);
       await Promise.all(Object.entries(additionalActors).map(async ([role, actorInfo]) => {
         let context = await browser.newContext();
         let page = await context.newPage();
@@ -30,7 +39,9 @@ class additionalActorContext {
           browser,
           context,
           page,
-          actorInfo
+          executionContext: {
+            actorInfo
+          }
         };
       }));
     } catch (error) {
@@ -50,11 +61,14 @@ class additionalActorContext {
 }
 var _default = exports.default = {
   actorContext: async ({
+    page,
+    context,
+    executionContext,
     $tags,
     browser
   }, use, testInfo) => {
-    const ctxObject = new additionalActorContext();
-    await ctxObject.setupAdditionalActors(browser, $tags, testInfo);
+    const ctxObject = new ActorContext();
+    await ctxObject.setup(browser, $tags, testInfo, context, page, executionContext);
     await use(ctxObject);
     await ctxObject.cleanup();
   }

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

@@ -9,8 +9,9 @@ var _default = exports.default = {
   executionContext: async ({
     $tags
   }, use) => {
-    const allActorsObj = (0, _customFixturesHelper.getCustomAccountDetails)($tags);
-    const currentActor = allActorsObj.main;
-    await use(currentActor);
+    const actorInfo = (0, _customFixturesHelper.getCustomAccountDetails)($tags);
+    await use({
+      actorInfo
+    });
   }
 };

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

@@ -13,7 +13,7 @@ var _default = exports.default = {
     page,
     executionContext
   }, use, testInfo) => {
-    let testPortalDetails = executionContext;
+    let testPortalDetails = executionContext.actorInfo;
     let testDetails = {
       page,
       $tags,

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

@@ -5,10 +5,16 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.additionProfiles = additionProfiles;
 var _getUsers = require("./auth/getUsers");
-function additionProfiles(tags, editionInfo, betaFeature, portalInfo) {
+var _customFixturesHelper = require("./customFixturesHelper");
+function additionProfiles(tags) {
+  const {
+    editionInfo,
+    betaFeature,
+    portalInfo
+  } = (0, _customFixturesHelper.extractTagInfo)(tags);
   const additionalProfileTags = tags.filter(tag => tag.startsWith('@additional_profile_'));
   let additionalProfileActors = {};
-  if (additionalProfileTags.length > 0 && editionInfo) {
+  if (additionalProfileTags.length > 0) {
     additionalProfileTags.forEach(tag => {
       const additionalProfile = tag.replace('@additional_profile_', '');
       const actorDetails = (0, _getUsers.getUserForSelectedEditionAndProfile)(editionInfo, additionalProfile, betaFeature, portalInfo);

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

@@ -9,6 +9,7 @@ exports.performDefaultPageSteps = performDefaultPageSteps;
 exports.verifyPageIsLoaded = verifyPageIsLoaded;
 var _auth = require("../auth");
 var _readConfigFile = require("../../readConfigFile");
+var _logger = require("../../../../utils/logger");
 let {
   testSetup,
   isAuthMode
@@ -48,6 +49,6 @@ async function executeDefaultLoginSteps(context, testInfo, testDetails, testPort
       process.env.actorInfo = JSON.stringify(testPortalDetails);
     }
   } catch (error) {
-    Logger.log(Logger.FAILURE_TYPE, 'Error while executing the default login steps:', error);
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while executing the default login steps:', error);
   }
 }

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

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.extractTagInfo = extractTagInfo;
 exports.getCustomAccountDetails = getCustomAccountDetails;
 var _auth = require("../helpers/auth");
-var _additionalProfiles = require("../helpers/additionalProfiles");
 var _logger = require("../../../utils/logger");
 /* eslint-disable global-require */
 
@@ -17,27 +17,42 @@ function getTagInputFromSelectedTags(tags, inputString) {
   }
   return tagInput;
 }
+function extractTagInfo(tags) {
+  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal'];
+  const filteredTags = tags.filter(tag => tagsTobeFiltered.some(prefix => tag.startsWith(prefix)));
+  if (!filteredTags.length) {
+    return {
+      portalInfo: null,
+      betaFeature: null,
+      profileInfo: null,
+      editionInfo: null
+    };
+  }
+  const portalInfo = getTagInputFromSelectedTags(filteredTags, '@portal');
+  const betaFeature = getTagInputFromSelectedTags(filteredTags, '@beta');
+  const profileInfo = getTagInputFromSelectedTags(filteredTags, '@profile');
+  const editionInfo = getTagInputFromSelectedTags(filteredTags, '@edition');
+  return {
+    portalInfo,
+    betaFeature,
+    profileInfo,
+    editionInfo
+  };
+}
 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 additionalActors = (0, _additionalProfiles.additionProfiles)(tags, editionInfo, betaFeature, portalInfo);
-      return {
-        main: mainActor,
-        additional: additionalActors
-      };
+    const {
+      portalInfo,
+      betaFeature,
+      profileInfo,
+      editionInfo
+    } = extractTagInfo(tags);
+    if (portalInfo || betaFeature || profileInfo || editionInfo) {
+      const user = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
+      return user;
     }
-    return {
-      main: (0, _auth.getDefaultActor)(),
-      additional: {}
-    };
+    return (0, _auth.getDefaultActor)();
   } catch (err) {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while getting custom account details:', err);
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while getting accounts details:', err);
   }
 }

package/build/core/playwright/setup/qc-custom-reporter.js

@@ -102,6 +102,7 @@ const createSpecEntry = (rootDir, test, testResultsById) => ({
   ...(test.location && {
     snippet: formSnippet(test.location)
   }),
+  tags: test.tags,
   tests: [extractTestDetails(test, testResultsById)]
 });
 const extractTestDetails = (test, testResultsById) => {
@@ -112,7 +113,6 @@ const extractTestDetails = (test, testResultsById) => {
     expectedStatus: test.expectedStatus,
     timeout: test.timeout,
     retries: test.retries,
-    tags: test.tags,
     results: testResultsById.get(key) ?? [],
     status: test.outcome()
   };

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

@@ -14,16 +14,14 @@ describe('executionContext', () => {
       profile: 'admin',
       email: 'xxx.x+uat@zohotest.com'
     };
-    const mockActorInfo = {
-      main: mockMainActorInfo,
-      additional: {}
-    };
-    _customFixturesHelper.getCustomAccountDetails.mockReturnValue(mockActorInfo);
+    _customFixturesHelper.getCustomAccountDetails.mockReturnValue(mockMainActorInfo);
     const use = jest.fn();
     await _executionContext.default.executionContext({
       $tags: mockTags
     }, use);
     expect(_customFixturesHelper.getCustomAccountDetails).toHaveBeenCalledWith(mockTags);
-    expect(use).toHaveBeenCalledWith(mockMainActorInfo);
+    expect(use).toHaveBeenCalledWith({
+      actorInfo: mockMainActorInfo
+    });
   });
 });

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

@@ -0,0 +1,45 @@
+"use strict";
+
+var _additionalProfiles = require("../../../../../core/playwright/helpers/additionalProfiles");
+jest.mock('../../../../../core/playwright/helpers/auth/getUsers', () => ({
+  getUserForSelectedEditionAndProfile: jest.fn((edition, profile, betaFeature, portalInfo) => {
+    return {
+      email: 'manager.m@zohotest.com',
+      id: '1',
+      edition: edition || 'enterprise',
+      orgName: 'orgName',
+      profile: profile || 'admin',
+      betaFeature: betaFeature || null,
+      portalInfo: portalInfo || null
+    };
+  })
+}));
+const defaultTags = ['@profile_admin', '@edition_enterprise'];
+const editionTags = ['@profile_admin', '@edition_enterprise', '@additional_profile_manager', '@additional_profile_agent'];
+const editionAndPortalTags = ['@profile_admin', '@edition_enterprise', '@beta_parentchild', '@portal_clientuat2', '@additional_profile_manager'];
+describe('additionalProfiles', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('should return empty object when no additional profile tags are present', () => {
+    const result = (0, _additionalProfiles.additionProfiles)(defaultTags);
+    expect(result).toEqual({});
+  });
+  test('should return additional profile actors when additional profile tags and editionInfo are present', () => {
+    const result = (0, _additionalProfiles.additionProfiles)(editionTags);
+    expect(Object.keys(result)).toEqual(['manager', 'agent']);
+    expect(result.manager).toHaveProperty('email');
+    expect(result.agent).toHaveProperty('email');
+    expect(result.manager.profile).toBe('manager');
+    expect(result.manager.betaFeature).toBe(null);
+    expect(result.agent.portalInfo).toBe(null);
+  });
+  test('should return additional profile actors when all actor details are present', () => {
+    const result = (0, _additionalProfiles.additionProfiles)(editionAndPortalTags);
+    expect(Object.keys(result)).toEqual(['manager']);
+    expect(result.manager).toHaveProperty('email');
+    expect(result.manager.profile).toBe('manager');
+    expect(result.manager.betaFeature).toBe("parentchild");
+    expect(result.manager.portalInfo).toBe("clientuat2");
+  });
+});

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

@@ -0,0 +1,51 @@
+"use strict";
+
+var _customFixturesHelper = require("../../../../../core/playwright/helpers/customFixturesHelper");
+var _logger = require("../../../../../utils/logger");
+var _getUsers = require("../../../../../core/playwright/helpers/auth/getUsers");
+jest.mock('../../../../../core/playwright/helpers/auth/getUsers', () => ({
+  getUserForSelectedEditionAndProfile: jest.fn((edition, profile, betaFeature, portalInfo) => ({
+    email: 'manager.m@zohotest.com',
+    id: '1',
+    edition: edition || 'enterprise',
+    orgName: 'orgName',
+    profile: profile || 'admin',
+    betaFeature: betaFeature || null,
+    portalInfo: portalInfo || null
+  })),
+  getDefaultActor: jest.fn(() => ({
+    edition: 'enterprise',
+    profile: 'admin'
+  }))
+}));
+jest.mock('../../../../../utils/logger', () => ({
+  Logger: {
+    log: jest.fn(),
+    FAILURE_TYPE: 'FAILURE'
+  }
+}));
+const mockTags = ['@profile_admin', '@edition_enterprise', '@beta_feature', '@portal_clientuat'];
+describe('getCustomAccountDetails', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('returns selected user when any tag info is present', () => {
+    const result = (0, _customFixturesHelper.getCustomAccountDetails)(mockTags);
+    expect(_getUsers.getUserForSelectedEditionAndProfile).toHaveBeenCalledWith('enterprise', 'admin', 'feature', 'clientuat');
+    expect(result).toHaveProperty('email', 'manager.m@zohotest.com');
+  });
+  test('logs and returns undefined if getCustomAccountDetails function throws', () => {
+    const error = new Error('failed to get user');
+    _getUsers.getUserForSelectedEditionAndProfile.mockImplementation(() => {
+      throw error;
+    });
+    const result = (0, _customFixturesHelper.getCustomAccountDetails)(mockTags);
+    expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.FAILURE_TYPE, 'Error while getting accounts details:', error);
+    expect(result).toBeUndefined();
+  });
+  test('returns default actor when no tag info is not provided', () => {
+    const result = (0, _customFixturesHelper.getCustomAccountDetails)([]);
+    expect(_getUsers.getDefaultActor).toHaveBeenCalledTimes(1);
+    expect(result).toEqual((0, _getUsers.getDefaultActor)());
+  });
+});

package/build/utils/logger.js

@@ -4,35 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Logger = void 0;
-// const SUCCESS_TYPE = 'success';
-// const FAILURE_TYPE = 'failure';
-// const INFO_TYPE = 'info';
-
-// function logger() {
-//   this.colors = {
-//     'success': ['\x1b[36m', '\x1b[0m'],
-//     'failure': ['\x1b[31m', '\x1b[0m'],
-//     'info': ['\x1b[33m', '\x1b[0m']
-//   }
-//   this.consoleLogger = console;
-//   return {
-//     SUCCESS_TYPE,
-//     FAILURE_TYPE,
-//     INFO_TYPE,
-//     error: () => { },
-//     info: () => { },
-//     log: (type, message) => {
-//       const color = this.colors[type];
-//       console.log(type, color)
-//       this.consoleLogger.log(`${color[0]}${message}${color[1]}`)
-//     }
-//   }
-// }
-
-// module.exports = {
-//   Logger: logger()
-// }
-
 class LoggerImpl {
   constructor() {
     this.SUCCESS_TYPE = 'success';