@zohodesk/testinglibrary 0.0.4 → 0.0.5-exp.2

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.0.4",
+  "version": "0.0.5-exp.2",
   "description": "",
   "main": "./src/index.js",
   "scripts": {
     "postinstall": "node bin/postinstall.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "clean": "rm -rf build && mkdir build",
+    "build-babel": "babel -d ./build ./src --copy-files",
+    "build": "npm run clean && npm run build-babel"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@babel/preset-env": "^7.22.9",
     "@babel/preset-react": "^7.22.5",
+    "@cucumber/cucumber": "^9.5.1",
     "@playwright/test": "^1.37.1",
     "@testing-library/jest-dom": "^5.11.9",
     "@testing-library/react": "^11.2.7",
@@ -23,9 +26,20 @@
     "jest-environment-jsdom": "^29.6.2",
     "msw": "^1.2.3",
     "react": "16.13.1",
-    "react-dom": "16.13.1"
+    "react-dom": "16.13.1",
+    "commander": "^11.0.0",
+    "fast-glob": "^3.3.1"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.22.15",
+    "@babel/core": "^7.22.17",
+    "@babel/node": "^7.22.15",
+    "@babel/plugin-transform-runtime": "^7.22.15",
+    "@babel/polyfill": "^7.12.1",
+    "@babel/preset-env": "^7.22.15",
+    "@babel/runtime": "^7.22.15"
   }
 }

package/playwright.config.js

@@ -12,7 +12,7 @@ const numCPUs = require('os').cpus().length;
 /**
  * @see https://playwright.dev/docs/test-configuration
  */
