@zohodesk/testinglibrary 0.1.9 → 0.1.16-experimental

package/.babelrc

@@ -13,10 +13,12 @@
     ]
   ],
   "plugins": [
-      ["@babel/plugin-transform-runtime"]
+      ["@babel/plugin-transform-runtime"],
+      ["@babel/plugin-transform-modules-commonjs"]
   ],
   // Ignored as these are setup files needed during init script. Files inside that folder are copied not transformed
   "ignore": [
-    "./src/setup-folder-structure/samples"
+    "./src/setup-folder-structure/samples",
+    "./src/common/**"
   ]
 }

package/.claude/settings.local.json

@@ -0,0 +1,14 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(cd /Users/muthu-19817/git/pipeline_scripts/CLIENTUAT && echo \"=== src/desk_client_app.sh \\(worker + run_uat part\\) ===\" && grep -n -A3 -B1 -E \"WORKERS|run_uat|is_cd_execution|shard\" src/desk_client_app.sh)",
+      "Read(//Users/muthu-19817/git/pipeline_scripts/CLIENTUAT/**)",
+      "Bash(curl -s \"https://api.github.com/repos/vitalets/playwright-timeline-reporter\")",
+      "Bash(python3 -c \"import json,sys; d=json.load\\(sys.stdin\\); print\\({k:d.get\\(k\\) for k in ['full_name','description','stargazers_count','forks_count','open_issues_count','created_at','updated_at','pushed_at','license','archived','default_branch','homepage']}\\)\")",
+      "Bash(mkdir -p \"/private/tmp/claude-502/-Users-muthu-19817-git-testing-framework/04916d48-1c69-4008-947c-820f8c6cc4da/scratchpad\")",
+      "Bash(curl -sS -L --max-time 60 \"https://raw.githubusercontent.com/vitalets/playwright-timeline-reporter/main/README.md\" -o \"/private/tmp/claude-502/-Users-muthu-19817-git-testing-framework/04916d48-1c69-4008-947c-820f8c6cc4da/scratchpad/README.md\")",
+      "Bash(curl -s \"https://api.github.com/repos/vitalets/playwright-timeline-reporter/commits?per_page=25\" -o commits.json)",
+      "Bash(python3 -c ' *)"
+    ]
+  }
+}

package/.gitlab-ci.yml

@@ -0,0 +1,206 @@
+image: zdesk-auto13.csez.zohocorpin.com/long-term-storage/node20-npm10:v1
+
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: always
+    - if: $CI_PIPELINE_SOURCE == "web"
+      when: always
+
+stages:
+  - build
+  - unit
+  - uat
+
+default:
+  cache:
+    key: build-cache
+    paths:
+      - node_modules
+      - build
+      - npm-shrinkwrap.json
+
+# Install dependencies stage
+build:
+  stage: build
+  script:
+    - npm -v
+    - node -v
+    - npm install --ignore-scripts
+    - npm run build
+    - npm install
+    - npm shrinkwrap
+    - npm run build
+    - npm pack . --pack-destination .
+    - cd examples && npm install ../zohodesk-testinglibrary-*.tgz && cd ..
+    - cd nobdd && npm install ../zohodesk-testinglibrary-*.tgz && cd ..
+  artifacts:
+    paths:
+      - zohodesk-testinglibrary-*.tgz
+      - examples/node_modules
+      - nobdd/node_modules
+
+# Unit tests stage
+unit:
+  stage: unit
+  script:
+    - npm run test
+  artifacts:
+    when: always
+    paths:
+      - unit_reports
+
+# UAT tests stage — node_modules from build artifact; browsers from runner cache
+.uat_base:
+  stage: uat
+  timeout: 20m
+  cache:
+    key: playwright-browsers
+    paths:
+      - .playwright-browsers
+  variables:
+    PLAYWRIGHT_BROWSERS_PATH: $CI_PROJECT_DIR/.playwright-browsers
+  before_script:
+    - npx --prefix examples playwright install chromium
+  needs:
+    - job: build
+      artifacts: true
+  artifacts:
+    when: always
+
+uat-auth:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uatauth || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+
+uat-noauth:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uatnoauth || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+    
+uat-profile:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uatprofile || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report 
+
+
+uat-unauth:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uatunauth || true
+    - node ../ValidateUATReport.js examples
+
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report 
+
+uat-nobdd:
+  extends: .uat_base
+  script:
+    - cd nobdd
+    - npm run uatnobdd -- --headless || true
+    - node ../ValidateUATReport.js nobdd
+
+
+  artifacts:
+    paths:
+      - nobdd/test-slices/uat/playwright-report
+
+
+uatmodule:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uatmodule || true
+    - node ../ValidateUATReport.js examples
+
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+
+uatconfigmodule:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uatconfigmodule || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+
+uat-smoketest:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uat-smoketest || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+
+uat-multiactor:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uat-multiactor || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+      
+uat-data_generator:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uat-data_generator || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+
+uat-data_generator_v2:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uat-data_generator_v2 || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report
+
+uat-search_indexing:
+  extends: .uat_base
+  script:
+    - cd examples
+    - npm run uat-search_indexing || true
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    paths:
+      - examples/test-slices/uat/playwright-report

