@zohodesk/testinglibrary 0.0.6 → 0.0.7-exp.1

package/Changelog.md

@@ -2,6 +2,17 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.0.7-exp.1
+
+- Tags Support
+- Enable running without bddmode feature
+- viewport configuration
+- Code refactoring
+
+# 0.0.7
+
+- Removed react and react-dom as dependencies. Added this as peer dependency
+
 # 0.0.6
 
 ## Provided Initial Support for cucumber feature files

package/build/core/playwright/index.js

@@ -51,7 +51,7 @@ var _readConfigFile = require("./readConfigFile");
 //   }
 // }
 const {
-  additionalPages = {},
+  additionalPages,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
 let base = bddMode ? _bddFramework.test : _test.test;

package/build/core/playwright/readConfigFile.js

@@ -12,6 +12,38 @@ var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 const fileName = 'uat.config.js';
+exports.fileName = fileName;
+function getDefaultConfig() {
+  return {
+    browsers: ['Chrome'],
+    trace: false,
+    video: false,
+    isAuthMode: false,
+    openReportOn: 'never',
+    reportPath: _path.default.join(process.cwd(), 'uat', 'playwright-report'),
+    bddMode: false,
+    expectTimeout: 5 * 1000,
+    testTimeout: 60 * 1000,
+    authFilePath: 'uat/playwright/.auth/user.json',
+    viewport: null,
+    debug: false,
+    mode: 'dev',
+    additionalPages: {}
+  };
+}
+function combineDefaultConfigWithUserConfig(userConfiguration) {
+  let defaultConfig = getDefaultConfig();
+  return {
+    ...defaultConfig,
+    ...userConfiguration
+  };
+}
+
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport 
+ */
 
 /**
  * Represents the user configuration object.
@@ -32,6 +64,7 @@ const fileName = 'uat.config.js';
  * @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
  */
 
 /**
@@ -39,13 +72,13 @@ const fileName = 'uat.config.js';
  *
  * @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;
+    const modifiedConfiguration = combineDefaultConfigWithUserConfig(config);
+    return modifiedConfiguration;
   }
   return {};
 }

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

@@ -14,7 +14,7 @@ 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')
+  reportPath: htmlPath
 } = (0, _readConfigFile.generateConfigFromFile)();
 const args = ['show-report', htmlPath].concat(userArgs);
 function generateReport() {

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

@@ -7,111 +7,62 @@ Object.defineProperty(exports, "__esModule", {
 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'];
+var _configUtils = require("./config-utils");
 const {
-  browsers = defaultBrowser,
-  trace = false,
-  video = false,
+  browsers,
+  trace,
+  video,
   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'
+  reportPath,
+  bddMode,
+  expectTimeout,
+  testTimeout,
+  authFilePath,
+  viewport
 } = (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]
+const projects = (0, _configUtils.getProjects)({
+  browsers,
+  isAuthMode,
+  authFilePath,
+  expectTimeout,
+  testTimeout
 });
+const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd());
+function getPlaywrightConfig() {
+  return {
+    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: {
+      viewport,
+      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(process.cwd(), 'uat')
+    }, ...projects] : [...projects]
+  };
+}
+var _default = (0, _test.defineConfig)(getPlaywrightConfig());
 exports.default = _default;

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

@@ -0,0 +1,105 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getProjects = getProjects;
+exports.getTestDir = getTestDir;
+var _test = require("@playwright/test");
+var _path = _interopRequireDefault(require("path"));
+var _readConfigFile = require("../readConfigFile");
+var _bddFramework = require("../../../bdd-framework");
+function getBrowserConfig({
+  browserName,
+  isAuthMode,
+  authFilePath,
+  expectTimeout,
+  testTimeout
+}) {
+  const browser = browserName.toLowerCase();
+  const commonConfig = {
+    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+  };
+  const dependencies = isAuthMode ? ['setup'] : [];
+  if (browser === 'chrome') {
+    return {
+      name: 'chromium',
+      use: {
+        ..._test.devices['Desktop Chrome'],
+        ...commonConfig
+      },
+      dependencies,
+      timeout: testTimeout,
+      expect: {
+        timeout: expectTimeout
+      }
+    };
+  } else if (browser === 'edge') {
+    return {
+      name: 'Microsoft Edge',
+      timeout: testTimeout,
+      expect: {
+        timeout: expectTimeout
+      },
+      use: {
+        ..._test.devices['Desktop Chrome'],
+        channel: 'msedge',
+        ...commonConfig
+      },
+      dependencies
+    };
+  } else if (browser === 'firefox') {
+    return {
+      name: 'firefox',
+      timeout: 2 * testTimeout,
+      expect: {
+        timeout: 2 * expectTimeout
+      },
+      use: {
+        ..._test.devices['Desktop Firefox'],
+        ...commonConfig
+      },
+      dependencies
+    };
+  } else if (browser === 'safari') {
+    return {
+      name: 'webkit',
+      timeout: 4 * testTimeout,
+      expect: {
+        timeout: 4 * expectTimeout
+      },
+      use: {
+        ..._test.devices['Desktop Safari'],
+        ...commonConfig
+      },
+      dependencies
+    };
+  } else {
+    return false;
+  }
+}
+function getProjects({
+  browsers,
+  isAuthMode,
+  authFilePath,
+  expectTimeout,
+  testTimeout
+}) {
+  return browsers.map(browserName => getBrowserConfig({
+    browserName,
+    isAuthMode,
+    authFilePath,
+    expectTimeout,
+    testTimeout
+  })).filter(Boolean);
+}
+function getTestDir(bddMode, cwd) {
+  return bddMode ? (0, _bddFramework.defineBddConfig)({
+    paths: [_path.default.join(cwd, 'uat', '**', '*.feature')],
+    import: [_path.default.join(cwd, 'uat', '**', 'steps', '*.spec.js')],
+    featuresRoot: _path.default.join(cwd, 'uat'),
+    outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
+    publish: true
+  }) : _path.default.join(cwd, 'uat');
+}

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

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = createTestRunner;
+exports.default = void 0;
 var _child_process = require("child_process");
 var _path = _interopRequireDefault(require("path"));
 var _customCommands = require("./custom-commands");
@@ -13,94 +13,51 @@ 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);
+function parseUserArgs() {
+  return (0, _cliArgsToObject.cliArgsToObject)(process.argv.slice(2));
+}
+function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
   const playwrightArgs = (0, _cliArgsToObject.objectToCliArgs)(userArgsObject, key => !_customCommands.CUSTOM_COMMANDS.includes(key));
   if (debug) {
     playwrightArgs.push('--debug');
   }
-  if (tagArgs) {
-    playwrightArgs.push(`--grep ${tagArgs}`);
+  if (!bddMode && tagArgs) {
+    playwrightArgs.push('--grep');
+    playwrightArgs.push(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}`);
-        }
-      });
+  return playwrightArgs;
+}
+function runPreprocessing(tagArgs, configPath) {
+  const beforeCommand = 'node';
+  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
+  const beforeArgs = [bddGenPath, '-c', configPath];
+  if (tagArgs) {
+    beforeArgs.push('--tags');
+    beforeArgs.push(tagArgs);
+  }
+  return new Promise((resolve, reject) => {
+    const childProcessForPreprocessing = (0, _child_process.spawn)(beforeCommand, beforeArgs, {
+      stdio: 'inherit'
     });
-    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}`);
-        }
-      });
+    childProcessForPreprocessing.on('error', data => {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
+      reject();
     });
-    promises.push(preprocessingPromise);
-  }
-  Promise.all(promises).then(() => {
+    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}`);
+      }
+    });
+  });
+}
+function runPlaywright(command, args) {
+  return new Promise((resolve, reject) => {
     const childProcessForRunningPlaywright = (0, _child_process.spawn)(command, args, {
       stdio: 'inherit'
     });
@@ -110,23 +67,38 @@ function createTestRunner() {
     childProcessForRunningPlaywright.on('exit', (code, signal) => {
       if (code !== 0) {
         _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
+        reject(`Child Process Exited with Code ${code} and Signal ${signal}`);
       } else {
         _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Test Ran Successfully');
+        resolve();
       }
-      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 => {
+  });
+}
+function main() {
+  const userArgsObject = parseUserArgs();
+  // eslint-disable-next-line
+  const tagArgs = userArgsObject['tags'];
+  const {
+    debug,
+    mode = 'dev',
+    bddMode = false,
+    headless = false
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
+  (0, _envInitializer.initializeEnvConfig)(userArgsObject.mode ? userArgsObject.mode : mode);
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
+  const args = ['test', '--config', configPath].concat(playwrightArgs);
+  let promises = [];
+  if (bddMode) {
+    promises.push(runPreprocessing(tagArgs, configPath));
+  }
+  Promise.all(promises).then(() => runPlaywright(command, args)).catch(err => {
     _logger.Logger.log(_logger.Logger.FAILURE_TYPE, err);
-    process.exit();
+    process.exit(1);
   });
-}
+}
+var _default = main;
+exports.default = _default;

package/build/setup-folder-structure/samples/uat-config-sample.js

@@ -1,3 +1,8 @@
+/**
+ * @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
@@ -17,6 +22,7 @@
  * @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. If null, it will take the screen width and height
  */
 
 /**
@@ -31,5 +37,6 @@ module.exports = {
   trace: true,
   video: true,
   featureFilesFolder: 'feature-files',
-  stepDefinitionsFolder: 'steps'
+  stepDefinitionsFolder: 'steps',
+  viewport: null
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.0.6",
+  "version": "0.0.7-exp.1",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -32,13 +32,15 @@
     "fast-glob": "^3.3.1",
     "jest": "^29.6.2",
     "jest-environment-jsdom": "^29.6.2",
-    "msw": "^1.2.3",
-    "react": "16.13.1",
-    "react-dom": "16.13.1"
+    "msw": "^1.2.3"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"
   },
+  "peerDependencies": {
+    "react": "16.13.1",
+    "react-dom": "16.13.1"
+  },
   "devDependencies": {
     "@babel/cli": "^7.22.15",
     "@babel/core": "^7.22.17",