@zohodesk/testinglibrary 0.4.93-n18-experimental → 0.4.95-n18-experimental

package/.gitlab-ci.yml

@@ -188,4 +188,19 @@ uat-data_generator:
     paths:
       - examples/uat/playwright-report
 
+uat-search_indexing:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uat-search_indexing)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+
 

package/README.md

@@ -19,8 +19,18 @@
 
 ## Version History
 
-#### Feature
-  - To store the login session in NFS, we have provided the teardown option in the configuration
+### Unpublished release
+
+### Feature
+
+  - New step `a search entity using {string}` provided for search indexing, This step will use run time data generation response as input for the indexing
+
+### v3.2.9 - 26-09-2025
+
+### Enhancement
+
+  - Authentication deatils for data generation can be configured in org level
+  - reference link : https://learn.zoho.in/portal/zohocorp/knowledge/manual/client-uat/article/data-generation#_Tocpd3n7yt9ngeg
 
 ### v3.2.8 - 18-09-2025
 

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

@@ -10,10 +10,10 @@ Given('generate a {string} entity {string} with generator {string}', async ({ pa
 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 generator {string} using {string} profile', async ({ $tags, page, context, i18N, cacheLayer, executionContext}, module, entityName, generatorName, profile, dataTable) => {
+    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile,$tags);
 });
 
-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 ({ $tags,page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, profile, dataTable) => {
+    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile, $tags);
 });

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

@@ -1,15 +1,17 @@
 import { test } from '@zohodesk/testinglibrary';
 import DataGenerator from '@zohodesk/testinglibrary/DataGenerator';
+ import {extractTagInfo, getUserForSelectedEditionAndProfile} from '@zohodesk/testinglibrary/helpers'
 
 const dataGenerator = new DataGenerator();
 
-export async function generateAndCacheTestData(executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null) {
+export async function generateAndCacheTestData(executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null, tags = 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);
+        const { portalInfo, betaFeature } = extractTagInfo(tags);
+        actorInfo = await getUserForSelectedEditionAndProfile(executionContext.actorInfo.edition, profile ,betaFeature, portalInfo)
     } else {
         actorInfo = executionContext.actorInfo;
     }

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

@@ -30,11 +30,22 @@ 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.');
+    
+    if (!payload.arguments || (!payload.arguments.entityId)) {
+        throw new Error('Invalid payload.arguments.entityId. It must be a non-empty string or array of strings.');
+    }
+
+    const entityId = payload.arguments.entityId;
+    
+    // If it's already an array, validate and clean it
+    if (Array.isArray(entityId)) {
+        payload.arguments.entityId = entityId.map(id => id.trim());
+    } 
+    // If it's a string, split and convert to array
+    else if (typeof entityId === 'string') {
+        payload.arguments.entityId = entityId.split(',').map(id => id.trim());
     }
 
-    payload.arguments.entityId = payload.arguments.entityId.split(',').map(id => id.trim());
     return payload;
 }
 

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

@@ -1,8 +1,14 @@
 import {createBdd } from '@zohodesk/testinglibrary';
 import { executeRpcRequest , entityIdReConstructor } from '../helpers/rpcRequestHelper';
+import jp from 'jsonpath';
 
 const { Given } = createBdd();
 