package/README.md

@@ -12,7 +12,270 @@
   ### Run TestCase
 
     - npm run test
+
   ### Generate Report
 
      - npm run report
-    
+
+### v4.2.0/v3.4.0 - 22-07-2026
+
+#### Feature
+- Error segregation support for failing tests.
+- Failures are classified into `CODE`, `CASE`, `TOOL`, and `ENVIRONMENT` using pattern-based matching on runtime browser logs and test stdout/stderr.
+- Controlled via the `failureSegregation` option in `uat-config` (default: `true`). When enabled, runtime logs are collected on failure and used for classification.
+
+### v4.1.9/v3.3.5 - 03-07-2026
+
+#### Feature
+- PortalDomain option provided in the settings.json.
+- This lets customer portal and related UAT flows resolve the portal URL from configuration instead of hardcoding environment-specific links.
+- It simplifies switching between setups such as dev, QA, and UAT without changing test code.
+
+
+### v4.1.5/v3.3.3 - 19-06-2026
+
+#### Refactor
+- Authenticator module refactored to use static imports instead of dynamic imports
+- Removed unnecessary `extends Authenticator` from concrete authenticator classes (`JWTauthenticator`, `OAuthAuthenticator`, `OrgOAuthAuthenticator`, `CookieAuthenticator`) to eliminate circular dependency
+- Unit test cases updated to align with actual source behavior
+
+### v4.1.4/v3.3.3 - 18-06-2026
+
+#### Bugfix
+- Dependency project failure stats pushed into custom reporter
+- `stepDefinitionsFolder` hardcoded changes removed
+
+### v4.1.3/v3.3.2 - 08-06-2026
+
+#### Features
+ - Scenario-Based Timeouts: Define custom execution limits directly in your feature files using Gherkin tags (e.g., @timeout_180).
+
+### v4.1.2/v3.3.1 - 21-05-2026
+
+#### Features
+- Supported UnitTest via testing-framework
+
+### v4.1.1/v3.3.0 - 28-01-2026
+
+#### Features
+  - Supported E2E configuration in testing-framework
+
+### v4.0.6/v3.2.21 - 22-01-2026
+
+#### Bug fix
+- Retry added for Missing Step Definitions Issue in the Feature Files
+
+### v4.0.5 - 08-01-2026
+
+#### Bug fix
+- @cucumber/cucumber depedency removed from testing-framework package.json
+
+### v4.0.4/v3.2.20 - 19-12-2025
+
+#### Enhancement
+- New common step provided for search index with the data generated entity
+
+### v4.0.3/v3.2.19 - 17-12-2025
+
+#### Enhancement
+- Cookie storage prefix support is provided in this version.
+
+### v4.0.2 - 16-12-2025
+ 
+#### Bug Fixes
+ 
+ - Deprecated the react and react hooks from dependencies
+ - @cucumber/cucumber - 10.9.0 version downgraded due to Missing Step Definition Issue
+
+
+### v4.0.0 - 04-12-2025
+ 
+#### Features
+- Supported node 20 for the testing-framework
+ 
+- Below package versions are updated in this release.
+- playwright - 1.56.1,
+- playwright-bdd - 8.4.2,
+- @playwright/test - 1.56.1,
+- @cucumber/cucumber - 12.2.0
+
+### v3.2.15 - 14-11-2025
+
+#### Enhancement
+
+- Aborted test results are now merged into the `.last-run.json` file.  
+  This ensures that any timed-out tests are included in the next retry cycle.
+
+### v3.2.13 - 30-10-2025
+ 
+#### Enhancement
+
+- A teardown option has been introduced in the configuration to manage and clean up login sessions stored in the NFS environment.
+
+### Issue fix
+
+- Custom teardown comment provided
+
+### 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
+ 
+
+### 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
+
+### 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
+  - Fixed a bug where the default profile page was not being handled properly in `this`.
+
+### v3.2.6 - 05-09-2025
+
+#### Feature
+
+  - Multi-actor execution support – now possible to switch between multiple profile agents within scenarios using the predefined step: - `access the {string} profile page`
+
+### Bug fix
+
+  - Fixed the issue where localapp and hcapp UAT were not running properly.
+
+### v3.2.5 - 28-08-2025
+
+#### Enhancement
+
+  - Removed the searchFake dependency from the project level and adopted it inside the framework, reducing project-side maintenance. use this predefined step: - `Given (a search entity)`
+
+### v3.2.4 - 29-07-2025
+
+#### Feature
+  - Data Generator steps are now supported directly via the framework.
+
+### Bug fix
+  - Feature File Root Directory not found issue fixed
+
+### v3.2.3 - 29-07-2025
+
+#### Feature
+  - Added support for running Smoke Tests in the UAT stage.
+
+### v3.2.0 - 22-06-2025
+
+#### Feature
+  - Default required spec files are now auto-imported from the library into the project.
+
+### v3.1.13 - 02-07-2025
+
+#### Enhancement
+  - Below package versions are updated in this release.
+    - @cucumber/Cucumber - 11.3.0
+    - Playwright/test - 1.53.2
+    - Playwright - 1.53.2
+    - Playwright-bdd - 8.3.1
+  - QC custom reporter changes have been adopted into the framework.
+
+### v3.1.5 - 22-05-2025
+
+#### Feature
+  - Added support for Module Based Execution UAT stage.
+
+### v3.1.4 - 12-05-2025
+
+#### Enhancement
+  - Playwright version 1.52.0 adopted in testing framework
+
+### v3.1.3 - 25-04-2025
+
+#### Enhancement
+  - Playwright version 1.51.0 adopted in testing framework
+
+### v0.2.8 - 26-09-2024
+
+#### Feature
+  - Added support for writing unitcases for framework implementations
+
+### Bug fix
+  - Updated the custom-reported to include the errors in tests during the executions. It will help us avoid the stage passed without the actual test execution. 
+
+
+### v3.0.8 - 25-12-2024
+
+#### Enhancement
+  - Added support to disable headless mode using command line arguments
+  - Proper validation added for node 14 build process
+  - Removed unwanted uat.config.js files in test projects (examples / nobdd)
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+  - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.
+  
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.
+
+### v0.2.9.1 - 14-11-2024
+
+#### Enhancement
+   - Beta feature Actors and edition configurations are unified 
+
+### v0.2.9 - 25-10-2024
+
+#### Feature
+  - Added support for scenario level tag support
+  - Added a new cli optin like uat-validate to validate the feature files using playwright-bdd
+  - Mode based configuration implementations
+  - @only option enabled in dev pipeline
+  - Latest setup related configuration changed for init option
+
+### v0.3.0 - 25-10-2024
+
+#### Features
+  - Added support for scenario level tag support
+  - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
+  - Below package versions are updated in this release. 
+    - playwright - 1.48.0, 
+    - playwright-bdd - 7.5.0,
+    - @playwright/test - 1.48.0,
+    - @cucumber/cucumber - 11.0.1
+  - From this version, We adopt the playwright-bdd as library instead of modified source
+  - Published on 11-11-2024
+  
+#### Deprecations
+  - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
+  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
+
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.
+
+### v0.3.3 - 27-11-2024
+
+#### Feature
+- Custom report integration support (ReportPortal)
+
+### v0.2.9.1 - 14-11-2024
+
+#### Enhancement
+   - Beta feature Actors and edition configurations are unified 
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+    - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.

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

