@zohodesk/testinglibrary 0.3.0-experimental → 0.3.0

package/.gitlab-ci.yml

@@ -0,0 +1,111 @@
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+
+#workflow:
+#  rules:
+#    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+
+stages:
+  - build
+  - unit
+  - uat
+
+# Install dependencies stage
+build:
+  stage: build
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install
+  artifacts:
+    paths:
+      - node_modules/
+
+
+# Unit tests stage
+unit:
+  stage: unit
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm run test
+  artifacts:
+    when: always
+    paths:
+      - unit_reports
+
+# UAT tests stage
+uat-auth:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatauth)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uat-noauth:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnoauth)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+    
+uat-profile:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatprofile)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report 
+
+uat-nobdd:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd nobdd
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnobdd)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+
+  artifacts:
+    when: always
+    paths:
+      - nobdd/uat/playwright-report
+

package/README.md

@@ -15,4 +15,42 @@
   ### Generate Report
 
      - npm run report
-    
+
+## Version History
+
+### 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. 
+
+
+## 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
+
+#### 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'`.

package/build/core/playwright/builtInFixtures/page.js

@@ -11,7 +11,7 @@ var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
 
 function getTagInputFromSelectedTags(tags, inputString) {
-  const selectedTag = tags.find(tag => tag.startsWith(inputString));
+  const selectedTag = [...tags].reverse().find(tag => tag.startsWith(inputString));
   let tagInput = null;
   if (selectedTag) {
     tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();

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

@@ -0,0 +1,25 @@
+"use strict";
+
+var _ConfigurationHelper = require("./ConfigurationHelper");
+class Configuration {
+  properties = {};
+  constructor(props) {
+    this.properties = props;
+  }
+  add(key, value) {
+    this.properties[key] = value;
+  }
+  addAll(newConfig) {
+    this.properties = (0, _ConfigurationHelper.combineConfiguration)(this.properties, newConfig.getAll());
+  }
+  get(key) {
+    return this.properties[key];
+  }
+  getAll() {
+    return this.properties;
+  }
+  delete(key) {
+    delete this.properties[key];
+  }
+}
+module.exports = Configuration;

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

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.combineConfiguration = combineConfiguration;
+exports.getApplicationConfig = getApplicationConfig;
+var _path = _interopRequireDefault(require("path"));
+var _logger = require("../../../utils/logger");
+var _configFileNameProvider = require("../helpers/configFileNameProvider");
+var _mergeObjects = require("../helpers/mergeObjects");
+var _fs = require("fs");
+const Configuration = require("./Configuration");
+function combineConfiguration(defaultConfig, userConfiguration) {
+  let configurationObj = {};
+  Object.keys(userConfiguration).forEach(configKey => {
+    let configValue = userConfiguration[configKey];
+    if (configValue !== null && configValue !== undefined) {
+      configurationObj[configKey] = configValue;
+    } else if (defaultConfig[configKey]) {
+      configurationObj[configKey] = defaultConfig[configKey];
+    } else {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, `key - ${configKey} is not yet supported in uat configuration. This will not be used while creating playwright configuration`);
+    }
+  });
+  return (0, _mergeObjects.mergeObjects)(defaultConfig, configurationObj);
+}
+function getApplicationConfig(mode) {
+  let filePath = "";
+  try {
+    filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)(mode));
+    if (!(0, _fs.existsSync)(filePath)) {
+      throw new Error("Exception while getting the uat file from the application - " + filePath);
+    }
+    const config = require(filePath);
+    return config;
+  } catch (err) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Founded Path - ${filePath} Application config file not Exist ...`);
+    _logger.Logger.error(err);
+    return {};
+  }
+}

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

@@ -0,0 +1,12 @@
+"use strict";
+
+var _cliArgsToObject = require("../../../utils/cliArgsToObject");
+class UserArgs {
+  static parseToObject(config) {
+    return (0, _cliArgsToObject.cliArgsToObject)(config);
+  }
+  static parseToArgs(object) {
+    return (0, _cliArgsToObject.objectToCliArgs)(object);
+  }
+}
+module.exports = UserArgs;

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

@@ -10,7 +10,6 @@ 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,12 +33,17 @@ function getDefaultActorConf() {
   const {
     uatDirectory
   } = (0, _readConfigFile.generateConfigFromFile)();
-  const defaultSettingFile = `conf/${getRunMode()}/settings.json`;
-  const filePath = _path.default.join(uatDirectory, defaultSettingFile);
-  if (!(0, _fs.existsSync)(filePath)) {
-    throw new Error(`${defaultSettingFile} is missing.`);
+  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.`);
   }
-  return require(filePath);
 }
 function getDefaultActor() {
   const {
@@ -52,18 +57,25 @@ function getListOfActors() {
     uatDirectory
   } = (0, _readConfigFile.generateConfigFromFile)();
   const mode = getRunMode();
-  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.`);
+  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}`);
   }
-  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
-  } = getListOfActors();
+  } = actorsData;
   const defaultConf = getDefaultActorConf();
   const edition = preferedEdition || defaultConf.edition;
   const profile = preferredProfile || defaultConf.profile;

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

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

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

@@ -3,9 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.parseUserArgs = parseUserArgs;
 var _cliArgsToObject = require("../../../utils/cliArgsToObject");
 function parseUserArgs() {
   return (0, _cliArgsToObject.cliArgsToObject)(process.argv.slice(2));
-}
-var _default = exports.default = parseUserArgs;
+}

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

@@ -6,18 +6,24 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.generateConfigFromFile = generateConfigFromFile;
 exports.getAuthFilePath = getAuthFilePath;
+exports.getDefaultConfig = getDefaultConfig;
 exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
 var _fs = require("fs");
 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");
 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,
@@ -32,26 +38,18 @@ function getDefaultConfig() {
       height: 720
     },
     debug: false,
-    mode: process.env.mode || 'dev',
+    testIdAttribute: 'data-testid',
     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;
@@ -110,22 +108,26 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  *
  * @returns {UserConfig}
  */
+
+function getConfigFilePath() {
+  return _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+}
 function generateConfigFromFile() {
-  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;
+  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();
   }
-  return {};
+  return cachedConfig;
 }
 function isUserConfigFileAvailable() {
-  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  const filePath = getConfigFilePath();
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }

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

@@ -9,6 +9,7 @@ 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,
@@ -25,7 +26,7 @@ const {
   stepDefinitionsFolder,
   testIdAttribute,
   globalTimeout
-} = (0, _readConfigFile.generateConfigFromFile)();
+} = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
@@ -38,12 +39,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
@@ -51,13 +52,11 @@ const testOptions = (0, _configUtils.getTestUseOptions)({
  * @returns {import('@playwright/test').PlaywrightTestConfig}
  */
 function getPlaywrightConfig() {
-  return {
+  const playwrightConfig = {
     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
@@ -66,7 +65,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use: testOptions,
+    use,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,
@@ -76,7 +75,9 @@ function getPlaywrightConfig() {
       name: 'cleanup',
       testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects]
+    }, ...projects] : [...projects],
+    ...uatConfig
   };
+  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;
 }