-module.exports = defineConfig({
+export default defineConfig({
   testDir: path.join(path.resolve(process.cwd()), 'uat'),
   outputDir: path.join(process.cwd(), 'test-results'),
   /* Run tests in files in parallel */

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

@@ -1,9 +0,0 @@
-const babelJest = require('babel-jest');
-
-module.exports = babelJest.createTransformer({
-  presets: [
-    require.resolve('@babel/preset-env'),
-    require.resolve('@babel/preset-react')
-  ],
-  plugins: [require.resolve('babel-plugin-transform-dynamic-import')]
-});

package/src/core/jest/setup/index.js

@@ -1,165 +0,0 @@
-//$Id$//
-import TestUtils from 'react-dom/test-utils';
-import { expect } from '@jest/globals'
-import React from 'react';
-import PropTypes from 'prop-types';
-import ReactDOM from 'react-dom';
-import '@testing-library/jest-dom/extend-expect';
-// let mockDomain = 'htt' + 'p://zoho.com';
-// const { document } = new JSDOM('').window;
-// global.document = document;
-// global.window = document.defaultView;
-// global.navigator = global.window.navigator;
-// global.localStorage = global.sessionStorage = {
-//   getItem(key) {
-//     return this[key];
-//   },
-//   setItem(key, value) {
-//     if (value.length > 100) {
-//       throw new Error('Data size is too exceeded');
-//     }
-//     this[key] = value;
-//   },
-//   removeItem(key) {
-//     delete this[key];
-//   },
-//   clear() {
-//     let keys = ['getItem', 'setItem', 'removeItem', 'clear'];
-//     for (let key in this) {
-//       if (keys.indexOf(key) === -1) {
-//         delete this[key];
-//       }
-//     }
-//   }
-// };
-// global.ZE_Init = {};
-// global.String.prototype.contains = function (text) {
-//   return this.indexOf(text) != -1;
-// };
-// global.TestUtils = TestUtils;
-// // let xmlReq = XMLHttpRequest;
-// // window.XMLHttpRequest = function () {
-// //   let xmlReqCopy = new xmlReq();
-// //   let originalOpen = xmlReqCopy.open;
-// //   xmlReqCopy.open = function () {
-// //     if (arguments[1].indexOf('http') != 0) {
-// //       arguments[1] = mockDomain + arguments[1];
-// //     }
-// //     return originalOpen.apply(this, arguments);
-// //   };
-// //   return xmlReqCopy;
-// // };
-
-// TestUtils.scryRenderedComponentsWithTestid = function (dom, name) {
-//   let componentList = TestUtils.findAllInRenderedTree(dom, (i, j) => {
-//     if (TestUtils.isDOMComponent(i)) {
-//       let val = i.getAttribute('data-id');
-//       if (typeof val !== 'undefined' && val == name) {
-//         return true;
-//       }
-//       return false;
-//     }
-//   });
-//   return componentList;
-// };
-
-// TestUtils.findRenderedComponentsWithTestid = function (dom, name) {
-//   let list = TestUtils.scryRenderedComponentsWithTestid(dom, name);
-//   if (list.length !== 1) {
-//     throw new Error(
-//       `Did not find exactly one match (found: ${list.length}) ` +
-//       `for data-id:${name}`
-//     );
-//   }
-//   return list[0];
-// };
-
-// global.render = function (Component, props) {
-//   const renderedDOM = TestUtils.renderIntoDocument(<Component {...props} />);
-//   return {
-//     props,
-//     renderedDOM
-//   };
-// };
-
-// global.setup = function (Component, props, state) {
-//   let router = {
-//     router: {
-//       push() { },
-//       createHref(ob) {
-//         return ob.pathname;
-//       },
-//       isActive() {
-//         return true;
-//       },
-//       replace() { },
-//       go() { },
-//       goBack() { },
-//       goForward() { },
-//       setRouteLeaveHook() { },
-//       getState() { }
-//     },
-//     store: {
-//       getState() {
-//         return state;
-//       }
-//     }
-//   };
-//   // var store = {
-//   // 	store:{
-//   // 		getState:function(){return state;}
-//   // 	}
-//   // }
-//   var Component = higherComponent(Component, router);
-//   const renderedDOM = TestUtils.renderIntoDocument(
-//     <Component {...props} />,
-//     router
-//   );
-//   return {
-//     props,
-//     renderedDOM
-//   };
-// };
-
-// function higherComponent(ActualComponent, context) {
-//   if (context) {
-//     class HigherComponent extends React.Component {
-//       constructor() {
-//         super();
-//       }
-
-//       getChildContext() {
-//         return context;
-//       }
-
-//       render() {
-//         return <ActualComponent {...this.props} />;
-//       }
-//     }
-
-//     HigherComponent.childContextTypes = {
-//       router: PropTypes.any,
-//       store: PropTypes.any
-//     };
-
-//     return HigherComponent;
-//   }
-//   return ActualComponent;
-// }
-// global.window.matchMedia =
-//   window.matchMedia ||
-//   function () {
-//     return {
-//       matches: false,
-//       addListener() { },
-//       removeListener() { }
-//     };
-//   };
-// // global.renderHTML = function(comp) {
-// //   return ReactDOM.findDOMNode(comp);
-// // };
-
-// global.TestUtils = TestUtils;
-// global.getI18NValue = function (inp) {
-//   return inp;
-// };

package/src/core/playwright/codegen.js

@@ -1,60 +0,0 @@
-const { spawn } = require('child_process')
-const path = require('path');
-const { chromium } = require('@playwright/test');
-const { Logger } = require('../../utils/logger');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-
-const userArgs = process.argv.slice(3);
-
-const playwrightPath = path.resolve(getExecutableBinaryPath('playwright'));
-const command = playwrightPath;
-
-const args = ['codegen'].concat(userArgs);
-
-function generateCodegen() {
-  const childProcess = spawn(command, args, { stdio: 'inherit' });
-
-  childProcess.on('error', (error) => {
-    Logger.log(Logger.FAILURE_TYPE, error);
-  })
-
-  childProcess.on('exit', (code, signal) => {
-    Logger.log(Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-
-    process.exit();
-  });
-
-  process.on('exit', () => {
-    Logger.log(Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    //childProcess.kill();
-    return;
-  });
-
-  process.on('SIGINT', () => {
-    Logger.log(Logger.INFO_TYPE, 'Cleaning up...');
-    //childProcess.kill();
-    process.exit();
-
-  });
-}
-
-
-// Another way to record. Below way will load the url in autheticated state if present
-// function generateCodegen() {
-//   (async () => {
-//     // Make sure to run headed.
-//     const browser = await chromium.launch({ headless: false });
-
-//     // Setup context however you like.
-//     const context = await browser.newContext({ storageState: path.resolve(process.cwd(), 'playwright/.auth/user.json') });
-//     await context.route('**/*', route => route.continue());
-
-//     // Pause the page, and start recording manually.
-//     const page = await context.newPage();
-//     console.log(userArgs.join(''));
-//     await page.goto(`https://${userArgs.join('')}`);
-//     await page.pause();
-//   })();
-// }
-
-module.exports = generateCodegen;

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

@@ -1,3 +0,0 @@
-module.exports = {
-  CUSTOM_COMMANDS: ['mode']
-}

package/src/core/playwright/env-initializer.js

@@ -1,24 +0,0 @@
-const { readFileSync } = require('fs');
-const path = require('path');
-
-
-
-function initializeEnvConfig(mode = 'dev') {
-  try {
-    const configFile = readFileSync(path.resolve(process.cwd(), './uat/config.json'));
-
-    const configJSON = JSON.parse(configFile);
-    process.env.mode = mode;
-    for (const key in configJSON[mode]) {
-      process.env[key] = configJSON[mode][key];
-    }
-  } catch (err) {
-    throw new Error('Config File Not Exists. Please provide a config file to intiailize the environment variables')
-  }
-
-}
-
-
-module.exports = {
-  initializeEnvConfig
-};

package/src/core/playwright/index.js

@@ -1,82 +0,0 @@
-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
-}

package/src/core/playwright/readConfigFile.js

@@ -1,30 +0,0 @@
-const { existsSync } = require('fs');
-const path = require('path');
-
-const fileName = 'uat.config.js';
-
-function generateConfigFromFile() {
-  const filePath = path.resolve(process.cwd(), fileName);
-
-  if (existsSync(filePath)) {
-    const config = require(filePath);
-    return config;
-  }
-
-  return {};
-}
-
-function isUserConfigFileAvailable() {
-  const filePath = path.resolve(process.cwd(), fileName);
-  if (existsSync(filePath)) {
-    return true;
-  }
-  return false;
-}
-
-
-module.exports = {
-  fileName,
-  isUserConfigFileAvailable,
-  generateConfigFromFile
-};

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

@@ -1,43 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const { Logger } = require('../../utils/logger');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-
-
-const userArgs = process.argv.slice(3);
-
-const playwrightPath = path.resolve(getExecutableBinaryPath('playwright'));;
-const command = playwrightPath;
-const reportPath = path.resolve(process.cwd(), './playwright-report');
-
-
-const args = ['show-report', reportPath].concat(userArgs);
-
-function generateReport() {
-  const childProcess = spawn(command, args, { stdio: 'inherit' });
-  childProcess.on('error', (error) => {
-    Logger.log(Logger.FAILURE_TYPE, error);
-  })
-
-  childProcess.on('exit', (code, signal) => {
-    Logger.log(Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-
-    process.exit();
-  });
-
-  process.on('exit', () => {
-    Logger.log(Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    childProcess.kill();
-    return;
-  });
-
-  process.on('SIGINT', () => {
-    Logger.log(Logger.INFO_TYPE, 'Cleaning up...');
-    childProcess.kill();
-    process.exit();
-
-  });
-}
-
-
-module.exports = generateReport;

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

@@ -1,77 +0,0 @@
-// @ts-check
-const { defineConfig, devices } = require('@playwright/test');
-const path = require('path');
-const { generateConfigFromFile } = require('../readConfigFile');
-const numCPUs = require('os').cpus().length;
-
-const defaultBrowser = ['Chrome']
-
-const { browsers = defaultBrowser, isAuthMode, trace = false, video = false } = generateConfigFromFile();
-
-
-let projects = browsers.map(browser => {
-  if (browser === 'Chrome') {
-    return {
-      name: 'chromium',
-      use: {
-        ...devices['Desktop Chrome'],
-        storageState: isAuthMode ? path.resolve(process.cwd(), 'playwright/.auth/user.json') : {}
-      },
-      dependencies: isAuthMode ? ['setup'] : [],
-    };
-  } else if (browser === 'Firefox') {
-    return {
-      name: 'firefox',
-      timeout: 4 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Firefox'],
-        storageState: isAuthMode ? path.resolve(process.cwd(), 'playwright/.auth/user.json') : {}
-      },
-      dependencies: isAuthMode ? ['setup'] : [],
-    };
-  } else if (browser === 'safari') {
-    return {
-      name: 'webkit',
-      timeout: 2 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Safari'],
-        storageState: isAuthMode ? path.resolve(process.cwd(), 'playwright/.auth/user.json') : {}
-      },
-      dependencies: isAuthMode ? ['setup'] : null,
-    }
-  }
-}).filter(Boolean);
-
-module.exports = defineConfig({
-  testDir: path.join(path.resolve(process.cwd()), 'uat'),
-  outputDir: path.join(process.cwd(), 'test-results'),
-  fullyParallel: true,
-  forbidOnly: !!process.env.CI,
-  retries: process.env.CI ? 2 : 0,
-  workers: process.env.CI ? 1 : 1,
-  reporter: [['html', { outputFolder: path.join(process.cwd(), 'playwright-report'), open: "always" }]],
-  timeout: 60 * 1000,
-  expect: {
-    timeout: 5 * 1000,
-  },
-
-  use: {
-    trace: trace ? 'on' : 'off',
-    video: video ? {
-      mode: 'on',
-      size: { width: 640, height: 480 }
-    } : 'off'
-  },
-
-  projects: isAuthMode ? [
-    { name: 'setup', testMatch: /.*\.setup\.js/ },
-    ...projects
-  ] : [...projects]
-});
-

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

@@ -1,64 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const { CUSTOM_COMMANDS } = require('./custom-commands');
-const { cliArgsToObject, objectToCliArgs } = require('../../utils/cliArgsToObject');
-const { initializeEnvConfig } = require('./env-initializer');
-const { Logger } = require('../../utils/logger');
-const { isUserConfigFileAvailable } = require('./readConfigFile');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-
-
-
-// Access the command line arguments
-const userArgs = process.argv.slice(2);
-
-const userArgsObject = cliArgsToObject(userArgs);
-
-
-// Environment variables Initialization
-initializeEnvConfig(userArgsObject.mode ? userArgsObject.mode : 'dev');
-
-
-const playwrightArgs = objectToCliArgs(userArgsObject, (key) => !CUSTOM_COMMANDS.includes(key));
-
-// Command and arguments for npx playwright test
-const playwrightPath = path.resolve(getExecutableBinaryPath('playwright'));
-
-const command = playwrightPath;
-
-const configPath = isUserConfigFileAvailable() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
-
-const args = ['test', '--config', configPath].concat(playwrightArgs);
-
-
-function createTestRunner() {
-  // Spawn the child process
-
-  const childProcess = spawn(command, args, { stdio: 'inherit' });
-
-  childProcess.on('error', (error) => {
-    Logger.log(Logger.FAILURE_TYPE, error);
-  })
-
-  childProcess.on('exit', (code, signal) => {
-    Logger.log(Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-
-    process.exit();
-  });
-
-  process.on('exit', () => {
-    Logger.log(Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    //childProcess.kill();
-    return;
-  });
-
-  process.on('SIGINT', () => {
-    Logger.log(Logger.INFO_TYPE, 'Cleaning up...');
-    //childProcess.kill();
-    process.exit();
-
-  });
-}
-
-
-module.exports = createTestRunner;

package/src/index.js

@@ -1,9 +0,0 @@
-const { expect, test } = require('./core/playwright/index');
-const { fireEvent, render } = require('@testing-library/react');
-
-module.exports = {
-  expect,
-  test,
-  fireEvent,
-  render
-}

package/src/lib/cli.js

@@ -1,35 +0,0 @@
-const createTestRunner = require("../core/playwright/test-runner");
-const createJestRunner = require('../core/jest/runner/jest-runner');
-const generateReport = require("../core/playwright/report-generator");
-const generateCodegen = require('../core/playwright/codegen')
-const { Logger } = require("../utils/logger");
-
-const [, , option] = process.argv;
-const args = process.argv.slice(3);
-const appPath = process.cwd();
-
-
-switch (option) {
-  case 'test': {
-    Logger.log(Logger.SUCCESS_TYPE, 'Running Tests..');
-    createTestRunner();
-    //createJestRunner();
-    break;
-  }
-  case 'report': {
-    // console.log('\x1b[36mGenerating Reports...\x1b[0m');
-    Logger.log(Logger.SUCCESS_TYPE, 'Generating Reports...');
-    generateReport();
-    break;
-  }
-  case 'codegen': {
-    Logger.log(Logger.INFO_TYPE, 'The purpose of codegen is to assist developer .....')
-    generateCodegen();
-    break;
-  }
-
-  default: {
-    console.log('Supported Commands test and report')
-    break;
-  }
-}