@@ -0,0 +1,19 @@
+import { createBdd , test } from '@zohodesk/testinglibrary';
+import { generateAndCacheTestData } from './DataGeneratorStepsHelper';  
+
+const { Given } = createBdd();
+
+Given('generate a {string} entity {string} with generator {string}', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, generatorName, dataTable) => {
+    await generateAndCacheTestData({ executionContext, type: "template", identifier: generatorName, dataTable, cacheLayer, entityName, page });
+});
+
+Given('generate a {string} entity {string} with API {string}', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, dataTable) => {
+    await generateAndCacheTestData({ executionContext, type: "API", identifier: operationId, dataTable, cacheLayer, entityName, page });
+});
+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, type: "template", identifier: generatorName, dataTable, cacheLayer, entityName, profile, page });
+});
+
+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, type: "API", identifier: operationId, dataTable, cacheLayer, entityName, profile, page });
+});

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

@@ -0,0 +1,21 @@
+import { test } from '@zohodesk/testinglibrary';
+import DataGenerator from '@zohodesk/testinglibrary/DataGenerator';
+ import {getUserForSelectedEditionAndProfile} from '@zohodesk/testinglibrary/helpers'
+
+const dataGenerator = new DataGenerator();
+
+export async function generateAndCacheTestData({ executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null, page = null }) {
+    let actorInfo;
+    const testInfo = test.info();
+    const scenarioName = testInfo.title.split('/').pop() || 'Unknown Scenario';
+
+    if (profile) {
+        const { edition, orgName: portal, beta } = executionContext.actorInfo;
+        actorInfo = await getUserForSelectedEditionAndProfile(edition, profile, beta, portal);
+    } else {
+        actorInfo = executionContext.actorInfo;
+    }
+    
+    const generatedData = await dataGenerator.generate(testInfo, actorInfo, type, identifier, scenarioName, dataTable ? dataTable.hashes() : [], page);
+    await cacheLayer.set(entityName, generatedData.data);
+}

