@zohodesk/testinglibrary 0.0.58-n20-experimental → 0.0.60-n20-experimental

package/.claude/worktrees/thirsty-yalow/changelog.md

@@ -1,167 +0,0 @@
-# Testing Framework
-
-## Framework that abstracts the configuration for playwright and Jest
-# 0.2.4
-- Issue fixes on custom fixtures
-  - Page Fixture
-  - i18n Fixture
-  
-# 0.2.1
-**Issue Fixes**
-- Fixes issue in actors configuration
-- Added Error Logger
-
-# 0.2.0
-**Major Breaking Change**
-- Removed Env-config.json in favour of conf/*/settings.json
-- Mode in uat.config.js is deprecated. Use command args instead
-
-**Enhancements**
-- Playwright version updated to 1.42.1
-- Playwright-bdd version updated to 6.1.1
-- Tags Support
-- Added getMetaInfo fixture to get the actors Info data
-
-**Issue Fixes**
-- Fixes #10- Mode config not working properly
-
-# 0.1.9
-**Enhancements**
-- Added option to specify browsers in command line.
-  - npm run uat -- --browsers='chrome,firefox'
-- Playwright version updated to 1.41.1
-- Added option to Skip Browser download
-- Added New Command re-run-failed to run only the failed cases
-**Major Change**
-- Default fixtures moved inside the library.(Page, Context, i18N, unauthenticatedPage)
-**Internal Library Change**
-Examples folder updated to latest testing library version.
-
-# 0.1.8
-**Issue Fixes**
-- Fix #9 Custom report generate Error on Windows
-- Add Tags annotations only on bddMode
-
-**Enhancements**
-- Added Failed steps in test summary
-
-# 0.1.7
-**Enhancements**
-- Added option to run  teardown logic.
-- Added support for tag based filtering.
-- Playwright-bdd version updated to 5.6.0.
-- New fixture added to add tag as annotations in test report
-
-**Issue Fixes**
-- Edition command option. Fixed the edition tags not generated properly
-
-# 0.1.6
-
-**Enhancements**
-- New Command option Added `--edition`.
-- New Configuration Added `editionOrder`.
-  `In uat.config.js, editionOrder: ['Free', 'Express']`
-- Cache Layer added
-
-**USAGE**
- - npm run uat --edition="Free"
-
-
-
-# 0.1.5
-
-**Enhancements**
-
-- Playwright version updated to `1.40.1`
-- And and But Support added
-- Added Code Suggestions support
-- Custom Reporter added. Now the report will be available in json format.
-- New Commands added.
-
-  `- help: npx ZDTestingFramework help`
-
-  - Will list down the commands available in the tool
-
-  `- clearCaches: npx ZDTestingFramework clearCaches`
-
-  - Will clear the exisiting cookies in the authentication setup
-
-**Issue Fixes**
-
-- Fixed Issue that occurs while quitting node process.
-
-# 0.1.4
-
-- `testIdAttribute` config added
-- Fixed issue while reading boolean configuration values
-
-# 0.1.3
-
-- uat config sample file updated with `bddMode` and `viewport` values
-- user configuration issue fix when the value is undefined
-
-# 0.1.2
-
-- Bdd version updated to `5.4.0`
-- Playwright version updated to `1.39.0`
-
-# 0.1.1
-
-- Fixed post install script error
-- Fixed error `@cucumber/gherkin` not found. Cause of this issue is updating @cucumber/cucumber to 9.5.0. Reverting this version to 9.2.0
-- Removed testing library exports
-
-# 0.1.0
-
-- Removed eslint as dev dependencies as it causes `npm aliases not supported error` for npm version < 6
-
-# 0.0.9
-
-- Video sized in report adjusted to viewport size
-- Changes in package.json scripts while setting up project
-
-# 0.0.8
-
-- Tags Support
-- Enable running without bddmode feature
-- viewport configuration
-- Internal Change - Code refactoring
-
-# 0.0.7
-
-- Removed react and react-dom as dependencies. Added this as peer dependency
-
-# 0.0.6
-
-## Provided Initial Support for cucumber feature files
-
-    - Playwright-bdd and cucumber added as dependencies
-    - Added config bddMode which toggles the feature files processing
-    - Added expect timeout and test timeout as an option
-    - Decorators support for given, when and then. Typescript support needed to use this feature
-
-## Internal Library change
-
-    - Provided support for import/export statements
-
-# 0.0.5
-
-- Added Init command to initialize the folder structure and configuration for testing
-- Renamed config.json to env-config.json
-- Configured report file path directory and Handled Edge case in Cookies Handling
-
-# 0.0.4
-
-- Issue Fixes while loading the storage state
-
-# 0.0.3
-
-- Added Support for custom config generator based on user preferences
-
-# 0.0.2
-
-- Fix for Finding directories inside node_modules folder
-
-# 0.0.1
-
-- test and report command support

package/.claude/worktrees/thirsty-yalow/jest.config.js

@@ -1,82 +0,0 @@
-const path = require('path');
-const { existsSync } = require('fs');
-const appPath = process.cwd();
-
-const appGlobals = path.resolve(appPath, '__testUtils__', 'globals.js');
-
-module.exports = {
-  reporters: [
-    "default",
-    [
-      "jest-html-reporter",
-      {
-        outputPath: "unit_reports/unit-report.html",
-        pageTitle: "Unit Report"
-      }
-    ]
-  ],
-  rootDir: process.cwd(),
-  testEnvironment: 'node',
-
-  setupFilesAfterEnv: [
-    existsSync(appGlobals) && appGlobals,
-    path.resolve(__dirname, 'src', 'core', 'jest', 'setup', 'index.js')
-  ].filter(Boolean),
-
-  transform: {
-    '^.+\\.(js|jsx)$': path.resolve(
-      __dirname,
-      'src',
-      'core',
-      'jest',
-      'preprocessor',
-      'jsPreprocessor.js'
-    ),
-    '^.+\\.jsx?$': 'babel-jest'
-  },
-  
-  testMatch: ['**/__tests__/**/*.test.js'],
-
-  modulePathIgnorePatterns: ['/build/'],
-
-  transformIgnorePatterns: [
-    '/node_modules/',
-    '/src/setup-folder-structure/samples/'
-  ],
-
-  coveragePathIgnorePatterns:[
-    '/src/setup-folder-structure/samples/'
-  ],
-
-  testPathIgnorePatterns: [
-    '/node_modules/',
-    '/build/',
-    '/uat/'
-  ],
-
-  watchPathIgnorePatterns: [
-    '/node_modules/',
-    '/build/'
-  ],
-
-  clearMocks: true,
-  resetMocks: false,
-
-  collectCoverage: true,
-  collectCoverageFrom: ['src/**/*.js'],
-  coverageDirectory: './build/cov',
-  coverageReporters: ['lcov', 'json', 'html', 'json-summary', 'text'],
-  // coverageThreshold: {
-  //   global: {
-  //     branches: 100,
-  //     functions: 100,
-  //     lines: 100,
-  //     statements: 100
-  //   }
-  // },
-  globals: {
-    __DEVELOPMENT__: true,
-    __DOCS__: false,
-    __TEST__: true
-  }
-};