+
+//  Given a search entity
+//      | moduleName   | entityId        | entityName     | searchString  |
+//      | contact    | 122000006785675, 122000007141665, 122000006636472  | QA Team   | testinguat   |
+
 Given('a search entity', async ({page}, dataTable)=>{
     const data = dataTable.hashes();
     
@@ -22,5 +28,50 @@ Given('a search entity', async ({page}, dataTable)=>{
 
         await executeRpcRequest(page, payload);
     }
-    
 });
+
+//  Given data generation step
+//  Given a search entity using "C1"
+//      | moduleName   | searchString  | searchEntity (response of the previous data generation step) |
+//      | contact    | testinguat   | $.id |
+//      | contact    | testinguat   | $.ids |
+//      | contact    | testinguat   |
+
+Given('a search entity using {string}', async ({page,cacheLayer}, reference,dataTable)=>{
+    const data = dataTable.hashes();
+    
+    const row = data[0];
+    if (!row || !row.moduleName || !row.searchString) {
+        throw new Error('Invalid or missing data in dataTable');
+    }
+    
+    const { moduleName, searchEntity, searchString } = row;
+    
+    const searchObj = cacheLayer.get(reference);
+    let entityIdValue;
+    
+    if (typeof searchObj === 'string') {
+        entityIdValue = searchObj;
+    } else {
+        const jsonPath = searchEntity?.startsWith?.('$') ? searchEntity : `$.${searchEntity}`;
+        const result = jp.query(searchObj, jsonPath);
+        
+        if (!result || result.length === 0) {
+            throw new Error(`JSONPath query '${jsonPath}' returned no results from cache object for reference: ${reference}`);
+        }
+        
+        entityIdValue = result.length === 1 ? result[0] : result;
+    }
+    
+    const payload = {
+        className: 'applicationDriver.rpc.desk.integrations.search.SearchFakeDataPopulator',
+        methodName: 'populateSearchData',
+        arguments: {
+            module: moduleName,
+            searchString: searchString, 
+            entityId: entityIdValue
+        }
+    };
+    await entityIdReConstructor(payload);
+    await executeRpcRequest(page, payload);
+});

package/build/core/dataGenerator/DataGenerator.js

@@ -47,15 +47,6 @@ class DataGenerator {
       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;

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

@@ -10,6 +10,12 @@ Object.defineProperty(exports, "accountLogin", {
     return _accountLogin.default;
   }
 });
+Object.defineProperty(exports, "extractTagInfo", {
+  enumerable: true,
+  get: function () {
+    return _customFixturesHelper.extractTagInfo;
+  }
+});
 Object.defineProperty(exports, "getDefaultActor", {
   enumerable: true,
   get: function () {
@@ -73,4 +79,5 @@ Object.defineProperty(exports, "verifyIfCookieFileExists", {
 var _accountLogin = _interopRequireDefault(require("./accountLogin"));
 var _checkAuthCookies = require("./checkAuthCookies");
 var _getUsers = require("./getUsers");
+var _customFixturesHelper = require("../customFixturesHelper");
 var _loginSteps = _interopRequireDefault(require("./loginSteps"));

package/build/core/playwright/readConfigFile.js

@@ -19,7 +19,6 @@ var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
 let cachedConfig = null;
 function getDefaultConfig() {
   return {
-    isTearDown: true,
     uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],

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

@@ -9,36 +9,47 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
-var _ProjectConfiguration = require("./ProjectConfiguration");
 const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
 const {
-  bddMode,
   browsers,
   isSmokeTest,
-  isTearDown,
+  trace,
+  video,
   isAuthMode,
   openReportOn,
   reportPath,
+  bddMode,
   expectTimeout,
   testTimeout,
   authFilePath,
   viewport,
+  featureFilesFolder,
+  stepDefinitionsFolder,
+  testIdAttribute,
   globalTimeout,
-  customReporter,
-  trace,
-  video,
-  testIdAttribute
+  customReporter
 } = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
   isSmokeTest,
-  isTearDown,
   authFilePath,
   expectTimeout,
   testTimeout,
   viewport
 });
+const testDir = (0, _configUtils.getTestDir)(bddMode, {
+  featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
+  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+  outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
+  uatPath: _path.default.join(process.cwd(), 'uat')
+});
+const use = {
+  trace,
+  video,
+  viewport,
+  testIdAttribute
+};
 let reporter = [['html', {
   outputFolder: reportPath,
   open: openReportOn
@@ -55,22 +66,29 @@ if (customReporter) {
  * @returns {import('@playwright/test').PlaywrightTestConfig}
  */
 
-const use = {
-  trace,
-  video,
-  viewport,
-  testIdAttribute
-};
-const testDir = (0, _configUtils.getTestDir)(bddMode, {
-  featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
-  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
-  outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
-  uatPath: _path.default.join(process.cwd(), 'uat')
-});
 function getPlaywrightConfig() {
-  const smokeTestProject = isSmokeTest ? (0, _ProjectConfiguration.smokeTestConfig)() : [];
-  const setupProject = isAuthMode ? (0, _ProjectConfiguration.setupConfig)() : [];
-  const cleanupProject = isTearDown ? (0, _ProjectConfiguration.cleanupConfig)() : [];
+  const commonConfig = {
+    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+  };
+  const dependencies = isAuthMode ? ['setup'] : [];
+  const smokeTestProject = isSmokeTest ? smokeTestConfig() : [];
+  function smokeTestConfig() {
+    const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
+      featureFilesFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*.feature'),
+      stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+      outputDir: _path.default.join(process.cwd(), 'uat', '.features-smoke-gen'),
+      uatPath: _path.default.join(process.cwd(), 'uat', 'smokeTest')
+    });
+    return [{
+      name: 'smokeTest',
+      testDir: smokeTestDir,
+      use: {
+        ...commonConfig
+      },
+      dependencies: dependencies,
+      retries: 0
+    }];
+  }
   const playwrightConfig = {
     testDir,
     globalTimeout: globalTimeout || 3600000,
@@ -82,7 +100,16 @@ function getPlaywrightConfig() {
       timeout: expectTimeout
     },
     use,
-    projects: [...setupProject, ...smokeTestProject, ...projects, ...cleanupProject],
+    projects: isAuthMode ? [{
+      name: 'setup',
+      testMatch: /.*\.setup\.js/,
+      testDir: _path.default.join(process.cwd(), 'uat'),
+      teardown: 'cleanup'
+    }, ...smokeTestProject, {
+      name: 'cleanup',
+      testMatch: /.*\.teardown\.js/,
+      testDir: _path.default.join(process.cwd(), 'uat')
+    }, ...projects] : [...projects, ...smokeTestProject],
     ...uatConfig
   };
   return playwrightConfig;

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();