@zohodesk/testinglibrary 0.0.11-n20-experimental → 0.0.12-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/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/runner/SpawnRunner.js

@@ -32,7 +32,6 @@ class SpawnRunner extends _Runner.default {
   }
   runPreprocessing() {
     console.log("Node version:", process.version);
-    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, "Node version- " + process.version);
     //This below functoin is called to copy the data generator spec files to the current project
     (0, _commonUtils.copyCommonSpecs)();
     const {

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,

package/npm-shrinkwrap.json

@@ -1,21 +1,21 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.0.11-n20-experimental",
+  "version": "0.0.12-n20-experimental",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@zohodesk/testinglibrary",
-      "version": "0.0.11-n20-experimental",
+      "version": "0.0.12-n20-experimental",
       "hasInstallScript": true,
       "license": "ISC",
       "dependencies": {
         "@babel/code-frame": "7.27.1",
-        "@babel/preset-react": "7.27.1",
+        "@babel/preset-react": "7.28.5",
         "@cucumber/cucumber": "12.2.0",
-        "@playwright/test": "1.56.0",
+        "@playwright/test": "1.56.1",
         "@reportportal/agent-js-playwright": "5.2.2",
-        "@testing-library/jest-dom": "6.8.0",
+        "@testing-library/jest-dom": "6.9.1",
         "@testing-library/react": "16.3.0",
         "babel-jest": "30.1.2",
         "babel-plugin-transform-dynamic-import": "2.1.0",
@@ -1901,14 +1901,14 @@
       }
     },
     "node_modules/@babel/preset-react": {
-      "version": "7.27.1",
-      "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.27.1.tgz",
-      "integrity": "sha512-oJHWh2gLhU9dW9HHr42q0cI0/iHHXTLGe39qvpAZZzagHy0MzYLCnCVV0symeRvzmjHyVU7mw2K06E6u/JwbhA==",
+      "version": "7.28.5",
+      "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.28.5.tgz",
+      "integrity": "sha512-Z3J8vhRq7CeLjdC58jLv4lnZ5RKFUJWqH5emvxmv9Hv3BD1T9R/Im713R4MTKwvFaV74ejZ3sM01LyEKk4ugNQ==",
       "license": "MIT",
       "dependencies": {
         "@babel/helper-plugin-utils": "^7.27.1",
         "@babel/helper-validator-option": "^7.27.1",
-        "@babel/plugin-transform-react-display-name": "^7.27.1",
+        "@babel/plugin-transform-react-display-name": "^7.28.0",
         "@babel/plugin-transform-react-jsx": "^7.27.1",
         "@babel/plugin-transform-react-jsx-development": "^7.27.1",
         "@babel/plugin-transform-react-pure-annotations": "^7.27.1"
@@ -3657,12 +3657,12 @@
       }
     },
     "node_modules/@playwright/test": {
-      "version": "1.56.0",
-      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.56.0.tgz",
-      "integrity": "sha512-Tzh95Twig7hUwwNe381/K3PggZBZblKUe2wv25oIpzWLr6Z0m4KgV1ZVIjnR6GM9ANEqjZD7XsZEa6JL/7YEgg==",
+      "version": "1.56.1",
+      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.56.1.tgz",
+      "integrity": "sha512-vSMYtL/zOcFpvJCW71Q/OEGQb7KYBPAdKh35WNSkaZA75JlAO8ED8UN6GUNTm3drWomcbcqRPFqQbLae8yBTdg==",
       "license": "Apache-2.0",
       "dependencies": {
-        "playwright": "1.56.0"
+        "playwright": "1.56.1"
       },
       "bin": {
         "playwright": "cli.js"
@@ -3671,6 +3671,38 @@
         "node": ">=18"
       }
     },
