@zohodesk/testinglibrary 0.0.5-n20-experimental → 0.0.6-n20-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

@@ -17,7 +17,28 @@
 
      - npm run report
 
-## Version History
+### v3.2.11 - 13-10-2025
+ 
+### 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
+ 
+### Issue fix
+- Custom teardown comment provided
+ 
+### v3.2.10 - 09-10-2025
+ 
+#### Enhancement
+- A teardown option has been introduced in the configuration to manage and clean up login sessions stored in the NFS environment.
+
+
+### 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/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 = null;//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/playwright/custom-commands.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CUSTOM_COMMANDS = void 0;
-const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition', 'browsers', 'filePath', 'headless', 'modules'];
+const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition', 'browsers', 'filePath', 'headless', 'modules', 'isTearDown'];

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

@@ -10,6 +10,7 @@ var _fileMutex = _interopRequireDefault(require("../fileMutex"));
 var _fileMutexConfig = require("../../constants/fileMutexConfig");
 var _checkAuthCookies = require("./checkAuthCookies");
 var _checkAuthDirectory = require("../checkAuthDirectory");
+var _logger = require("../../../../utils/logger");
 /* eslint-disable no-console */
 
 async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
@@ -25,7 +26,7 @@ async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
   let loginUsingCookie = false;
   try {
     if ((0, _checkAuthCookies.verifyIfCookieFileExists)(authFile)) {
-      console.log(`${email} Cookie file exists. Loading cookies, worker index - ${process.env.TEST_WORKER_INDEX}`);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, `${email} Cookie file exists. Loading cookies, worker index - ${process.env.TEST_WORKER_INDEX}`);
       loginUsingCookie = true;
     } else {
       await fileMutex.acquire();
@@ -40,7 +41,7 @@ async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
       });
     }
   } catch (error) {
-    console.error(`Error during login for ${email}:`, error);
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error during login for ${email}:`, error);
   } finally {
     if (!loginUsingCookie) {
       await fileMutex.release();

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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
 var _fs = require("fs");
+var _logger = require("../../../utils/logger");
 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"); }
@@ -24,7 +25,7 @@ class FileMutex {
     return new Promise((resolve, reject) => {
       if (!(0, _fs.existsSync)(this.lockFilePath)) {
         (0, _fs.writeFileSync)(this.lockFilePath, 'locked');
-        console.log(`Lock file created: ${this.lockFilePath}, worker index - ${process.env.TEST_WORKER_INDEX}`);
+        _logger.Logger.log(_logger.Logger.INFO_TYPE, `Lock file created: ${this.lockFilePath}, worker index - ${process.env.TEST_WORKER_INDEX}`);
         return resolve();
       }
       const timeout = setTimeout(() => {
@@ -35,12 +36,12 @@ class FileMutex {
         try {
           if (eventType === 'rename' && filename === this.lockFileName) {
             clearTimeout(timeout);
-            console.log(`Lock file deleted! Proceeding, worker index - ${process.env.TEST_WORKER_INDEX}`);
+            _logger.Logger.log(_logger.Logger.INFO_TYPE, `Lock file deleted! Proceeding, worker index - ${process.env.TEST_WORKER_INDEX}`);
             watcher.close();
             resolve();
           }
         } catch (err) {
-          console.error(`Error watching for lock file deletion: ${err.message}`);
+          _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error watching for lock file deletion: ${err.message}`);
           watcher.close();
         }
       });
