@zohodesk/testinglibrary 0.1.8-exp-bdd-v2 → 0.1.8-exp-bdd-v4

package/build/bdd-framework/utils/index.js

@@ -4,6 +4,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.callWithTimeout = callWithTimeout;
+exports.extractTemplateParams = extractTemplateParams;
 exports.getPackageVersion = getPackageVersion;
 exports.getSymbolByName = getSymbolByName;
 exports.removeDuplicates = removeDuplicates;
@@ -11,7 +13,12 @@ exports.resolvePackageRoot = resolvePackageRoot;
 exports.template = template;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
-// See: https://stackoverflow.com/questions/50453640/how-can-i-get-the-value-of-a-symbol-property
+var _util = require("util");
+const setTimeoutPromise = (0, _util.promisify)(setTimeout);
+/**
+ * Returns Symbol by name.
+ * See: https://stackoverflow.com/questions/50453640/how-can-i-get-the-value-of-a-symbol-property
+ */
 function getSymbolByName(target, name) {
   const ownKeys = Reflect.ownKeys(target);
   const symbol = ownKeys.find(key => key.toString() === `Symbol(${name})`);
@@ -29,6 +36,13 @@ function template(t, params = {}) {
     return params[key] !== undefined ? String(params[key]) : match;
   });
 }
+/**
+ * Extracts all template params from string.
+ * Params defined as <param>.
+ */
+function extractTemplateParams(t) {
+  return [...t.matchAll(/<(.+?)>/g)].map(m => m[1]);
+}
 function removeDuplicates(arr) {
   return [...new Set(arr)];
 }
@@ -41,4 +55,16 @@ function getPackageVersion(packageName) {
   const packageJsonPath = _path.default.join(packageRoot, 'package.json');
   const packageJson = JSON.parse(_fs.default.readFileSync(packageJsonPath, 'utf8'));
   return packageJson.version || '';
+}
+async function callWithTimeout(fn, timeout, timeoutMsg) {
+  if (!timeout) {
+    return fn();
+  }
+  const ac = new AbortController();
+  return Promise.race([fn(), setTimeoutPromise(timeout, null, {
+    ref: false,
+    signal: ac.signal
+  }).then(() => {
+    throw new Error(timeoutMsg || `Function timeout (${timeout} ms)`);
+  })]).finally(() => ac.abort());
 }

package/build/bdd-framework/utils/logger.js

