@zohodesk/testinglibrary 0.4.2-experimental → 0.4.3-experimental

package/README.md

@@ -29,27 +29,23 @@
 
 ## Version History
 
-### 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
+### v0.2.9 - 30-09-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,
+    - playwright - 1.47.2, 
+    - playwright-bdd - 7.4.2,
+    - @playwright/test - 1.47.2,
     - @cucumber/cucumber - 11.0.1
   - From this version, We adopt the playwright-bdd as library instead of modified source
 
 #### 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'`.
+  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
+
+### v0.2.9 - 08-10-2024
+
+#### Feature
+  - Added support for scenario level tag support

package/build/core/playwright/configuration/Configuration.js

@@ -18,8 +18,5 @@ class Configuration {
   getAll() {
     return this.properties;
   }
-  delete(key) {
-    delete this.properties[key];
-  }
 }
 module.exports = Configuration;

package/build/core/playwright/configuration/ConfigurationHelper.js

@@ -12,9 +12,16 @@ var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _mergeObjects = require("../helpers/mergeObjects");
 var _fs = require("fs");
 const Configuration = require("./Configuration");
+function checkForDeprecatedKeys(configKey) {
+  let deprecatedConfigInUatConfigFile = ['mode'];
+  if (deprecatedConfigInUatConfigFile.includes(configKey)) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `key ${configKey} is deprecated. Please use other options`);
+  }
+}
 function combineConfiguration(defaultConfig, userConfiguration) {
   let configurationObj = {};
   Object.keys(userConfiguration).forEach(configKey => {
+    checkForDeprecatedKeys(configKey);
     let configValue = userConfiguration[configKey];
     if (configValue !== null && configValue !== undefined) {
       configurationObj[configKey] = configValue;
@@ -26,10 +33,10 @@ function combineConfiguration(defaultConfig, userConfiguration) {
   });
   return (0, _mergeObjects.mergeObjects)(defaultConfig, configurationObj);
 }
-function getApplicationConfig(mode) {
+function getApplicationConfig() {
   let filePath = "";
   try {
-    filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)(mode));
+    filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
     if (!(0, _fs.existsSync)(filePath)) {
       throw new Error("Exception while getting the uat file from the application - " + filePath);
     }

package/build/core/playwright/env-initializer.js

@@ -10,6 +10,7 @@ var _path = _interopRequireDefault(require("path"));
 var _configFileNameProvider = require("./helpers/configFileNameProvider");
 var _logger = require("../../utils/logger");
 var _getUsers = require("./helpers/auth/getUsers");
+var _readConfigFile = require("./readConfigFile");
 function setEnvironmentVariables(configJSON) {
   for (const key in configJSON) {
     process.env[key] = configJSON[key];

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

@@ -33,17 +33,12 @@ function getDefaultActorConf() {
   const {
     uatDirectory
   } = (0, _readConfigFile.generateConfigFromFile)();
-  const modeSettingsFile = `conf/${getRunMode()}/settings.json`;
-  const filePath = _path.default.join(uatDirectory, modeSettingsFile);
-  try {
-    if (!(0, _fs.existsSync)(filePath)) {
-      const defaultSettingsFile = _path.default.join(uatDirectory, `conf/default/settings.json`);
-      return require(defaultSettingsFile);
-    }
-    return require(filePath);
-  } catch (error) {
-    throw new Error(`${defaultSettingFile} ${filePath} both files are missing.`);
+  const defaultSettingFile = `conf/${getRunMode()}/settings.json`;
+  const filePath = _path.default.join(uatDirectory, defaultSettingFile);
+  if (!(0, _fs.existsSync)(filePath)) {
+    throw new Error(`${defaultSettingFile} is missing.`);
   }
+  return require(filePath);
 }
 function getDefaultActor() {
   const {
@@ -57,25 +52,18 @@ function getListOfActors() {
     uatDirectory
   } = (0, _readConfigFile.generateConfigFromFile)();
   const mode = getRunMode();
-  let configFile = _path.default.join(uatDirectory, `conf/${mode}/actors/index.js`);
-  if (!(0, _fs.existsSync)(configFile)) {
-    configFile = _path.default.join(uatDirectory, `conf/default/actors/index.js`);
-  }
-  try {
-    return require(configFile);
-  } catch (error) {
-    throw new Error(`Error loading actor configuration from ${configFile}`);
+  const configFile = `conf/${mode}/actors/index`;
+  const filePath = _path.default.join(uatDirectory, configFile);
+  if (!(0, _fs.existsSync)(filePath + '.js')) {
+    throw new Error(`${configFile}.js is missing.`);
   }
+  return require(filePath);
 }
 function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
-  const actorsData = getListOfActors();
-  if (!actorsData || !actorsData.editions) {
-    throw new Error("The actors data is missing.");
-  }
   const {
     editions: userdata,
     beta: betaPortals
-  } = actorsData;
+  } = getListOfActors();
   const defaultConf = getDefaultActorConf();
   const edition = preferedEdition || defaultConf.edition;
   const profile = preferredProfile || defaultConf.profile;

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

@@ -9,14 +9,8 @@ exports.getReportFileName = getReportFileName;
 exports.getUATFileName = getUATFileName;
 var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
-var _auth = require("./auth");
-function getUATFileName(mode) {
-  mode = mode || (0, _auth.getRunMode)();
-  const uatConfFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/uat.config.js`);
-  if (_fs.default.existsSync(uatConfFilePath)) {
-    return uatConfFilePath;
-  }
-  return _path.default.resolve(process.cwd(), `uat.config.js`);
+function getUATFileName() {
+  return 'uat.config.js';
 }
 function getEnvConfigFilePath(mode) {
   const confFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/settings.json`);
@@ -24,7 +18,7 @@ function getEnvConfigFilePath(mode) {
   if (_fs.default.existsSync(confFilePath)) {
     return `uat/conf/${mode}/settings.json`;
   }
-  return `uat/conf/default/settings.json`;
+  return `uat/env-config.json`;
 }
 function getReportFileName() {
   return `test-summary.json`;

package/build/core/playwright/readConfigFile.js

@@ -13,17 +13,13 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _configFileNameProvider = require("./helpers/configFileNameProvider");
 var _mergeObjects = require("./helpers/mergeObjects");
-var _Configuration = _interopRequireDefault(require("./configuration/Configuration"));
-var _UserArgs = _interopRequireDefault(require("./configuration/UserArgs"));
-var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
+var _Configuration = require("./configuration/Configuration");
 let cachedConfig = null;
 function getDefaultConfig() {
   return {
     uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],
-    forbidOnly: false,
-    retries: 0,
     trace: false,
     video: false,
     isAuthMode: false,
@@ -38,18 +34,26 @@ function getDefaultConfig() {
       height: 720
     },
     debug: false,
-    testIdAttribute: 'data-testid',
+    mode: process.env.mode || 'dev',
     additionalPages: {},
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
+    testIdAttribute: 'data-testid',
     testSetup: {},
     editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
+function checkForDeprecatedKeys(configKey) {
+  let deprecatedConfigInUatConfigFile = ['mode'];
+  if (deprecatedConfigInUatConfigFile.includes(configKey)) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `key ${configKey} is deprecated. Please use other options`);
+  }
+}
 function combineDefaultConfigWithUserConfig(userConfiguration) {
   let defaultConfig = getDefaultConfig();
   let configurationObj = {};
   Object.keys(userConfiguration).forEach(configKey => {
+    checkForDeprecatedKeys(configKey);
     let configValue = userConfiguration[configKey];
     if (configValue !== null && configValue !== undefined) {
       configurationObj[configKey] = configValue;
@@ -108,26 +112,22 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  *
  * @returns {UserConfig}
  */
-
-function getConfigFilePath() {
-  return _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
-}
 function generateConfigFromFile() {
-  if (cachedConfig === null) {
-    // Getting the default config's from framework
-    const uatConfig = new _Configuration.default(getDefaultConfig());
-    // overriding the application config's from project
-    const appConfig = new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)());
-    const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
-    // overriding the user config's from CLI
-    uatConfig.addAll(appConfig);
-    uatConfig.addAll(userArgConfig);
-    cachedConfig = uatConfig.getAll();
+  if (cachedConfig !== null) {
+    return cachedConfig; // If cached, return the cached configuration
+  }
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  if ((0, _fs.existsSync)(filePath)) {
+    /** @type {UserConfig} */
+    const config = require(filePath);
+    const modifiedConfiguration = combineDefaultConfigWithUserConfig(config);
+    cachedConfig = modifiedConfiguration;
+    return modifiedConfiguration;
   }
-  return cachedConfig;
+  return {};
 }
 function isUserConfigFileAvailable() {
-  const filePath = getConfigFilePath();
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }

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

@@ -9,7 +9,6 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
-const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
 const {
   browsers,
   trace,
@@ -26,7 +25,7 @@ const {
   stepDefinitionsFolder,
   testIdAttribute,
   globalTimeout
-} = uatConfig;
+} = (0, _readConfigFile.generateConfigFromFile)();
 const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
@@ -52,11 +51,13 @@ const use = {
  * @returns {import('@playwright/test').PlaywrightTestConfig}
  */
 function getPlaywrightConfig() {
-  const playwrightConfig = {
+  return {
     testDir,
     globalTimeout: globalTimeout || 3600000,
     outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
     fullyParallel: true,
+    forbidOnly: !!process.env.CI,
+    retries: process.env.CI ? 2 : 0,
     reporter: [['html', {
       outputFolder: reportPath,
       open: openReportOn
@@ -75,9 +76,7 @@ function getPlaywrightConfig() {
       name: 'cleanup',
       testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects],
-    ...uatConfig
+    }, ...projects] : [...projects]
   };
-  return playwrightConfig;
 }
 var _default = exports.default = (0, _test.defineConfig)(getPlaywrightConfig());

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

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-exports.runPreprocessing = runPreprocessing;
 var _child_process = require("child_process");
 var _path = _interopRequireDefault(require("path"));
 var _customCommands = require("./custom-commands");
@@ -58,7 +57,7 @@ function runPreprocessing(tagArgs, configPath) {
     });
     childProcessForPreprocessing.on('error', data => {
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
-      reject(data);
+      reject();
     });
     childProcessForPreprocessing.on('exit', code => {
       if (code === 0) {
@@ -104,16 +103,15 @@ function main() {
   const uatConfig = new _Configuration.default((0, _readConfigFile.getDefaultConfig)());
 
   // overriding the application config's from project
-
-  const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
-  const mode = userArgConfig.get("mode");
-  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)(mode)));
+  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)()));
 
   // overriding the user config's from CLI
+  const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
   uatConfig.addAll(userArgConfig);
   const {
     isAuthMode,
     editionOrder,
+    mode,
     debug,
     bddMode = false,
     headless = false

package/build/lib/cli.js

@@ -10,7 +10,6 @@ var _parser = require("../parser/parser");
 var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-caches"));
 var _helper = _interopRequireDefault(require("../setup-folder-structure/helper"));
 var _parseUserArgs = _interopRequireDefault(require("../core/playwright/helpers/parseUserArgs"));
-var _validateFeature = _interopRequireDefault(require("../core/playwright/validateFeature"));
 // import createJestRunner from '../core/jest/runner/jest-runner';
 
 const [,, option, ...otherOptions] = process.argv;
@@ -22,11 +21,6 @@ switch (option) {
       //createJestRunner();
       break;
     }
-  case 'validate':
-    {
-      (0, _validateFeature.default)();
-      break;
-    }
   case 're-run-failed':
     {
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Failed Tests..');

package/build/setup-folder-structure/samples/auth-setup-sample.js

@@ -1,21 +1,73 @@
 /* eslint-disable no-console */
 import { test as setup, expect } from '@zohodesk/testinglibrary';
-import {
-  performLoginSteps,
-  getDefaultActor
-} from '@zohodesk/testinglibrary/helpers';
+import path from 'path';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import { getAuthFileDirectory } from '../../core/playwright';
+import { Logger } from '../../utils/logger';
 
-const user = getDefaultActor();
+const userdata = require('./authUsers.json');
 
-async function verifyPageIsLoaded(page) {
-  //Implement your validation steps here
-  //Refer desk_client_app auth.setup.js
-  return true;
+const authContent = { cookies: [] };
+
+const LOGIN_ERR_MESSAGE = 'Need go be logged in';
+// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
+
+function convertCookiesToParse(cookies, authFilePath) {
+  try {
+    return JSON.parse(cookies);
+  } catch (err) {
+    Logger.error(err);
+    throw new Error(
+      ` Error while parsing cookies ${err} \n${path.resolve(
+        process.cwd(),
+        authFilePath
+      )} File is Empty`
+    );
+    // process.exit()
+  }
+}
+const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
+if (!existsSync(authDirectory)) {
+  console.log('Creating auth directory for the first time setup...');
+  mkdirSync(authDirectory, { recursive: true });
 }
 
-setup(`${user.edition} - Authentication`, async ({ page }) => {
+userdata.forEach(data => {
+  const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
+  if (!existsSync(authFile)) {
+    console.log('creating auth file..');
+    writeFileSync(authFile, JSON.stringify(authContent, null, 2));
+  }
+  setup(data.description, async ({ page }) => {
+    try {
+      const cookies = readFileSync(authFile);
+      const parsedCookies = convertCookiesToParse(cookies, authFile);
+      await page
+        .context()
+        .addCookies(
+          parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
+        );
+      await page.goto(page.getBaseUrl());
+      await page.waitForLoadState();
+      if (await page.url().includes(process.env.domain)) {
+        await page.waitForSelector(data.locator);
+      } else {
+        throw new Error(LOGIN_ERR_MESSAGE);
+      }
+    } catch (err) {
+      if (err.message === LOGIN_ERR_MESSAGE) {
+        await expect(page.locator('.load-bg')).toBeHidden();
+        await page.locator('#login_id').type(data.useremail);
+        await page.locator('#nextbtn').click();
+        await page.locator('#password').type(data.password);
+        await page.locator('#nextbtn').click();
+
+        await page.waitForLoadState('networkidle');
+
+        await page.waitForSelector(data.locator);
 
-  //Implement performLoginSteps here
-  const { email, password } = user;
-  await performLoginSteps({ },verifyPageIsLoaded );
-});
+        await page.context().storageState({ path: authFile });
+      }
+    }
+  });
+});

package/build/setup-folder-structure/samples/authUsers-sample.json

@@ -0,0 +1,9 @@
+[
+    {
+        "useremail": "/ user name /",
+        "password": "/ password /",
+        "description": "/ description/",
+        "filename": "user.json",
+        "locator": "/ selector to identify page has been loaded completely /"
+    }
+]

package/build/setup-folder-structure/samples/env-config-sample.json

@@ -0,0 +1,21 @@
+{
+  "dev": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name",
+    "devURL": "Provide your devURL here"
+  },
+  "prod": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  },
+  "k8test": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  }
+}

package/build/setup-folder-structure/setupProject.js

@@ -10,9 +10,8 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../utils/logger");
 function getScriptsToBeAdded() {
   return {
-    "uat": "ZDTestingFramework test --mode=dev --headed",
-    "uat-debug": "ZDTestingFramework test --mode=dev --debug",
-    "uat-validate": "ZDTestingFramework validate",
+    "uat": "ZDTestingFramework test --mode=prod --headed",
+    "uat-debug": "ZDTestingFramework test --mode=prod --debug",
     "uat-report": "ZDTestingFramework report --port=9009",
     "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
   };
@@ -72,6 +71,7 @@ function createAuthenticationFile() {
         });
       }
       (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
       _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
     } catch (err) {
       _logger.Logger.error(err);
@@ -84,21 +84,8 @@ function createAuthenticationFile() {
 function createConfigJson() {
   const uatFolder = _path.default.resolve(process.cwd(), 'uat');
   if ((0, _fs.existsSync)(uatFolder)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
-    if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
-      (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
-        recursive: true
-      });
-    }
-    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
-    if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
-      (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
-        recursive: true
-      });
-    }
-    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
-    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
-    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating env-config file inside UAT Folder');
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, './env-config.json'), getSetupFileAsString('env-config-sample.json'), null, 2);
   } else {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
   }

package/build/utils/cliArgsToObject.js

@@ -36,9 +36,6 @@ function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
         value = true;
       }
       processEnv[key] = value;
-      if (!isNaN(parseInt(value))) {
-        processEnv[key] = parseInt(value);
-      }
     }
   });
   return processEnv;

package/jest.config.js

@@ -56,14 +56,14 @@ module.exports = {
   collectCoverageFrom: ['src/**/*.js'],
   coverageDirectory: './build/cov',
   coverageReporters: ['lcov', 'json', 'html', 'json-summary', 'text'],
-  // coverageThreshold: {
-  //   global: {
-  //     branches: 100,
-  //     functions: 100,
-  //     lines: 100,
-  //     statements: 100
-  //   }
-  // },
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
   globals: {
     __DEVELOPMENT__: true,
     __DOCS__: false,

package/npm-shrinkwrap.json

@@ -1,18 +1,18 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.2.8",
+  "version": "0.4.3-experimental",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@zohodesk/testinglibrary",
-      "version": "0.2.8",
+      "version": "0.4.3-experimental",
       "hasInstallScript": true,
       "license": "ISC",
       "dependencies": {
         "@babel/preset-react": "7.22.5",
         "@cucumber/cucumber": "11.0.1",
-        "@playwright/test": "1.47.2",
+        "@playwright/test": "1.48.0",
         "@testing-library/jest-dom": "5.11.9",
         "@testing-library/react": "11.2.7",
         "@testing-library/react-hooks": "7.0.2",
@@ -22,8 +22,8 @@
         "jest": "29.6.2",
         "jest-environment-jsdom": "29.6.2",
         "msw": "1.2.3",
-        "playwright": "1.47.2",
-        "playwright-bdd": "7.4.2",
+        "playwright": "1.48.0",
+        "playwright-bdd": "7.5.0",
         "supports-color": "8.1.1"
       },
       "bin": {
@@ -37,8 +37,7 @@
         "@babel/polyfill": "7.12.1",
         "@babel/preset-env": "7.22.15",
         "@babel/runtime": "7.22.15",
-        "commander": "^11.0.0",
-        "typescript": "^5.4.2"
+        "commander": "^11.0.0"
       },
       "peerDependencies": {
         "eslint": "*",
@@ -3271,11 +3270,11 @@
       }
     },
     "node_modules/@playwright/test": {
-      "version": "1.47.2",
-      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.47.2.tgz",
-      "integrity": "sha512-jTXRsoSPONAs8Za9QEQdyjFn+0ZQFjCiIztAIF6bi1HqhBzG9Ma7g1WotyiGqFSBRZjIEqMdT8RUlbk1QVhzCQ==",
+      "version": "1.48.0",
+      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.48.0.tgz",
+      "integrity": "sha512-W5lhqPUVPqhtc/ySvZI5Q8X2ztBOUgZ8LbAFy0JQgrXZs2xaILrUcNO3rQjwbLPfGK13+rZsDa1FpG+tqYkT5w==",
       "dependencies": {
-        "playwright": "1.47.2"
+        "playwright": "1.48.0"
       },
       "bin": {
         "playwright": "cli.js"
@@ -8310,11 +8309,11 @@
       }
     },
     "node_modules/playwright": {
-      "version": "1.47.2",
-      "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.47.2.tgz",
-      "integrity": "sha512-nx1cLMmQWqmA3UsnjaaokyoUpdVaaDhJhMoxX2qj3McpjnsqFHs516QAKYhqHAgOP+oCFTEOCOAaD1RgD/RQfA==",
+      "version": "1.48.0",
+      "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.48.0.tgz",
+      "integrity": "sha512-qPqFaMEHuY/ug8o0uteYJSRfMGFikhUysk8ZvAtfKmUK3kc/6oNl/y3EczF8OFGYIi/Ex2HspMfzYArk6+XQSA==",
       "dependencies": {
-        "playwright-core": "1.47.2"
+        "playwright-core": "1.48.0"
       },
       "bin": {
         "playwright": "cli.js"
@@ -8327,20 +8326,21 @@
       }
     },
     "node_modules/playwright-bdd": {
-      "version": "7.4.2",
-      "resolved": "https://registry.npmjs.org/playwright-bdd/-/playwright-bdd-7.4.2.tgz",
-      "integrity": "sha512-qxtUUeUIXHqAU+MbEmt5AlxUeQ4OidhQ5VgJGiCAw+fbYkYOqFDv4d1hEOcyxN35xLLFFtldWlvCsCnwJgplBg==",
+      "version": "7.5.0",
+      "resolved": "https://registry.npmjs.org/playwright-bdd/-/playwright-bdd-7.5.0.tgz",
+      "integrity": "sha512-z6rBqVqlvkaGCR6hS5yuLmNg2dn/AaQlguc96U7Xl2OvHgeiP6wZMU8CEdnp2VYU35qnYSW1xngH0EHI9/ZF2A==",
       "dependencies": {
         "@cucumber/cucumber-expressions": "17.1.0",
         "@cucumber/gherkin": "29.0.0",
         "@cucumber/gherkin-streams": "5.0.1",
         "@cucumber/gherkin-utils": "9.0.0",
         "@cucumber/html-formatter": "21.7.0",
-        "@cucumber/messages": "26.0.0",
+        "@cucumber/messages": "26.0.1",
         "@cucumber/tag-expressions": "6.1.0",
         "cli-table3": "0.6.5",
         "commander": "12.1.0",
         "fast-glob": "^3.3.2",
+        "mime-types": "2.1.35",
         "xmlbuilder": "15.1.1"
       },
       "bin": {
@@ -8365,9 +8365,9 @@
       }
     },
     "node_modules/playwright-bdd/node_modules/@cucumber/messages": {
-      "version": "26.0.0",
-      "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-26.0.0.tgz",
-      "integrity": "sha512-8czw2GfA1caaTKCnQJkpmly6bU2jwUmHfgH2wV9skVxr79O9UnzjCeCy36XGm87l97G+7AQ5GucsR8wYWu8Fbg==",
+      "version": "26.0.1",
+      "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-26.0.1.tgz",
+      "integrity": "sha512-DIxSg+ZGariumO+Lq6bn4kOUIUET83A4umrnWmidjGFl8XxkBieUZtsmNbLYgH/gnsmP07EfxxdTr0hOchV1Sg==",
       "dependencies": {
         "@types/uuid": "10.0.0",
         "class-transformer": "0.5.1",
@@ -8435,9 +8435,9 @@
       }
     },
     "node_modules/playwright-core": {
-      "version": "1.47.2",
-      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.47.2.tgz",
-      "integrity": "sha512-3JvMfF+9LJfe16l7AbSmU555PaTl2tPyQsVInqm3id16pdDfvZ8TTZ/pyzmkbDrZTQefyzU7AIHlZqQnxpqHVQ==",
+      "version": "1.48.0",
+      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.48.0.tgz",
+      "integrity": "sha512-RBvzjM9rdpP7UUFrQzRwR8L/xR4HyC1QXMzGYTbf1vjw25/ya9NRAVnXi/0fvFopjebvyPzsmoK58xxeEOaVvA==",
       "bin": {
         "playwright-core": "cli.js"
       },
@@ -9618,10 +9618,11 @@
       }
     },
     "node_modules/typescript": {
-      "version": "5.4.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.2.tgz",
-      "integrity": "sha512-+2/g0Fds1ERlP6JsakQQDXjZdZMM+rqpamFZJEKh4kwTIn3iDkgKtby0CeNd5ATNZ4Ry1ax15TMx0W2V+miizQ==",
-      "devOptional": true,
+      "version": "5.1.6",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.6.tgz",
+      "integrity": "sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==",
+      "optional": true,
+      "peer": true,
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.4.2-experimental",
+  "version": "0.4.3-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {

package/playwright.config.js

@@ -18,7 +18,7 @@ export default defineConfig({
   /* Run tests in files in parallel */
   fullyParallel: true,
   /* Fail the build on CI if you accidentally left test.only in the source code. */
-  //forbidOnly: !!process.env.CI,
+  forbidOnly: !!process.env.CI,
   /* Retry on CI only */
   retries: process.env.CI ? 2 : 0,
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */

package/.gitlab-ci.yml

@@ -1,44 +0,0 @@
-image: node:14.17.3
-
-workflow:
-  rules:
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-
-stages:
-  - build
-  - unit
-  - uat
-
-# Install dependencies stage
-build:
-  stage: build
-  image: node:14.17.3
-  script:
-    - npm install
-  artifacts:
-    paths:
-      - node_modules/
-
-
-# Unit tests stage
-unit:
-  stage: unit
-  image: node:14.17.3
-  script:
-    - npm test
-  artifacts:
-    when: always
-    paths:
-      - test-reports
-
-uat:
-  stage: uat
-  image: node:14.17.3
-  script:
-    - cd examples
-    - npm i
-    - npm run uat
-  artifacts:
-    when: always
-    paths:
-      - uat-reports

package/build/core/playwright/validateFeature.js

@@ -1,58 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _parseUserArgs = _interopRequireDefault(require("./helpers/parseUserArgs"));
-var _readConfigFile = require("./readConfigFile");
-var _tagProcessor = require("./tag-processor");
-var _testRunner = require("./test-runner");
-var _logger = require("../../utils/logger");
-// @cucumber/gherkins need to be includ in package.json
-
-// const getFeatureFiles = (dir) => {
-//     let featureFiles = [];
-//     const files = fs.readdirSync(dir, { withFileTypes: true });
-//     files.forEach(file => {
-//       const fullPath = path.join(dir, file.name);
-//       if (file.isDirectory()) {
-//         featureFiles = featureFiles.concat(getFeatureFiles(fullPath));
-//       } else if (file.isFile() && fullPath.endsWith('.feature')) {
-//         featureFiles.push(fullPath);
-//       }
-//     });
-//     return featureFiles;
-//   };
-
-//const validateFeatureFiles = () => {
-// const featuresDir = path.join(process.cwd(), 'uat/modules');
-// const parser = new Parser();
-// const featureFiles = getFeatureFiles(featuresDir);
-// featureFiles.forEach( filePath => {
-//         const featureFileContent = fs.readFileSync(filePath, 'utf-8');
-//         try {
-//             parser.parse(featureFileContent);
-//             console.log(`${filePath}: Feature file is valid!`);
-//         } catch (error) {
-//             console.error(`${filePath}: Feature file is invalid - ${error.message}`);
-//         }
-// })
-//}
-
-const validateFeatureFiles = () => {
-  const userArgsObject = (0, _parseUserArgs.default)();
-  const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
-  const {
-    editionOrder
-  } = uatConfig;
-  const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
-  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
-  (0, _testRunner.runPreprocessing)(tagArgs, configPath).then(() => {
-    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
-  }).catch(error => {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error while validating the feature files - ${error}`);
-  });
-};
-var _default = exports.default = validateFeatureFiles;

package/build/setup-folder-structure/samples/actors-index.js

@@ -1,3 +0,0 @@
-const editions = require('./editions/index');
-
-module.exports = { editions }

package/build/setup-folder-structure/samples/editions-index.js

@@ -1,3 +0,0 @@
-const free = require('./free.json');
-const editions = { free};
-module.exports = editions;

package/build/setup-folder-structure/samples/free-sample.json

@@ -1,25 +0,0 @@
-[
-    {
-      "id": "1",
-      "edition": "free",
-      "orgName": "orgFree",
-      "profiles": [
-        {
-          "profile": "admin",
-          "email": "admin+free@zohotest.com",
-          "password": "password@0987"
-        },
-        {
-          "profile": "agent",
-          "email": "agent@zohotest.com",
-          "password": "password@12345"
-        },
-        {
-          "profile": "lightagent",
-          "email": "lightagent@zohotest.com",
-          "password": "password@12345"
-        }
-      ]
-    }
-  ]
-  

package/build/setup-folder-structure/samples/settings.json

@@ -1,7 +0,0 @@
-{
-  "environment": "dev",
-  "edition": "enterprise",
-  "profile": "admin",
-  "domain": "https://desk.localzoho.com/agent",
-  "devUrl" : "" 
-}

package/build/test/core/playwright/__tests__/validateFeature.test.js

@@ -1,64 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _validateFeature = _interopRequireDefault(require("../../../../core/playwright/validateFeature"));
-var _parseUserArgs = _interopRequireDefault(require("../../../../core/playwright/helpers/parseUserArgs"));
-var _readConfigFile = require("../../../../core/playwright/readConfigFile");
-var _tagProcessor = require("../../../../core/playwright/tag-processor");
-var _testRunner = require("../../../../core/playwright/test-runner");
-var _logger = require("../../../../utils/logger");
-jest.mock('../../../../core/playwright/helpers/parseUserArgs', () => ({
-  __esModule: true,
-  default: jest.fn()
-}));
-jest.mock('../../../../core/playwright/readConfigFile');
-jest.mock('../../../../core/playwright/tag-processor');
-jest.mock('../../../../core/playwright/test-runner');
-jest.mock('../../../../utils/logger', () => ({
-  __esModule: true,
-  Logger: {
-    log: jest.fn(),
-    SUCCESS_TYPE: 'success',
-    FAILURE_TYPE: 'failure'
-  }
-}));
-describe('validateFeatureFiles', () => {
-  beforeEach(() => {
-    jest.clearAllMocks();
-  });
-  test('runPreprocessing with correct arguments and log success', async () => {
-    const mockUserArgs = {
-      mode: 'dev'
-    };
-    _parseUserArgs.default.mockReturnValue(mockUserArgs);
-    const mockConfig = {
-      editionOrder: ["beta", "enterprice"]
-    };
-    _readConfigFile.generateConfigFromFile.mockReturnValue(mockConfig);
-    _readConfigFile.isUserConfigFileAvailable.mockReturnValue(true);
-    const mockTagArgs = ['@beta_admin'];
-    _tagProcessor.tagProcessor.mockReturnValue(mockTagArgs);
-    _testRunner.runPreprocessing.mockResolvedValueOnce();
-    await (0, _validateFeature.default)();
-    expect(_parseUserArgs.default).toHaveBeenCalled();
-    expect(_readConfigFile.generateConfigFromFile).toHaveBeenCalled();
-    expect(_readConfigFile.isUserConfigFileAvailable).toHaveBeenCalled();
-    expect(_tagProcessor.tagProcessor).toHaveBeenCalledWith(mockUserArgs, ["beta", "enterprice"]);
-    expect(_testRunner.runPreprocessing).toHaveBeenCalledWith(mockTagArgs, expect.stringContaining('config-creator.js'));
-    expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
-  });
-  test('runPreprocessing with playwright conf', async () => {
-    const mockTagArgs = ['@beta_admin'];
-    _tagProcessor.tagProcessor.mockReturnValue(mockTagArgs);
-    _readConfigFile.isUserConfigFileAvailable.mockReturnValue(false);
-    _testRunner.runPreprocessing.mockResolvedValueOnce();
-    await (0, _validateFeature.default)();
-    expect(_testRunner.runPreprocessing).toHaveBeenCalledWith(mockTagArgs, expect.stringContaining('playwright.config.js'));
-  });
-  test('error when runPreprocessing fails', async () => {
-    const mockError = new Error('Test error');
-    _testRunner.runPreprocessing.mockRejectedValueOnce(mockError);
-    await await (0, _validateFeature.default)();
-    expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.FAILURE_TYPE, `Error while validating the feature files - ${mockError}`);
-  });
-});

package/build/test/core/playwright/helpers/__tests__/configFileNameProvider.test.js

@@ -1,34 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _fs = require("fs");
-var _path = _interopRequireDefault(require("path"));
-var _configFileNameProvider = require("../../../../../core/playwright/helpers/configFileNameProvider");
-jest.mock('fs');
-jest.mock('path');
-const mockCwd = '/mock/current/directory';
-_path.default.resolve = jest.fn();
-process.cwd = jest.fn(() => mockCwd);
-describe('getUATFileName', () => {
-  beforeEach(() => {
-    jest.clearAllMocks();
-  });
-  test('return the pipeline matched config files for pipeline matched files exists', () => {
-    const mode = 'cd';
-    const mockPath = `${mockCwd}/uat/conf/${mode}/uat.config.js`;
-    _fs.existsSync.mockReturnValue(true);
-    _path.default.resolve.mockImplementation((...args) => args.join('/'));
-    const result = (0, _configFileNameProvider.getUATFileName)(mode);
-    expect(_fs.existsSync).toHaveBeenCalledWith(mockPath);
-    expect(result).toBe(mockPath);
-  });
-  test('return the default config files for pipeline matched files not exists', () => {
-    const mode = 'ci';
-    const defaultPath = `${mockCwd}/uat.config.js`;
-    _fs.existsSync.mockReturnValue(false);
-    _path.default.resolve.mockImplementation((...args) => args.join('/'));
-    const result = (0, _configFileNameProvider.getUATFileName)(mode);
-    expect(_fs.existsSync).toHaveBeenCalledWith(`${mockCwd}/uat/conf/${mode}/uat.config.js`);
-    expect(result).toBe(defaultPath);
-  });
-});