@zohodesk/testinglibrary 0.1.8-stb-bdd-v26 → 0.1.9-exp-actors

package/build/core/playwright/index.js

@@ -4,35 +4,101 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.When = exports.Then = exports.Given = void 0;
+Object.defineProperty(exports, "accountLogin", {
+  enumerable: true,
+  get: function () {
+    return _index.accountLogin;
+  }
+});
+Object.defineProperty(exports, "createBdd", {
+  enumerable: true,
+  get: function () {
+    return _bddFramework.createBdd;
+  }
+});
 Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
     return _test.expect;
   }
 });
+Object.defineProperty(exports, "getDefaultActor", {
+  enumerable: true,
+  get: function () {
+    return _index.getDefaultActor;
+  }
+});
+Object.defineProperty(exports, "getListOfActors", {
+  enumerable: true,
+  get: function () {
+    return _index.getListOfActors;
+  }
+});
+Object.defineProperty(exports, "getRunMode", {
+  enumerable: true,
+  get: function () {
+    return _index.getRunMode;
+  }
+});
+Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
+  enumerable: true,
+  get: function () {
+    return _index.getUserForSelectedEditionAndProfile;
+  }
+});
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () {
+    return _index.isCI;
+  }
+});
+Object.defineProperty(exports, "isDevelopmentSetup", {
+  enumerable: true,
+  get: function () {
+    return _index.isDevelopmentSetup;
+  }
+});
+Object.defineProperty(exports, "loadCookiesIfPresent", {
+  enumerable: true,
+  get: function () {
+    return _index.loadCookiesIfPresent;
+  }
+});
+Object.defineProperty(exports, "performLoginSteps", {
+  enumerable: true,
+  get: function () {
+    return _index.performLoginSteps;
+  }
+});
 exports.test = void 0;
+Object.defineProperty(exports, "verifyIfCookieFileExists", {
+  enumerable: true,
+  get: function () {
+    return _index.verifyIfCookieFileExists;
+  }
+});
+var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
 var _readConfigFile = require("./readConfigFile");
 var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
-// import { createBdd, test as bddBase } from '../../bdd-framework';
-
+var _index = require("./helpers/auth/index");
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
 const {
-  additionalPages: userFixtures,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
-// In house BDD testing. so, use playwright test
-let base = _test.test;
+let base = bddMode ? _bddFramework.test : _test.test;
 const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
-var $customFixtures = {};
-if (!bddMode) {
-  $customFixtures = {
-    $tags: ({}, use) => use([])
-  };
-}
+const userFixtures = (0, _getUserFixtures.default)();
 const test = exports.test = base.extend({
   ...buildInFixtures,
-  ...userFixtures,
-  ...$customFixtures
+  ...userFixtures
 });
-
-// const { Given, When, Then } = createBdd();
+const {
+  Given,
+  When,
+  Then
+} = (0, _bddFramework.createBdd)();
+exports.Then = Then;
+exports.When = When;
+exports.Given = Given;

package/build/core/playwright/readConfigFile.js

@@ -4,16 +4,17 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.fileName = void 0;
 exports.generateConfigFromFile = generateConfigFromFile;
 exports.getAuthFilePath = getAuthFilePath;
 exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
-const fileName = exports.fileName = 'uat.config.js';
+var _configFileNameProvider = require("./helpers/configFileNameProvider");
+var _mergeObjects = require("./helpers/mergeObjects");
 function getDefaultConfig() {
   return {
+    uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],
     trace: false,
@@ -35,6 +36,7 @@ function getDefaultConfig() {
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
     testIdAttribute: 'data-testid',
+    testSetup: {},
     editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
@@ -51,49 +53,58 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
       _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 {
-    ...defaultConfig,
-    ...configurationObj
-  };
+  return (0, _mergeObjects.mergeObjects)(defaultConfig, configurationObj);
 }
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
 
-/**
- * @typedef {Object|null} viewportConfig
- * @property {number} width - width of the viewport
- * @property {number} height - height of the viewport 
+/**
+ * @typedef {Object|null} testSetupConfig
+ * @property {any} page - Function that will be called while setting up page fixtures
+ * @property {any} context - Function that will be called while setting up context fixtures
  */
 
-/**
- * Represents the user configuration object.
- * @typedef {Object} UserConfig
- * @property {string} headless - Headless Browsers mode.
- * @property {number} trace - trace for test cases.
- * @property {boolean} video - video for test cases,
- * @property {boolean} debug - debug mode
- * @property {string} mode: mode in which the test cases needs to run
- * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
- * @property {string} authFilePath - File Path where the cookies stored
- * @property {any} browsers: List of browsers
- * @property {string} openReportOn: default Option value (never, on-failure and always) 
- * @property {any} reportPath : directory where report is generate
- * @property {boolean} bddMode: Feature files needs to be processed
- * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
- * @property {number} testTimeout: time in milliseconds which the test should fail
- * @property {Object} additionalPages: custom pages configuration
- * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
- * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
- * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
- * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
- * @property {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
+/**
+ * Represents the user configuration object.
+ * @typedef {Object} UserConfig
+ * @property {string} uatDirectory - Directory in which uat configuration is places.
+ * @property {string} headless - Headless Browsers mode.
+ * @property {number} trace - trace for test cases.
+ * @property {boolean} video - video for test cases,
+ * @property {boolean} debug - debug mode
+ * @property {string} mode: mode in which the test cases needs to run
+ * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
+ * @property {string} authFilePath - File Path where the cookies stored
+ * @property {any} browsers: List of browsers
+ * @property {string} openReportOn: default Option value (never, on-failure and always)
+ * @property {any} reportPath : directory where report is generate
+ * @property {boolean} bddMode: Feature files needs to be processed
+ * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {Object} additionalPages: custom pages configuration
+ * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
+ * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
+ * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
+ * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
+ * @property {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
+ * @property {testSetupConfig} testSetup: Specify page and context functions that will be called while intilaizing fixtures.
  */
 
-/**
- * Generates a configuration object from a file, if it exists.
- *
- * @returns {UserConfig}
-*/
+/**
+ * Generates a configuration object from a file, if it exists.
+ *
+ * @returns {UserConfig}
+ */
 function generateConfigFromFile() {
-  const filePath = _path.default.resolve(process.cwd(), fileName);
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     /** @type {UserConfig} */
     const config = require(filePath);
@@ -103,7 +114,7 @@ function generateConfigFromFile() {
   return {};
 }
 function isUserConfigFileAvailable() {
-  const filePath = _path.default.resolve(process.cwd(), fileName);
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }

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

@@ -10,15 +10,15 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _rootPath = require("../../utils/rootPath");
 var _readConfigFile = require("./readConfigFile");
-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);
 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'
   });

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