+    "node_modules/@playwright/test/node_modules/fsevents": {
+      "version": "2.3.2",
+      "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
+      "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
+      "hasInstallScript": true,
+      "license": "MIT",
+      "optional": true,
+      "os": [
+        "darwin"
+      ],
+      "engines": {
+        "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
+      }
+    },
+    "node_modules/@playwright/test/node_modules/playwright": {
+      "version": "1.56.1",
+      "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.56.1.tgz",
+      "integrity": "sha512-aFi5B0WovBHTEvpM3DzXTUaeN6eN0qWnTkKx4NQaH4Wvcmc153PdaY2UBdSYKaGYw+UyWXSVyxDUg5DoPEttjw==",
+      "license": "Apache-2.0",
+      "dependencies": {
+        "playwright-core": "1.56.1"
+      },
+      "bin": {
+        "playwright": "cli.js"
+      },
+      "engines": {
+        "node": ">=18"
+      },
+      "optionalDependencies": {
+        "fsevents": "2.3.2"
+      }
+    },
     "node_modules/@reportportal/agent-js-playwright": {
       "version": "5.2.2",
       "resolved": "https://registry.npmjs.org/@reportportal/agent-js-playwright/-/agent-js-playwright-5.2.2.tgz",
@@ -3809,9 +3841,9 @@
       }
     },
     "node_modules/@testing-library/jest-dom": {
-      "version": "6.8.0",
-      "resolved": "https://registry.npmjs.org/@testing-library/jest-dom/-/jest-dom-6.8.0.tgz",
-      "integrity": "sha512-WgXcWzVM6idy5JaftTVC8Vs83NKRmGJz4Hqs4oyOuO2J4r/y79vvKZsb+CaGyCSEbUPI6OsewfPd0G1A0/TUZQ==",
+      "version": "6.9.1",
+      "resolved": "https://registry.npmjs.org/@testing-library/jest-dom/-/jest-dom-6.9.1.tgz",
+      "integrity": "sha512-zIcONa+hVtVSSep9UT3jZ5rizo2BsxgyDYU7WFD5eICBE7no3881HGeb/QkGfsJs6JTkY1aQhT7rIPC7e+0nnA==",
       "license": "MIT",
       "dependencies": {
         "@adobe/css-tools": "^4.4.0",
@@ -9753,6 +9785,18 @@
         "node": ">= 0.6"
       }
     },
+    "node_modules/playwright-core": {
+      "version": "1.56.1",
+      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.56.1.tgz",
+      "integrity": "sha512-hutraynyn31F+Bifme+Ps9Vq59hKuUCz7H1kDOcBs+2oGguKkWTU50bBWrtz34OUWmIwpBTWDxaRPXrIXkgvmQ==",
+      "license": "Apache-2.0",
+      "bin": {
+        "playwright-core": "cli.js"
+      },
+      "engines": {
+        "node": ">=18"
+      }
+    },
     "node_modules/playwright/node_modules/fsevents": {
       "version": "2.3.2",
       "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.0.11-n20-experimental",
+  "version": "0.0.12-n20-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -23,11 +23,11 @@
   "license": "ISC",
   "dependencies": {
     "@babel/code-frame": "7.27.1",
-    "@babel/preset-react": "7.27.1",
+    "@babel/preset-react": "7.28.5",
     "@cucumber/cucumber": "12.2.0",
-    "@playwright/test": "1.56.0",
+    "@playwright/test": "1.56.1",
     "@reportportal/agent-js-playwright": "5.2.2",
-    "@testing-library/jest-dom": "6.8.0",
+    "@testing-library/jest-dom": "6.9.1",
     "@testing-library/react": "16.3.0",
     "babel-jest": "30.1.2",
     "babel-plugin-transform-dynamic-import": "2.1.0",
@@ -36,8 +36,8 @@
     "jest-environment-jsdom": "30.1.2",
     "msw": "2.11.2",
     "playwright": "1.56.0",
-    "playwright-bdd": "8.4.1",
-    "supports-color": "10.2.2"
+    "supports-color": "10.2.2",
+    "playwright-bdd": "8.4.1"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"