package/build/common/multi-actor/steps/multiActorHandling.spec.js

@@ -0,0 +1,26 @@
+import { createBdd } from '@zohodesk/testinglibrary';
+const { BeforeScenario, Given } = createBdd();
+
+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];
+        if (userPage) {
+            this.page = userPage.page;
+            this.context = userPage.context;
+            this.browser = userPage.browser;
+            this.executionContext = userPage.executionContext;
+        } else {
+            throw new Error(`Actor "${role}" not found in user pages.`);
+        }
+    }
+});
+
+Given("access the {string} profile page", async function({ page }, userRole) {
+    await this.setActor(userRole);
+});

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

@@ -0,0 +1,52 @@
+import { expect } from '@zohodesk/testinglibrary';
+
+async function executeRpcRequest(page, payload) {
+
+    const url = new URL(page.url());
+    const baseUrl = `${url.protocol}//${url.host}`;
+    const invokeURL = `${baseUrl}/api/testing/acceptanceTest/rpc/invoke`;
+    
+    try {
+        const response = await page.request.post(invokeURL, {
+            headers: {'Content-Type': 'application/json'},
+            data: payload
+        });
+
+        if (!response.ok()) {
+            throw new Error(`HTTP ${response.status()}: ${response.statusText()}`);
+        }
+
+        const responseData = await response.json();
+        expect(responseData.data).toHaveProperty('status', 'success');
+
+    } catch (error) {
+        throw error;
+    }
+}
+
+
+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 || (!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());
+    }
+
+    return payload;
+}
+
+module.exports = { executeRpcRequest, entityIdReConstructor };