@@ -9,8 +9,8 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
-var _testData = require("../../../bdd-poc/test/testData");
-var _stepRunner = require("../../../bdd-poc/core-runner/stepRunner");
+var _bddFramework = require("../../../bdd-framework");
+const defaultCIBrowsers = ['Chrome', 'Firefox', 'Edge', 'Safari'];
 const {
   browsers,
   trace,
@@ -23,21 +23,23 @@ const {
   testTimeout,
   authFilePath,
   viewport,
+  featureFilesFolder,
+  stepDefinitionsFolder,
   testIdAttribute
 } = (0, _readConfigFile.generateConfigFromFile)();
+const browserList = process.env.mode === 'ci' ? defaultCIBrowsers : browsers;
 const projects = (0, _configUtils.getProjects)({
-  browsers,
+  browsers: browserList,
   isAuthMode,
   authFilePath,
   expectTimeout,
   testTimeout,
   viewport
 });
-// const testDir = getTestDir(bddMode, process.cwd(), { featureFilesFolder, stepDefinitionsFolder });
-var testDir = _path.default.resolve(process.cwd(), 'uat', '.feature-gen');
-if (!bddMode) {
-  testDir = _path.default.resolve(process.cwd(), 'uat', 'playwright-TestCase');
-}
+const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
+  featureFilesFolder,
+  stepDefinitionsFolder
+});
 const testOptions = (0, _configUtils.getTestUseOptions)({
   trace,
   video,
@@ -45,15 +47,12 @@ const testOptions = (0, _configUtils.getTestUseOptions)({
   testIdAttribute
 });
 
-/**
- * Playwright configuration object
- *
- * @returns {import('@playwright/test').PlaywrightTestConfig}
+/**
+ * Playwright configuration object
+ *
+ * @returns {import('@playwright/test').PlaywrightTestConfig}
 */
-async function getPlaywrightConfig() {
-  globalThis.globalStepMap = new Map();
-  (0, _stepRunner.createStepCallBack)();
-  globalThis.globalTestdata = await (0, _testData.testDataCreation)();
+function getPlaywrightConfig() {
   return {
     testDir,
     outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),

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

@@ -4,16 +4,21 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+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");
-// import { defineBddConfig } from '../../../bdd-framework';
-
-/**
- ** Playwright project configuration
- * @returns {import('@playwright/test').Project}
+var _bddFramework = require("../../../bdd-framework");
+var _logger = require("../../../utils/logger");
+var _browserTypes = require("../constants/browserTypes");
+var _configFileNameProvider = require("../helpers/configFileNameProvider");
+var _fileUtils = require("../../../utils/fileUtils");
+/**
+ ** Playwright project configuration
+ * @returns {import('@playwright/test').Project}
  */
 function getBrowserConfig({
   browserName,
@@ -31,7 +36,7 @@ function getBrowserConfig({
   const dependencies = isAuthMode ? ['setup'] : [];
   if (browser === 'chrome') {
     return {
-      name: 'chromium',
+      name: _browserTypes.BROWSER_PROJECT_MAPPING.CHROME,
       use: {
         ..._test.devices['Desktop Chrome'],
         ...commonConfig
@@ -44,7 +49,7 @@ function getBrowserConfig({
     };
   } else if (browser === 'edge') {
     return {
-      name: 'Microsoft Edge',
+      name: _browserTypes.BROWSER_PROJECT_MAPPING.EDGE,
       timeout: testTimeout,
       expect: {
         timeout: expectTimeout
@@ -58,7 +63,7 @@ function getBrowserConfig({
     };
   } else if (browser === 'firefox') {
     return {
-      name: 'firefox',
+      name: _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX,
       timeout: 2 * testTimeout,
       expect: {
         timeout: 2 * expectTimeout
@@ -71,7 +76,7 @@ function getBrowserConfig({
     };
   } else if (browser === 'safari') {
     return {
-      name: 'webkit',
+      name: _browserTypes.BROWSER_PROJECT_MAPPING.SAFARI,
       timeout: 4 * testTimeout,
       expect: {
         timeout: 4 * expectTimeout
@@ -87,10 +92,10 @@ function getBrowserConfig({
   }
 }
 
-/**
- * 
- * @param {*} param0 
- * @returns {import('@playwright/test').Project[]}
+/**
+ *
+ * @param {*} param0
+ * @returns {import('@playwright/test').Project[]}
  */
 function getProjects({
   browsers,
@@ -109,19 +114,48 @@ function getProjects({
     viewport
   })).filter(Boolean);
 }
-
-// function getTestDir(bddMode, cwd, { stepDefinitionsFolder }) {
-//   return bddMode
-//     ? defineBddConfig({
-//       paths: [path.join(cwd, 'uat', '**', '*.feature')],
-//       import: [path.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
-//       featuresRoot: path.join(cwd, 'uat'),
-//       outputDir: path.join(cwd, 'uat', '.features-gen'),
-//       publish: true,
-//     })
-//     : path.join(cwd, 'uat');
-// }
-
+function getBrowsersList(browserFromArgs) {
+  if (browserFromArgs) {
+    if (typeof browserFromArgs === 'string') {
+      let listOfbrowsers = browserFromArgs.split(',').map(browser => browser.trim().toLowerCase());
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Using browsers from command line args');
+      return listOfbrowsers;
+    }
+  }
+  return [];
+}
+function getPathsForFeatureFiles(cwd) {
+  if (process.env.isRerunFailedCases) {
+    let {
+      reportPath
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    let filePathFromArgs = process.env.filePath;
+    let filePath = filePathFromArgs ? filePathFromArgs : reportPath;
+    const testSummary = (0, _fileUtils.readFileContents)(filePath);
+    if (testSummary !== null) {
+      const {
+        failed = []
+      } = JSON.parse(testSummary);
+      const casesToRun = failed.map(filePath => _path.default.join(cwd, 'uat', filePath.replace(/\.spec\.js$|\.js$/, '')));
+      return casesToRun;
+    } else {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, `Unable to read test summary from the ${reportPath}. Verify If File Exists in the path`);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Going to run all test cases');
+    }
+  }
+  return [_path.default.join(cwd, 'uat', '**', '*.feature')];
+}
+function getTestDir(bddMode, cwd, {
+  stepDefinitionsFolder
+}) {
+  return bddMode ? (0, _bddFramework.defineBddConfig)({
+    paths: getPathsForFeatureFiles(cwd),
+    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
+    featuresRoot: _path.default.join(cwd, 'uat'),
+    outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
+    publish: true
+  }) : _path.default.join(cwd, 'uat');
+}
 function getTestUseOptions({
   viewport,
   trace,

package/build/core/playwright/setup/custom-reporter.js

@@ -10,6 +10,7 @@ var _readline = _interopRequireDefault(require("readline"));
 var _fileUtils = require("../../../utils/fileUtils");
 var _readConfigFile = require("../readConfigFile");
 var _logger = require("../../../utils/logger");
+var _configFileNameProvider = require("../helpers/configFileNameProvider");
 class JSONSummaryReporter {
   constructor() {
     this.durationInMS = -1;
@@ -43,7 +44,7 @@ class JSONSummaryReporter {
       }
     }
     // This will publish the file name + line number test begins on
-    const z = `${fileName[0]}:${test.location.line}:${test.location.column}`;
+    const z = `${fileName[0]}`;
     // Using the t variable in the push will push a full test name + test description
     const t = title.join(' > ');
     // Set the status
@@ -93,7 +94,7 @@ class JSONSummaryReporter {
     let {
       reportPath
     } = (0, _readConfigFile.generateConfigFromFile)();
-    (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, './', 'test-summary.json'), JSON.stringify(this, null, '  '));
+    (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, './', (0, _configFileNameProvider.getReportFileName)()), JSON.stringify(this, null, '  '));
   }
   onExit() {
     const shouldClearLastLine = this._open !== 'always' || this._open !== 'on-failure';

package/build/core/playwright/tag-processor.js

@@ -3,16 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.buildEditionTags = buildEditionTags;
-exports.editionPreprocessing = editionPreprocessing;
 exports.tagProcessor = tagProcessor;
 var _logger = require("../../utils/logger");
 /* eslint-disable dot-notation */
 
-// function getTagsString(tags, editionTags) {
-//   return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
-// }
-
+function getTagsString(tags, editionTags) {
+  return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
+}
 function getEdition(edition) {
   if (edition.startsWith('<=')) {
     return ['<=', edition.slice(2)];
@@ -31,11 +28,11 @@ function editionPreprocessing(editionOrder, selectedEdition) {
   if (index !== -1) {
     let resultArray;
     if (operator === '<=') {
-      resultArray = editionOrder.slice(0, index + 1);
+      resultArray = editionOrder.slice(index + 1);
     } else if (operator === '>=') {
       resultArray = editionOrder.slice(0, index);
     } else if (operator === '<') {
-      resultArray = editionOrder.slice(0, index);
+      resultArray = editionOrder.slice(index);
     } else if (operator === '>') {
       resultArray = editionOrder.slice(0, index + 1);
     } else {
@@ -46,34 +43,26 @@ function editionPreprocessing(editionOrder, selectedEdition) {
   _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions ${selectedEdition} found. Running with default edition`);
   return [];
 }
-function buildEditionTags(editionArgs, operator, prefix = "") {
-  return editionArgs.map(edition => `${prefix}${edition}`).join(` ${operator} `);
+function buildEditionTags(editionArgs, operator) {
+  return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
 }
 function tagProcessor(userArgsObject, editionOrder) {
-  let filteredTags;
   let tagArgs = userArgsObject['tags'];
-  let multiTags = userArgsObject['tags'] || " ";
-  if (multiTags.split(',').length >= 2) {
-    tagArgs = buildEditionTags(multiTags.split(','), '|');
-  }
   const edition = userArgsObject['edition'] || null;
   if (edition !== null) {
     let editionsArray = edition.split(',');
     if (editionsArray.length === 1) {
       const editionArgs = editionPreprocessing(editionOrder, edition);
       if (editionArgs && editionArgs.length > 0) {
-        const editionTags = buildEditionTags(editionArgs, '|', "@edition_");
-        filteredTags = editionTags;
+        const editionTags = buildEditionTags(editionArgs, 'or');
+        tagArgs = `${getTagsString(tagArgs, editionTags)}`;
       }
     } else {
       // More than one edition given
       const filteredEditions = editionOrder.filter(edition => !editionsArray.includes(edition));
-      const editionTags = buildEditionTags(filteredEditions, '|', "@edition_");
-      filteredTags = editionTags;
+      const editionTags = buildEditionTags(filteredEditions, 'or');
+      tagArgs = `${getTagsString(tagArgs, editionTags)}`;
     }
   }
-  return {
-    tags: tagArgs,
-    editionTags: filteredTags
-  };
+  return tagArgs;
 }