@zohodesk/testinglibrary 0.0.5 → 0.0.6

package/{src → build}/core/playwright/index.js

@@ -1,82 +1,112 @@
-const { expect, test: base } = require('@playwright/test');
-// 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')
-//     }
-//   }
-// }
-
-const test = base.extend({
-  page: async ({ baseURL, 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) => {
-    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
-    await use(context);
-  }
-})
-
-
-module.exports = {
-  expect,
-  test
-}
+"use strict";
+
+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 () {
+    return _test.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);
+//   }
+
+//   getByRole(...args) {
+//     return this.page['getByRole'](...args);
+//   }
+// }
+
+// function FilteredPage(page) {
+//   return {
+//     getByRole: () => {
+//       throw new Error('You cannnot use getByRole property')
+//     }
+//   }
+// }
+const {
+  additionalPages = {},
+  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
+});
+exports.test = test;
+const {
+  Given,
+  When,
+  Then
+} = (0, _bddFramework.createBdd)();
+exports.Then = Then;
+exports.When = When;
+exports.Given = Given;

package/build/core/playwright/readConfigFile.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+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 = 'uat.config.js';
+
+/**
+ * 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
+ */
+
+/**
+ * Generates a configuration object from a file, if it exists.
+ *
+ * @returns {UserConfig}
+*/
+exports.fileName = fileName;
+function generateConfigFromFile() {
+  const filePath = _path.default.resolve(process.cwd(), fileName);
+  if ((0, _fs.existsSync)(filePath)) {
+    /** @type {UserConfig} */
+    const config = require(filePath);
+    return config;
+  }
+  return {};
+}
+function isUserConfigFileAvailable() {
+  const filePath = _path.default.resolve(process.cwd(), fileName);
+  if ((0, _fs.existsSync)(filePath)) {
+    return true;
+  }
+  return false;
+}
+function getAuthFilePath(filePath) {
+  try {
+    if ((0, _fs.existsSync)(filePath)) {
+      return filePath;
+    } else {
+      return {};
+    }
+  } catch (err) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Founded Path - ${filePath} Authetication file not Exist ...`);
+  }
+}

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

@@ -0,0 +1,41 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = generateReport;
+var _child_process = require("child_process");
+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 = _path.default.resolve(process.cwd(), 'uat', './playwright-report')
+} = (0, _readConfigFile.generateConfigFromFile)();
+const args = ['show-report', htmlPath].concat(userArgs);
+function generateReport() {
+  const childProcess = (0, _child_process.spawn)(command, args, {
+    stdio: 'inherit'
+  });
+  childProcess.on('error', error => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+  });
+  childProcess.on('exit', (code, signal) => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
+    process.exit();
+  });
+  process.on('exit', () => {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Terminating Playwright Process...');
+    childProcess.kill();
+    return;
+  });
+  process.on('SIGINT', () => {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Cleaning up...');
+    childProcess.kill();
+    process.exit();
+  });
+}

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

@@ -0,0 +1,117 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _test = require("@playwright/test");
+var _path = _interopRequireDefault(require("path"));
+var _bddFramework = require("../../../bdd-framework");
+var _readConfigFile = require("../readConfigFile");
+// @ts-check
+
+// import { cpus } from 'os';
+// const numOfCpus = cpus().length;
+const defaultBrowser = ['Chrome'];
+const {
+  browsers = defaultBrowser,
+  trace = false,
+  video = false,
+  isAuthMode,
+  openReportOn,
+  reportPath = _path.default.join(process.cwd(), 'uat', 'playwright-report'),
+  bddMode = false,
+  expectTimeout = 5 * 1000,
+  testTimeout = 60 * 1000,
+  authFilePath = 'uat/playwright/.auth/user.json'
+} = (0, _readConfigFile.generateConfigFromFile)();
+let projects = browsers.map(browserName => {
+  let browser = browserName.toLowerCase();
+  if (browser === 'chrome') {
+    return {
+      name: 'chromium',
+      use: {
+        ..._test.devices['Desktop Chrome'],
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+      },
+      dependencies: isAuthMode ? ['setup'] : []
+    };
+  } else if (browser === 'edge') {
+    return {
+      name: 'Microsoft Edge',
+      use: {
+        ..._test.devices['Desktop Chrome'],
+        channel: 'msedge',
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+      },
+      dependencies: isAuthMode ? ['setup'] : []
+    };
+  } else if (browser === 'firefox') {
+    return {
+      name: 'firefox',
+      timeout: 4 * 60 * 1000,
+      expect: {
+        timeout: 80 * 1000
+      },
+      use: {
+        ..._test.devices['Desktop Firefox'],
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+      },
+      dependencies: isAuthMode ? ['setup'] : []
+    };
+  } else if (browser === 'safari') {
+    return {
+      name: 'webkit',
+      timeout: 2 * 60 * 1000,
+      expect: {
+        timeout: 80 * 1000
+      },
+      use: {
+        ..._test.devices['Desktop Safari'],
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+      },
+      dependencies: isAuthMode ? ['setup'] : null
+    };
+  }
+}).filter(Boolean);
+const testPath = _path.default.join(_path.default.resolve(process.cwd()), 'uat');
+const testDir = bddMode ? (0, _bddFramework.defineBddConfig)({
+  paths: [`${testPath}/**/*.feature`],
+  import: [`${testPath}/**/steps/*.spec.js`],
+  featuresRoot: `${testPath}`,
+  outputDir: `${testPath}/.features-gen`,
+  publish: true
+}) : _path.default.join(_path.default.resolve(process.cwd()), 'uat');
+var _default = (0, _test.defineConfig)({
+  testDir,
+  outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : 1,
+  reporter: [['html', {
+    outputFolder: reportPath,
+    open: openReportOn
+  }]],
+  timeout: testTimeout,
+  expect: {
+    timeout: expectTimeout
+  },
+  use: {
+    trace: trace ? 'on' : 'off',
+    video: video ? {
+      mode: 'on',
+      size: {
+        width: 640,
+        height: 480
+      }
+    } : 'off'
+  },
+  projects: isAuthMode ? [{
+    name: 'setup',
+    testMatch: /.*\.setup\.js/,
+    testDir: _path.default.join(_path.default.resolve(process.cwd()), 'uat')
+  }, ...projects] : [...projects]
+});
+exports.default = _default;

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

@@ -0,0 +1,132 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createTestRunner;
+var _child_process = require("child_process");
+var _path = _interopRequireDefault(require("path"));
+var _customCommands = require("./custom-commands");
+var _cliArgsToObject = require("../../utils/cliArgsToObject");
+var _envInitializer = require("./env-initializer");
+var _logger = require("../../utils/logger");
+var _readConfigFile = require("./readConfigFile");
+var _rootPath = require("../../utils/rootPath");
+function createTestRunner() {
+  // Access the command line arguments
+  const userArgs = process.argv.slice(2);
+  const userArgsObject = (0, _cliArgsToObject.cliArgsToObject)(userArgs);
+
+  // eslint-disable-next-line
+  const tagArgs = userArgsObject['tags'];
+  const {
+    debug,
+    mode = 'dev',
+    bddMode = false,
+    headless = false
+  } = (0, _readConfigFile.generateConfigFromFile)();
+
+  // Environment variables Initialization
+  (0, _envInitializer.initializeEnvConfig)(userArgsObject.mode ? userArgsObject.mode : mode);
+  const playwrightArgs = (0, _cliArgsToObject.objectToCliArgs)(userArgsObject, key => !_customCommands.CUSTOM_COMMANDS.includes(key));
+  if (debug) {
+    playwrightArgs.push('--debug');
+  }
+  if (tagArgs) {
+    playwrightArgs.push(`--grep ${tagArgs}`);
+  }
+  if (!headless && !userArgsObject.headed) {
+    playwrightArgs.push('--headed');
+  }
+
+  // ZDTetsting test --tags=@live
+  // Command and arguments for npx playwright test
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+
+  // npm run bddgen && npm run playwright test
+
+  const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
+  const args = ['test', '--config', configPath].concat(playwrightArgs);
+  // Spawn the child process
+
+  let promises = [];
+  if (bddMode) {
+    const beforeCommand = 'node';
+    const bddGenPath = _path.default.resolve(_path.default.join(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js'));
+    const beforeArgs = [bddGenPath, '-c', configPath];
+    const preprocessingPromise = new Promise((resolve, reject) => {
+      const childProcessForPreprocessing = (0, _child_process.spawn)(beforeCommand, beforeArgs, {
+        stdio: 'inherit'
+      });
+      childProcessForPreprocessing.on('error', data => {
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
+        reject();
+      });
+      childProcessForPreprocessing.on('exit', code => {
+        if (code === 0) {
+          _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature Files Processed Successfully');
+          resolve();
+        } else {
+          reject(`BddGen exited with code ${code}`);
+        }
+      });
+    });
+    promises.push(preprocessingPromise);
+  } else {
+    const beforeCommand = 'node';
+    const bddGenPath = _path.default.resolve(_path.default.join(__dirname, '../', '../', 'parser', 'verifier.js'));
+    const beforeArgs = [bddGenPath];
+    const preprocessingPromise = new Promise((resolve, reject) => {
+      const childProcessForPreprocessing = (0, _child_process.spawn)(beforeCommand, beforeArgs);
+
+      // Handle the output and errors for the first command
+      childProcessForPreprocessing.stdout.on('data', data => {
+        _logger.Logger.log(_logger.Logger.INFO_TYPE, data);
+      });
+      childProcessForPreprocessing.stderr.on('data', data => {
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
+        reject();
+      });
+      childProcessForPreprocessing.on('close', code => {
+        if (code === 0) {
+          _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature Files Processed Successfully');
+          resolve();
+        } else {
+          reject(`Preprocessing exited with code ${code}`);
+        }
+      });
+    });
+    promises.push(preprocessingPromise);
+  }
+  Promise.all(promises).then(() => {
+    const childProcessForRunningPlaywright = (0, _child_process.spawn)(command, args, {
+      stdio: 'inherit'
+    });
+    childProcessForRunningPlaywright.on('error', error => {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+    });
+    childProcessForRunningPlaywright.on('exit', (code, signal) => {
+      if (code !== 0) {
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
+      } else {
+        _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Test Ran Successfully');
+      }
+      process.exit();
+    });
+    process.on('exit', () => {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Terminating Playwright Process...');
+      //childProcess.kill();
+      return;
+    });
+    process.on('SIGINT', () => {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Cleaning up...');
+      //childProcess.kill();
+      process.exit();
+    });
+  }).catch(err => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, err);
+    process.exit();
+  });
+}

package/build/decorators.d.ts

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

package/build/decorators.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _decorators = require("./bdd-framework/decorators");
+Object.keys(_decorators).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _decorators[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _decorators[key];
+    }
+  });
+});

package/build/index.d.ts

@@ -0,0 +1,5 @@
+import { Given, Then, When, Step, expect, test, createBdd } from './core/playwright/index';
+import { fireEvent, render } from '@testing-library/react';
+
+export { Given, Then, When, Step, expect, test, createBdd, fireEvent, render };
+export * from '@playwright/test/types/test';

package/build/index.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.When = exports.Then = exports.Step = exports.Given = void 0;
+Object.defineProperty(exports, "createBdd", {
+  enumerable: true,
+  get: function () {
+    return _index.createBdd;
+  }
+});
+Object.defineProperty(exports, "expect", {
+  enumerable: true,
+  get: function () {
+    return _index.expect;
+  }
+});
+Object.defineProperty(exports, "fireEvent", {
+  enumerable: true,
+  get: function () {
+    return _react.fireEvent;
+  }
+});
+Object.defineProperty(exports, "render", {
+  enumerable: true,
+  get: function () {
+    return _react.render;
+  }
+});
+Object.defineProperty(exports, "test", {
+  enumerable: true,
+  get: function () {
+    return _index.test;
+  }
+});
+var _index = require("./core/playwright/index");
+var _react = require("@testing-library/react");
+// const { expect, test, createBdd } = require('./core/playwright/index');
+// const { fireEvent, render } = require('@testing-library/react');
+
+// module.exports = {
+//   expect,
+//   test,
+//   fireEvent,
+//   render,
+//   createBdd
+// }
+
+const {
+  Given,
+  Then,
+  When,
+  Step
+} = (0, _index.createBdd)();
+exports.Step = Step;
+exports.When = When;
+exports.Then = Then;
+exports.Given = Given;