@zohodesk/testinglibrary 0.1.8-exp-bdd-v1 → 0.1.8-exp.1

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

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+// function test(descrition, callback) {
+//   return test(descrition, ({ page }) => {
+//     const { locator, ...custompage } = page
+//     callback({ page: custompage })
+//   })
+// }
+// class FilteredPage {
+//   constructor(page) {
+//     this.page = page;
+//     this.allowedMethods = ['getByText', 'getByTitle'];
+//     this.context = page.context;
+//   }
+//   goto(...args) {
+//     return this.page['goto'](...args);
+//   }
+//   getByRole(...args) {
+//     return this.page['getByRole'](...args);
+//   }
+// }
+// function FilteredPage(page) {
+//   return {
+//     getByRole: () => {
+//       throw new Error('You cannnot use getByRole property')
+//     }
+//   }
+// }
+var _default = exports.default = {
+  page: async ({
+    page
+  }, use) => {
+    page.getBaseUrl = function () {
+      if (process.env.mode === 'dev') {
+        return `${process.env.domain}?devURL=${process.env.devUrl}`;
+      }
+      return `${process.env.domain}`;
+    };
+    page.getCustomPageUrl = function (url) {
+      if (process.env.mode === 'dev') {
+        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`;
+      }
+      return `${process.env.domain}/${url}`;
+    };
+    await use(page);
+  }
+};

package/build/core/playwright/clear-caches.js

@@ -0,0 +1,29 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _fileUtils = require("../../utils/fileUtils");
+var _logger = require("../../utils/logger");
+var _readConfigFile = require("./readConfigFile");
+function clearCaches() {
+  try {
+    const {
+      authFilePath,
+      reportPath
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    authFilePath.split('/').pop();
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting auth files present in ${authFilePath}`);
+    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), authFilePath));
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting Playwright report ${reportPath}`);
+    (0, _fileUtils.deleteFolder)(reportPath);
+    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), 'uat', '.features-gen'));
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared');
+  } catch (err) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error While clearing cookies');
+  }
+}
+var _default = exports.default = clearCaches;

package/build/core/playwright/custom-commands.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CUSTOM_COMMANDS = void 0;
-const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags'];
+const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition', 'browsers'];

package/build/core/playwright/index.js

@@ -1,5 +1,6 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -20,85 +21,16 @@ exports.test = void 0;
 var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
 var _readConfigFile = require("./readConfigFile");
-// function test(descrition, callback) {
-//   return test(descrition, ({ page }) => {
-//     const { locator, ...custompage } = page
-//     callback({ page: custompage })
-//   })
-// }
-
-// class FilteredPage {
-//   constructor(page) {
-//     this.page = page;
-//     this.allowedMethods = ['getByText', 'getByTitle'];
-//     this.context = page.context;
-//   }
-
-//   goto(...args) {
-//     return this.page['goto'](...args);
-//   }
-
-//   getByRole(...args) {
-//     return this.page['getByRole'](...args);
-//   }
-// }
-
-// function FilteredPage(page) {
-//   return {
-//     getByRole: () => {
-//       throw new Error('You cannnot use getByRole property')
-//     }
-//   }
-// }
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
 const {
-  additionalPages,
+  additionalPages: userFixtures,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
 let base = bddMode ? _bddFramework.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
 const test = exports.test = base.extend({
-  page: async ({
-    page
-  }, use) => {
-    // const proxyPage = new Proxy(page, {
-    //   get: function (obj, prop) {
-    //     console.log('Gettig Priop', prop);
-    //     let filterMethod = FilteredPage(page)[prop];
-    //     if (filterMethod) {
-    //       return filterMethod;
-    //     } else {
-    //       return obj[prop] ? obj[prop] : 'property does not exist';
-    //     }
-    //   }
-    // })
-    page.getBaseUrl = function () {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}`;
-    };
-    page.getCustomPageUrl = function (url) {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}/${url}`;
-    };
-    await use(page);
-
-    //await use(new FilteredPage(page));
-
-    // await use(async (page) => {
-    //   delete page.getByTestId;
-    //   await page;
-    // });
-  },
-  context: async ({
-    context
-  }, use) => {
-    // eslint-disable-next-line no-undef
-    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
-    await use(context);
-  },
-  ...additionalPages
+  ...buildInFixtures,
+  ...userFixtures
 });
 const {
   Given,

package/build/core/playwright/readConfigFile.js

@@ -14,6 +14,7 @@ var _logger = require("../../utils/logger");
 const fileName = exports.fileName = 'uat.config.js';
 function getDefaultConfig() {
   return {
+    headless: false,
     browsers: ['Chrome'],
     trace: false,
     video: false,
@@ -30,7 +31,11 @@ function getDefaultConfig() {
     },
     debug: false,
     mode: 'dev',
-    additionalPages: {}
+    additionalPages: {},
+    featureFilesFolder: 'feature-files',
+    stepDefinitionsFolder: 'steps',
+    testIdAttribute: 'data-testid',
+    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
@@ -38,7 +43,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
   let configurationObj = {};
   Object.keys(userConfiguration).forEach(configKey => {
     let configValue = userConfiguration[configKey];
-    if (configValue && configValue !== null) {
+    if (configValue !== null && configValue !== undefined) {
       configurationObj[configKey] = configValue;
     } else if (defaultConfig[configKey]) {
       configurationObj[configKey] = defaultConfig[configKey];
@@ -52,38 +57,40 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
   };
 }
 
-/**
- * @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 
  */
 
-/**
- * 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
- * @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
+/**
+ * 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
  */
 
-/**
- * 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);

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

@@ -17,7 +17,8 @@ const {
   reportPath: htmlPath
 } = (0, _readConfigFile.generateConfigFromFile)();
 const args = ['show-report', htmlPath].concat(userArgs);
-function generateReport() {
+async function generateReport() {
+  // await preProcessReport()
   const childProcess = (0, _child_process.spawn)(command, args, {
     stdio: 'inherit'
   });

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

@@ -9,8 +9,22 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
-var _testDataMap = require("../../../bdd-poc/test/testDataMap");
-var _runner = require("../../../bdd-poc/runner");
+var _cliArgsToObject = require("../../../utils/cliArgsToObject");
+var _logger = require("../../../utils/logger");
+function getBrowsersList(browserFromArgs, browsersFromConfig) {
+  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 user args');
+      return listOfbrowsers;
+    } else {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `--browsers option should be of type 'string' splitted by ','\n\t --browsers='chrome,firefox,safari'`);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Using browsers from uat.config.js');
+      return browsersFromConfig;
+    }
+  }
+  return browsersFromConfig;
+}
 const {
   browsers,
   trace,
@@ -24,10 +38,16 @@ const {
   authFilePath,
   viewport,
   featureFilesFolder,
-  stepDefinitionsFolder
+  stepDefinitionsFolder,
+  testIdAttribute
 } = (0, _readConfigFile.generateConfigFromFile)();
+const userArgs = (0, _cliArgsToObject.parseUserArgs)();
+const {
+  browsersFromArgs = null
+} = userArgs;
+let listOfbrowsers = getBrowsersList(browsersFromArgs, browsers);
 const projects = (0, _configUtils.getProjects)({
-  browsers,
+  listOfbrowsers,
   isAuthMode,
   authFilePath,
   expectTimeout,
@@ -38,12 +58,19 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
+const testOptions = (0, _configUtils.getTestUseOptions)({
+  trace,
+  video,
+  viewport,
+  testIdAttribute
+});
+
+/**
+ * Playwright configuration object
+ *
+ * @returns {import('@playwright/test').PlaywrightTestConfig}
+*/
 function getPlaywrightConfig() {
-  globalThis.globalStepMap = new Map();
-  (0, _runner.stepFileMap)();
-  (0, _testDataMap.testDataCreation)().then(inputs => {
-    globalThis.globalTestdata = inputs;
-  });
   return {
     testDir,
     outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
@@ -54,24 +81,20 @@ function getPlaywrightConfig() {
     reporter: [['html', {
       outputFolder: reportPath,
       open: openReportOn
-    }]],
+    }], ['list'], ['./custom-reporter.js']],
     timeout: testTimeout,
     expect: {
       timeout: expectTimeout
     },
-    use: {
-      viewport,
-      trace: trace ? 'on' : 'off',
-      video: video ? {
-        mode: 'on',
-        size: {
-          ...viewport
-        }
-      } : 'off'
-    },
+    use: testOptions,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,
+      testDir: _path.default.join(process.cwd(), 'uat'),
+      teardown: 'cleanup'
+    }, {
+      name: 'cleanup',
+      testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
     }, ...projects] : [...projects]
   };

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

@@ -6,10 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 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");
+/**
+ ** Playwright project configuration
+ * @returns {import('@playwright/test').Project}
+ */
 function getBrowserConfig({
   browserName,
   isAuthMode,
@@ -81,6 +86,12 @@ function getBrowserConfig({
     return false;
   }
 }
+
+/**
+ * 
+ * @param {*} param0 
+ * @returns {import('@playwright/test').Project[]}
+ */
 function getProjects({
   browsers,
   isAuthMode,
@@ -108,4 +119,23 @@ function getTestDir(bddMode, cwd, {
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
     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/setup/custom-reporter.js

@@ -0,0 +1,109 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _readline = _interopRequireDefault(require("readline"));
+var _fileUtils = require("../../../utils/fileUtils");
+var _readConfigFile = require("../readConfigFile");
+var _logger = require("../../../utils/logger");
+class JSONSummaryReporter {
+  constructor() {
+    this.durationInMS = -1;
+    this.passed = [];
+    this.skipped = [];
+    this.failed = [];
+    this.warned = [];
+    this.interrupted = [];
+    this.timedOut = [];
+    this.flakey = [];
+    this.failedSteps = [];
+    this.status = 'unknown';
+    this.startedAt = 0;
+    this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
+  }
+  onBegin() {
+    this.startedAt = Date.now();
+  }
+  onTestEnd(test, result) {
+    const title = [];
+    const fileName = [];
+    let clean = true;
+    for (const s of test.titlePath()) {
+      if (s === '' && clean) {
+        continue;
+      }
+      clean = false;
+      title.push(s);
+      if (s.includes('.ts') || s.includes('.js')) {
+        fileName.push(s);
+      }
+    }
+    // This will publish the file name + line number test begins on
+    const z = `${fileName[0]}:${test.location.line}:${test.location.column}`;
+    // Using the t variable in the push will push a full test name + test description
+    const t = title.join(' > ');
+    // Set the status
+    const stepTitleList = result.steps.map(step => ({
+      title: step.title,
+      error: step.error,
+      testTitle: t
+    })).filter(step => step.error !== undefined);
+    if (stepTitleList.length > 0) {
+      this.failedSteps = [...this.failedSteps, ...stepTitleList];
+    }
+    const status = !['passed', 'skipped'].includes(result.status) && t.includes('@warn') ? 'warned' : result.status;
+    // Logic to push the results into the correct array
+    if (result.status === 'passed' && result.retry >= 1) {
+      this.flakey.push(z);
+    } else {
+      this[status].push(z);
+    }
+    this[status].push(z);
+  }
+  onEnd(result) {
+    this.durationInMS = Date.now() - this.startedAt;
+    this.status = result.status;
+    // removing duplicate tests from passed array
+    this.passed = this.passed.filter((element, index) => {
+      return this.passed.indexOf(element) === index;
+    });
+    // removing duplicate tests from the failed array
+    this.failed = this.failed.filter((element, index) => {
+      if (!this.passed.includes(element)) {
+        return this.failed.indexOf(element) === index;
+      }
+    });
+    // removing duplicate tests from the skipped array
+    this.skipped = this.skipped.filter((element, index) => {
+      return this.skipped.indexOf(element) === index;
+    });
+    // removing duplicate tests from the timedOut array
+    this.timedOut = this.timedOut.filter((element, index) => {
+      return this.timedOut.indexOf(element) === index;
+    });
+    // removing duplicate tests from the interrupted array
+    this.interrupted = this.interrupted.filter((element, index) => {
+      return this.interrupted.indexOf(element) === index;
+    });
+    // fs.writeFileSync('./summary.json', JSON.stringify(this, null, '  '));
+    let {
+      reportPath
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, './', 'test-summary.json'), JSON.stringify(this, null, '  '));
+  }
+  onExit() {
+    const shouldClearLastLine = this._open !== 'always' || this._open !== 'on-failure';
+    if (shouldClearLastLine) {
+      /**Below code is to replace the playwright default report commond with abstraction tool command */
+      _readline.default.moveCursor(process.stdout, 0, -2); // up two line
+      _readline.default.clearLine(process.stdout, 1); // from cursor to end
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'npx ZDTestingFramework report or npm run uat-report');
+      return;
+    }
+  }
+}
+var _default = exports.default = JSONSummaryReporter;

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

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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 getEdition(edition) {
+  if (edition.startsWith('<=')) {
+    return ['<=', edition.slice(2)];
+  } else if (edition.startsWith('>=')) {
+    return ['>=', edition.slice(2)];
+  } else if (edition.startsWith('<')) {
+    return ['<', edition.slice(1)];
+  } else if (edition.startsWith('>')) {
+    return ['>', edition.slice(1)];
+  }
+  return [null, edition];
+}
+function editionPreprocessing(editionOrder, selectedEdition) {
+  const [operator, editionToBeSearched] = getEdition(selectedEdition.toLowerCase());
+  const index = editionOrder.findIndex(edition => edition.toLowerCase() === editionToBeSearched);
+  if (index !== -1) {
+    let resultArray;
+    if (operator === '<=') {
+      resultArray = editionOrder.slice(index + 1);
+    } else if (operator === '>=') {
+      resultArray = editionOrder.slice(0, index);
+    } else if (operator === '<') {
+      resultArray = editionOrder.slice(index);
+    } else if (operator === '>') {
+      resultArray = editionOrder.slice(0, index + 1);
+    } else {
+      resultArray = editionOrder.filter((_, order) => order !== index);
+    }
+    return resultArray;
+  }
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions ${selectedEdition} found. Running with default edition`);
+  return [];
+}
+function buildEditionTags(editionArgs, operator) {
+  return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
+}
+function tagProcessor(userArgsObject, editionOrder) {
+  let tagArgs = userArgsObject['tags'];
+  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, 'or');
+        tagArgs = `${getTagsString(tagArgs, editionTags)}`;
+      }
+    } else {
+      // More than one edition given
+      const filteredEditions = editionOrder.filter(edition => !editionsArray.includes(edition));
+      const editionTags = buildEditionTags(filteredEditions, 'or');
+      tagArgs = `${getTagsString(tagArgs, editionTags)}`;
+    }
+  }
+  return tagArgs;
+}