@zohodesk/testinglibrary 0.4.1-experimental → 0.4.3-experimental

package/README.md

@@ -26,6 +26,25 @@
 ### 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. 
 
+
+## Version History
+
+### 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.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'`.
+
 ### v0.2.9 - 08-10-2024
 
 #### Feature

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/fixtures.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _test = require("@playwright/test");
+var _playwrightBdd = require("playwright-bdd");
+var _readConfigFile = require("./readConfigFile");
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
+const {
+  bddMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+let base = bddMode ? _playwrightBdd.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)();
+const buildInFixturesTest = base.extend({
+  ...buildInFixtures
+});
+const userFixtures = (0, _getUserFixtures.default)();
+const userFixturesTest = base.extend({
+  ...userFixtures
+});
+const test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
+module.exports = {
+  test
+};

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/index.js

@@ -1,37 +1,24 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "createBdd", {
+exports.createBdd = void 0;
+Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
-    return _bddFramework.createBdd;
+    return _test.expect;
   }
 });
-Object.defineProperty(exports, "expect", {
+Object.defineProperty(exports, "test", {
   enumerable: true,
   get: function () {
-    return _test.expect;
+    return _playwrightBdd.test;
   }
 });
-exports.test = void 0;
-var _bddFramework = require("../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _test = require("@playwright/test");
-var _readConfigFile = require("./readConfigFile");
-var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
-var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
-const {
-  bddMode
-} = (0, _readConfigFile.generateConfigFromFile)();
-let base = bddMode ? _bddFramework.test : _test.test;
-const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
-const buildInFixturesTest = base.extend({
-  ...buildInFixtures
-});
-const userFixtures = (0, _getUserFixtures.default)();
-const userFixturesTest = base.extend({
-  ...userFixtures
-});
-const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
+let createBdd = function () {
+  return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
+};
+exports.createBdd = createBdd;

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,
@@ -39,12 +38,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-const testOptions = (0, _configUtils.getTestUseOptions)({
+const use = {
   trace,
   video,
   viewport,
   testIdAttribute
-});
+};
 
 /**
  * Playwright configuration object
@@ -52,11 +51,13 @@ const testOptions = (0, _configUtils.getTestUseOptions)({
  * @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
@@ -65,7 +66,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use: testOptions,
+    use,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,
@@ -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/setup/config-utils.js

@@ -7,14 +7,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
-exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _bddFramework = require("../../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
-var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _fileUtils = require("../../../utils/fileUtils");
 /**
  ** Playwright project configuration
@@ -148,30 +146,15 @@ function getPathsForFeatureFiles(cwd) {
 function getTestDir(bddMode, cwd, {
   stepDefinitionsFolder
 }) {
-  return bddMode ? (0, _bddFramework.defineBddConfig)({
-    paths: getPathsForFeatureFiles(cwd),
-    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
+  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
+    features: getPathsForFeatureFiles(cwd),
+    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
+    importTestFrom: require.resolve('../fixtures.js'),
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
+    disableWarnings: {
+      importTestFrom: true
+    },
     publish: true
   }) : _path.default.join(cwd, 'uat');
-}
-function getTestUseOptions({
-  viewport,
-  trace,
-  video,
-  testIdAttribute
-}) {
-  let defaultTestuseOptions = {
-    viewport,
-    testIdAttribute,
-    trace: trace ? 'on' : 'off',
-    video: video ? {
-      mode: 'on',
-      size: {
-        ...viewport
-      }
-    } : 'off'
-  };
-  return defaultTestuseOptions;
 }

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

@@ -42,7 +42,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
 }
 function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
+  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');
@@ -103,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/decorators.d.ts

@@ -1 +1 @@
-export * from './bdd-framework/decorators';
+export * from 'playwright-bdd/decorators';

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("./bdd-framework/decorators");
+var _decorators = require("playwright-bdd/decorators");
 Object.keys(_decorators).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _decorators[key]) return;

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;