@@ -50,10 +51,10 @@ class FileMutex {
     try {
       if ((0, _fs.existsSync)(this.lockFilePath)) {
         (0, _fs.unlinkSync)(this.lockFilePath);
-        console.log(`Lock file deleted: ${this.lockFilePath}, worker index - ${process.env.TEST_WORKER_INDEX}`);
+        _logger.Logger.log(_logger.Logger.INFO_TYPE, `Lock file deleted: ${this.lockFilePath}, worker index - ${process.env.TEST_WORKER_INDEX}`);
       }
     } catch (err) {
-      console.error(`Error deleting lock file: ${err.message}, worker index - ${process.env.TEST_WORKER_INDEX}`);
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error deleting lock file: ${err.message}, worker index - ${process.env.TEST_WORKER_INDEX}`);
       throw err;
     }
   }

package/build/core/playwright/readConfigFile.js

@@ -19,6 +19,7 @@ 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/Project.js

@@ -0,0 +1,35 @@
+"use strict";
+
+class Project {
+  constructor(name) {
+    this.properties = {};
+    this.properties.name = name;
+  }
+  setTestDir(value) {
+    this.properties.testDir = value;
+  }
+  setTestMatch(value) {
+    this.properties.testMatch = value;
+  }
+  setRetries(value) {
+    this.properties.retries = value;
+  }
+  setUse(value) {
+    this.properties.use = value;
+  }
+  setTearDown(value) {
+    this.properties.teardown = value;
+  }
+  setDependencies(value) {
+    this.properties.dependencies = value;
+  }
+  setProperty(key, value) {
+    this.properties[key] = value;
+  }
+  getProperties() {
+    return this.properties;
+  }
+}
+module.exports = {
+  Project
+};

package/build/core/playwright/setup/ProjectConfiguration.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cleanupConfig = cleanupConfig;
+exports.setupConfig = setupConfig;
+exports.smokeTestConfig = smokeTestConfig;
+var _path = _interopRequireDefault(require("path"));
+var _Project = require("./Project");
+var _configUtils = require("./config-utils");
+var _readConfigFile = require("../readConfigFile");
+const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
+const {
+  isAuthMode,
+  isSmokeTest,
+  bddMode,
+  authFilePath,
+  trace,
+  video,
+  testIdAttribute,
+  viewport
+} = uatConfig;
+function setupConfig() {
+  const setupProject = new _Project.Project('setup');
+  setupProject.setTestMatch(/.*\.setup\.js/);
+  setupProject.setTestDir(_path.default.join(process.cwd(), 'uat'));
+  const isTearDown = JSON.parse(process.env.tearDown);
+  setupProject.setTearDown(isTearDown ? 'cleanup' : '');
+  const setupProjectConfig = [setupProject.getProperties()];
+  return setupProjectConfig;
+}
+function smokeTestConfig() {
+  const smokeTestProject = new _Project.Project('smokeTest');
+  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')
+  });
+  const commonConfig = {
+    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+  };
+  smokeTestProject.setTestDir(smokeTestDir);
+  smokeTestProject.setRetries(0);
+  smokeTestProject.setUse({
+    ...commonConfig
+  });
+  smokeTestProject.setDependencies(isAuthMode ? ['setup'] : []);
+  const smokeTestProjectConfig = [smokeTestProject.getProperties()];
+  return smokeTestProjectConfig;
+}
+function defaultConfig() {
+  const defaultProject = new _Project.Project('default');
+  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
+  };
+  defaultProject.setUse(use);
+  defaultProject.setTestDir(testDir);
+  defaultProject.setDependencies(isSmokeTest ? ['smokeTest'] : []);
+  const defaultProjectConfig = [defaultProject.getProperties()];
+  return defaultProjectConfig;
+}
+function cleanupConfig() {
+  const cleanupProject = new _Project.Project('cleanup');
+  cleanupProject.setTestMatch(/.*\.teardown\.js/);
+  cleanupProject.setTestDir(_path.default.join(process.cwd(), 'uat'));
+  const cleanupProjectConfig = [cleanupProject.getProperties()];
+  return cleanupProjectConfig;
+}

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

@@ -9,25 +9,24 @@ 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,
-  trace,
-  video,
   isAuthMode,
   openReportOn,
   reportPath,
-  bddMode,
   expectTimeout,
   testTimeout,
   authFilePath,
   viewport,
-  featureFilesFolder,
-  stepDefinitionsFolder,
-  testIdAttribute,
   globalTimeout,
-  customReporter
+  customReporter,
+  trace,
+  video,
+  testIdAttribute
 } = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -38,18 +37,6 @@ const projects = (0, _configUtils.getProjects)({
   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
@@ -66,29 +53,23 @@ 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 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 smokeTestProject = isSmokeTest ? (0, _ProjectConfiguration.smokeTestConfig)() : [];
+  const setupProject = isAuthMode ? (0, _ProjectConfiguration.setupConfig)() : [];
+  const isTearDown = JSON.parse(process.env.tearDown);
+  const cleanupProject = isTearDown ? (0, _ProjectConfiguration.cleanupConfig)() : [];
   const playwrightConfig = {
     testDir,
     globalTimeout: globalTimeout || 3600000,
@@ -100,16 +81,7 @@ function getPlaywrightConfig() {
       timeout: expectTimeout
     },
     use,
-    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],
+    projects: [...setupProject, ...smokeTestProject, ...projects, ...cleanupProject],
     ...uatConfig
   };
   return playwrightConfig;

package/build/core/playwright/test-runner.js

@@ -90,9 +90,11 @@ function main() {
   // overriding the user config's from CLI
   uatConfig.addAll(userArgConfig);
   const modules = uatConfig.get('modules');
+  const tearDown = uatConfig.get('isTearDown');
 
   //We need to change this process.env variable to pass the module name in future.
   process.env.modules = modules;
+  process.env.tearDown = tearDown;
   const {
     isAuthMode,
     editionOrder,