@zohodesk/testinglibrary 3.2.10 → 3.2.11

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,10 +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
 
-#### Feature
-  - To store the login session in NFS, we have provided the teardown option in the configuration
 
 ### 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 = 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/setup/ProjectConfiguration.js

@@ -14,7 +14,6 @@ var _readConfigFile = require("../readConfigFile");
 const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
 const {
   isAuthMode,
-  isTearDown,
   isSmokeTest,
   bddMode,
   authFilePath,
@@ -27,6 +26,7 @@ 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;

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

@@ -15,7 +15,6 @@ const {
   bddMode,
   browsers,
   isSmokeTest,
-  isTearDown,
   isAuthMode,
   openReportOn,
   reportPath,
@@ -33,7 +32,6 @@ const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
   isSmokeTest,
-  isTearDown,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -70,6 +68,7 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, {
 function getPlaywrightConfig() {
   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,

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,12 +1,12 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "3.2.10",
+  "version": "3.2.11",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@zohodesk/testinglibrary",
-      "version": "3.2.10",
+      "version": "3.2.11",
       "hasInstallScript": true,
       "license": "ISC",
       "dependencies": {
@@ -23,6 +23,7 @@
         "fast-glob": "3.3.1",
         "jest": "29.6.2",
         "jest-environment-jsdom": "29.6.2",
+        "jsonpath": "1.1.1",
         "msw": "1.2.3",
         "playwright": "1.53.2",
         "playwright-bdd": "8.3.1",
@@ -5431,8 +5432,7 @@
       "version": "0.1.4",
       "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz",
       "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==",
-      "license": "MIT",
-      "peer": true
+      "license": "MIT"
     },
     "node_modules/deepmerge": {
       "version": "4.3.1",
@@ -6199,8 +6199,7 @@
       "version": "2.0.6",
       "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
       "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==",
-      "license": "MIT",
-      "peer": true
+      "license": "MIT"
     },
     "node_modules/fastq": {
       "version": "1.19.1",
@@ -9297,6 +9296,29 @@
         "node": ">=6"
       }
     },
+    "node_modules/jsonpath": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/jsonpath/-/jsonpath-1.1.1.tgz",
+      "integrity": "sha512-l6Cg7jRpixfbgoWgkrl77dgEj8RPvND0wMH6TwQmi9Qs4TFfS9u5cUFnbeKTwj5ga5Y3BTGGNI28k117LJ009w==",
+      "license": "MIT",
+      "dependencies": {
+        "esprima": "1.2.2",
+        "static-eval": "2.0.2",
+        "underscore": "1.12.1"
+      }
+    },
+    "node_modules/jsonpath/node_modules/esprima": {
+      "version": "1.2.2",
+      "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.2.2.tgz",
+      "integrity": "sha512-+JpPZam9w5DuJ3Q67SqsMGtiHKENSMRVoxvArfJZK01/BfLEObtZ6orJa/MtoGNR/rfMgp5837T41PAmTwAv/A==",
+      "bin": {
+        "esparse": "bin/esparse.js",
+        "esvalidate": "bin/esvalidate.js"
+      },
+      "engines": {
+        "node": ">=0.4.0"
+      }
+    },
     "node_modules/keyv": {
       "version": "4.5.4",
       "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz",
@@ -11476,6 +11498,96 @@
       "integrity": "sha512-oeVtt7eWQS+Na6F//S4kJ2K2VbRlS9D43mAlMyVpVWovy9o+jfgH8O9agzANzaiLjclA0oYzUXEM4PurhSUChw==",
       "license": "MIT"
     },
+    "node_modules/static-eval": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/static-eval/-/static-eval-2.0.2.tgz",
+      "integrity": "sha512-N/D219Hcr2bPjLxPiV+TQE++Tsmrady7TqAJugLy7Xk1EumfDWS/f5dtBbkRCGE7wKKXuYockQoj8Rm2/pVKyg==",
+      "license": "MIT",
+      "dependencies": {
+        "escodegen": "^1.8.1"
+      }
+    },
+    "node_modules/static-eval/node_modules/escodegen": {
+      "version": "1.14.3",
+      "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.14.3.tgz",
+      "integrity": "sha512-qFcX0XJkdg+PB3xjZZG/wKSuT1PnQWx57+TVSjIMmILd2yC/6ByYElPwJnslDsuWuSAp4AwJGumarAAmJch5Kw==",
+      "license": "BSD-2-Clause",
+      "dependencies": {
+        "esprima": "^4.0.1",
+        "estraverse": "^4.2.0",
+        "esutils": "^2.0.2",
+        "optionator": "^0.8.1"
+      },
+      "bin": {
+        "escodegen": "bin/escodegen.js",
+        "esgenerate": "bin/esgenerate.js"
+      },
+      "engines": {
+        "node": ">=4.0"
+      },
+      "optionalDependencies": {
+        "source-map": "~0.6.1"
+      }
+    },
+    "node_modules/static-eval/node_modules/estraverse": {
+      "version": "4.3.0",
+      "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz",
+      "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==",
+      "license": "BSD-2-Clause",
+      "engines": {
+        "node": ">=4.0"
+      }
+    },
+    "node_modules/static-eval/node_modules/levn": {
+      "version": "0.3.0",
+      "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz",
+      "integrity": "sha512-0OO4y2iOHix2W6ujICbKIaEQXvFQHue65vUG3pb5EUomzPI90z9hsA1VsO/dbIIpC53J8gxM9Q4Oho0jrCM/yA==",
+      "license": "MIT",
+      "dependencies": {
+        "prelude-ls": "~1.1.2",
+        "type-check": "~0.3.2"
+      },
+      "engines": {
+        "node": ">= 0.8.0"
+      }
+    },
+    "node_modules/static-eval/node_modules/optionator": {
+      "version": "0.8.3",
+      "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz",
+      "integrity": "sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==",
+      "license": "MIT",
+      "dependencies": {
+        "deep-is": "~0.1.3",
+        "fast-levenshtein": "~2.0.6",
+        "levn": "~0.3.0",
+        "prelude-ls": "~1.1.2",
+        "type-check": "~0.3.2",
+        "word-wrap": "~1.2.3"
+      },
+      "engines": {
+        "node": ">= 0.8.0"
+      }
+    },
+    "node_modules/static-eval/node_modules/prelude-ls": {
+      "version": "1.1.2",
+      "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz",
+      "integrity": "sha512-ESF23V4SKG6lVSGZgYNpbsiaAkdab6ZgOxe52p7+Kid3W3u3bxR4Vfd/o21dmN7jSt0IwgZ4v5MUd26FEtXE9w==",
+      "engines": {
+        "node": ">= 0.8.0"
+      }
+    },
+    "node_modules/static-eval/node_modules/type-check": {
+      "version": "0.3.2",
+      "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz",
+      "integrity": "sha512-ZCmOJdvOWDBYJlzAoFkC+Q0+bUyEOS1ltgp1MGU03fqHG+dbi9tBFU2Rd9QKiDZFAYrhPh2JUf7rZRIuHRKtOg==",
+      "license": "MIT",
+      "dependencies": {
+        "prelude-ls": "~1.1.2"
+      },
+      "engines": {
+        "node": ">= 0.8.0"
+      }
+    },
     "node_modules/stop-iteration-iterator": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz",
@@ -11983,6 +12095,12 @@
         "url": "https://github.com/sponsors/ljharb"
       }
     },
+    "node_modules/underscore": {
+      "version": "1.12.1",
+      "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz",
+      "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw==",
+      "license": "MIT"
+    },
     "node_modules/undici-types": {
       "version": "7.12.0",
       "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.12.0.tgz",
@@ -12405,7 +12523,6 @@
       "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz",
       "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==",
       "license": "MIT",
-      "peer": true,
       "engines": {
         "node": ">=0.10.0"
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "3.2.10",
+  "version": "3.2.11",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -35,6 +35,7 @@
     "fast-glob": "3.3.1",
     "jest": "29.6.2",
     "jest-environment-jsdom": "29.6.2",
+    "jsonpath": "1.1.1",
     "msw": "1.2.3",
     "playwright": "1.53.2",
     "supports-color": "8.1.1",