package/.claude/worktrees/thirsty-yalow/package.json

@@ -1,62 +0,0 @@
-{
-  "name": "@zohodesk/testinglibrary",
-  "version": "3.2.21",
-  "description": "",
-  "main": "./build/index.js",
-  "scripts": {
-    "postinstall": "node bin/postinstall.js",
-    "test": "jest",
-    "clean": "rm -rf build && mkdir build",
-    "build-babel": "babel -d ./build ./src --copy-files",
-    "build": "npm run clean && npm run build-babel",
-    "prepare": "npm run build",
-    "lint": "eslint src/* --fix"
-  },
-  "exports": {
-    ".": "./build/index.js",
-    "./helpers": "./build/core/playwright/helpers/auth/index.js",
-    "./DataGenerator": "./build/core/dataGenerator/DataGenerator.js",
-    "./thirdPartyHelper": "./build/core/playwright/helpers/thirdPartyLib.js"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@babel/code-frame": "7.27.1",
-    "@babel/preset-react": "7.22.5",
-    "@cucumber/cucumber": "11.3.0",
-    "@playwright/test": "1.53.2",
-    "@reportportal/agent-js-playwright": "5.1.11",
-    "@testing-library/jest-dom": "5.11.9",
-    "babel-jest": "29.6.2",
-    "babel-plugin-transform-dynamic-import": "2.1.0",
-    "fast-glob": "3.3.1",
-    "jest": "29.6.2",
-    "jest-environment-jsdom": "29.6.2",
-    "msw": "1.2.3",
-    "playwright": "1.53.2",
-    "playwright-bdd": "8.3.1",
-    "properties-reader": "2.3.0",
-    "supports-color": "8.1.1",
-    "jsonpath": "^1.1.1"
-  },
-  "bin": {
-    "ZDTestingFramework": "./bin/cli.js"
-  },
-  "peerDependencies": {
-    "eslint": "*",
-    "react": "*",
-    "react-dom": "*"
-  },
-  "devDependencies": {
-    "@babel/cli": "7.22.15",
-    "@babel/core": "7.22.17",
-    "@babel/node": "7.22.15",
-    "@babel/plugin-transform-runtime": "7.22.15",
-    "@babel/polyfill": "7.12.1",
-    "@babel/preset-env": "7.22.15",
-    "@babel/runtime": "7.22.15",
-    "commander": "11.0.0",
-    "jest-html-reporter": "3.10.2"
-  }
-}