@@ -13,7 +13,9 @@ class Logger {
     this.options = options;
   }
   log(...args) {
-    if (this.options.verbose) console.log(...args);
+    if (this.options.verbose) {
+      console.log(...args);
+    }
   }
   warn(...args) {
     // using log() to output warnings to stdout, not stderr
@@ -25,5 +27,4 @@ class Logger {
 }
 // default logger
 exports.Logger = Logger;
-const logger = new Logger();
-exports.logger = logger;
+const logger = exports.logger = new Logger();

package/build/bdd-poc/core-runner/main.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCucumberBDD = createCucumberBDD;
+var _stepFileGenerate = require("../test/stepGenerate/stepFileGenerate");
+async function createCucumberBDD() {
+  await (0, _stepFileGenerate.generateSpecFiles)();
+}

package/build/bdd-poc/core-runner/stepDefinitions.js

@@ -27,7 +27,6 @@ function getInputArray(description, argument) {
     return [specInput.dataTableStep];
   }
   if (specInput.scenarioTable) {
-    console.log(specInput.inputParameter);
     var exceedParam = specInput.inputParameter[0];
     const extracted = argument.map(element => {
       return exceedParam[element];

package/build/bdd-poc/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "createBdd", {
+  enumerable: true,
+  get: function () {
+    return _exportMethods.createBdd;
+  }
+});
+Object.defineProperty(exports, "createCucumberBDD", {
+  enumerable: true,
+  get: function () {
+    return _main.createCucumberBDD;
+  }
+});
+Object.defineProperty(exports, "createNativeBDD", {
+  enumerable: true,
+  get: function () {
+    return _stepDefinitions.createNativeBDD;
+  }
+});
+var _exportMethods = require("./core-runner/exportMethods");
+var _stepDefinitions = require("./core-runner/stepDefinitions");
+var _main = require("./core-runner/main");

package/build/bdd-poc/test/stepGenerate/stepFileGenerate.js

@@ -11,18 +11,18 @@ var _path = _interopRequireDefault(require("path"));
 var _featureFileParer = require("../cucumber/featureFileParer");
 var _testStructure = require("../testStructure");
 async function stepFileCreation(featureContent, stepFilename, featureFilePath) {
-  const generatedFolderPath = _path.default.resolve(process.cwd(), 'uat', 'feature-gen');
-  if (!(0, _fs.existsSync)(generatedFolderPath)) {
-    (0, _fs.mkdirSync)('./feature-gen', {
-      recursive: true
-    });
-  }
   const stepsFilePath = _path.default.resolve(process.cwd(), 'uat', 'feature-gen', stepFilename);
   const stepsSnippets = (0, _testStructure.testSnippet)(featureContent, featureFilePath);
   await (0, _fs.writeFileSync)(stepsFilePath, stepsSnippets);
 }
 function generateSpecFiles() {
   const featureFilePattern = _path.default.resolve(process.cwd(), 'uat', 'modules', '**', '**', '**', '**', '**', '**', '**', '**', '*.feature').split(`\\`).join('/');
+  const generatedFolderPath = _path.default.resolve(process.cwd(), 'uat', 'feature-gen');
+  if (!(0, _fs.existsSync)(generatedFolderPath)) {
+    (0, _fs.mkdirSync)(generatedFolderPath, {
+      recursive: true
+    });
+  }
   _fastGlob.default.globSync(featureFilePattern, {
     dot: true,
     cwd: process.cwd()

package/build/bdd-poc/test/stepGenerate/stepsnippets.js

@@ -8,8 +8,7 @@ exports.testCase = testCase;
 exports.testFile = testFile;
 exports.testStep = testStep;
 exports.testSuite = testSuite;
-const TESTING_LIBRARY = '@zohodesk/testinglibrary';
-exports.TESTING_LIBRARY = TESTING_LIBRARY;
+const TESTING_LIBRARY = exports.TESTING_LIBRARY = '@zohodesk/testinglibrary';
 function testStep(keyword, description, browserObject, testData, options) {
   return `await $${keyword}('${description}')(${browserObject},${testData})\n`;
 }

package/build/bdd-poc/test/testDataMap.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.testDataCreation = testDataCreation;
-var _gherkin = _interopRequireDefault(require("@cucumber/gherkin"));
+var _gherkin = require("@cucumber/gherkin");
 var _messages = require("@cucumber/messages");
 var _fastGlob = _interopRequireDefault(require("fast-glob"));
 var _fs = require("fs");
@@ -13,12 +13,12 @@ var _path = _interopRequireDefault(require("path"));
 var _testStructure = require("./testStructure");
 async function testDataCreation() {
   var uuidFn = _messages.IdGenerator.uuid();
-  var builder = new _gherkin.default.AstBuilder(uuidFn);
-  var matcher = new _gherkin.default.GherkinClassicTokenMatcher();
-  var parser = new _gherkin.default.Parser(builder, matcher);
+  var builder = new _gherkin.AstBuilder(uuidFn);
+  var matcher = new _gherkin.GherkinClassicTokenMatcher();
+  var parser = new _gherkin.Parser(builder, matcher);
   var exampleSteps = [];
   const globalTestdata = new Map();
-  const actualStepFilePath = _path.default.resolve('uat', 'modules', '**', '**', '**', '**', '**', '*.spec.js').split('\\').join('/');
+  const actualStepFilePath = _path.default.resolve('uat', 'modules', '**', '**', '**', '**', '**', '*.feature').split('\\').join('/');
   await _fastGlob.default.globSync(actualStepFilePath, {
     dot: true,
     cwd: process.cwd()

package/build/core/jest/preprocessor/jsPreprocessor.js

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _babelJest = _interopRequireDefault(require("babel-jest"));
-var _default = _babelJest.default.createTransformer({
+var _default = exports.default = _babelJest.default.createTransformer({
   presets: [require.resolve('@babel/preset-env'), require.resolve('@babel/preset-react')],
   plugins: [require.resolve('babel-plugin-transform-dynamic-import')]
-});
-exports.default = _default;
+});

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

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  addTags: [async ({
+    $tags
+  }, use, testInfo) => {
+    testInfo.annotations.push({
+      type: 'tags',
+      description: $tags.join(', ')
+    });
+    await use();
+  }, {
+    auto: true
+  }]
+};

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+const cacheMap = new Map();
+var _default = exports.default = {
+  // eslint-disable-next-line no-empty-pattern
+  cacheLayer: async ({}, use) => {
+    await use(cacheMap);
+  }
+};

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

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  context: async ({
+    context
+  }, use) => {
+    // eslint-disable-next-line no-undef
+    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
+    await use(context);
+  }
+};

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

@@ -0,0 +1,26 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _page = _interopRequireDefault(require("./page"));
+var _context = _interopRequireDefault(require("./context"));
+var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
+var _addTags = _interopRequireDefault(require("./addTags"));
+function getBuiltInFixtures(bddMode) {
+  let builtInFixtures = {
+    ..._page.default,
+    ..._context.default,
+    ..._cacheLayer.default
+  };
+  if (bddMode) {
+    builtInFixtures = {
+      ...builtInFixtures,
+      ..._addTags.default
+    };
+  }
+  return builtInFixtures;
+}
+var _default = exports.default = getBuiltInFixtures;

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,5 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CUSTOM_COMMANDS = void 0;
-const CUSTOM_COMMANDS = ['mode', 'tags'];
-exports.CUSTOM_COMMANDS = CUSTOM_COMMANDS;
+const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition'];

package/build/core/playwright/index.js

@@ -1,15 +1,9 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.When = exports.Then = exports.Given = void 0;
-Object.defineProperty(exports, "createBdd", {
-  enumerable: true,
-  get: function () {
-    return _bddFramework.createBdd;
-  }
-});
 Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
@@ -17,96 +11,21 @@ Object.defineProperty(exports, "expect", {
   }
 });
 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);
-//   }
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+// import { createBdd, test as bddBase } from '../../bdd-framework';
 
-//   getByRole(...args) {
-//     return this.page['getByRole'](...args);
-//   }
-// }
-
-// function FilteredPage(page) {
-//   return {
-//     getByRole: () => {
-//       throw new Error('You cannnot use getByRole property')
-//     }
-//   }
-// }
 const {
-  additionalPages,
+  additionalPages: userFixtures,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
-let base = bddMode ? _bddFramework.test : _test.test;
-const 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
+// In house BDD testing. so, use playwright test
+let base = _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
+const test = exports.test = base.extend({
+  ...buildInFixtures,
+  ...userFixtures
 });
-exports.test = test;
-const {
-  Given,
-  When,
-  Then
-} = (0, _bddFramework.createBdd)();
-exports.Then = Then;
-exports.When = When;
-exports.Given = Given;
+
+// const { Given, When, Then } = createBdd();

package/build/core/playwright/readConfigFile.js

@@ -11,10 +11,10 @@ exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
-const fileName = 'uat.config.js';
-exports.fileName = fileName;
+const fileName = exports.fileName = 'uat.config.js';
 function getDefaultConfig() {
   return {
+    headless: false,
     browsers: ['Chrome'],
     trace: false,
     video: false,
@@ -31,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) {
@@ -39,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];
@@ -67,7 +71,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @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 {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) 
@@ -78,7 +82,9 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @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
+ * @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
  */
 
 /**

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

@@ -10,7 +10,7 @@ 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 _index = require("../../../bdd-poc/index");
 const {
   browsers,
   trace,
@@ -23,8 +23,7 @@ const {
   testTimeout,
   authFilePath,
   viewport,
-  featureFilesFolder,
-  stepDefinitionsFolder
+  testIdAttribute
 } = (0, _readConfigFile.generateConfigFromFile)();
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -36,9 +35,21 @@ const projects = (0, _configUtils.getProjects)({
 });
 // const testDir = getTestDir(bddMode, process.cwd(), { featureFilesFolder, stepDefinitionsFolder });
 const testDir = _path.default.resolve(process.cwd(), 'uat', 'feature-gen');
+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, _index.stepFileMap)();
   (0, _testDataMap.testDataCreation)().then(inputs => {
     globalThis.globalTestdata = inputs;
   });
@@ -52,27 +63,22 @@ 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]
   };
 }
-var _default = (0, _test.defineConfig)(getPlaywrightConfig());
-exports.default = _default;
+var _default = exports.default = (0, _test.defineConfig)(getPlaywrightConfig());