package/.claude/worktrees/thirsty-yalow/playwright.config.js

@@ -1,62 +0,0 @@
-// @ts-check
-const { defineConfig, devices } = require('@playwright/test');
-const path = require('path');
-const numCPUs = require('os').cpus().length;
-
-export default defineConfig({
-  testDir: path.join(path.resolve(process.cwd()), 'uat'),
-  outputDir: path.join(process.cwd(), 'uat', 'test-results'),
-  fullyParallel: true,
-  retries: process.env.CI ? 2 : 0,
-  reporter: [['html', { outputFolder: path.join(process.cwd(), 'uat', 'playwright-report'), open: "always" }]],
-  timeout: 60 * 1000,
-  expect: {
-    timeout: 5 * 1000,
-  },
-  use: {
-    trace: 'on',
-    video: {
-      mode: 'on',
-      size: { width: 640, height: 480 }
-    }
-  },
-  projects: [
-    { name: 'setup', testMatch: /.*\.setup\.js/ },
-    {
-      name: 'chromium',
-      use: {
-        ...devices['Desktop Chrome'],
-        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    {
-      name: 'firefox',
-      timeout: 4 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Firefox'],
-        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    {
-      name: 'webkit',
-      timeout: 2 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Safari'],
-        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-  ],
-});
-

package/AUTO_CLEANUP_PLAN.md

@@ -1,171 +0,0 @@
-# Data Generator System — Design & Current State
-
-## Data Generator Overview
-
-### How It Works
-- BDD step: `Given generate a "{Type}" entity "{name}" with generator "{GeneratorName}"`
-- Framework builds a **global generator index** at first use — scans all `*.generators.json` files under `modules/`
-- Generator names must be **unique across the entire UAT suite**
-- `ZDTestingFramework validate` checks for duplicate generator names before test run
-- Data generated using **org-level OAuth credentials** (org-oauth) by default
-- When scenario runs under a non-admin profile (`@profile_agent`), data generation still uses org-level `data-generator` — falls back automatically if profile has no own credentials
-
-### Generator File Convention
-- **Pattern:** `*.generators.json` (configurable via `generatorFilePattern` in `uat.config.js`)
-- **Location:** anywhere under `modules/` — discovered globally via recursive scan
-- **Examples:** `ticket.generators.json`, `account.generators.json`, `webhook.generators.json`
-
-### Generator JSON Structure
-```json
-{
-    "generators": {
-        "GeneratorName": [
-            {
-                "type": "dynamic",
-                "name": "stepName",
-                "generatorOperationId": "support.Module.operationName",
-                "dataPath": "$.response.body:$",
-                "params": { "key": "$previousStep.value" }
-            }
-        ]
-    }
-}
-```
-
-### Discovery Mechanism
-- **Index-based** — built once, O(1) lookups
-- `#getModulesRoot()` uses `configConstants.TEST_SLICE_FOLDER + stage + 'modules'` (deterministic)
-- Scans recursively for files matching `generatorFilePattern` (default: `*.generators.json`)
-- First generator name match wins (no duplicates enforced by validator)
-
-### Profile Resolution for Data Generation
-- **Default (no `using` profile):** Uses org-level `data-generator` from edition JSON. If scenario profile (e.g., `@profile_agent`) has no `data-generator`, falls back to org-level via `getListOfActors()`.
-- **Explicit profile (`using "agent" profile`):** Resolves that profile's credentials via `getUserForSelectedEditionAndProfile()`.
-
-### Constraints
-| Constraint | Detail |
-|---|---|
-| **Unique generator names** | Generator names must be unique across all `*.generators.json` files |
-| **Global discovery** | Framework scans entire `modules/` tree — generators in any module are accessible from any feature file |
-| **File pattern** | Configurable via `generatorFilePattern` in `uat.config.js` (default: `*.generators.json`) |
-| **DG_API_NAME matching** | In Gherkin data tables, `DG_API_NAME` column matches generator step's `name` field to inject params |
-| **Chained steps** | Multi-step generators use `$previousStep.value` syntax to pass output between steps |
-| **dataPath extraction** | `dataPath` uses JSONPath to extract specific fields from DG service response |
-| **Cached response** | Generated data is cached via `cacheLayer.set(entityName, response.data)` for use in subsequent steps |
-| **Org-level auth fallback** | If profile has no `data-generator`, org-level config from edition JSON is used automatically |
-
----
-
-## Current Generators
-
-| Generator | File | Steps | Used By |
-|---|---|---|---|
-| `TicketWithDepartment` | `Ticket/data-generators/ticket.generators.json` | getDepartments → createProduct → createTicket | 452+ scenarios |
-| `TicketBasic` | `Ticket/data-generators/ticket.generators.json` | getDepartments → createTicket (no product) | Express/Free editions |
-| `CreateAccountRecord` | `Account/data-generators/account.generators.json` | createAccount | 37 scenarios |
-| `CreateContactRecord` | `Contact/data-generators/contact.generators.json` | createContact | 42 scenarios |
-| `CreateContractRecord` | `Contract/DV/Subtabs/*/data-generators/contract.generators.json` | getDepartments → createAccount → createContract | 4 scenarios |
-| `CreateWebhookRecord` | `Webhooks/List/data-generators/webhook.generators.json` | createWebhook (with default subscriptions) | Webhook scenarios |
-| `ProductWithDepartment` | `Search/products/data-generators/products.generators.json` | getDepartments → createProduct | Product/Search scenarios |
-
----
-
-## Auto-Cleanup — Design (Not Yet Implemented)
-
-### Status
-- **V1 implemented then removed** in `0.0.47` — CleanupTracker + DataCleanup were too tightly coupled
-- **V2 planned** — proper redesign needed
-
-### Why Cleanup Was Removed
-1. `cleanupTracker` fixture added complexity to all step definitions (extra parameter)
-2. Cleanup ran inside fixture teardown — failures were hard to debug
-3. REST API cleanup needed auth that wasn't available in the cleanup context
-4. No way to control cleanup order for cross-entity dependencies
-
-### V2 Design Principles
-1. **Cleanup config stays in generator JSON** — `cleanup` property on each step (same as V1)
-2. **Separate cleanup phase** — not in fixture teardown, but as explicit post-scenario hook
-3. **Auth-aware** — cleanup uses the same `actorInfo` that created the data
-4. **Configurable** — cleanup can be disabled per scenario or globally
-5. **Non-blocking** — cleanup failures never fail the test
-
-### Cleanup Types (unchanged from V1 design)
-
-#### Type 1: `oas` — DG service delete
-```json
-"cleanup": {
-    "type": "oas",
-    "operationId": "support.Contact.deleteContact",
-    "idPath": "$.id"
-}
-```
-
-#### Type 2: `api` — Direct REST API DELETE
-```json
-"cleanup": {
-    "type": "api",
-    "method": "DELETE",
-    "apiPath": "/api/v1/contracts/{id}",
-    "idPath": "$.id"
-}
-```
-
-#### Type 3: `api` — Disable via PATCH
-```json
-"cleanup": {
-    "type": "api",
-    "method": "PATCH",
-    "apiPath": "/api/v1/webhooks/{id}",
-    "idPath": "$.id",
-    "body": { "isActive": false }
-}
-```
-
-#### No cleanup — read-only operations
-Steps without `cleanup` property are skipped (e.g., `getDepartments`).
-
-### V2 Implementation Plan
-
-1. **CleanupManager** (replaces CleanupTracker + DataCleanup)
-   - Single class managing both tracking and execution
-   - Runs after scenario via `testSetup` hook (not fixture teardown)
-   - Uses `actorInfo` from the generation step for auth
-
-2. **Config flag** in `uat.config.js`:
-   ```javascript
-   autoCleanup: true,  // default: true
-   cleanupTimeout: 30000  // per-entity timeout
-   ```
-
-3. **Per-scenario opt-out** via tag:
-   ```gherkin
-   @skip_cleanup
-   Scenario: Test that needs data to persist
-   ```
-
-4. **Cleanup order**: reverse of creation (dependent entities first)
-
----
-
-## Seed Data System — Design (Planned)
-
-See `SEED_DATA_PLAN.md` in the consumer repo for the full design.
-
-### Summary
-- **Edition-scoped** — data maps to edition tiers, not portal names
-- **Profile-based** — support creating data as specific profiles (agent login)
-- **OAS + REST** — both API types supported
-- **Runs before scenarios** — in `page.js` fixture after login
-- **Idempotent** — skips existing data, creates only missing
-
----
-
-## Multi-DC Portability — Design (Planned)
-
-See `MULTI_DC_STRATEGY.md` in the consumer repo for the full design.
-
-### Summary
-- **`capability` field** on each portal for DC-agnostic resolution
-- **Department aliases** in portal config for cross-DC mapping
-- **Framework resolves** by `capability` first, `orgName` fallback
-- **Same feature files** work across all DCs

package/build/core/dataGenerator/validateGenerators.js

@@ -1,82 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.validateGenerators = validateGenerators;
-var _path = _interopRequireDefault(require("path"));
-var _fs = _interopRequireDefault(require("fs"));
-var _logger = require("../../utils/logger");
-var _readConfigFile = require("../playwright/readConfigFile");
-function matchesPattern(filename, pattern) {
-  const regex = new RegExp('^' + pattern.replace(/\./g, '\\.').replace(/\*/g, '.*') + '$');
-  return regex.test(filename);
-}
-function findGeneratorFiles(dir, pattern, results = []) {
-  const entries = _fs.default.readdirSync(dir, {
-    withFileTypes: true
-  });
-  for (const entry of entries) {
-    const fullPath = _path.default.join(dir, entry.name);
-    if (entry.isDirectory()) {
-      findGeneratorFiles(fullPath, pattern, results);
-    } else if (matchesPattern(entry.name, pattern)) {
-      results.push(fullPath);
-    }
-  }
-  return results;
-}
-function validateGenerators(modulesRoot) {
-  if (!_fs.default.existsSync(modulesRoot)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Modules directory not found: ${modulesRoot}. Skipping generator validation.`);
-    return {
-      valid: true,
-      duplicates: []
-    };
-  }
-  const {
-    generatorFilePattern: pattern = '*.generators.json'
-  } = (0, _readConfigFile.generateConfigFromFile)();
-  const generatorMap = {};
-  const generatorFiles = findGeneratorFiles(modulesRoot, pattern);
-  for (const filePath of generatorFiles) {
-    try {
-      const data = _fs.default.readFileSync(filePath, 'utf8');
-      const generatorObj = JSON.parse(data);
-      if (generatorObj.generators) {
-        for (const name of Object.keys(generatorObj.generators)) {
-          if (!generatorMap[name]) {
-            generatorMap[name] = [];
-          }
-          generatorMap[name].push(filePath);
-        }
-      }
-    } catch (err) {
-      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Failed to parse generator file: ${filePath} - ${err.message}`);
-    }
-  }
-  const duplicates = Object.entries(generatorMap).filter(([, files]) => files.length > 1).map(([name, files]) => ({
-    name,
-    files
-  }));
-  if (duplicates.length > 0) {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Duplicate generator names found:');
-    for (const dup of duplicates) {
-      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `  Generator "${dup.name}" defined in:`);
-      for (const file of dup.files) {
-        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `    - ${file}`);
-      }
-    }
-    return {
-      valid: false,
-      duplicates
-    };
-  }
-  const generatorCount = Object.keys(generatorMap).length;
-  _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, `Generator validation passed. ${generatorCount} unique generators found across ${generatorFiles.length} generator files.`);
-  return {
-    valid: true,
-    duplicates: []
-  };
-}

package/build/core/playwright/report-generator.js

@@ -1,42 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = generateReport;
-var _child_process = require("child_process");
-var _path = _interopRequireDefault(require("path"));
-var _logger = require("../../utils/logger");
-var _rootPath = require("../../utils/rootPath");
-var _readConfigFile = require("./readConfigFile");
-async function generateReport() {
-  // await preProcessReport()
-  const userArgs = process.argv.slice(3);
-  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-  const command = playwrightPath;
-  const {
-    reportPath: htmlPath
-  } = (0, _readConfigFile.generateConfigFromFile)();
-  const args = ['show-report', htmlPath].concat(userArgs);
-  const childProcess = (0, _child_process.spawn)(command, args, {
-    stdio: 'inherit'
-  });
-  childProcess.on('error', error => {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
-  });
-  childProcess.on('exit', (code, signal) => {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-    process.exit();
-  });
-  process.on('exit', () => {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    childProcess.kill();
-    return;
-  });
-  process.on('SIGINT', () => {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Cleaning up...');
-    childProcess.kill();
-    process.exit();
-  });
-}